actions

package
v0.0.0-...-2284865 Latest Latest
Warning

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

 Go to latest Published: Oct 26, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package actions provides primitives to interact with the openapi HTTP API.

Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.

Package actions provides primitives to interact with the openapi HTTP API.

Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.

Index

Constants

View Source 
const (
	Developer_hapikeyScopes = "developer_hapikey.Scopes"
	HapikeyScopes           = "hapikey.Scopes"
	Oauth2_legacyScopes     = "oauth2_legacy.Scopes"
)
View Source 
const DefaultServer = "https://api.hubapi.com/"

DefaultServer is the default server to be used.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionFunction 

type ActionFunction struct {
	// The function source code.
	FunctionSource string `json:"functionSource"`

	// The type of function. This determines when the function will be called.
	FunctionType ActionFunctionFunctionType `json:"functionType"`

	// The ID qualifier for the function. This is used to specify which input field a function is associated with for `PRE_FETCH_OPTIONS` and `POST_FETCH_OPTIONS` function types.
	Id *string `json:"id,omitempty"`
}

A serverless function associated with this custom workflow action.

type ActionFunctionFunctionType 

type ActionFunctionFunctionType string

The type of function. This determines when the function will be called. 

const (
	ActionFunctionFunctionTypePOSTFETCHOPTIONS ActionFunctionFunctionType = "POST_FETCH_OPTIONS"

	ActionFunctionFunctionTypePREACTIONEXECUTION ActionFunctionFunctionType = "PRE_ACTION_EXECUTION"

	ActionFunctionFunctionTypePREFETCHOPTIONS ActionFunctionFunctionType = "PRE_FETCH_OPTIONS"
)

Defines values for ActionFunctionFunctionType.

type ActionFunctionIdentifier 

type ActionFunctionIdentifier struct {
	// The type of function. This determines when the function will be called.
	FunctionType ActionFunctionIdentifierFunctionType `json:"functionType"`

	// The ID qualifier for the function. This is used to specify which input field a function is associated with for `PRE_FETCH_OPTIONS` and `POST_FETCH_OPTIONS` function types.
	Id *string `json:"id,omitempty"`
}

A serverless function associated with this custom workflow action.

type ActionFunctionIdentifierFunctionType 

type ActionFunctionIdentifierFunctionType string

The type of function. This determines when the function will be called. 

const (
	ActionFunctionIdentifierFunctionTypePOSTFETCHOPTIONS ActionFunctionIdentifierFunctionType = "POST_FETCH_OPTIONS"

	ActionFunctionIdentifierFunctionTypePREACTIONEXECUTION ActionFunctionIdentifierFunctionType = "PRE_ACTION_EXECUTION"

	ActionFunctionIdentifierFunctionTypePREFETCHOPTIONS ActionFunctionIdentifierFunctionType = "PRE_FETCH_OPTIONS"
)

Defines values for ActionFunctionIdentifierFunctionType.

type ActionLabels 

type ActionLabels struct {
	// The label to be displayed in the action card of the workflow editor once this custom action has been added to a workflow.
	ActionCardContent *string `json:"actionCardContent,omitempty"`

	// A description for this custom action. This will show up in the action editor along with the input fields.
	ActionDescription *string `json:"actionDescription,omitempty"`

	// The name of this custom action. This is what will show up when users are selecting an action in the workflows app.
	ActionName string `json:"actionName"`

	// The name to be displayed at the top of the action editor in the workflows app.
	AppDisplayName *string `json:"appDisplayName,omitempty"`

	// A map of input field names to descriptions for the fields. These will show up as tooltips when users are editing your action.
	InputFieldDescriptions *ActionLabels_InputFieldDescriptions `json:"inputFieldDescriptions,omitempty"`

	// A map of input field names to the user-facing labels.
	InputFieldLabels *ActionLabels_InputFieldLabels `json:"inputFieldLabels,omitempty"`
}

User-facing labels for this custom workflow action.

type ActionLabels_InputFieldDescriptions 

type ActionLabels_InputFieldDescriptions struct {
	AdditionalProperties map[string]string `json:"-"`
}

A map of input field names to descriptions for the fields. These will show up as tooltips when users are editing your action.

func (ActionLabels_InputFieldDescriptions) Get 

func (a ActionLabels_InputFieldDescriptions) Get(fieldName string) (value string, found bool)

Getter for additional properties for ActionLabels_InputFieldDescriptions. Returns the specified element and whether it was found

func (ActionLabels_InputFieldDescriptions) MarshalJSON 

func (a ActionLabels_InputFieldDescriptions) MarshalJSON() ([]byte, error)

Override default JSON handling for ActionLabels_InputFieldDescriptions to handle AdditionalProperties

func (*ActionLabels_InputFieldDescriptions) Set 

func (a *ActionLabels_InputFieldDescriptions) Set(fieldName string, value string)

Setter for additional properties for ActionLabels_InputFieldDescriptions

func (*ActionLabels_InputFieldDescriptions) UnmarshalJSON 

func (a *ActionLabels_InputFieldDescriptions) UnmarshalJSON(b []byte) error

Override default JSON handling for ActionLabels_InputFieldDescriptions to handle AdditionalProperties

type ActionLabels_InputFieldLabels 

type ActionLabels_InputFieldLabels struct {
	AdditionalProperties map[string]string `json:"-"`
}

A map of input field names to the user-facing labels.

func (ActionLabels_InputFieldLabels) Get 

func (a ActionLabels_InputFieldLabels) Get(fieldName string) (value string, found bool)

Getter for additional properties for ActionLabels_InputFieldLabels. Returns the specified element and whether it was found

func (ActionLabels_InputFieldLabels) MarshalJSON 

func (a ActionLabels_InputFieldLabels) MarshalJSON() ([]byte, error)

Override default JSON handling for ActionLabels_InputFieldLabels to handle AdditionalProperties

func (*ActionLabels_InputFieldLabels) Set 

func (a *ActionLabels_InputFieldLabels) Set(fieldName string, value string)

Setter for additional properties for ActionLabels_InputFieldLabels

func (*ActionLabels_InputFieldLabels) UnmarshalJSON 

func (a *ActionLabels_InputFieldLabels) UnmarshalJSON(b []byte) error

Override default JSON handling for ActionLabels_InputFieldLabels to handle AdditionalProperties

type ActionRevision 

type ActionRevision struct {
	// The date the revision was created.
	CreatedAt time.Time `json:"createdAt"`

	// Configuration for custom workflow action.
	Definition ExtensionActionDefinition `json:"definition"`
	Id         string                    `json:"id"`

	// The version number of the custom action.
	RevisionId string `json:"revisionId"`
}

A revision of this custom action.

type ArchiveByFunctionTypeParamsFunctionType 

type ArchiveByFunctionTypeParamsFunctionType string

ArchiveByFunctionTypeParamsFunctionType defines parameters for ArchiveByFunctionType.

type ArchiveByFunctionTypeResponse 

type ArchiveByFunctionTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (ArchiveByFunctionTypeResponse) Status 

func (r ArchiveByFunctionTypeResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveByFunctionTypeResponse) StatusCode 

func (r ArchiveByFunctionTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArchiveDefinitionResponse 

type ArchiveDefinitionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (ArchiveDefinitionResponse) Status 

func (r ArchiveDefinitionResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveDefinitionResponse) StatusCode 

func (r ArchiveDefinitionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArchiveFunctionParamsFunctionType 

type ArchiveFunctionParamsFunctionType string

ArchiveFunctionParamsFunctionType defines parameters for ArchiveFunction.

type ArchiveFunctionResponse 

type ArchiveFunctionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (ArchiveFunctionResponse) Status 

func (r ArchiveFunctionResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveFunctionResponse) StatusCode 

func (r ArchiveFunctionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchInputCallbackCompletionBatchRequest 

type BatchInputCallbackCompletionBatchRequest struct {
	Inputs []CallbackCompletionBatchRequest `json:"inputs"`
}

BatchInputCallbackCompletionBatchRequest defines model for BatchInputCallbackCompletionBatchRequest.

type CallbackCompletionBatchRequest 

type CallbackCompletionBatchRequest struct {
	// The ID of the callback to complete.
	CallbackId string `json:"callbackId"`

	// A map of action output names and values.
	OutputFields CallbackCompletionBatchRequest_OutputFields `json:"outputFields"`
}

Any information to send back to Workflows when completing an action callback as part of a batch request.

type CallbackCompletionBatchRequest_OutputFields 

type CallbackCompletionBatchRequest_OutputFields struct {
	AdditionalProperties map[string]string `json:"-"`
}

A map of action output names and values.

func (CallbackCompletionBatchRequest_OutputFields) Get 

func (a CallbackCompletionBatchRequest_OutputFields) Get(fieldName string) (value string, found bool)

Getter for additional properties for CallbackCompletionBatchRequest_OutputFields. Returns the specified element and whether it was found

func (CallbackCompletionBatchRequest_OutputFields) MarshalJSON 

func (a CallbackCompletionBatchRequest_OutputFields) MarshalJSON() ([]byte, error)

Override default JSON handling for CallbackCompletionBatchRequest_OutputFields to handle AdditionalProperties

func (*CallbackCompletionBatchRequest_OutputFields) Set 

func (a *CallbackCompletionBatchRequest_OutputFields) Set(fieldName string, value string)

Setter for additional properties for CallbackCompletionBatchRequest_OutputFields

func (*CallbackCompletionBatchRequest_OutputFields) UnmarshalJSON 

func (a *CallbackCompletionBatchRequest_OutputFields) UnmarshalJSON(b []byte) error

Override default JSON handling for CallbackCompletionBatchRequest_OutputFields to handle AdditionalProperties

type CallbackCompletionRequest 

type CallbackCompletionRequest struct {
	// A map of action output names and values.
	OutputFields CallbackCompletionRequest_OutputFields `json:"outputFields"`
}

Any information to send back to Workflows when completing an action callback.

type CallbackCompletionRequest_OutputFields 

type CallbackCompletionRequest_OutputFields struct {
	AdditionalProperties map[string]string `json:"-"`
}

A map of action output names and values.

func (CallbackCompletionRequest_OutputFields) Get 

func (a CallbackCompletionRequest_OutputFields) Get(fieldName string) (value string, found bool)

Getter for additional properties for CallbackCompletionRequest_OutputFields. Returns the specified element and whether it was found

func (CallbackCompletionRequest_OutputFields) MarshalJSON 

func (a CallbackCompletionRequest_OutputFields) MarshalJSON() ([]byte, error)

Override default JSON handling for CallbackCompletionRequest_OutputFields to handle AdditionalProperties

func (*CallbackCompletionRequest_OutputFields) Set 

func (a *CallbackCompletionRequest_OutputFields) Set(fieldName string, value string)

Setter for additional properties for CallbackCompletionRequest_OutputFields

func (*CallbackCompletionRequest_OutputFields) UnmarshalJSON 

func (a *CallbackCompletionRequest_OutputFields) UnmarshalJSON(b []byte) error

Override default JSON handling for CallbackCompletionRequest_OutputFields to handle AdditionalProperties

type Client 

type Client client.Client

Client conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(opts ...client.Option) (*Client, error)

NewClient creates a new Client with reasonable defaults.

func (*Client) ArchiveByFunctionType 

func (c *Client) ArchiveByFunctionType(ctx context.Context, appId int32, definitionId string, functionType ArchiveByFunctionTypeParamsFunctionType, reqEditors ...client.RequestEditorFn) (*ArchiveByFunctionTypeResponse, error)

ArchiveByFunctionType request returning *ArchiveByFunctionTypeResponse

func (*Client) ArchiveDefinition 

func (c *Client) ArchiveDefinition(ctx context.Context, appId int32, definitionId string, reqEditors ...client.RequestEditorFn) (*ArchiveDefinitionResponse, error)

ArchiveDefinition request returning *ArchiveDefinitionResponse

func (*Client) ArchiveFunction 

func (c *Client) ArchiveFunction(ctx context.Context, appId int32, definitionId string, functionType ArchiveFunctionParamsFunctionType, functionId string, reqEditors ...client.RequestEditorFn) (*ArchiveFunctionResponse, error)

ArchiveFunction request returning *ArchiveFunctionResponse

func (*Client) CompleteBatch 

func (c *Client) CompleteBatch(ctx context.Context, body CompleteBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CompleteBatchResponse, error)

func (*Client) CompleteBatchWithBody 

func (c *Client) CompleteBatchWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CompleteBatchResponse, error)

CompleteBatchWithBody request with arbitrary body returning *CompleteBatchResponse

func (*Client) CompleteCallback 

func (c *Client) CompleteCallback(ctx context.Context, callbackId string, body CompleteCallbackJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CompleteCallbackResponse, error)

func (*Client) CompleteCallbackWithBody 

func (c *Client) CompleteCallbackWithBody(ctx context.Context, callbackId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CompleteCallbackResponse, error)

CompleteCallbackWithBody request with arbitrary body returning *CompleteCallbackResponse

func (*Client) CreateApp 

func (c *Client) CreateApp(ctx context.Context, appId int32, body CreateAppJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateAppResponse, error)

func (*Client) CreateAppWithBody 

func (c *Client) CreateAppWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateAppResponse, error)

CreateAppWithBody request with arbitrary body returning *CreateAppResponse

func (*Client) CreateOrReplaceByFunctionTypeWithBody 

func (c *Client) CreateOrReplaceByFunctionTypeWithBody(ctx context.Context, appId int32, definitionId string, functionType CreateOrReplaceByFunctionTypeParamsFunctionType, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateOrReplaceByFunctionTypeResponse, error)

CreateOrReplaceByFunctionTypeWithBody request with arbitrary body returning *CreateOrReplaceByFunctionTypeResponse

func (*Client) CreateOrReplaceFunctionWithBody 

func (c *Client) CreateOrReplaceFunctionWithBody(ctx context.Context, appId int32, definitionId string, functionType CreateOrReplaceFunctionParamsFunctionType, functionId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateOrReplaceFunctionResponse, error)

CreateOrReplaceFunctionWithBody request with arbitrary body returning *CreateOrReplaceFunctionResponse

func (*Client) GetByFunctionType 

func (c *Client) GetByFunctionType(ctx context.Context, appId int32, definitionId string, functionType GetByFunctionTypeParamsFunctionType, reqEditors ...client.RequestEditorFn) (*GetByFunctionTypeResponse, error)

GetByFunctionType request returning *GetByFunctionTypeResponse

func (*Client) GetDefinition 

func (c *Client) GetDefinition(ctx context.Context, appId int32, definitionId string, params *GetDefinitionParams, reqEditors ...client.RequestEditorFn) (*GetDefinitionResponse, error)

GetDefinition request returning *GetDefinitionResponse

func (*Client) GetFunction 

func (c *Client) GetFunction(ctx context.Context, appId int32, definitionId string, functionType GetFunctionParamsFunctionType, functionId string, reqEditors ...client.RequestEditorFn) (*GetFunctionResponse, error)

GetFunction request returning *GetFunctionResponse

func (*Client) GetRevision 

func (c *Client) GetRevision(ctx context.Context, appId int32, definitionId string, revisionId string, reqEditors ...client.RequestEditorFn) (*GetRevisionResponse, error)

GetRevision request returning *GetRevisionResponse

func (*Client) ListApp 

func (c *Client) ListApp(ctx context.Context, appId int32, params *ListAppParams, reqEditors ...client.RequestEditorFn) (*ListAppResponse, error)

ListApp request returning *ListAppResponse

func (*Client) ListFunctions 

func (c *Client) ListFunctions(ctx context.Context, appId int32, definitionId string, reqEditors ...client.RequestEditorFn) (*ListFunctionsResponse, error)

ListFunctions request returning *ListFunctionsResponse

func (*Client) ListRevisions 

func (c *Client) ListRevisions(ctx context.Context, appId int32, definitionId string, params *ListRevisionsParams, reqEditors ...client.RequestEditorFn) (*ListRevisionsResponse, error)

ListRevisions request returning *ListRevisionsResponse

func (*Client) UpdateDefinition 

func (c *Client) UpdateDefinition(ctx context.Context, appId int32, definitionId string, body UpdateDefinitionJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateDefinitionResponse, error)

func (*Client) UpdateDefinitionWithBody 

func (c *Client) UpdateDefinitionWithBody(ctx context.Context, appId int32, definitionId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateDefinitionResponse, error)

UpdateDefinitionWithBody request with arbitrary body returning *UpdateDefinitionResponse

type ClientInterface 

type ClientInterface interface {
	// CompleteBatch request with any body
	CompleteBatchWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CompleteBatchResponse, error)
	CompleteBatch(ctx context.Context, body CompleteBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CompleteBatchResponse, error)

	// CompleteCallback request with any body
	CompleteCallbackWithBody(ctx context.Context, callbackId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CompleteCallbackResponse, error)
	CompleteCallback(ctx context.Context, callbackId string, body CompleteCallbackJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CompleteCallbackResponse, error)

	// ListApp request
	ListApp(ctx context.Context, appId int32, params *ListAppParams, reqEditors ...client.RequestEditorFn) (*ListAppResponse, error)

	// CreateApp request with any body
	CreateAppWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateAppResponse, error)
	CreateApp(ctx context.Context, appId int32, body CreateAppJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateAppResponse, error)

	// ArchiveDefinition request
	ArchiveDefinition(ctx context.Context, appId int32, definitionId string, reqEditors ...client.RequestEditorFn) (*ArchiveDefinitionResponse, error)

	// GetDefinition request
	GetDefinition(ctx context.Context, appId int32, definitionId string, params *GetDefinitionParams, reqEditors ...client.RequestEditorFn) (*GetDefinitionResponse, error)

	// UpdateDefinition request with any body
	UpdateDefinitionWithBody(ctx context.Context, appId int32, definitionId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateDefinitionResponse, error)
	UpdateDefinition(ctx context.Context, appId int32, definitionId string, body UpdateDefinitionJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateDefinitionResponse, error)

	// ListFunctions request
	ListFunctions(ctx context.Context, appId int32, definitionId string, reqEditors ...client.RequestEditorFn) (*ListFunctionsResponse, error)

	// ArchiveByFunctionType request
	ArchiveByFunctionType(ctx context.Context, appId int32, definitionId string, functionType ArchiveByFunctionTypeParamsFunctionType, reqEditors ...client.RequestEditorFn) (*ArchiveByFunctionTypeResponse, error)

	// GetByFunctionType request
	GetByFunctionType(ctx context.Context, appId int32, definitionId string, functionType GetByFunctionTypeParamsFunctionType, reqEditors ...client.RequestEditorFn) (*GetByFunctionTypeResponse, error)

	// CreateOrReplaceByFunctionType request with any body
	CreateOrReplaceByFunctionTypeWithBody(ctx context.Context, appId int32, definitionId string, functionType CreateOrReplaceByFunctionTypeParamsFunctionType, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateOrReplaceByFunctionTypeResponse, error)

	// ArchiveFunction request
	ArchiveFunction(ctx context.Context, appId int32, definitionId string, functionType ArchiveFunctionParamsFunctionType, functionId string, reqEditors ...client.RequestEditorFn) (*ArchiveFunctionResponse, error)

	// GetFunction request
	GetFunction(ctx context.Context, appId int32, definitionId string, functionType GetFunctionParamsFunctionType, functionId string, reqEditors ...client.RequestEditorFn) (*GetFunctionResponse, error)

	// CreateOrReplaceFunction request with any body
	CreateOrReplaceFunctionWithBody(ctx context.Context, appId int32, definitionId string, functionType CreateOrReplaceFunctionParamsFunctionType, functionId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateOrReplaceFunctionResponse, error)

	// ListRevisions request
	ListRevisions(ctx context.Context, appId int32, definitionId string, params *ListRevisionsParams, reqEditors ...client.RequestEditorFn) (*ListRevisionsResponse, error)

	// GetRevision request
	GetRevision(ctx context.Context, appId int32, definitionId string, revisionId string, reqEditors ...client.RequestEditorFn) (*GetRevisionResponse, error)
}

ClientInterface interface specification for the client.

type CollectionResponseActionFunctionIdentifierNoPaging 

type CollectionResponseActionFunctionIdentifierNoPaging struct {
	Results []ActionFunctionIdentifier `json:"results"`
}

CollectionResponseActionFunctionIdentifierNoPaging defines model for CollectionResponseActionFunctionIdentifierNoPaging.

type CollectionResponseActionRevisionForwardPaging 

type CollectionResponseActionRevisionForwardPaging struct {
	Paging  *ForwardPaging   `json:"paging,omitempty"`
	Results []ActionRevision `json:"results"`
}

CollectionResponseActionRevisionForwardPaging defines model for CollectionResponseActionRevisionForwardPaging.

type CollectionResponseExtensionActionDefinitionForwardPaging 

type CollectionResponseExtensionActionDefinitionForwardPaging struct {
	Paging  *ForwardPaging              `json:"paging,omitempty"`
	Results []ExtensionActionDefinition `json:"results"`
}

CollectionResponseExtensionActionDefinitionForwardPaging defines model for CollectionResponseExtensionActionDefinitionForwardPaging.

type CompleteBatchJSONBody 

type CompleteBatchJSONBody BatchInputCallbackCompletionBatchRequest

CompleteBatchJSONBody defines parameters for CompleteBatch.

type CompleteBatchJSONRequestBody 

type CompleteBatchJSONRequestBody CompleteBatchJSONBody

CompleteBatchJSONRequestBody defines body for CompleteBatch for application/json ContentType.

type CompleteBatchResponse 

type CompleteBatchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (CompleteBatchResponse) Status 

func (r CompleteBatchResponse) Status() string

Status returns HTTPResponse.Status

func (CompleteBatchResponse) StatusCode 

func (r CompleteBatchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CompleteCallbackJSONBody 

type CompleteCallbackJSONBody CallbackCompletionRequest

CompleteCallbackJSONBody defines parameters for CompleteCallback.

type CompleteCallbackJSONRequestBody 

type CompleteCallbackJSONRequestBody CompleteCallbackJSONBody

CompleteCallbackJSONRequestBody defines body for CompleteCallback for application/json ContentType.

type CompleteCallbackResponse 

type CompleteCallbackResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (CompleteCallbackResponse) Status 

func (r CompleteCallbackResponse) Status() string

Status returns HTTPResponse.Status

func (CompleteCallbackResponse) StatusCode 

func (r CompleteCallbackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ConditionalSingleFieldDependency 

type ConditionalSingleFieldDependency struct {
	ControllingFieldName  string                                         `json:"controllingFieldName"`
	ControllingFieldValue string                                         `json:"controllingFieldValue"`
	DependencyType        ConditionalSingleFieldDependencyDependencyType `json:"dependencyType"`
	DependentFieldNames   []string                                       `json:"dependentFieldNames"`
}

ConditionalSingleFieldDependency defines model for ConditionalSingleFieldDependency.

type ConditionalSingleFieldDependencyDependencyType 

type ConditionalSingleFieldDependencyDependencyType string

ConditionalSingleFieldDependencyDependencyType defines model for ConditionalSingleFieldDependency.DependencyType. 

const (
	ConditionalSingleFieldDependencyDependencyTypeCONDITIONALSINGLEFIELD ConditionalSingleFieldDependencyDependencyType = "CONDITIONAL_SINGLE_FIELD"
)

Defines values for ConditionalSingleFieldDependencyDependencyType.

type CreateAppJSONBody 

type CreateAppJSONBody ExtensionActionDefinitionInput

CreateAppJSONBody defines parameters for CreateApp.

type CreateAppJSONRequestBody 

type CreateAppJSONRequestBody CreateAppJSONBody

CreateAppJSONRequestBody defines body for CreateApp for application/json ContentType.

type CreateAppResponse 

type CreateAppResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *ExtensionActionDefinition
}

func (CreateAppResponse) Status 

func (r CreateAppResponse) Status() string

Status returns HTTPResponse.Status

func (CreateAppResponse) StatusCode 

func (r CreateAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrReplaceByFunctionTypeParamsFunctionType 

type CreateOrReplaceByFunctionTypeParamsFunctionType string

CreateOrReplaceByFunctionTypeParamsFunctionType defines parameters for CreateOrReplaceByFunctionType.

type CreateOrReplaceByFunctionTypeResponse 

type CreateOrReplaceByFunctionTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ActionFunctionIdentifier
}

func (CreateOrReplaceByFunctionTypeResponse) Status 

func (r CreateOrReplaceByFunctionTypeResponse) Status() string

Status returns HTTPResponse.Status

func (CreateOrReplaceByFunctionTypeResponse) StatusCode 

func (r CreateOrReplaceByFunctionTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrReplaceFunctionParamsFunctionType 

type CreateOrReplaceFunctionParamsFunctionType string

CreateOrReplaceFunctionParamsFunctionType defines parameters for CreateOrReplaceFunction.

type CreateOrReplaceFunctionResponse 

type CreateOrReplaceFunctionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ActionFunctionIdentifier
}

func (CreateOrReplaceFunctionResponse) Status 

func (r CreateOrReplaceFunctionResponse) Status() string

Status returns HTTPResponse.Status

func (CreateOrReplaceFunctionResponse) StatusCode 

func (r CreateOrReplaceFunctionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error 

type Error struct {
	// The error category
	Category string `json:"category"`

	// Context about the error condition
	Context *Error_Context `json:"context,omitempty"`

	// A unique identifier for the request. Include this value with any error reports or support tickets
	CorrelationId string `json:"correlationId"`

	// further information about the error
	Errors *[]ErrorDetail `json:"errors,omitempty"`

	// A map of link names to associated URIs containing documentation about the error or recommended remediation steps
	Links *Error_Links `json:"links,omitempty"`

	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`

	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
}

Error defines model for Error.

type ErrorDetail 

type ErrorDetail struct {
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`

	// Context about the error condition
	Context *ErrorDetail_Context `json:"context,omitempty"`

	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`

	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`

	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
}

ErrorDetail defines model for ErrorDetail.

type ErrorDetail_Context 

type ErrorDetail_Context struct {
	AdditionalProperties map[string][]string `json:"-"`
}

Context about the error condition

func (ErrorDetail_Context) Get 

func (a ErrorDetail_Context) Get(fieldName string) (value []string, found bool)

Getter for additional properties for ErrorDetail_Context. Returns the specified element and whether it was found

func (ErrorDetail_Context) MarshalJSON 

func (a ErrorDetail_Context) MarshalJSON() ([]byte, error)

Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties

func (*ErrorDetail_Context) Set 

func (a *ErrorDetail_Context) Set(fieldName string, value []string)

Setter for additional properties for ErrorDetail_Context

func (*ErrorDetail_Context) UnmarshalJSON 

func (a *ErrorDetail_Context) UnmarshalJSON(b []byte) error

Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties

type Error_Context 

type Error_Context struct {
	AdditionalProperties map[string][]string `json:"-"`
}

Context about the error condition

func (Error_Context) Get 

func (a Error_Context) Get(fieldName string) (value []string, found bool)

Getter for additional properties for Error_Context. Returns the specified element and whether it was found

func (Error_Context) MarshalJSON 

func (a Error_Context) MarshalJSON() ([]byte, error)

Override default JSON handling for Error_Context to handle AdditionalProperties

func (*Error_Context) Set 

func (a *Error_Context) Set(fieldName string, value []string)

Setter for additional properties for Error_Context

func (*Error_Context) UnmarshalJSON 

func (a *Error_Context) UnmarshalJSON(b []byte) error

Override default JSON handling for Error_Context to handle AdditionalProperties 

type Error_Links struct {
	AdditionalProperties map[string]string `json:"-"`
}

A map of link names to associated URIs containing documentation about the error or recommended remediation steps

func (Error_Links) Get 

func (a Error_Links) Get(fieldName string) (value string, found bool)

Getter for additional properties for Error_Links. Returns the specified element and whether it was found

func (Error_Links) MarshalJSON 

func (a Error_Links) MarshalJSON() ([]byte, error)

Override default JSON handling for Error_Links to handle AdditionalProperties

func (*Error_Links) Set 

func (a *Error_Links) Set(fieldName string, value string)

Setter for additional properties for Error_Links

func (*Error_Links) UnmarshalJSON 

func (a *Error_Links) UnmarshalJSON(b []byte) error

Override default JSON handling for Error_Links to handle AdditionalProperties

type ExtensionActionDefinition 

type ExtensionActionDefinition struct {
	// The URL that will accept an HTTPS request each time workflows executes the custom action.
	ActionUrl string `json:"actionUrl"`

	// The date that this custom action was archived, if the custom action is archived.
	ArchivedAt *int64 `json:"archivedAt,omitempty"`

	// A list of functions associated with the custom workflow action.
	Functions []ActionFunctionIdentifier `json:"functions"`

	// The ID of the custom action.
	Id string `json:"id"`

	// A list of dependencies between the input fields. These configure when the input fields should be visible.
	InputFieldDependencies *[]interface{} `json:"inputFieldDependencies,omitempty"`

	// The list of input fields to display in this custom action.
	InputFields []InputFieldDefinition `json:"inputFields"`

	// The user-facing labels for the custom action.
	Labels ExtensionActionDefinition_Labels `json:"labels"`

	// Configures what properties of the enrolled CRM object are included in the action execution request
	ObjectRequestOptions *ObjectRequestOptions `json:"objectRequestOptions,omitempty"`

	// The object types that this custom action supports.
	ObjectTypes []string `json:"objectTypes"`

	// Whether this custom action is published to customers.
	Published  bool   `json:"published"`
	RevisionId string `json:"revisionId"`
}

Configuration for custom workflow action.

type ExtensionActionDefinitionInput 

type ExtensionActionDefinitionInput struct {
	// The URL that will accept an HTTPS request each time workflows executes the custom action.
	ActionUrl string `json:"actionUrl"`

	// The date that this custom action was archived, if the custom action is archived.
	ArchivedAt *int64 `json:"archivedAt,omitempty"`

	// A list of functions associated with the custom workflow action.
	Functions []ActionFunction `json:"functions"`

	// A list of dependencies between the input fields. These configure when the input fields should be visible.
	InputFieldDependencies *[]interface{} `json:"inputFieldDependencies,omitempty"`

	// The list of input fields to display in this custom action.
	InputFields []InputFieldDefinition `json:"inputFields"`

	// The user-facing labels for the custom action.
	Labels ExtensionActionDefinitionInput_Labels `json:"labels"`

	// Configures what properties of the enrolled CRM object are included in the action execution request
	ObjectRequestOptions *ObjectRequestOptions `json:"objectRequestOptions,omitempty"`

	// The object types that this custom action supports.
	ObjectTypes []string `json:"objectTypes"`

	// Whether this custom action is published to customers.
	Published bool `json:"published"`
}

State of custom workflow action to be created.

type ExtensionActionDefinitionInput_Labels 

type ExtensionActionDefinitionInput_Labels struct {
	AdditionalProperties map[string]ActionLabels `json:"-"`
}

The user-facing labels for the custom action.

func (ExtensionActionDefinitionInput_Labels) Get 

func (a ExtensionActionDefinitionInput_Labels) Get(fieldName string) (value ActionLabels, found bool)

Getter for additional properties for ExtensionActionDefinitionInput_Labels. Returns the specified element and whether it was found

func (ExtensionActionDefinitionInput_Labels) MarshalJSON 

func (a ExtensionActionDefinitionInput_Labels) MarshalJSON() ([]byte, error)

Override default JSON handling for ExtensionActionDefinitionInput_Labels to handle AdditionalProperties

func (*ExtensionActionDefinitionInput_Labels) Set 

func (a *ExtensionActionDefinitionInput_Labels) Set(fieldName string, value ActionLabels)

Setter for additional properties for ExtensionActionDefinitionInput_Labels

func (*ExtensionActionDefinitionInput_Labels) UnmarshalJSON 

func (a *ExtensionActionDefinitionInput_Labels) UnmarshalJSON(b []byte) error

Override default JSON handling for ExtensionActionDefinitionInput_Labels to handle AdditionalProperties

type ExtensionActionDefinitionPatch 

type ExtensionActionDefinitionPatch struct {
	// The URL that will accept an HTTPS request each time workflows executes the custom action.
	ActionUrl *string `json:"actionUrl,omitempty"`

	// A list of dependencies between the input fields. These configure when the input fields should be visible.
	InputFieldDependencies *[]interface{} `json:"inputFieldDependencies,omitempty"`

	// The list of input fields to display in this custom action.
	InputFields *[]InputFieldDefinition `json:"inputFields,omitempty"`

	// The user-facing labels for the custom action.
	Labels *ExtensionActionDefinitionPatch_Labels `json:"labels,omitempty"`

	// Configures what properties of the enrolled CRM object are included in the action execution request
	ObjectRequestOptions *ObjectRequestOptions `json:"objectRequestOptions,omitempty"`

	// The object types that this custom action supports.
	ObjectTypes *[]string `json:"objectTypes,omitempty"`

	// Whether this custom action is published to customers.
	Published *bool `json:"published,omitempty"`
}

Fields on custom workflow action to be updated.

type ExtensionActionDefinitionPatch_Labels 

type ExtensionActionDefinitionPatch_Labels struct {
	AdditionalProperties map[string]ActionLabels `json:"-"`
}

The user-facing labels for the custom action.

func (ExtensionActionDefinitionPatch_Labels) Get 

func (a ExtensionActionDefinitionPatch_Labels) Get(fieldName string) (value ActionLabels, found bool)

Getter for additional properties for ExtensionActionDefinitionPatch_Labels. Returns the specified element and whether it was found

func (ExtensionActionDefinitionPatch_Labels) MarshalJSON 

func (a ExtensionActionDefinitionPatch_Labels) MarshalJSON() ([]byte, error)

Override default JSON handling for ExtensionActionDefinitionPatch_Labels to handle AdditionalProperties

func (*ExtensionActionDefinitionPatch_Labels) Set 

func (a *ExtensionActionDefinitionPatch_Labels) Set(fieldName string, value ActionLabels)

Setter for additional properties for ExtensionActionDefinitionPatch_Labels

func (*ExtensionActionDefinitionPatch_Labels) UnmarshalJSON 

func (a *ExtensionActionDefinitionPatch_Labels) UnmarshalJSON(b []byte) error

Override default JSON handling for ExtensionActionDefinitionPatch_Labels to handle AdditionalProperties

type ExtensionActionDefinition_Labels 

type ExtensionActionDefinition_Labels struct {
	AdditionalProperties map[string]ActionLabels `json:"-"`
}

The user-facing labels for the custom action.

func (ExtensionActionDefinition_Labels) Get 

func (a ExtensionActionDefinition_Labels) Get(fieldName string) (value ActionLabels, found bool)

Getter for additional properties for ExtensionActionDefinition_Labels. Returns the specified element and whether it was found

func (ExtensionActionDefinition_Labels) MarshalJSON 

func (a ExtensionActionDefinition_Labels) MarshalJSON() ([]byte, error)

Override default JSON handling for ExtensionActionDefinition_Labels to handle AdditionalProperties

func (*ExtensionActionDefinition_Labels) Set 

func (a *ExtensionActionDefinition_Labels) Set(fieldName string, value ActionLabels)

Setter for additional properties for ExtensionActionDefinition_Labels

func (*ExtensionActionDefinition_Labels) UnmarshalJSON 

func (a *ExtensionActionDefinition_Labels) UnmarshalJSON(b []byte) error

Override default JSON handling for ExtensionActionDefinition_Labels to handle AdditionalProperties

type FieldTypeDefinition 

type FieldTypeDefinition struct {
	// Controls how the field appears in HubSpot.
	FieldType *FieldTypeDefinitionFieldType `json:"fieldType,omitempty"`

	// The input field name.
	Name string `json:"name"`

	// A list of valid options for the field value.
	Options []Option `json:"options"`

	// A URL that will accept HTTPS requests when the valid options for the field are fetched.
	OptionsUrl *string `json:"optionsUrl,omitempty"`

	// This can be set to `OWNER` if the field should contain a HubSpot owner value.
	ReferencedObjectType *FieldTypeDefinitionReferencedObjectType `json:"referencedObjectType,omitempty"`

	// The data type of the field.
	Type FieldTypeDefinitionType `json:"type"`
}

The data type expected by an input field.

type FieldTypeDefinitionFieldType 

type FieldTypeDefinitionFieldType string

Controls how the field appears in HubSpot. 

const (
	FieldTypeDefinitionFieldTypeBooleancheckbox FieldTypeDefinitionFieldType = "booleancheckbox"

	FieldTypeDefinitionFieldTypeCalculationEquation FieldTypeDefinitionFieldType = "calculation_equation"

	FieldTypeDefinitionFieldTypeCalculationReadTime FieldTypeDefinitionFieldType = "calculation_read_time"

	FieldTypeDefinitionFieldTypeCalculationRollup FieldTypeDefinitionFieldType = "calculation_rollup"

	FieldTypeDefinitionFieldTypeCalculationScore FieldTypeDefinitionFieldType = "calculation_score"

	FieldTypeDefinitionFieldTypeCheckbox FieldTypeDefinitionFieldType = "checkbox"

	FieldTypeDefinitionFieldTypeDate FieldTypeDefinitionFieldType = "date"

	FieldTypeDefinitionFieldTypeFile FieldTypeDefinitionFieldType = "file"

	FieldTypeDefinitionFieldTypeNumber FieldTypeDefinitionFieldType = "number"

	FieldTypeDefinitionFieldTypePhonenumber FieldTypeDefinitionFieldType = "phonenumber"

	FieldTypeDefinitionFieldTypeRadio FieldTypeDefinitionFieldType = "radio"

	FieldTypeDefinitionFieldTypeSelect FieldTypeDefinitionFieldType = "select"

	FieldTypeDefinitionFieldTypeText FieldTypeDefinitionFieldType = "text"

	FieldTypeDefinitionFieldTypeTextarea FieldTypeDefinitionFieldType = "textarea"

	FieldTypeDefinitionFieldTypeUnknown FieldTypeDefinitionFieldType = "unknown"
)

Defines values for FieldTypeDefinitionFieldType.

type FieldTypeDefinitionReferencedObjectType 

type FieldTypeDefinitionReferencedObjectType string

This can be set to `OWNER` if the field should contain a HubSpot owner value. 

const (
	FieldTypeDefinitionReferencedObjectTypeAD FieldTypeDefinitionReferencedObjectType = "AD"

	FieldTypeDefinitionReferencedObjectTypeADACCOUNT FieldTypeDefinitionReferencedObjectType = "AD_ACCOUNT"

	FieldTypeDefinitionReferencedObjectTypeADCAMPAIGN FieldTypeDefinitionReferencedObjectType = "AD_CAMPAIGN"

	FieldTypeDefinitionReferencedObjectTypeADGROUP FieldTypeDefinitionReferencedObjectType = "AD_GROUP"

	FieldTypeDefinitionReferencedObjectTypeATTRIBUTION FieldTypeDefinitionReferencedObjectType = "ATTRIBUTION"

	FieldTypeDefinitionReferencedObjectTypeAUTOMATIONPLATFORMFLOW FieldTypeDefinitionReferencedObjectType = "AUTOMATION_PLATFORM_FLOW"

	FieldTypeDefinitionReferencedObjectTypeBETALERT FieldTypeDefinitionReferencedObjectType = "BET_ALERT"

	FieldTypeDefinitionReferencedObjectTypeBETDELIVERABLESERVICE FieldTypeDefinitionReferencedObjectType = "BET_DELIVERABLE_SERVICE"

	FieldTypeDefinitionReferencedObjectTypeBLOGPOST FieldTypeDefinitionReferencedObjectType = "BLOG_POST"

	FieldTypeDefinitionReferencedObjectTypeCALL FieldTypeDefinitionReferencedObjectType = "CALL"

	FieldTypeDefinitionReferencedObjectTypeCAMPAIGN FieldTypeDefinitionReferencedObjectType = "CAMPAIGN"

	FieldTypeDefinitionReferencedObjectTypeCHATFLOW FieldTypeDefinitionReferencedObjectType = "CHATFLOW"

	FieldTypeDefinitionReferencedObjectTypeCOMMUNICATION FieldTypeDefinitionReferencedObjectType = "COMMUNICATION"

	FieldTypeDefinitionReferencedObjectTypeCOMPANY FieldTypeDefinitionReferencedObjectType = "COMPANY"

	FieldTypeDefinitionReferencedObjectTypeCONTACT FieldTypeDefinitionReferencedObjectType = "CONTACT"

	FieldTypeDefinitionReferencedObjectTypeCONTACTCREATEATTRIBUTION FieldTypeDefinitionReferencedObjectType = "CONTACT_CREATE_ATTRIBUTION"

	FieldTypeDefinitionReferencedObjectTypeCONTENT FieldTypeDefinitionReferencedObjectType = "CONTENT"

	FieldTypeDefinitionReferencedObjectTypeCONVERSATION FieldTypeDefinitionReferencedObjectType = "CONVERSATION"

	FieldTypeDefinitionReferencedObjectTypeCONVERSATIONINBOX FieldTypeDefinitionReferencedObjectType = "CONVERSATION_INBOX"

	FieldTypeDefinitionReferencedObjectTypeCONVERSATIONSESSION FieldTypeDefinitionReferencedObjectType = "CONVERSATION_SESSION"

	FieldTypeDefinitionReferencedObjectTypeCTA FieldTypeDefinitionReferencedObjectType = "CTA"

	FieldTypeDefinitionReferencedObjectTypeDEAL FieldTypeDefinitionReferencedObjectType = "DEAL"

	FieldTypeDefinitionReferencedObjectTypeEMAIL FieldTypeDefinitionReferencedObjectType = "EMAIL"

	FieldTypeDefinitionReferencedObjectTypeENGAGEMENT FieldTypeDefinitionReferencedObjectType = "ENGAGEMENT"

	FieldTypeDefinitionReferencedObjectTypeEXPORT FieldTypeDefinitionReferencedObjectType = "EXPORT"

	FieldTypeDefinitionReferencedObjectTypeFEEDBACKSUBMISSION FieldTypeDefinitionReferencedObjectType = "FEEDBACK_SUBMISSION"

	FieldTypeDefinitionReferencedObjectTypeFORECAST FieldTypeDefinitionReferencedObjectType = "FORECAST"

	FieldTypeDefinitionReferencedObjectTypeFORM FieldTypeDefinitionReferencedObjectType = "FORM"

	FieldTypeDefinitionReferencedObjectTypeFORMSUBMISSIONINBOUNDDB FieldTypeDefinitionReferencedObjectType = "FORM_SUBMISSION_INBOUNDDB"

	FieldTypeDefinitionReferencedObjectTypeHUB FieldTypeDefinitionReferencedObjectType = "HUB"

	FieldTypeDefinitionReferencedObjectTypeIMPORT FieldTypeDefinitionReferencedObjectType = "IMPORT"

	FieldTypeDefinitionReferencedObjectTypeINVOICE FieldTypeDefinitionReferencedObjectType = "INVOICE"

	FieldTypeDefinitionReferencedObjectTypeKEYWORD FieldTypeDefinitionReferencedObjectType = "KEYWORD"

	FieldTypeDefinitionReferencedObjectTypeLANDINGPAGE FieldTypeDefinitionReferencedObjectType = "LANDING_PAGE"

	FieldTypeDefinitionReferencedObjectTypeLINEITEM FieldTypeDefinitionReferencedObjectType = "LINE_ITEM"

	FieldTypeDefinitionReferencedObjectTypeMARKETINGEMAIL FieldTypeDefinitionReferencedObjectType = "MARKETING_EMAIL"

	FieldTypeDefinitionReferencedObjectTypeMARKETINGEVENT FieldTypeDefinitionReferencedObjectType = "MARKETING_EVENT"

	FieldTypeDefinitionReferencedObjectTypeMEDIABRIDGE FieldTypeDefinitionReferencedObjectType = "MEDIA_BRIDGE"

	FieldTypeDefinitionReferencedObjectTypeMEETINGEVENT FieldTypeDefinitionReferencedObjectType = "MEETING_EVENT"

	FieldTypeDefinitionReferencedObjectTypeNOTE FieldTypeDefinitionReferencedObjectType = "NOTE"

	FieldTypeDefinitionReferencedObjectTypeOBJECTLIST FieldTypeDefinitionReferencedObjectType = "OBJECT_LIST"

	FieldTypeDefinitionReferencedObjectTypeOWNER FieldTypeDefinitionReferencedObjectType = "OWNER"

	FieldTypeDefinitionReferencedObjectTypePORTAL FieldTypeDefinitionReferencedObjectType = "PORTAL"

	FieldTypeDefinitionReferencedObjectTypePRODUCT FieldTypeDefinitionReferencedObjectType = "PRODUCT"

	FieldTypeDefinitionReferencedObjectTypePRODUCTORFOLDER FieldTypeDefinitionReferencedObjectType = "PRODUCT_OR_FOLDER"

	FieldTypeDefinitionReferencedObjectTypePUBLISHINGTASK FieldTypeDefinitionReferencedObjectType = "PUBLISHING_TASK"

	FieldTypeDefinitionReferencedObjectTypeQUOTA FieldTypeDefinitionReferencedObjectType = "QUOTA"

	FieldTypeDefinitionReferencedObjectTypeQUOTE FieldTypeDefinitionReferencedObjectType = "QUOTE"

	FieldTypeDefinitionReferencedObjectTypeRESTORABLECRMOBJECT FieldTypeDefinitionReferencedObjectType = "RESTORABLE_CRM_OBJECT"

	FieldTypeDefinitionReferencedObjectTypeSALESFORCESYNCERROR FieldTypeDefinitionReferencedObjectType = "SALESFORCE_SYNC_ERROR"

	FieldTypeDefinitionReferencedObjectTypeSEQUENCE FieldTypeDefinitionReferencedObjectType = "SEQUENCE"

	FieldTypeDefinitionReferencedObjectTypeSEQUENCESTEP FieldTypeDefinitionReferencedObjectType = "SEQUENCE_STEP"

	FieldTypeDefinitionReferencedObjectTypeSITEPAGE FieldTypeDefinitionReferencedObjectType = "SITE_PAGE"

	FieldTypeDefinitionReferencedObjectTypeSNIPPET FieldTypeDefinitionReferencedObjectType = "SNIPPET"

	FieldTypeDefinitionReferencedObjectTypeSOCIALCHANNEL FieldTypeDefinitionReferencedObjectType = "SOCIAL_CHANNEL"

	FieldTypeDefinitionReferencedObjectTypeSOCIALPOST FieldTypeDefinitionReferencedObjectType = "SOCIAL_POST"

	FieldTypeDefinitionReferencedObjectTypeTASK FieldTypeDefinitionReferencedObjectType = "TASK"

	FieldTypeDefinitionReferencedObjectTypeTASKTEMPLATE FieldTypeDefinitionReferencedObjectType = "TASK_TEMPLATE"

	FieldTypeDefinitionReferencedObjectTypeTEMPLATE FieldTypeDefinitionReferencedObjectType = "TEMPLATE"

	FieldTypeDefinitionReferencedObjectTypeTICKET FieldTypeDefinitionReferencedObjectType = "TICKET"

	FieldTypeDefinitionReferencedObjectTypeUNKNOWN FieldTypeDefinitionReferencedObjectType = "UNKNOWN"

	FieldTypeDefinitionReferencedObjectTypeUNSUBSCRIBE FieldTypeDefinitionReferencedObjectType = "UNSUBSCRIBE"
)

Defines values for FieldTypeDefinitionReferencedObjectType.

type FieldTypeDefinitionType 

type FieldTypeDefinitionType string

The data type of the field. 

const (
	FieldTypeDefinitionTypeBool FieldTypeDefinitionType = "bool"

	FieldTypeDefinitionTypeCurrencyNumber FieldTypeDefinitionType = "currency_number"

	FieldTypeDefinitionTypeDate FieldTypeDefinitionType = "date"

	FieldTypeDefinitionTypeDatetime FieldTypeDefinitionType = "datetime"

	FieldTypeDefinitionTypeEnumeration FieldTypeDefinitionType = "enumeration"

	FieldTypeDefinitionTypeJson FieldTypeDefinitionType = "json"

	FieldTypeDefinitionTypeNumber FieldTypeDefinitionType = "number"

	FieldTypeDefinitionTypeObjectCoordinates FieldTypeDefinitionType = "object_coordinates"

	FieldTypeDefinitionTypePhoneNumber FieldTypeDefinitionType = "phone_number"

	FieldTypeDefinitionTypeString FieldTypeDefinitionType = "string"
)

Defines values for FieldTypeDefinitionType.

type ForwardPaging 

type ForwardPaging struct {
	Next *NextPage `json:"next,omitempty"`
}

ForwardPaging defines model for ForwardPaging.

type GetByFunctionTypeParamsFunctionType 

type GetByFunctionTypeParamsFunctionType string

GetByFunctionTypeParamsFunctionType defines parameters for GetByFunctionType.

type GetByFunctionTypeResponse 

type GetByFunctionTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ActionFunction
}

func (GetByFunctionTypeResponse) Status 

func (r GetByFunctionTypeResponse) Status() string

Status returns HTTPResponse.Status

func (GetByFunctionTypeResponse) StatusCode 

func (r GetByFunctionTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDefinitionParams 

type GetDefinitionParams struct {
	// Whether to include archived custom actions.
	Archived *bool `json:"archived,omitempty"`
}

GetDefinitionParams defines parameters for GetDefinition.

type GetDefinitionResponse 

type GetDefinitionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExtensionActionDefinition
}

func (GetDefinitionResponse) Status 

func (r GetDefinitionResponse) Status() string

Status returns HTTPResponse.Status

func (GetDefinitionResponse) StatusCode 

func (r GetDefinitionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFunctionParamsFunctionType 

type GetFunctionParamsFunctionType string

GetFunctionParamsFunctionType defines parameters for GetFunction.

type GetFunctionResponse 

type GetFunctionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ActionFunction
}

func (GetFunctionResponse) Status 

func (r GetFunctionResponse) Status() string

Status returns HTTPResponse.Status

func (GetFunctionResponse) StatusCode 

func (r GetFunctionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRevisionResponse 

type GetRevisionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ActionRevision
}

func (GetRevisionResponse) Status 

func (r GetRevisionResponse) Status() string

Status returns HTTPResponse.Status

func (GetRevisionResponse) StatusCode 

func (r GetRevisionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InputFieldDefinition 

type InputFieldDefinition struct {
	// Whether the field is required for the custom action to be valid
	IsRequired bool `json:"isRequired"`

	// Controls what kind of input a customer can use to specify the field value. Must contain exactly one of `STATIC_VALUE` or `OBJECT_PROPERTY`. If `STATIC_VALUE`, the customer will be able to choose a value when configuring the custom action; if `OBJECT_PROPERTY`, the customer will be able to choose a property from the enrolled workflow object that the field value will be copied from. In the future we may support more than one input control type here.
	SupportedValueTypes *[]InputFieldDefinitionSupportedValueTypes `json:"supportedValueTypes,omitempty"`

	// The data type expected by an input field.
	TypeDefinition FieldTypeDefinition `json:"typeDefinition"`
}

Configuration for an input field on the custom action

type InputFieldDefinitionSupportedValueTypes 

type InputFieldDefinitionSupportedValueTypes string

InputFieldDefinitionSupportedValueTypes defines model for InputFieldDefinition.SupportedValueTypes. 

const (
	InputFieldDefinitionSupportedValueTypesFIELDDATA InputFieldDefinitionSupportedValueTypes = "FIELD_DATA"

	InputFieldDefinitionSupportedValueTypesOBJECTPROPERTY InputFieldDefinitionSupportedValueTypes = "OBJECT_PROPERTY"

	InputFieldDefinitionSupportedValueTypesSTATICVALUE InputFieldDefinitionSupportedValueTypes = "STATIC_VALUE"
)

Defines values for InputFieldDefinitionSupportedValueTypes.

type ListAppParams 

type ListAppParams struct {
	// Maximum number of results per page.
	Limit *int32 `json:"limit,omitempty"`

	// The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
	After *string `json:"after,omitempty"`

	// Whether to include archived custom actions.
	Archived *bool `json:"archived,omitempty"`
}

ListAppParams defines parameters for ListApp.

type ListAppResponse 

type ListAppResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionResponseExtensionActionDefinitionForwardPaging
}

func (ListAppResponse) Status 

func (r ListAppResponse) Status() string

Status returns HTTPResponse.Status

func (ListAppResponse) StatusCode 

func (r ListAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListFunctionsResponse 

type ListFunctionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionResponseActionFunctionIdentifierNoPaging
}

func (ListFunctionsResponse) Status 

func (r ListFunctionsResponse) Status() string

Status returns HTTPResponse.Status

func (ListFunctionsResponse) StatusCode 

func (r ListFunctionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListRevisionsParams 

type ListRevisionsParams struct {
	// Maximum number of results per page.
	Limit *int32 `json:"limit,omitempty"`

	// The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
	After *string `json:"after,omitempty"`
}

ListRevisionsParams defines parameters for ListRevisions.

type ListRevisionsResponse 

type ListRevisionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionResponseActionRevisionForwardPaging
}

func (ListRevisionsResponse) Status 

func (r ListRevisionsResponse) Status() string

Status returns HTTPResponse.Status

func (ListRevisionsResponse) StatusCode 

func (r ListRevisionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NextPage 

type NextPage struct {
	After string  `json:"after"`
	Link  *string `json:"link,omitempty"`
}

NextPage defines model for NextPage.

type ObjectRequestOptions 

type ObjectRequestOptions struct {
	// A list of properties of the CRM object to include with the request to the `actionUrl`.
	Properties []string `json:"properties"`
}

Configures what properties of the enrolled CRM object are included in the action execution request

type Option 

type Option struct {
	Description  string  `json:"description"`
	DisplayOrder int32   `json:"displayOrder"`
	DoubleData   float32 `json:"doubleData"`
	Hidden       bool    `json:"hidden"`

	// The user-facing label for the option.
	Label    string `json:"label"`
	ReadOnly bool   `json:"readOnly"`

	// The internal value for the option. This is what will be included in the execution request to the `actionUrl`.
	Value string `json:"value"`
}

An option for a field value.

type SingleFieldDependency 

type SingleFieldDependency struct {
	ControllingFieldName string                              `json:"controllingFieldName"`
	DependencyType       SingleFieldDependencyDependencyType `json:"dependencyType"`
	DependentFieldNames  []string                            `json:"dependentFieldNames"`
}

SingleFieldDependency defines model for SingleFieldDependency.

type SingleFieldDependencyDependencyType 

type SingleFieldDependencyDependencyType string

SingleFieldDependencyDependencyType defines model for SingleFieldDependency.DependencyType. 

const (
	SingleFieldDependencyDependencyTypeSINGLEFIELD SingleFieldDependencyDependencyType = "SINGLE_FIELD"
)

Defines values for SingleFieldDependencyDependencyType.

type UpdateDefinitionJSONBody 

type UpdateDefinitionJSONBody ExtensionActionDefinitionPatch

UpdateDefinitionJSONBody defines parameters for UpdateDefinition.

type UpdateDefinitionJSONRequestBody 

type UpdateDefinitionJSONRequestBody UpdateDefinitionJSONBody

UpdateDefinitionJSONRequestBody defines body for UpdateDefinition for application/json ContentType.

type UpdateDefinitionResponse 

type UpdateDefinitionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExtensionActionDefinition
}

func (UpdateDefinitionResponse) Status 

func (r UpdateDefinitionResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateDefinitionResponse) StatusCode 

func (r UpdateDefinitionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Source Files

View all Source files

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.