formancesdkgo

package module
v2.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 30, 2024 License: MIT Imports: 12 Imported by: 1

README

github.com/formancehq/formance-sdk-go/v2

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

SDK Installation

go get github.com/formancehq/formance-sdk-go

SDK Example Usage

Example
package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"log"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithSecurity(shared.Security{
			Authorization: "<YOUR_AUTHORIZATION_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.GetOIDCWellKnowns(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Available Resources and Operations

Formance SDK
Auth
Ledger
Orchestration
Payments
Reconciliation
Wallets
Webhooks

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object Status Code Content Type
sdkerrors.ErrorResponse default application/json
sdkerrors.SDKError 4xx-5xx /
Example
package main

import (
	"context"
	"errors"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/sdkerrors"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"log"
	"math/big"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithSecurity(shared.Security{
			Authorization: "<YOUR_AUTHORIZATION_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.Ledger.CreateTransactions(ctx, operations.CreateTransactionsRequest{
		Transactions: shared.Transactions{
			Transactions: []shared.TransactionData{
				shared.TransactionData{
					Postings: []shared.Posting{
						shared.Posting{
							Amount:      big.NewInt(100),
							Asset:       "COIN",
							Destination: "users:002",
							Source:      "users:001",
						},
					},
					Reference: formancesdkgo.String("ref:001"),
				},
			},
		},
		Ledger: "ledger001",
	})
	if err != nil {

		var e *sdkerrors.ErrorResponse
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 http://localhost None
Example
package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"log"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithServerIndex(0),
		formancesdkgo.WithSecurity(shared.Security{
			Authorization: "<YOUR_AUTHORIZATION_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.GetOIDCWellKnowns(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}
Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"log"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithServerURL("http://localhost"),
		formancesdkgo.WithSecurity(shared.Security{
			Authorization: "<YOUR_AUTHORIZATION_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.GetOIDCWellKnowns(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
Authorization oauth2 OAuth2 token

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"log"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithSecurity(shared.Security{
			Authorization: "<YOUR_AUTHORIZATION_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.GetOIDCWellKnowns(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Special Types

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ServerList = []string{

	"http://localhost",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool 

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32 

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64 

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int 

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64 

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func String 

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type Auth 

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

func (*Auth) CreateClient 

func (s *Auth) CreateClient(ctx context.Context, request *shared.CreateClientRequest) (*operations.CreateClientResponse, error)

CreateClient - Create client

func (*Auth) CreateSecret 

func (s *Auth) CreateSecret(ctx context.Context, request operations.CreateSecretRequest) (*operations.CreateSecretResponse, error)

CreateSecret - Add a secret to a client

func (*Auth) DeleteClient 

func (s *Auth) DeleteClient(ctx context.Context, request operations.DeleteClientRequest) (*operations.DeleteClientResponse, error)

DeleteClient - Delete client

func (*Auth) DeleteSecret 

func (s *Auth) DeleteSecret(ctx context.Context, request operations.DeleteSecretRequest) (*operations.DeleteSecretResponse, error)

DeleteSecret - Delete a secret from a client

func (*Auth) ListClients 

func (s *Auth) ListClients(ctx context.Context) (*operations.ListClientsResponse, error)

ListClients - List clients

func (*Auth) ListUsers 

func (s *Auth) ListUsers(ctx context.Context) (*operations.ListUsersResponse, error)

ListUsers - List users List users

func (*Auth) ReadClient 

func (s *Auth) ReadClient(ctx context.Context, request operations.ReadClientRequest) (*operations.ReadClientResponse, error)

ReadClient - Read client

func (*Auth) ReadUser 

func (s *Auth) ReadUser(ctx context.Context, request operations.ReadUserRequest) (*operations.ReadUserResponse, error)

ReadUser - Read user Read user

func (*Auth) UpdateClient 

func (s *Auth) UpdateClient(ctx context.Context, request operations.UpdateClientRequest) (*operations.UpdateClientResponse, error)

UpdateClient - Update client

type Formance 

type Formance struct {
	Auth           *Auth
	Ledger         *Ledger
	Orchestration  *Orchestration
	Payments       *Payments
	Reconciliation *Reconciliation
	Search         *Search
	Wallets        *Wallets
	Webhooks       *Webhooks
	// contains filtered or unexported fields
}

Formance Stack API: Open, modular foundation for unique payments flows

# Introduction This API is documented in **OpenAPI format**.

# Authentication Formance Stack offers one forms of authentication:

  • OAuth2

OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications. <SecurityDefinitions />

func New 

func New(opts ...SDKOption) *Formance

New creates a new instance of the SDK with the provided options

func (*Formance) GetOIDCWellKnowns added in v2.1.3 

func (s *Formance) GetOIDCWellKnowns(ctx context.Context) (*operations.GetOIDCWellKnownsResponse, error)

GetOIDCWellKnowns - Retrieve OpenID connect well-knowns.

func (*Formance) GetVersions 

func (s *Formance) GetVersions(ctx context.Context) (*operations.GetVersionsResponse, error)

GetVersions - Show stack version information

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for suplying the SDK with a custom HTTP client

type Ledger 

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

func (*Ledger) AddMetadataOnTransaction 

func (s *Ledger) AddMetadataOnTransaction(ctx context.Context, request operations.AddMetadataOnTransactionRequest) (*operations.AddMetadataOnTransactionResponse, error)

AddMetadataOnTransaction - Set the metadata of a transaction by its ID

func (*Ledger) AddMetadataToAccount 

func (s *Ledger) AddMetadataToAccount(ctx context.Context, request operations.AddMetadataToAccountRequest) (*operations.AddMetadataToAccountResponse, error)

AddMetadataToAccount - Add metadata to an account

func (*Ledger) CountAccounts 

func (s *Ledger) CountAccounts(ctx context.Context, request operations.CountAccountsRequest) (*operations.CountAccountsResponse, error)

CountAccounts - Count the accounts from a ledger

func (*Ledger) CountTransactions 

func (s *Ledger) CountTransactions(ctx context.Context, request operations.CountTransactionsRequest) (*operations.CountTransactionsResponse, error)

CountTransactions - Count the transactions from a ledger

func (*Ledger) CreateTransaction 

func (s *Ledger) CreateTransaction(ctx context.Context, request operations.CreateTransactionRequest) (*operations.CreateTransactionResponse, error)

CreateTransaction - Create a new transaction to a ledger

func (*Ledger) CreateTransactions 

func (s *Ledger) CreateTransactions(ctx context.Context, request operations.CreateTransactionsRequest) (*operations.CreateTransactionsResponse, error)

CreateTransactions - Create a new batch of transactions to a ledger

func (*Ledger) GetAccount 

func (s *Ledger) GetAccount(ctx context.Context, request operations.GetAccountRequest) (*operations.GetAccountResponse, error)

GetAccount - Get account by its address

func (*Ledger) GetBalances 

func (s *Ledger) GetBalances(ctx context.Context, request operations.GetBalancesRequest) (*operations.GetBalancesResponse, error)

GetBalances - Get the balances from a ledger's account

func (*Ledger) GetBalancesAggregated 

func (s *Ledger) GetBalancesAggregated(ctx context.Context, request operations.GetBalancesAggregatedRequest) (*operations.GetBalancesAggregatedResponse, error)

GetBalancesAggregated - Get the aggregated balances from selected accounts

func (*Ledger) GetInfo 

func (s *Ledger) GetInfo(ctx context.Context) (*operations.GetInfoResponse, error)

GetInfo - Show server information

func (*Ledger) GetLedgerInfo 

func (s *Ledger) GetLedgerInfo(ctx context.Context, request operations.GetLedgerInfoRequest) (*operations.GetLedgerInfoResponse, error)

GetLedgerInfo - Get information about a ledger

func (*Ledger) GetMapping 

func (s *Ledger) GetMapping(ctx context.Context, request operations.GetMappingRequest) (*operations.GetMappingResponse, error)

GetMapping - Get the mapping of a ledger

func (*Ledger) GetTransaction 

func (s *Ledger) GetTransaction(ctx context.Context, request operations.GetTransactionRequest) (*operations.GetTransactionResponse, error)

GetTransaction - Get transaction from a ledger by its ID

func (*Ledger) ListAccounts 

func (s *Ledger) ListAccounts(ctx context.Context, request operations.ListAccountsRequest) (*operations.ListAccountsResponse, error)

ListAccounts - List accounts from a ledger List accounts from a ledger, sorted by address in descending order.

func (*Ledger) ListLogs 

func (s *Ledger) ListLogs(ctx context.Context, request operations.ListLogsRequest) (*operations.ListLogsResponse, error)

ListLogs - List the logs from a ledger List the logs from a ledger, sorted by ID in descending order.

func (*Ledger) ListTransactions 

func (s *Ledger) ListTransactions(ctx context.Context, request operations.ListTransactionsRequest) (*operations.ListTransactionsResponse, error)

ListTransactions - List transactions from a ledger List transactions from a ledger, sorted by txid in descending order.

func (*Ledger) ReadStats 

func (s *Ledger) ReadStats(ctx context.Context, request operations.ReadStatsRequest) (*operations.ReadStatsResponse, error)

ReadStats - Get statistics from a ledger Get statistics from a ledger. (aggregate metrics on accounts and transactions)

func (*Ledger) RevertTransaction 

func (s *Ledger) RevertTransaction(ctx context.Context, request operations.RevertTransactionRequest) (*operations.RevertTransactionResponse, error)

RevertTransaction - Revert a ledger transaction by its ID

func (*Ledger) RunScript 

func (s *Ledger) RunScript(ctx context.Context, request operations.RunScriptRequest) (*operations.RunScriptResponse, error)

RunScript - Execute a Numscript This route is deprecated, and has been merged into `POST /{ledger}/transactions`.

Deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.

func (*Ledger) UpdateMapping 

func (s *Ledger) UpdateMapping(ctx context.Context, request operations.UpdateMappingRequest) (*operations.UpdateMappingResponse, error)

UpdateMapping - Update the mapping of a ledger

func (*Ledger) V2AddMetadataOnTransaction 

func (s *Ledger) V2AddMetadataOnTransaction(ctx context.Context, request operations.V2AddMetadataOnTransactionRequest) (*operations.V2AddMetadataOnTransactionResponse, error)

V2AddMetadataOnTransaction - Set the metadata of a transaction by its ID

func (*Ledger) V2AddMetadataToAccount 

func (s *Ledger) V2AddMetadataToAccount(ctx context.Context, request operations.V2AddMetadataToAccountRequest) (*operations.V2AddMetadataToAccountResponse, error)

V2AddMetadataToAccount - Add metadata to an account

func (*Ledger) V2CountAccounts 

func (s *Ledger) V2CountAccounts(ctx context.Context, request operations.V2CountAccountsRequest) (*operations.V2CountAccountsResponse, error)

V2CountAccounts - Count the accounts from a ledger

func (*Ledger) V2CountTransactions 

func (s *Ledger) V2CountTransactions(ctx context.Context, request operations.V2CountTransactionsRequest) (*operations.V2CountTransactionsResponse, error)

V2CountTransactions - Count the transactions from a ledger

func (*Ledger) V2CreateBulk 

func (s *Ledger) V2CreateBulk(ctx context.Context, request operations.V2CreateBulkRequest) (*operations.V2CreateBulkResponse, error)

V2CreateBulk - Bulk request

func (*Ledger) V2CreateLedger 

func (s *Ledger) V2CreateLedger(ctx context.Context, request operations.V2CreateLedgerRequest) (*operations.V2CreateLedgerResponse, error)

V2CreateLedger - Create a ledger

func (*Ledger) V2CreateTransaction 

func (s *Ledger) V2CreateTransaction(ctx context.Context, request operations.V2CreateTransactionRequest) (*operations.V2CreateTransactionResponse, error)

V2CreateTransaction - Create a new transaction to a ledger

func (*Ledger) V2DeleteAccountMetadata 

func (s *Ledger) V2DeleteAccountMetadata(ctx context.Context, request operations.V2DeleteAccountMetadataRequest) (*operations.V2DeleteAccountMetadataResponse, error)

V2DeleteAccountMetadata - Delete metadata by key Delete metadata by key

func (*Ledger) V2DeleteLedgerMetadata added in v2.1.3 

func (s *Ledger) V2DeleteLedgerMetadata(ctx context.Context, request operations.V2DeleteLedgerMetadataRequest) (*operations.V2DeleteLedgerMetadataResponse, error)

V2DeleteLedgerMetadata - Delete ledger metadata by key

func (*Ledger) V2DeleteTransactionMetadata 

func (s *Ledger) V2DeleteTransactionMetadata(ctx context.Context, request operations.V2DeleteTransactionMetadataRequest) (*operations.V2DeleteTransactionMetadataResponse, error)

V2DeleteTransactionMetadata - Delete metadata by key Delete metadata by key

func (*Ledger) V2GetAccount 

func (s *Ledger) V2GetAccount(ctx context.Context, request operations.V2GetAccountRequest) (*operations.V2GetAccountResponse, error)

V2GetAccount - Get account by its address

func (*Ledger) V2GetBalancesAggregated 

func (s *Ledger) V2GetBalancesAggregated(ctx context.Context, request operations.V2GetBalancesAggregatedRequest) (*operations.V2GetBalancesAggregatedResponse, error)

V2GetBalancesAggregated - Get the aggregated balances from selected accounts

func (*Ledger) V2GetInfo 

func (s *Ledger) V2GetInfo(ctx context.Context) (*operations.V2GetInfoResponse, error)

V2GetInfo - Show server information

func (*Ledger) V2GetLedger 

func (s *Ledger) V2GetLedger(ctx context.Context, request operations.V2GetLedgerRequest) (*operations.V2GetLedgerResponse, error)

V2GetLedger - Get a ledger

func (*Ledger) V2GetLedgerInfo 

func (s *Ledger) V2GetLedgerInfo(ctx context.Context, request operations.V2GetLedgerInfoRequest) (*operations.V2GetLedgerInfoResponse, error)

V2GetLedgerInfo - Get information about a ledger

func (*Ledger) V2GetTransaction 

func (s *Ledger) V2GetTransaction(ctx context.Context, request operations.V2GetTransactionRequest) (*operations.V2GetTransactionResponse, error)

V2GetTransaction - Get transaction from a ledger by its ID

func (*Ledger) V2GetVolumesWithBalances added in v2.1.4 

func (s *Ledger) V2GetVolumesWithBalances(ctx context.Context, request operations.V2GetVolumesWithBalancesRequest) (*operations.V2GetVolumesWithBalancesResponse, error)

V2GetVolumesWithBalances - Get list of volumes with balances for (account/asset)

func (*Ledger) V2ListAccounts 

func (s *Ledger) V2ListAccounts(ctx context.Context, request operations.V2ListAccountsRequest) (*operations.V2ListAccountsResponse, error)

V2ListAccounts - List accounts from a ledger List accounts from a ledger, sorted by address in descending order.

func (*Ledger) V2ListLedgers 

func (s *Ledger) V2ListLedgers(ctx context.Context, request operations.V2ListLedgersRequest) (*operations.V2ListLedgersResponse, error)

V2ListLedgers - List ledgers

func (*Ledger) V2ListLogs 

func (s *Ledger) V2ListLogs(ctx context.Context, request operations.V2ListLogsRequest) (*operations.V2ListLogsResponse, error)

V2ListLogs - List the logs from a ledger List the logs from a ledger, sorted by ID in descending order.

func (*Ledger) V2ListTransactions 

func (s *Ledger) V2ListTransactions(ctx context.Context, request operations.V2ListTransactionsRequest) (*operations.V2ListTransactionsResponse, error)

V2ListTransactions - List transactions from a ledger List transactions from a ledger, sorted by id in descending order.

func (*Ledger) V2ReadStats 

func (s *Ledger) V2ReadStats(ctx context.Context, request operations.V2ReadStatsRequest) (*operations.V2ReadStatsResponse, error)

V2ReadStats - Get statistics from a ledger Get statistics from a ledger. (aggregate metrics on accounts and transactions)

func (*Ledger) V2RevertTransaction 

func (s *Ledger) V2RevertTransaction(ctx context.Context, request operations.V2RevertTransactionRequest) (*operations.V2RevertTransactionResponse, error)

V2RevertTransaction - Revert a ledger transaction by its ID

func (*Ledger) V2UpdateLedgerMetadata added in v2.1.3 

func (s *Ledger) V2UpdateLedgerMetadata(ctx context.Context, request operations.V2UpdateLedgerMetadataRequest) (*operations.V2UpdateLedgerMetadataResponse, error)

V2UpdateLedgerMetadata - Update ledger metadata

type Orchestration 

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

func (*Orchestration) CancelEvent 

func (s *Orchestration) CancelEvent(ctx context.Context, request operations.CancelEventRequest) (*operations.CancelEventResponse, error)

CancelEvent - Cancel a running workflow Cancel a running workflow

func (*Orchestration) CreateTrigger 

func (s *Orchestration) CreateTrigger(ctx context.Context, request *shared.TriggerData) (*operations.CreateTriggerResponse, error)

CreateTrigger - Create trigger Create trigger

func (*Orchestration) CreateWorkflow 

func (s *Orchestration) CreateWorkflow(ctx context.Context, request *shared.CreateWorkflowRequest) (*operations.CreateWorkflowResponse, error)

CreateWorkflow - Create workflow Create a workflow

func (*Orchestration) DeleteTrigger 

func (s *Orchestration) DeleteTrigger(ctx context.Context, request operations.DeleteTriggerRequest) (*operations.DeleteTriggerResponse, error)

DeleteTrigger - Delete trigger Read trigger

func (*Orchestration) DeleteWorkflow 

func (s *Orchestration) DeleteWorkflow(ctx context.Context, request operations.DeleteWorkflowRequest) (*operations.DeleteWorkflowResponse, error)

DeleteWorkflow - Delete a flow by id Delete a flow by id

func (*Orchestration) GetInstance 

func (s *Orchestration) GetInstance(ctx context.Context, request operations.GetInstanceRequest) (*operations.GetInstanceResponse, error)

GetInstance - Get a workflow instance by id Get a workflow instance by id

func (*Orchestration) GetInstanceHistory 

func (s *Orchestration) GetInstanceHistory(ctx context.Context, request operations.GetInstanceHistoryRequest) (*operations.GetInstanceHistoryResponse, error)

GetInstanceHistory - Get a workflow instance history by id Get a workflow instance history by id

func (*Orchestration) GetInstanceStageHistory 

func (s *Orchestration) GetInstanceStageHistory(ctx context.Context, request operations.GetInstanceStageHistoryRequest) (*operations.GetInstanceStageHistoryResponse, error)

GetInstanceStageHistory - Get a workflow instance stage history Get a workflow instance stage history

func (*Orchestration) GetWorkflow 

func (s *Orchestration) GetWorkflow(ctx context.Context, request operations.GetWorkflowRequest) (*operations.GetWorkflowResponse, error)

GetWorkflow - Get a flow by id Get a flow by id

func (*Orchestration) ListInstances 

func (s *Orchestration) ListInstances(ctx context.Context, request operations.ListInstancesRequest) (*operations.ListInstancesResponse, error)

ListInstances - List instances of a workflow List instances of a workflow

func (*Orchestration) ListTriggers 

func (s *Orchestration) ListTriggers(ctx context.Context, request operations.ListTriggersRequest) (*operations.ListTriggersResponse, error)

ListTriggers - List triggers List triggers

func (*Orchestration) ListTriggersOccurrences 

func (s *Orchestration) ListTriggersOccurrences(ctx context.Context, request operations.ListTriggersOccurrencesRequest) (*operations.ListTriggersOccurrencesResponse, error)

ListTriggersOccurrences - List triggers occurrences List triggers occurrences

func (*Orchestration) ListWorkflows 

func (s *Orchestration) ListWorkflows(ctx context.Context) (*operations.ListWorkflowsResponse, error)

ListWorkflows - List registered workflows List registered workflows

func (*Orchestration) OrchestrationgetServerInfo 

func (s *Orchestration) OrchestrationgetServerInfo(ctx context.Context) (*operations.OrchestrationgetServerInfoResponse, error)

OrchestrationgetServerInfo - Get server info

func (*Orchestration) ReadTrigger 

func (s *Orchestration) ReadTrigger(ctx context.Context, request operations.ReadTriggerRequest) (*operations.ReadTriggerResponse, error)

ReadTrigger - Read trigger Read trigger

func (*Orchestration) RunWorkflow 

func (s *Orchestration) RunWorkflow(ctx context.Context, request operations.RunWorkflowRequest) (*operations.RunWorkflowResponse, error)

RunWorkflow - Run workflow Run workflow

func (*Orchestration) SendEvent 

func (s *Orchestration) SendEvent(ctx context.Context, request operations.SendEventRequest) (*operations.SendEventResponse, error)

SendEvent - Send an event to a running workflow Send an event to a running workflow

func (*Orchestration) TestTrigger 

func (s *Orchestration) TestTrigger(ctx context.Context, request operations.TestTriggerRequest) (*operations.TestTriggerResponse, error)

TestTrigger - Test trigger Test trigger

func (*Orchestration) V2CancelEvent 

func (s *Orchestration) V2CancelEvent(ctx context.Context, request operations.V2CancelEventRequest) (*operations.V2CancelEventResponse, error)

V2CancelEvent - Cancel a running workflow Cancel a running workflow

func (*Orchestration) V2CreateTrigger 

func (s *Orchestration) V2CreateTrigger(ctx context.Context, request *shared.V2TriggerData) (*operations.V2CreateTriggerResponse, error)

V2CreateTrigger - Create trigger Create trigger

func (*Orchestration) V2CreateWorkflow 

func (s *Orchestration) V2CreateWorkflow(ctx context.Context, request *shared.V2CreateWorkflowRequest) (*operations.V2CreateWorkflowResponse, error)

V2CreateWorkflow - Create workflow Create a workflow

func (*Orchestration) V2DeleteTrigger 

func (s *Orchestration) V2DeleteTrigger(ctx context.Context, request operations.V2DeleteTriggerRequest) (*operations.V2DeleteTriggerResponse, error)

V2DeleteTrigger - Delete trigger Read trigger

func (*Orchestration) V2DeleteWorkflow 

func (s *Orchestration) V2DeleteWorkflow(ctx context.Context, request operations.V2DeleteWorkflowRequest) (*operations.V2DeleteWorkflowResponse, error)

V2DeleteWorkflow - Delete a flow by id Delete a flow by id

func (*Orchestration) V2GetInstance 

func (s *Orchestration) V2GetInstance(ctx context.Context, request operations.V2GetInstanceRequest) (*operations.V2GetInstanceResponse, error)

V2GetInstance - Get a workflow instance by id Get a workflow instance by id

func (*Orchestration) V2GetInstanceHistory 

func (s *Orchestration) V2GetInstanceHistory(ctx context.Context, request operations.V2GetInstanceHistoryRequest) (*operations.V2GetInstanceHistoryResponse, error)

V2GetInstanceHistory - Get a workflow instance history by id Get a workflow instance history by id

func (*Orchestration) V2GetInstanceStageHistory 

func (s *Orchestration) V2GetInstanceStageHistory(ctx context.Context, request operations.V2GetInstanceStageHistoryRequest) (*operations.V2GetInstanceStageHistoryResponse, error)

V2GetInstanceStageHistory - Get a workflow instance stage history Get a workflow instance stage history

func (*Orchestration) V2GetServerInfo 

func (s *Orchestration) V2GetServerInfo(ctx context.Context) (*operations.V2GetServerInfoResponse, error)

V2GetServerInfo - Get server info

func (*Orchestration) V2GetWorkflow 

func (s *Orchestration) V2GetWorkflow(ctx context.Context, request operations.V2GetWorkflowRequest) (*operations.V2GetWorkflowResponse, error)

V2GetWorkflow - Get a flow by id Get a flow by id

func (*Orchestration) V2ListInstances 

func (s *Orchestration) V2ListInstances(ctx context.Context, request operations.V2ListInstancesRequest) (*operations.V2ListInstancesResponse, error)

V2ListInstances - List instances of a workflow List instances of a workflow

func (*Orchestration) V2ListTriggers 

func (s *Orchestration) V2ListTriggers(ctx context.Context, request operations.V2ListTriggersRequest) (*operations.V2ListTriggersResponse, error)

V2ListTriggers - List triggers List triggers

func (*Orchestration) V2ListTriggersOccurrences 

func (s *Orchestration) V2ListTriggersOccurrences(ctx context.Context, request operations.V2ListTriggersOccurrencesRequest) (*operations.V2ListTriggersOccurrencesResponse, error)

V2ListTriggersOccurrences - List triggers occurrences List triggers occurrences

func (*Orchestration) V2ListWorkflows 

func (s *Orchestration) V2ListWorkflows(ctx context.Context, request operations.V2ListWorkflowsRequest) (*operations.V2ListWorkflowsResponse, error)

V2ListWorkflows - List registered workflows List registered workflows

func (*Orchestration) V2ReadTrigger 

func (s *Orchestration) V2ReadTrigger(ctx context.Context, request operations.V2ReadTriggerRequest) (*operations.V2ReadTriggerResponse, error)

V2ReadTrigger - Read trigger Read trigger

func (*Orchestration) V2RunWorkflow 

func (s *Orchestration) V2RunWorkflow(ctx context.Context, request operations.V2RunWorkflowRequest) (*operations.V2RunWorkflowResponse, error)

V2RunWorkflow - Run workflow Run workflow

func (*Orchestration) V2SendEvent 

func (s *Orchestration) V2SendEvent(ctx context.Context, request operations.V2SendEventRequest) (*operations.V2SendEventResponse, error)

V2SendEvent - Send an event to a running workflow Send an event to a running workflow

type Payments 

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

func (*Payments) AddAccountToPool 

func (s *Payments) AddAccountToPool(ctx context.Context, request operations.AddAccountToPoolRequest) (*operations.AddAccountToPoolResponse, error)

AddAccountToPool - Add an account to a pool Add an account to a pool

func (*Payments) ConnectorsTransfer 

func (s *Payments) ConnectorsTransfer(ctx context.Context, request operations.ConnectorsTransferRequest) (*operations.ConnectorsTransferResponse, error)

ConnectorsTransfer - Transfer funds between Connector accounts Execute a transfer between two accounts.

func (*Payments) CreateAccount added in v2.1.5 

func (s *Payments) CreateAccount(ctx context.Context, request shared.AccountRequest) (*operations.CreateAccountResponse, error)

CreateAccount - Create an account Create an account

func (*Payments) CreateBankAccount 

func (s *Payments) CreateBankAccount(ctx context.Context, request shared.BankAccountRequest) (*operations.CreateBankAccountResponse, error)

CreateBankAccount - Create a BankAccount in Payments and on the PSP Create a bank account in Payments and on the PSP.

func (*Payments) CreatePayment 

func (s *Payments) CreatePayment(ctx context.Context, request shared.PaymentRequest) (*operations.CreatePaymentResponse, error)

CreatePayment - Create a payment Create a payment

func (*Payments) CreatePool 

func (s *Payments) CreatePool(ctx context.Context, request shared.PoolRequest) (*operations.CreatePoolResponse, error)

CreatePool - Create a Pool Create a Pool

func (*Payments) CreateTransferInitiation 

func (s *Payments) CreateTransferInitiation(ctx context.Context, request shared.TransferInitiationRequest) (*operations.CreateTransferInitiationResponse, error)

CreateTransferInitiation - Create a TransferInitiation Create a transfer initiation

func (*Payments) DeletePool 

func (s *Payments) DeletePool(ctx context.Context, request operations.DeletePoolRequest) (*operations.DeletePoolResponse, error)

DeletePool - Delete a Pool Delete a pool by its id.

func (*Payments) DeleteTransferInitiation 

func (s *Payments) DeleteTransferInitiation(ctx context.Context, request operations.DeleteTransferInitiationRequest) (*operations.DeleteTransferInitiationResponse, error)

DeleteTransferInitiation - Delete a transfer initiation Delete a transfer initiation by its id.

func (*Payments) ForwardBankAccount 

func (s *Payments) ForwardBankAccount(ctx context.Context, request operations.ForwardBankAccountRequest) (*operations.ForwardBankAccountResponse, error)

ForwardBankAccount - Forward a bank account to a connector

func (*Payments) GetAccountBalances 

func (s *Payments) GetAccountBalances(ctx context.Context, request operations.GetAccountBalancesRequest) (*operations.GetAccountBalancesResponse, error)

GetAccountBalances - Get account balances

func (*Payments) GetBankAccount 

func (s *Payments) GetBankAccount(ctx context.Context, request operations.GetBankAccountRequest) (*operations.GetBankAccountResponse, error)

GetBankAccount - Get a bank account created by user on Formance

func (*Payments) GetConnectorTask 

func (s *Payments) GetConnectorTask(ctx context.Context, request operations.GetConnectorTaskRequest) (*operations.GetConnectorTaskResponse, error)

GetConnectorTask - Read a specific task of the connector Get a specific task associated to the connector.

Deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.

func (*Payments) GetConnectorTaskV1 

func (s *Payments) GetConnectorTaskV1(ctx context.Context, request operations.GetConnectorTaskV1Request) (*operations.GetConnectorTaskV1Response, error)

GetConnectorTaskV1 - Read a specific task of the connector Get a specific task associated to the connector.

func (*Payments) GetPayment 

func (s *Payments) GetPayment(ctx context.Context, request operations.GetPaymentRequest) (*operations.GetPaymentResponse, error)

GetPayment - Get a payment

func (*Payments) GetPool 

func (s *Payments) GetPool(ctx context.Context, request operations.GetPoolRequest) (*operations.GetPoolResponse, error)

GetPool - Get a Pool

func (*Payments) GetPoolBalances 

func (s *Payments) GetPoolBalances(ctx context.Context, request operations.GetPoolBalancesRequest) (*operations.GetPoolBalancesResponse, error)

GetPoolBalances - Get pool balances

func (*Payments) GetTransferInitiation 

func (s *Payments) GetTransferInitiation(ctx context.Context, request operations.GetTransferInitiationRequest) (*operations.GetTransferInitiationResponse, error)

GetTransferInitiation - Get a transfer initiation

func (*Payments) InstallConnector 

func (s *Payments) InstallConnector(ctx context.Context, request operations.InstallConnectorRequest) (*operations.InstallConnectorResponse, error)

InstallConnector - Install a connector Install a connector by its name and config.

func (*Payments) ListAllConnectors 

func (s *Payments) ListAllConnectors(ctx context.Context) (*operations.ListAllConnectorsResponse, error)

ListAllConnectors - List all installed connectors List all installed connectors.

func (*Payments) ListBankAccounts 

func (s *Payments) ListBankAccounts(ctx context.Context, request operations.ListBankAccountsRequest) (*operations.ListBankAccountsResponse, error)

ListBankAccounts - List bank accounts created by user on Formance List all bank accounts created by user on Formance.

func (*Payments) ListConfigsAvailableConnectors 

func (s *Payments) ListConfigsAvailableConnectors(ctx context.Context) (*operations.ListConfigsAvailableConnectorsResponse, error)

ListConfigsAvailableConnectors - List the configs of each available connector List the configs of each available connector.

func (*Payments) ListConnectorTasks 

func (s *Payments) ListConnectorTasks(ctx context.Context, request operations.ListConnectorTasksRequest) (*operations.ListConnectorTasksResponse, error)

ListConnectorTasks - List tasks from a connector List all tasks associated with this connector.

Deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.

func (*Payments) ListConnectorTasksV1 

func (s *Payments) ListConnectorTasksV1(ctx context.Context, request operations.ListConnectorTasksV1Request) (*operations.ListConnectorTasksV1Response, error)

ListConnectorTasksV1 - List tasks from a connector List all tasks associated with this connector.

func (*Payments) ListPayments 

func (s *Payments) ListPayments(ctx context.Context, request operations.ListPaymentsRequest) (*operations.ListPaymentsResponse, error)

ListPayments - List payments

func (*Payments) ListPools 

func (s *Payments) ListPools(ctx context.Context, request operations.ListPoolsRequest) (*operations.ListPoolsResponse, error)

ListPools - List Pools

func (*Payments) ListTransferInitiations 

func (s *Payments) ListTransferInitiations(ctx context.Context, request operations.ListTransferInitiationsRequest) (*operations.ListTransferInitiationsResponse, error)

ListTransferInitiations - List Transfer Initiations

func (*Payments) PaymentsgetAccount 

func (s *Payments) PaymentsgetAccount(ctx context.Context, request operations.PaymentsgetAccountRequest) (*operations.PaymentsgetAccountResponse, error)

PaymentsgetAccount - Get an account

func (*Payments) PaymentsgetServerInfo 

func (s *Payments) PaymentsgetServerInfo(ctx context.Context) (*operations.PaymentsgetServerInfoResponse, error)

PaymentsgetServerInfo - Get server info

func (*Payments) PaymentslistAccounts 

func (s *Payments) PaymentslistAccounts(ctx context.Context, request operations.PaymentslistAccountsRequest) (*operations.PaymentslistAccountsResponse, error)

PaymentslistAccounts - List accounts

func (*Payments) ReadConnectorConfig 

func (s *Payments) ReadConnectorConfig(ctx context.Context, request operations.ReadConnectorConfigRequest) (*operations.ReadConnectorConfigResponse, error)

ReadConnectorConfig - Read the config of a connector Read connector config

Deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.

func (*Payments) ReadConnectorConfigV1 

func (s *Payments) ReadConnectorConfigV1(ctx context.Context, request operations.ReadConnectorConfigV1Request) (*operations.ReadConnectorConfigV1Response, error)

ReadConnectorConfigV1 - Read the config of a connector Read connector config

func (*Payments) RemoveAccountFromPool 

func (s *Payments) RemoveAccountFromPool(ctx context.Context, request operations.RemoveAccountFromPoolRequest) (*operations.RemoveAccountFromPoolResponse, error)

RemoveAccountFromPool - Remove an account from a pool Remove an account from a pool by its id.

func (*Payments) ResetConnector 

func (s *Payments) ResetConnector(ctx context.Context, request operations.ResetConnectorRequest) (*operations.ResetConnectorResponse, error)

ResetConnector - Reset a connector Reset a connector by its name. It will remove the connector and ALL PAYMENTS generated with it.

Deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.

func (*Payments) ResetConnectorV1 

func (s *Payments) ResetConnectorV1(ctx context.Context, request operations.ResetConnectorV1Request) (*operations.ResetConnectorV1Response, error)

ResetConnectorV1 - Reset a connector Reset a connector by its name. It will remove the connector and ALL PAYMENTS generated with it.

func (*Payments) RetryTransferInitiation 

func (s *Payments) RetryTransferInitiation(ctx context.Context, request operations.RetryTransferInitiationRequest) (*operations.RetryTransferInitiationResponse, error)

RetryTransferInitiation - Retry a failed transfer initiation Retry a failed transfer initiation

func (*Payments) ReverseTransferInitiation 

func (s *Payments) ReverseTransferInitiation(ctx context.Context, request operations.ReverseTransferInitiationRequest) (*operations.ReverseTransferInitiationResponse, error)

ReverseTransferInitiation - Reverse a transfer initiation Reverse transfer initiation

func (*Payments) UdpateTransferInitiationStatus 

func (s *Payments) UdpateTransferInitiationStatus(ctx context.Context, request operations.UdpateTransferInitiationStatusRequest) (*operations.UdpateTransferInitiationStatusResponse, error)

UdpateTransferInitiationStatus - Update the status of a transfer initiation Update a transfer initiation status

func (*Payments) UninstallConnector 

func (s *Payments) UninstallConnector(ctx context.Context, request operations.UninstallConnectorRequest) (*operations.UninstallConnectorResponse, error)

UninstallConnector - Uninstall a connector Uninstall a connector by its name.

Deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.

func (*Payments) UninstallConnectorV1 

func (s *Payments) UninstallConnectorV1(ctx context.Context, request operations.UninstallConnectorV1Request) (*operations.UninstallConnectorV1Response, error)

UninstallConnectorV1 - Uninstall a connector Uninstall a connector by its name.

func (*Payments) UpdateBankAccountMetadata 

func (s *Payments) UpdateBankAccountMetadata(ctx context.Context, request operations.UpdateBankAccountMetadataRequest) (*operations.UpdateBankAccountMetadataResponse, error)

UpdateBankAccountMetadata - Update metadata of a bank account

func (*Payments) UpdateConnectorConfigV1 

func (s *Payments) UpdateConnectorConfigV1(ctx context.Context, request operations.UpdateConnectorConfigV1Request) (*operations.UpdateConnectorConfigV1Response, error)

UpdateConnectorConfigV1 - Update the config of a connector Update connector config

func (*Payments) UpdateMetadata 

func (s *Payments) UpdateMetadata(ctx context.Context, request operations.UpdateMetadataRequest) (*operations.UpdateMetadataResponse, error)

UpdateMetadata - Update metadata

type Reconciliation 

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

func (*Reconciliation) CreatePolicy 

func (s *Reconciliation) CreatePolicy(ctx context.Context, request shared.PolicyRequest) (*operations.CreatePolicyResponse, error)

CreatePolicy - Create a policy Create a policy

func (*Reconciliation) DeletePolicy 

func (s *Reconciliation) DeletePolicy(ctx context.Context, request operations.DeletePolicyRequest) (*operations.DeletePolicyResponse, error)

DeletePolicy - Delete a policy Delete a policy by its id.

func (*Reconciliation) GetPolicy 

func (s *Reconciliation) GetPolicy(ctx context.Context, request operations.GetPolicyRequest) (*operations.GetPolicyResponse, error)

GetPolicy - Get a policy

func (*Reconciliation) GetReconciliation 

func (s *Reconciliation) GetReconciliation(ctx context.Context, request operations.GetReconciliationRequest) (*operations.GetReconciliationResponse, error)

GetReconciliation - Get a reconciliation

func (*Reconciliation) ListPolicies 

func (s *Reconciliation) ListPolicies(ctx context.Context, request operations.ListPoliciesRequest) (*operations.ListPoliciesResponse, error)

ListPolicies - List policies

func (*Reconciliation) ListReconciliations 

func (s *Reconciliation) ListReconciliations(ctx context.Context, request operations.ListReconciliationsRequest) (*operations.ListReconciliationsResponse, error)

ListReconciliations - List reconciliations

func (*Reconciliation) Reconcile 

func (s *Reconciliation) Reconcile(ctx context.Context, request operations.ReconcileRequest) (*operations.ReconcileResponse, error)

Reconcile using a policy Reconcile using a policy

func (*Reconciliation) ReconciliationgetServerInfo 

func (s *Reconciliation) ReconciliationgetServerInfo(ctx context.Context) (*operations.ReconciliationgetServerInfoResponse, error)

ReconciliationgetServerInfo - Get server info

type SDKOption 

type SDKOption func(*Formance)

func WithClient 

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithRetryConfig 

func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption

func WithSecurity 

func WithSecurity(security shared.Security) SDKOption

WithSecurity configures the SDK to use the provided security details

func WithSecuritySource 

func WithSecuritySource(security func(context.Context) (shared.Security, error)) SDKOption

WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication

func WithServerIndex 

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL 

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL 

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters 

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

func (*Search) Search 

func (s *Search) Search(ctx context.Context, request shared.Query) (*operations.SearchResponse, error)

Search ElasticSearch query engine

func (*Search) SearchgetServerInfo 

func (s *Search) SearchgetServerInfo(ctx context.Context) (*operations.SearchgetServerInfoResponse, error)

SearchgetServerInfo - Get server info

type Wallets 

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

func (*Wallets) ConfirmHold 

func (s *Wallets) ConfirmHold(ctx context.Context, request operations.ConfirmHoldRequest) (*operations.ConfirmHoldResponse, error)

ConfirmHold - Confirm a hold

func (*Wallets) CreateBalance 

func (s *Wallets) CreateBalance(ctx context.Context, request operations.CreateBalanceRequest) (*operations.CreateBalanceResponse, error)

CreateBalance - Create a balance

func (*Wallets) CreateWallet 

func (s *Wallets) CreateWallet(ctx context.Context, request *shared.CreateWalletRequest) (*operations.CreateWalletResponse, error)

CreateWallet - Create a new wallet

func (*Wallets) CreditWallet 

func (s *Wallets) CreditWallet(ctx context.Context, request operations.CreditWalletRequest) (*operations.CreditWalletResponse, error)

CreditWallet - Credit a wallet

func (*Wallets) DebitWallet 

func (s *Wallets) DebitWallet(ctx context.Context, request operations.DebitWalletRequest) (*operations.DebitWalletResponse, error)

DebitWallet - Debit a wallet

func (*Wallets) GetBalance 

func (s *Wallets) GetBalance(ctx context.Context, request operations.GetBalanceRequest) (*operations.GetBalanceResponse, error)

GetBalance - Get detailed balance

func (*Wallets) GetHold 

func (s *Wallets) GetHold(ctx context.Context, request operations.GetHoldRequest) (*operations.GetHoldResponse, error)

GetHold - Get a hold

func (*Wallets) GetHolds 

func (s *Wallets) GetHolds(ctx context.Context, request operations.GetHoldsRequest) (*operations.GetHoldsResponse, error)

GetHolds - Get all holds for a wallet

func (*Wallets) GetTransactions 

func (s *Wallets) GetTransactions(ctx context.Context, request operations.GetTransactionsRequest) (*operations.GetTransactionsResponse, error)

func (*Wallets) GetWallet 

func (s *Wallets) GetWallet(ctx context.Context, request operations.GetWalletRequest) (*operations.GetWalletResponse, error)

GetWallet - Get a wallet

func (*Wallets) GetWalletSummary 

func (s *Wallets) GetWalletSummary(ctx context.Context, request operations.GetWalletSummaryRequest) (*operations.GetWalletSummaryResponse, error)

GetWalletSummary - Get wallet summary

func (*Wallets) ListBalances 

func (s *Wallets) ListBalances(ctx context.Context, request operations.ListBalancesRequest) (*operations.ListBalancesResponse, error)

ListBalances - List balances of a wallet

func (*Wallets) ListWallets 

func (s *Wallets) ListWallets(ctx context.Context, request operations.ListWalletsRequest) (*operations.ListWalletsResponse, error)

ListWallets - List all wallets

func (*Wallets) UpdateWallet 

func (s *Wallets) UpdateWallet(ctx context.Context, request operations.UpdateWalletRequest) (*operations.UpdateWalletResponse, error)

UpdateWallet - Update a wallet

func (*Wallets) VoidHold 

func (s *Wallets) VoidHold(ctx context.Context, request operations.VoidHoldRequest) (*operations.VoidHoldResponse, error)

VoidHold - Cancel a hold

func (*Wallets) WalletsgetServerInfo 

func (s *Wallets) WalletsgetServerInfo(ctx context.Context) (*operations.WalletsgetServerInfoResponse, error)

WalletsgetServerInfo - Get server info

type Webhooks 

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

func (*Webhooks) ActivateConfig 

func (s *Webhooks) ActivateConfig(ctx context.Context, request operations.ActivateConfigRequest) (*operations.ActivateConfigResponse, error)

ActivateConfig - Activate one config Activate a webhooks config by ID, to start receiving webhooks to its endpoint.

func (*Webhooks) ChangeConfigSecret 

func (s *Webhooks) ChangeConfigSecret(ctx context.Context, request operations.ChangeConfigSecretRequest) (*operations.ChangeConfigSecretResponse, error)

ChangeConfigSecret - Change the signing secret of a config Change the signing secret of the endpoint of a webhooks config.

If not passed or empty, a secret is automatically generated. The format is a random string of bytes of size 24, base64 encoded. (larger size after encoding)

func (*Webhooks) DeactivateConfig 

func (s *Webhooks) DeactivateConfig(ctx context.Context, request operations.DeactivateConfigRequest) (*operations.DeactivateConfigResponse, error)

DeactivateConfig - Deactivate one config Deactivate a webhooks config by ID, to stop receiving webhooks to its endpoint.

func (*Webhooks) DeleteConfig 

func (s *Webhooks) DeleteConfig(ctx context.Context, request operations.DeleteConfigRequest) (*operations.DeleteConfigResponse, error)

DeleteConfig - Delete one config Delete a webhooks config by ID.

func (*Webhooks) GetManyConfigs 

func (s *Webhooks) GetManyConfigs(ctx context.Context, request operations.GetManyConfigsRequest) (*operations.GetManyConfigsResponse, error)

GetManyConfigs - Get many configs Sorted by updated date descending

func (*Webhooks) InsertConfig 

func (s *Webhooks) InsertConfig(ctx context.Context, request shared.ConfigUser) (*operations.InsertConfigResponse, error)

InsertConfig - Insert a new config Insert a new webhooks config.

The endpoint should be a valid https URL and be unique.

The secret is the endpoint's verification secret. If not passed or empty, a secret is automatically generated. The format is a random string of bytes of size 24, base64 encoded. (larger size after encoding)

All eventTypes are converted to lower-case when inserted.

func (*Webhooks) TestConfig 

func (s *Webhooks) TestConfig(ctx context.Context, request operations.TestConfigRequest) (*operations.TestConfigResponse, error)

TestConfig - Test one config Test a config by sending a webhook to its endpoint.

Source Files

View all Source files

Directories

Path Synopsis
internal
hooks
pkg
models/operations
models/sdkerrors
models/shared
types
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.