Documentation
¶
Index ¶
- type Client
- func (c *Client) Create(ctx context.Context, request *management.CreateFormRequestContent, ...) (*management.CreateFormResponseContent, error)
- func (c *Client) Delete(ctx context.Context, id string, opts ...option.RequestOption) error
- func (c *Client) Get(ctx context.Context, id string, request *management.GetFormRequestParameters, ...) (*management.GetFormResponseContent, error)
- func (c *Client) List(ctx context.Context, request *management.ListFormsRequestParameters, ...) (...)
- func (c *Client) Update(ctx context.Context, id string, request *management.UpdateFormRequestContent, ...) (*management.UpdateFormResponseContent, error)
- type RawClient
- func (r *RawClient) Create(ctx context.Context, request *management.CreateFormRequestContent, ...) (*core.Response[*management.CreateFormResponseContent], error)
- func (r *RawClient) Delete(ctx context.Context, id string, opts ...option.RequestOption) (*core.Response[any], error)
- func (r *RawClient) Get(ctx context.Context, id string, request *management.GetFormRequestParameters, ...) (*core.Response[*management.GetFormResponseContent], error)
- func (r *RawClient) Update(ctx context.Context, id string, request *management.UpdateFormRequestContent, ...) (*core.Response[*management.UpdateFormResponseContent], error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
WithRawResponse *RawClient
// 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.CreateFormRequestContent, opts ...option.RequestOption, ) (*management.CreateFormResponseContent, error)
Example:
request := &management.CreateFormRequestContent{
Name: "name",
}
client.Forms.Create(
context.TODO(),
request,
)
func (*Client) Get ¶
func (c *Client) Get( ctx context.Context, id string, request *management.GetFormRequestParameters, opts ...option.RequestOption, ) (*management.GetFormResponseContent, error)
Example:
request := &management.GetFormRequestParameters{
Hydrate: []*management.FormsRequestParametersHydrateEnum{
management.FormsRequestParametersHydrateEnumFlowCount.Ptr(),
},
}
client.Forms.Get(
context.TODO(),
"id",
request,
)
func (*Client) List ¶
func (c *Client) List( ctx context.Context, request *management.ListFormsRequestParameters, opts ...option.RequestOption, ) (*core.Page[*int, *management.FormSummary, *management.ListFormsOffsetPaginatedResponseContent], error)
Example:
request := &management.ListFormsRequestParameters{
Page: management.Int(
1,
),
PerPage: management.Int(
1,
),
IncludeTotals: management.Bool(
true,
),
Hydrate: []*management.FormsRequestParametersHydrateEnum{
management.FormsRequestParametersHydrateEnumFlowCount.Ptr(),
},
}
client.Forms.List(
context.TODO(),
request,
)
func (*Client) Update ¶
func (c *Client) Update( ctx context.Context, id string, request *management.UpdateFormRequestContent, opts ...option.RequestOption, ) (*management.UpdateFormResponseContent, error)
Example:
request := &management.UpdateFormRequestContent{}
client.Forms.Update(
context.TODO(),
"id",
request,
)
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.CreateFormRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.CreateFormResponseContent], error)
func (*RawClient) Get ¶
func (r *RawClient) Get( ctx context.Context, id string, request *management.GetFormRequestParameters, opts ...option.RequestOption, ) (*core.Response[*management.GetFormResponseContent], error)
func (*RawClient) Update ¶
func (r *RawClient) Update( ctx context.Context, id string, request *management.UpdateFormRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.UpdateFormResponseContent], error)
Click to show internal directories.
Click to hide internal directories.