Documentation
¶
Index ¶
- type Client
- func (c *Client) Create(ctx context.Context, request *management.CreateActionRequestContent, ...) (*management.CreateActionResponseContent, error)
- func (c *Client) Delete(ctx context.Context, id string, ...) error
- func (c *Client) Deploy(ctx context.Context, id string, opts ...option.RequestOption) (*management.DeployActionResponseContent, error)
- func (c *Client) Get(ctx context.Context, id string, opts ...option.RequestOption) (*management.GetActionResponseContent, error)
- func (c *Client) List(ctx context.Context, request *management.ListActionsRequestParameters, ...) (...)
- func (c *Client) Test(ctx context.Context, id string, request *management.TestActionRequestContent, ...) (*management.TestActionResponseContent, error)
- func (c *Client) Update(ctx context.Context, id string, request *management.UpdateActionRequestContent, ...) (*management.UpdateActionResponseContent, error)
- type RawClient
- func (r *RawClient) Create(ctx context.Context, request *management.CreateActionRequestContent, ...) (*core.Response[*management.CreateActionResponseContent], error)
- func (r *RawClient) Delete(ctx context.Context, id string, ...) (*core.Response[any], error)
- func (r *RawClient) Deploy(ctx context.Context, id string, opts ...option.RequestOption) (*core.Response[*management.DeployActionResponseContent], error)
- func (r *RawClient) Get(ctx context.Context, id string, opts ...option.RequestOption) (*core.Response[*management.GetActionResponseContent], error)
- func (r *RawClient) Test(ctx context.Context, id string, request *management.TestActionRequestContent, ...) (*core.Response[*management.TestActionResponseContent], error)
- func (r *RawClient) Update(ctx context.Context, id string, request *management.UpdateActionRequestContent, ...) (*core.Response[*management.UpdateActionResponseContent], error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
WithRawResponse *RawClient
Versions *versions.Client
Executions *executions.Client
Modules *client.Client
Triggers *triggersclient.Client
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(options *core.RequestOptions) *Client
func (*Client) Create ¶
func (c *Client) Create( ctx context.Context, request *management.CreateActionRequestContent, opts ...option.RequestOption, ) (*management.CreateActionResponseContent, error)
Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.
func (*Client) Delete ¶
func (c *Client) Delete( ctx context.Context, id string, request *management.DeleteActionRequestParameters, opts ...option.RequestOption, ) error
Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.
func (*Client) Deploy ¶
func (c *Client) Deploy( ctx context.Context, id string, opts ...option.RequestOption, ) (*management.DeployActionResponseContent, error)
Deploy an action. Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.
func (*Client) Get ¶
func (c *Client) Get( ctx context.Context, id string, opts ...option.RequestOption, ) (*management.GetActionResponseContent, error)
Retrieve an action by its ID.
func (*Client) List ¶
func (c *Client) List( ctx context.Context, request *management.ListActionsRequestParameters, opts ...option.RequestOption, ) (*core.Page[*int, *management.Action, *management.ListActionsPaginatedResponseContent], error)
Retrieve all actions.
func (*Client) Test ¶
func (c *Client) Test( ctx context.Context, id string, request *management.TestActionRequestContent, opts ...option.RequestOption, ) (*management.TestActionResponseContent, error)
Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.
func (*Client) Update ¶
func (c *Client) Update( ctx context.Context, id string, request *management.UpdateActionRequestContent, opts ...option.RequestOption, ) (*management.UpdateActionResponseContent, error)
Update an existing action. If this action is currently bound to a trigger, updating it will <strong>not</strong> affect any user flows until the action is deployed.
type RawClient ¶
type RawClient struct {
// contains filtered or unexported fields
}
func NewRawClient ¶
func NewRawClient(options *core.RequestOptions) *RawClient
func (*RawClient) Create ¶
func (r *RawClient) Create( ctx context.Context, request *management.CreateActionRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.CreateActionResponseContent], error)
func (*RawClient) Delete ¶
func (r *RawClient) Delete( ctx context.Context, id string, request *management.DeleteActionRequestParameters, opts ...option.RequestOption, ) (*core.Response[any], error)
func (*RawClient) Deploy ¶
func (r *RawClient) Deploy( ctx context.Context, id string, opts ...option.RequestOption, ) (*core.Response[*management.DeployActionResponseContent], error)
func (*RawClient) Get ¶
func (r *RawClient) Get( ctx context.Context, id string, opts ...option.RequestOption, ) (*core.Response[*management.GetActionResponseContent], error)
func (*RawClient) Test ¶
func (r *RawClient) Test( ctx context.Context, id string, request *management.TestActionRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.TestActionResponseContent], error)
func (*RawClient) Update ¶
func (r *RawClient) Update( ctx context.Context, id string, request *management.UpdateActionRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.UpdateActionResponseContent], error)