api

type Client struct {
	// contains filtered or unexported fields
}

type ClientItf interface {
	OAuthClientItf
	UsersClientItf
	NodesClientItf
	SubnetsClientItf
	ShipmentsClientItf
	StatementsClientItf
	TransactionsClientItf
	SubscriptionsClientItf
}

type Config struct {
	ID string
	// Key is the authentication API key.
	// Most requests to the Synapse API must be authenticated with an API key.
	// You can create an API key in your Settings page after creating a Synapse account.
	// Reference: https://docs.synapsefi.com/intro-to-apis
	Key string
	// Timeout describes total waiting time before a request is treated as timeout.
	// Optional.
	// Default: 1 min.
	Timeout time.Duration
	// RetryCount describes total number of retry in case error occurred.
	// Optional.
	// Default: 0 = disable retry mechanism.
	RetryCount int
	// RetryMaxWaitTime describes total waiting time between each retry.
	// Optional.
	// Default: 2 second.
	RetryMaxWaitTime time.Duration
	// Debug describes the client to enter debug mode.
	// Debug mode will dump the request and response on each API call.
	// Be warn, credentials data will be dumped too.
	// Ensure you're only this mode on safe environment like local.
	// Optional.
	// Default: false.
	Debug bool
	// HostURL describes the host url target.
	// HostURL can be filled with your fake server host url for testing purpose.
	// Optional.
	// Default: https://api.synapsefi.com
	HostURL string
}

type NodesClientItf interface {
	ViewAllUserNodes(ctx context.Context, req *entity.ViewAllUserNodesReq) (*entity.ViewAllUserNodesResp, error)
	ViewNode(ctx context.Context, req *entity.ViewNodeReq) (*entity.ViewNodeResp, error)
	CreateNode(ctx context.Context, req *entity.CreateNodeReq) (*entity.CreateNodeResp, error)
	UpdateNode(ctx context.Context, req *entity.UpdateNodeReq) (*entity.UpdateNodeResp, error)
	GenerateECashBarcode(ctx context.Context, req *entity.GenerateECashBarcodeReq) (*entity.GenerateECashBarcodeResp, error)
	AllowedNodeTypes(ctx context.Context) (*entity.AllowedNodeTypesResp, error)
	ViewATMs(ctx context.Context) (*entity.ViewATMsResp, error)
}

type OAuthClientItf interface {
	CreateOAuthKey(ctx context.Context, req *entity.CreateOAuthKeyReq) (*entity.CreateOAuthKeyResp, error)
	GenerateRefreshToken(ctx context.Context, req *entity.GenerateRefreshTokenReq) (*entity.GenerateRefreshTokenResp, error)
}

type ShipmentsClientItf interface {
}

type StatementsClientItf interface {
}

type SubnetsClientItf interface {
	ViewAllNodeSubnets(ctx context.Context, req *entity.ViewAllNodeSubnetsReq) (*entity.ViewAllNodeSubnetsResp, error)
	ViewSubnet(ctx context.Context, req *entity.ViewSubnetReq) (*entity.ViewSubnetResp, error)
	CreateSubnet(ctx context.Context, req *entity.CreateSubnetReq) (*entity.CreateSubnetResp, error)
	UpdateSubnet(ctx context.Context, req *entity.UpdateSubnetReq) (*entity.UpdateSubnetResp, error)
	PushToWallet(ctx context.Context, req *entity.PushToWalletReq) (*entity.PushToWalletResp, error)
}

type SubscriptionsClientItf interface {
}

type TransactionsClientItf interface {
}

type UsersClientItf interface {
	ViewAllUsers(ctx context.Context, req *entity.ViewAllUsersReq) (*entity.ViewAllUsersResp, error)
	ViewUser(ctx context.Context, req *entity.ViewUserReq) (*entity.ViewUserResp, error)
	CreateUser(ctx context.Context, req *entity.CreateUserReq) (*entity.CreateUserResp, error)
	UpdateUser(ctx context.Context, req *entity.UpdateUserReq) (*entity.UpdateUserResp, error)
	GenerateUBODoc(ctx context.Context, req *entity.GenerateUBODocReq) (*entity.GenerateUBODocResp, error)
	GetDuplicates(ctx context.Context, req *entity.GetDuplicatesReq) (*entity.GetDuplicatesResp, error)
	SwapDuplicateUsers(ctx context.Context, req *entity.SwapDuplicateUsersReq) (*entity.SwapDuplicateUsersResp, error)
	AllowedDocumentTypes(ctx context.Context) (*entity.AllowedDocumentTypesResp, error)
	AllowedEntityScopes(ctx context.Context) (*entity.AllowedEntityScopesResp, error)
	AllowedEntityTypes(ctx context.Context) (*entity.AllowedEntityTypesResp, error)
}