Skip to content

Latest commit

 

History

History
1066 lines (812 loc) · 55 KB

README.md

File metadata and controls

1066 lines (812 loc) · 55 KB

FormanceV2

(Orchestration.V2)

Overview

Available Operations

CancelEvent

Cancel a running workflow

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.CancelEvent(ctx, operations.V2CancelEventRequest{
        InstanceID: "xxx",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2CancelEventRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2CancelEventResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

CreateTrigger

Create trigger

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

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

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request shared.V2TriggerData ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2CreateTriggerResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

CreateWorkflow

Create a workflow

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

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

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request shared.V2CreateWorkflowRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2CreateWorkflowResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

DeleteTrigger

Read trigger

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.DeleteTrigger(ctx, operations.V2DeleteTriggerRequest{
        TriggerID: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2DeleteTriggerRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2DeleteTriggerResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

DeleteWorkflow

Delete a flow by id

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.DeleteWorkflow(ctx, operations.V2DeleteWorkflowRequest{
        FlowID: "xxx",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2DeleteWorkflowRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2DeleteWorkflowResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

GetInstance

Get a workflow instance by id

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.GetInstance(ctx, operations.V2GetInstanceRequest{
        InstanceID: "xxx",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2GetWorkflowInstanceResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2GetInstanceRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2GetInstanceResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

GetInstanceHistory

Get a workflow instance history by id

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.GetInstanceHistory(ctx, operations.V2GetInstanceHistoryRequest{
        InstanceID: "xxx",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2GetWorkflowInstanceHistoryResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2GetInstanceHistoryRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2GetInstanceHistoryResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

GetInstanceStageHistory

Get a workflow instance stage history

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.GetInstanceStageHistory(ctx, operations.V2GetInstanceStageHistoryRequest{
        InstanceID: "xxx",
        Number: 0,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2GetWorkflowInstanceHistoryStageResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2GetInstanceStageHistoryRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2GetInstanceStageHistoryResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

GetServerInfo

Get server info

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

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

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2GetServerInfoResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

GetWorkflow

Get a flow by id

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.GetWorkflow(ctx, operations.V2GetWorkflowRequest{
        FlowID: "xxx",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2GetWorkflowResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2GetWorkflowRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2GetWorkflowResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

ListInstances

List instances of a workflow

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.ListInstances(ctx, operations.V2ListInstancesRequest{
        Cursor: formancesdkgo.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
        PageSize: formancesdkgo.Int64(100),
        Running: formancesdkgo.Bool(true),
        WorkflowID: formancesdkgo.String("xxx"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2ListRunsResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2ListInstancesRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2ListInstancesResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

ListTriggers

List triggers

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.ListTriggers(ctx, operations.V2ListTriggersRequest{
        Cursor: formancesdkgo.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
        PageSize: formancesdkgo.Int64(100),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2ListTriggersResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2ListTriggersRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2ListTriggersResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

ListTriggersOccurrences

List triggers occurrences

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.ListTriggersOccurrences(ctx, operations.V2ListTriggersOccurrencesRequest{
        Cursor: formancesdkgo.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
        PageSize: formancesdkgo.Int64(100),
        TriggerID: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2ListTriggersOccurrencesResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2ListTriggersOccurrencesRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2ListTriggersOccurrencesResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

ListWorkflows

List registered workflows

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.ListWorkflows(ctx, operations.V2ListWorkflowsRequest{
        Cursor: formancesdkgo.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
        PageSize: formancesdkgo.Int64(100),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2ListWorkflowsResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2ListWorkflowsRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2ListWorkflowsResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

ReadTrigger

Read trigger

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.ReadTrigger(ctx, operations.V2ReadTriggerRequest{
        TriggerID: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2ReadTriggerResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2ReadTriggerRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2ReadTriggerResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

RunWorkflow

Run workflow

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.RunWorkflow(ctx, operations.V2RunWorkflowRequest{
        WorkflowID: "xxx",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2RunWorkflowResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2RunWorkflowRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2RunWorkflowResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

SendEvent

Send an event to a running workflow

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.SendEvent(ctx, operations.V2SendEventRequest{
        InstanceID: "xxx",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V2SendEventRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.V2SendEventResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /

TestTrigger

Test trigger

Example Usage

package main

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

func main() {
    s := formancesdkgo.New(
        formancesdkgo.WithSecurity(shared.Security{
            ClientID: formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
            ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
        }),
    )

    ctx := context.Background()
    res, err := s.Orchestration.V2.TestTrigger(ctx, operations.TestTriggerRequest{
        TriggerID: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2TestTriggerResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.TestTriggerRequest ✔️ The request object to use for the request.
opts []operations.Option The options for this request.

Response

*operations.TestTriggerResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.V2Error default application/json
sdkerrors.SDKError 4xx-5xx /