Documentation ¶
Index ¶
- Constants
- Variables
- func GetUserAgent() string
- type ApplicationDeployment
- type Artifact
- type AuthenticationError
- type AuthorizationError
- type BadGatewayError
- type ByProjectKeyDeploymentsByIDLogsRequestBuilder
- type ByProjectKeyDeploymentsByIDLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) ApplicationName(v string) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
- func (r *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) EndDate(v time.Time) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) Execute(ctx context.Context) (result *DeploymentLogCursorPagedQueryResponse, err error)
- func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) PageToken(v string) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) StartDate(v time.Time) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) WithQueryParams(input ByProjectKeyDeploymentsByIDLogsRequestMethodGetInput) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
- type ByProjectKeyDeploymentsByIDLogsRequestMethodGetInput
- type ByProjectKeyDeploymentsByIDRequestBuilder
- func (rb *ByProjectKeyDeploymentsByIDRequestBuilder) Delete() *ByProjectKeyDeploymentsByIDRequestMethodDelete
- func (rb *ByProjectKeyDeploymentsByIDRequestBuilder) Get() *ByProjectKeyDeploymentsByIDRequestMethodGet
- func (rb *ByProjectKeyDeploymentsByIDRequestBuilder) Logs() *ByProjectKeyDeploymentsByIDLogsRequestBuilder
- func (rb *ByProjectKeyDeploymentsByIDRequestBuilder) Post(body DeploymentUpdate) *ByProjectKeyDeploymentsByIDRequestMethodPost
- type ByProjectKeyDeploymentsByIDRequestMethodDelete
- func (r *ByProjectKeyDeploymentsByIDRequestMethodDelete) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Deployment, err error)
- func (rb *ByProjectKeyDeploymentsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsByIDRequestMethodDelete
- type ByProjectKeyDeploymentsByIDRequestMethodGet
- func (r *ByProjectKeyDeploymentsByIDRequestMethodGet) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsByIDRequestMethodGet) Execute(ctx context.Context) (result *Deployment, err error)
- func (rb *ByProjectKeyDeploymentsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsByIDRequestMethodGet
- type ByProjectKeyDeploymentsByIDRequestMethodPost
- func (r *ByProjectKeyDeploymentsByIDRequestMethodPost) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsByIDRequestMethodPost) Execute(ctx context.Context) (result *Deployment, err error)
- func (rb *ByProjectKeyDeploymentsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsByIDRequestMethodPost
- type ByProjectKeyDeploymentsKeyByKeyLogsRequestBuilder
- type ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) ApplicationName(v string) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
- func (r *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) EndDate(v time.Time) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) Execute(ctx context.Context) (result *DeploymentLogCursorPagedQueryResponse, err error)
- func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) PageToken(v string) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) StartDate(v time.Time) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) WithQueryParams(input ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGetInput) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
- type ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGetInput
- type ByProjectKeyDeploymentsKeyByKeyRequestBuilder
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestBuilder) Delete() *ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestBuilder) Get() *ByProjectKeyDeploymentsKeyByKeyRequestMethodGet
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestBuilder) Logs() *ByProjectKeyDeploymentsKeyByKeyLogsRequestBuilder
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestBuilder) Post(body DeploymentUpdate) *ByProjectKeyDeploymentsKeyByKeyRequestMethodPost
- type ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete
- func (r *ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Deployment, err error)
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete
- type ByProjectKeyDeploymentsKeyByKeyRequestMethodGet
- func (r *ByProjectKeyDeploymentsKeyByKeyRequestMethodGet) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Deployment, err error)
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsKeyByKeyRequestMethodGet
- type ByProjectKeyDeploymentsKeyByKeyRequestMethodPost
- func (r *ByProjectKeyDeploymentsKeyByKeyRequestMethodPost) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Deployment, err error)
- func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsKeyByKeyRequestMethodPost
- type ByProjectKeyDeploymentsRequestBuilder
- func (rb *ByProjectKeyDeploymentsRequestBuilder) Get() *ByProjectKeyDeploymentsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsRequestBuilder) Post(body DeploymentDraft) *ByProjectKeyDeploymentsRequestMethodPost
- func (rb *ByProjectKeyDeploymentsRequestBuilder) WithId(id string) *ByProjectKeyDeploymentsByIDRequestBuilder
- func (rb *ByProjectKeyDeploymentsRequestBuilder) WithKey(key string) *ByProjectKeyDeploymentsKeyByKeyRequestBuilder
- type ByProjectKeyDeploymentsRequestMethodGet
- func (r *ByProjectKeyDeploymentsRequestMethodGet) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsRequestMethodGet) Execute(ctx context.Context) (result *DeploymentPagedQueryResponse, err error)
- func (rb *ByProjectKeyDeploymentsRequestMethodGet) IntegrationTypes(v []IntegrationType) *ByProjectKeyDeploymentsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsRequestMethodGet) Limit(v int) *ByProjectKeyDeploymentsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsRequestMethodGet) Offset(v int) *ByProjectKeyDeploymentsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsRequestMethodGet) Sort(v []string) *ByProjectKeyDeploymentsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsRequestMethodGet
- func (rb *ByProjectKeyDeploymentsRequestMethodGet) WithQueryParams(input ByProjectKeyDeploymentsRequestMethodGetInput) *ByProjectKeyDeploymentsRequestMethodGet
- type ByProjectKeyDeploymentsRequestMethodGetInput
- type ByProjectKeyDeploymentsRequestMethodPost
- func (r *ByProjectKeyDeploymentsRequestMethodPost) Dump() map[string]interface{}
- func (rb *ByProjectKeyDeploymentsRequestMethodPost) Execute(ctx context.Context) (result *Deployment, err error)
- func (rb *ByProjectKeyDeploymentsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsRequestMethodPost
- type ByProjectKeyRequestBuilder
- type CertificationInfo
- type CertificationInfoComment
- type Client
- type ClientConfig
- type ConcurrentModificationError
- type ConfigurationKeySecured
- type ConfigurationKeyStandard
- type ConfigurationValue
- type Connector
- type ConnectorAddCertificationCommentAction
- type ConnectorAddPrivateProjectAction
- type ConnectorAlreadyCertifiedError
- type ConnectorConfigurationApplication
- type ConnectorDraft
- type ConnectorPublishAction
- type ConnectorReference
- type ConnectorReferenceNotFoundError
- type ConnectorRemovePrivateProjectAction
- type ConnectorReport
- type ConnectorReportEntry
- type ConnectorReportEntryType
- type ConnectorSearchPagedQueryResponse
- type ConnectorSetCreatorCompanyAction
- type ConnectorSetCreatorEmailAction
- type ConnectorSetCreatorLogoAction
- type ConnectorSetCreatorNameAction
- type ConnectorSetCreatorNoOfContributorsAction
- type ConnectorSetCreatorSupportUrlAction
- type ConnectorSetCreatorTitleAction
- type ConnectorSetDescriptionAction
- type ConnectorSetDocumentationUrlAction
- type ConnectorSetIntegrationTypesAction
- type ConnectorSetNameAction
- type ConnectorSetRepositoryAction
- type ConnectorSetSupportedRegionsAction
- type ConnectorSpecificationFileNotFoundError
- func (obj *ConnectorSpecificationFileNotFoundError) DecodeStruct(src map[string]interface{}) error
- func (obj ConnectorSpecificationFileNotFoundError) Error() string
- func (obj ConnectorSpecificationFileNotFoundError) MarshalJSON() ([]byte, error)
- func (obj *ConnectorSpecificationFileNotFoundError) UnmarshalJSON(data []byte) error
- type ConnectorSpecificationFileNotValidError
- func (obj *ConnectorSpecificationFileNotValidError) DecodeStruct(src map[string]interface{}) error
- func (obj ConnectorSpecificationFileNotValidError) Error() string
- func (obj ConnectorSpecificationFileNotValidError) MarshalJSON() ([]byte, error)
- func (obj *ConnectorSpecificationFileNotValidError) UnmarshalJSON(data []byte) error
- type ConnectorStaged
- type ConnectorStagedInCertificationError
- func (obj *ConnectorStagedInCertificationError) DecodeStruct(src map[string]interface{}) error
- func (obj ConnectorStagedInCertificationError) Error() string
- func (obj ConnectorStagedInCertificationError) MarshalJSON() ([]byte, error)
- func (obj *ConnectorStagedInCertificationError) UnmarshalJSON(data []byte) error
- type ConnectorStagedNotPreviewableError
- func (obj *ConnectorStagedNotPreviewableError) DecodeStruct(src map[string]interface{}) error
- func (obj ConnectorStagedNotPreviewableError) Error() string
- func (obj ConnectorStagedNotPreviewableError) MarshalJSON() ([]byte, error)
- func (obj *ConnectorStagedNotPreviewableError) UnmarshalJSON(data []byte) error
- type ConnectorStagedNotPrivateError
- type ConnectorStagedPagedQueryResponse
- type ConnectorStagedPreviewRequestUnderProcessError
- func (obj *ConnectorStagedPreviewRequestUnderProcessError) DecodeStruct(src map[string]interface{}) error
- func (obj ConnectorStagedPreviewRequestUnderProcessError) Error() string
- func (obj ConnectorStagedPreviewRequestUnderProcessError) MarshalJSON() ([]byte, error)
- func (obj *ConnectorStagedPreviewRequestUnderProcessError) UnmarshalJSON(data []byte) error
- type ConnectorStatus
- type ConnectorUnlistAction
- type ConnectorUpdate
- type ConnectorUpdateAction
- type ConnectorUpdatePreviewableAction
- type ConnectorsByIDRequestBuilder
- type ConnectorsByIDRequestMethodGet
- type ConnectorsDraftsByIDRequestBuilder
- type ConnectorsDraftsByIDRequestMethodGet
- func (r *ConnectorsDraftsByIDRequestMethodGet) Dump() map[string]interface{}
- func (rb *ConnectorsDraftsByIDRequestMethodGet) Execute(ctx context.Context) (result *ConnectorStaged, err error)
- func (rb *ConnectorsDraftsByIDRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsDraftsByIDRequestMethodGet
- type ConnectorsDraftsByIDRequestMethodPost
- func (r *ConnectorsDraftsByIDRequestMethodPost) Dump() map[string]interface{}
- func (rb *ConnectorsDraftsByIDRequestMethodPost) Execute(ctx context.Context) (result *ConnectorStaged, err error)
- func (rb *ConnectorsDraftsByIDRequestMethodPost) WithHeaders(headers http.Header) *ConnectorsDraftsByIDRequestMethodPost
- type ConnectorsDraftsKeyByKeyRequestBuilder
- type ConnectorsDraftsKeyByKeyRequestMethodGet
- func (r *ConnectorsDraftsKeyByKeyRequestMethodGet) Dump() map[string]interface{}
- func (rb *ConnectorsDraftsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ConnectorStaged, err error)
- func (rb *ConnectorsDraftsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsDraftsKeyByKeyRequestMethodGet
- type ConnectorsDraftsKeyByKeyRequestMethodPost
- func (r *ConnectorsDraftsKeyByKeyRequestMethodPost) Dump() map[string]interface{}
- func (rb *ConnectorsDraftsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ConnectorStaged, err error)
- func (rb *ConnectorsDraftsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ConnectorsDraftsKeyByKeyRequestMethodPost
- type ConnectorsDraftsRequestBuilder
- func (rb *ConnectorsDraftsRequestBuilder) Get() *ConnectorsDraftsRequestMethodGet
- func (rb *ConnectorsDraftsRequestBuilder) Post(body ConnectorDraft) *ConnectorsDraftsRequestMethodPost
- func (rb *ConnectorsDraftsRequestBuilder) WithId(id string) *ConnectorsDraftsByIDRequestBuilder
- func (rb *ConnectorsDraftsRequestBuilder) WithKey(key string) *ConnectorsDraftsKeyByKeyRequestBuilder
- type ConnectorsDraftsRequestMethodGet
- func (r *ConnectorsDraftsRequestMethodGet) Dump() map[string]interface{}
- func (rb *ConnectorsDraftsRequestMethodGet) Execute(ctx context.Context) (result *ConnectorStagedPagedQueryResponse, err error)
- func (rb *ConnectorsDraftsRequestMethodGet) IntegrationTypes(v []IntegrationType) *ConnectorsDraftsRequestMethodGet
- func (rb *ConnectorsDraftsRequestMethodGet) Limit(v int) *ConnectorsDraftsRequestMethodGet
- func (rb *ConnectorsDraftsRequestMethodGet) Offset(v int) *ConnectorsDraftsRequestMethodGet
- func (rb *ConnectorsDraftsRequestMethodGet) Sort(v []string) *ConnectorsDraftsRequestMethodGet
- func (rb *ConnectorsDraftsRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsDraftsRequestMethodGet
- func (rb *ConnectorsDraftsRequestMethodGet) WithQueryParams(input ConnectorsDraftsRequestMethodGetInput) *ConnectorsDraftsRequestMethodGet
- type ConnectorsDraftsRequestMethodGetInput
- type ConnectorsDraftsRequestMethodPost
- type ConnectorsKeyByKeyRequestBuilder
- type ConnectorsKeyByKeyRequestMethodGet
- type ConnectorsRequestBuilder
- func (rb *ConnectorsRequestBuilder) Drafts() *ConnectorsDraftsRequestBuilder
- func (rb *ConnectorsRequestBuilder) Search() *ConnectorsSearchRequestBuilder
- func (rb *ConnectorsRequestBuilder) WithId(id string) *ConnectorsByIDRequestBuilder
- func (rb *ConnectorsRequestBuilder) WithKey(key string) *ConnectorsKeyByKeyRequestBuilder
- type ConnectorsSearchRequestBuilder
- type ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) CreatorCompany(v string) *ConnectorsSearchRequestMethodGet
- func (r *ConnectorsSearchRequestMethodGet) Dump() map[string]interface{}
- func (rb *ConnectorsSearchRequestMethodGet) Execute(ctx context.Context) (result *ConnectorSearchPagedQueryResponse, err error)
- func (rb *ConnectorsSearchRequestMethodGet) ID(v []string) *ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) IntegrationTypes(v []IntegrationType) *ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) Key(v []string) *ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) Limit(v int) *ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) Offset(v int) *ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) Private(v bool) *ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) Sort(v []string) *ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) Text(v string) *ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsSearchRequestMethodGet
- func (rb *ConnectorsSearchRequestMethodGet) WithQueryParams(input ConnectorsSearchRequestMethodGetInput) *ConnectorsSearchRequestMethodGet
- type ConnectorsSearchRequestMethodGetInput
- type Creator
- type Date
- type DecodeStruct
- type Deployment
- type DeploymentApplicationDoNotBelongError
- func (obj *DeploymentApplicationDoNotBelongError) DecodeStruct(src map[string]interface{}) error
- func (obj DeploymentApplicationDoNotBelongError) Error() string
- func (obj DeploymentApplicationDoNotBelongError) MarshalJSON() ([]byte, error)
- func (obj *DeploymentApplicationDoNotBelongError) UnmarshalJSON(data []byte) error
- type DeploymentApplicationRequiredError
- func (obj *DeploymentApplicationRequiredError) DecodeStruct(src map[string]interface{}) error
- func (obj DeploymentApplicationRequiredError) Error() string
- func (obj DeploymentApplicationRequiredError) MarshalJSON() ([]byte, error)
- func (obj *DeploymentApplicationRequiredError) UnmarshalJSON(data []byte) error
- type DeploymentConfigurationApplication
- type DeploymentConnector
- type DeploymentConnectorUpdateFailureError
- func (obj *DeploymentConnectorUpdateFailureError) DecodeStruct(src map[string]interface{}) error
- func (obj DeploymentConnectorUpdateFailureError) Error() string
- func (obj DeploymentConnectorUpdateFailureError) MarshalJSON() ([]byte, error)
- func (obj *DeploymentConnectorUpdateFailureError) UnmarshalJSON(data []byte) error
- type DeploymentCreator
- type DeploymentDetails
- type DeploymentDetailsBuild
- type DeploymentDraft
- type DeploymentInvalidStatusTransitionError
- func (obj *DeploymentInvalidStatusTransitionError) DecodeStruct(src map[string]interface{}) error
- func (obj DeploymentInvalidStatusTransitionError) Error() string
- func (obj DeploymentInvalidStatusTransitionError) MarshalJSON() ([]byte, error)
- func (obj *DeploymentInvalidStatusTransitionError) UnmarshalJSON(data []byte) error
- type DeploymentLog
- type DeploymentLogCursorPagedQueryResponse
- type DeploymentLogSeverity
- type DeploymentMustIncludeApplicationError
- func (obj *DeploymentMustIncludeApplicationError) DecodeStruct(src map[string]interface{}) error
- func (obj DeploymentMustIncludeApplicationError) Error() string
- func (obj DeploymentMustIncludeApplicationError) MarshalJSON() ([]byte, error)
- func (obj *DeploymentMustIncludeApplicationError) UnmarshalJSON(data []byte) error
- type DeploymentPagedQueryResponse
- type DeploymentRedeployAction
- type DeploymentReport
- type DeploymentReportEntry
- type DeploymentReportEntryType
- type DeploymentStatus
- type DeploymentUnknownApplicationConfigurationError
- func (obj *DeploymentUnknownApplicationConfigurationError) DecodeStruct(src map[string]interface{}) error
- func (obj DeploymentUnknownApplicationConfigurationError) Error() string
- func (obj DeploymentUnknownApplicationConfigurationError) MarshalJSON() ([]byte, error)
- func (obj *DeploymentUnknownApplicationConfigurationError) UnmarshalJSON(data []byte) error
- type DeploymentUnknownApplicationConfigurationKeyError
- func (obj *DeploymentUnknownApplicationConfigurationKeyError) DecodeStruct(src map[string]interface{}) error
- func (obj DeploymentUnknownApplicationConfigurationKeyError) Error() string
- func (obj DeploymentUnknownApplicationConfigurationKeyError) MarshalJSON() ([]byte, error)
- func (obj *DeploymentUnknownApplicationConfigurationKeyError) UnmarshalJSON(data []byte) error
- type DeploymentUnsupportedRegionError
- func (obj *DeploymentUnsupportedRegionError) DecodeStruct(src map[string]interface{}) error
- func (obj DeploymentUnsupportedRegionError) Error() string
- func (obj DeploymentUnsupportedRegionError) MarshalJSON() ([]byte, error)
- func (obj *DeploymentUnsupportedRegionError) UnmarshalJSON(data []byte) error
- type DeploymentUpdate
- type DeploymentUpdateAction
- type DuplicateFieldError
- type ErrorObject
- type ErrorResponse
- type FieldValueNotFoundError
- type GeneralError
- type GenericRequestError
- type GitRepositoryNotReachableError
- type IntegrationType
- type InvalidJsonInputError
- type InvalidPathParamError
- type InvalidQueryParamError
- type IsPreviewable
- type Region
- type Repository
- type ResourceNotFoundError
- type SetUserAgentTransport
Constants ¶
const Version = "1.5.0"
Version identifies the current library version. Should match the git tag
Variables ¶
var ErrNotFound = errors.New("resource not found")
Functions ¶
func GetUserAgent ¶
func GetUserAgent() string
Types ¶
type ApplicationDeployment ¶
type ApplicationDeployment struct { // Unique identifier of the application deployment. ID string `json:"id"` // Name of the application. Should match the value of `name` within the connect.yaml file of the Connector. ApplicationName string `json:"applicationName"` // Contains values of keys that are saved in plain text. Can be accessed after being set. StandardConfiguration []ConfigurationValue `json:"standardConfiguration"` // Contains values of secret keys. Cannot be accessed after being set. SecuredConfiguration []ConfigurationValue `json:"securedConfiguration"` // URL generated after deployment of service applications. Url *string `json:"url,omitempty"` // Pub/Sub Topic generated after deployment of event applications. Topic *string `json:"topic,omitempty"` // Cron schedule for job applications. Schedule *string `json:"schedule,omitempty"` }
* * Describes an application deployment of the Connector. *
type Artifact ¶
type Artifact struct { ApplicationName string `json:"applicationName"` ArtifactPath string `json:"artifactPath"` }
* * A connector internal build artifact (ex: docker image). *
type AuthenticationError ¶
type AuthenticationError struct { // `"Bad credientals or Client ID is not defined"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the client cannot be authenticated. *
func (*AuthenticationError) DecodeStruct ¶
func (obj *AuthenticationError) DecodeStruct(src map[string]interface{}) error
func (AuthenticationError) Error ¶
func (obj AuthenticationError) Error() string
func (AuthenticationError) MarshalJSON ¶
func (obj AuthenticationError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*AuthenticationError) UnmarshalJSON ¶
func (obj *AuthenticationError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type AuthorizationError ¶
type AuthorizationError struct { // `"Access denied"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the client does not have sufficient permissions for this operation. *
func (*AuthorizationError) DecodeStruct ¶
func (obj *AuthorizationError) DecodeStruct(src map[string]interface{}) error
func (AuthorizationError) Error ¶
func (obj AuthorizationError) Error() string
func (AuthorizationError) MarshalJSON ¶
func (obj AuthorizationError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*AuthorizationError) UnmarshalJSON ¶
func (obj *AuthorizationError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type BadGatewayError ¶
type BadGatewayError struct { // Plain text description of the error. Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when a server-side problem is caused by scaling infrastructure resources. * * The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. *
func (*BadGatewayError) DecodeStruct ¶
func (obj *BadGatewayError) DecodeStruct(src map[string]interface{}) error
func (BadGatewayError) Error ¶
func (obj BadGatewayError) Error() string
func (BadGatewayError) MarshalJSON ¶
func (obj BadGatewayError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*BadGatewayError) UnmarshalJSON ¶
func (obj *BadGatewayError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ByProjectKeyDeploymentsByIDLogsRequestBuilder ¶
type ByProjectKeyDeploymentsByIDLogsRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsByIDLogsRequestBuilder) Get ¶
func (rb *ByProjectKeyDeploymentsByIDLogsRequestBuilder) Get() *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
* * Retrieves logs for the given deployment.
type ByProjectKeyDeploymentsByIDLogsRequestMethodGet ¶
type ByProjectKeyDeploymentsByIDLogsRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsByIDLogsRequestMethodGet) ApplicationName ¶
func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) ApplicationName(v string) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
func (*ByProjectKeyDeploymentsByIDLogsRequestMethodGet) Dump ¶
func (r *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsByIDLogsRequestMethodGet) EndDate ¶
func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) EndDate(v time.Time) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
func (*ByProjectKeyDeploymentsByIDLogsRequestMethodGet) Execute ¶
func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) Execute(ctx context.Context) (result *DeploymentLogCursorPagedQueryResponse, err error)
* * Retrieves logs for the given deployment.
func (*ByProjectKeyDeploymentsByIDLogsRequestMethodGet) PageToken ¶
func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) PageToken(v string) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
func (*ByProjectKeyDeploymentsByIDLogsRequestMethodGet) StartDate ¶
func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) StartDate(v time.Time) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
func (*ByProjectKeyDeploymentsByIDLogsRequestMethodGet) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
func (*ByProjectKeyDeploymentsByIDLogsRequestMethodGet) WithQueryParams ¶
func (rb *ByProjectKeyDeploymentsByIDLogsRequestMethodGet) WithQueryParams(input ByProjectKeyDeploymentsByIDLogsRequestMethodGetInput) *ByProjectKeyDeploymentsByIDLogsRequestMethodGet
type ByProjectKeyDeploymentsByIDLogsRequestMethodGetInput ¶
type ByProjectKeyDeploymentsByIDLogsRequestMethodGetInput struct { PageToken *string ApplicationName *string StartDate *time.Time EndDate *time.Time }
func (*ByProjectKeyDeploymentsByIDLogsRequestMethodGetInput) Values ¶
func (input *ByProjectKeyDeploymentsByIDLogsRequestMethodGetInput) Values() url.Values
type ByProjectKeyDeploymentsByIDRequestBuilder ¶
type ByProjectKeyDeploymentsByIDRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsByIDRequestBuilder) Delete ¶
func (rb *ByProjectKeyDeploymentsByIDRequestBuilder) Delete() *ByProjectKeyDeploymentsByIDRequestMethodDelete
type ByProjectKeyDeploymentsByIDRequestMethodDelete ¶
type ByProjectKeyDeploymentsByIDRequestMethodDelete struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsByIDRequestMethodDelete) Dump ¶
func (r *ByProjectKeyDeploymentsByIDRequestMethodDelete) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsByIDRequestMethodDelete) Execute ¶
func (rb *ByProjectKeyDeploymentsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Deployment, err error)
func (*ByProjectKeyDeploymentsByIDRequestMethodDelete) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsByIDRequestMethodDelete
type ByProjectKeyDeploymentsByIDRequestMethodGet ¶
type ByProjectKeyDeploymentsByIDRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsByIDRequestMethodGet) Dump ¶
func (r *ByProjectKeyDeploymentsByIDRequestMethodGet) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsByIDRequestMethodGet) Execute ¶
func (rb *ByProjectKeyDeploymentsByIDRequestMethodGet) Execute(ctx context.Context) (result *Deployment, err error)
func (*ByProjectKeyDeploymentsByIDRequestMethodGet) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsByIDRequestMethodGet
type ByProjectKeyDeploymentsByIDRequestMethodPost ¶
type ByProjectKeyDeploymentsByIDRequestMethodPost struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsByIDRequestMethodPost) Dump ¶
func (r *ByProjectKeyDeploymentsByIDRequestMethodPost) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsByIDRequestMethodPost) Execute ¶
func (rb *ByProjectKeyDeploymentsByIDRequestMethodPost) Execute(ctx context.Context) (result *Deployment, err error)
func (*ByProjectKeyDeploymentsByIDRequestMethodPost) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsByIDRequestMethodPost
type ByProjectKeyDeploymentsKeyByKeyLogsRequestBuilder ¶
type ByProjectKeyDeploymentsKeyByKeyLogsRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsKeyByKeyLogsRequestBuilder) Get ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestBuilder) Get() *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
* * Retrieves logs for the given deployment.
type ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet ¶
type ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) ApplicationName ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) ApplicationName(v string) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
func (*ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) Dump ¶
func (r *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) Execute ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) Execute(ctx context.Context) (result *DeploymentLogCursorPagedQueryResponse, err error)
* * Retrieves logs for the given deployment.
func (*ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) PageToken ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) PageToken(v string) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
func (*ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) StartDate ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) StartDate(v time.Time) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
func (*ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet
func (*ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGet) WithQueryParams ¶
type ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGetInput ¶
type ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGetInput struct { PageToken *string ApplicationName *string StartDate *time.Time EndDate *time.Time }
func (*ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGetInput) Values ¶
func (input *ByProjectKeyDeploymentsKeyByKeyLogsRequestMethodGetInput) Values() url.Values
type ByProjectKeyDeploymentsKeyByKeyRequestBuilder ¶
type ByProjectKeyDeploymentsKeyByKeyRequestBuilder struct {
// contains filtered or unexported fields
}
type ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete ¶
type ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete) Dump ¶
func (r *ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete) Execute ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Deployment, err error)
func (*ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsKeyByKeyRequestMethodDelete
type ByProjectKeyDeploymentsKeyByKeyRequestMethodGet ¶
type ByProjectKeyDeploymentsKeyByKeyRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsKeyByKeyRequestMethodGet) Dump ¶
func (r *ByProjectKeyDeploymentsKeyByKeyRequestMethodGet) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsKeyByKeyRequestMethodGet) Execute ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Deployment, err error)
func (*ByProjectKeyDeploymentsKeyByKeyRequestMethodGet) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsKeyByKeyRequestMethodGet
type ByProjectKeyDeploymentsKeyByKeyRequestMethodPost ¶
type ByProjectKeyDeploymentsKeyByKeyRequestMethodPost struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsKeyByKeyRequestMethodPost) Dump ¶
func (r *ByProjectKeyDeploymentsKeyByKeyRequestMethodPost) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsKeyByKeyRequestMethodPost) Execute ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Deployment, err error)
func (*ByProjectKeyDeploymentsKeyByKeyRequestMethodPost) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsKeyByKeyRequestMethodPost
type ByProjectKeyDeploymentsRequestBuilder ¶
type ByProjectKeyDeploymentsRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsRequestBuilder) Get ¶
func (rb *ByProjectKeyDeploymentsRequestBuilder) Get() *ByProjectKeyDeploymentsRequestMethodGet
* * Retrieves all deployments of a project key.
func (*ByProjectKeyDeploymentsRequestBuilder) Post ¶
func (rb *ByProjectKeyDeploymentsRequestBuilder) Post(body DeploymentDraft) *ByProjectKeyDeploymentsRequestMethodPost
* * Specific error codes: * - [ConnectorStagedNotPreviewable](ctp:connect:type:ConnectorStagedNotPreviewableError) * - [DeploymentUnsupportedRegion](ctp:connect:type:DeploymentUnsupportedRegionError) * - [DeploymentUnknownApplicationConfiguration](ctp:connect:type:DeploymentUnknownApplicationConfigurationError) * - [DeploymentUnknownApplicationConfigurationKey](ctp:connect:type:DeploymentUnknownApplicationConfigurationKeyError) * - [DeploymentApplicationDoNotBelong](ctp:connect:type:DeploymentApplicationDoNotBelongError) * - [DeploymentMustIncludeApplication](ctp:connect:type:DeploymentMustIncludeApplicationError) * - [DeploymentApplicationRequired](ctp:connect:type:DeploymentApplicationRequiredError) *
func (*ByProjectKeyDeploymentsRequestBuilder) WithId ¶
func (rb *ByProjectKeyDeploymentsRequestBuilder) WithId(id string) *ByProjectKeyDeploymentsByIDRequestBuilder
func (*ByProjectKeyDeploymentsRequestBuilder) WithKey ¶
func (rb *ByProjectKeyDeploymentsRequestBuilder) WithKey(key string) *ByProjectKeyDeploymentsKeyByKeyRequestBuilder
type ByProjectKeyDeploymentsRequestMethodGet ¶
type ByProjectKeyDeploymentsRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsRequestMethodGet) Dump ¶
func (r *ByProjectKeyDeploymentsRequestMethodGet) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsRequestMethodGet) Execute ¶
func (rb *ByProjectKeyDeploymentsRequestMethodGet) Execute(ctx context.Context) (result *DeploymentPagedQueryResponse, err error)
* * Retrieves all deployments of a project key.
func (*ByProjectKeyDeploymentsRequestMethodGet) IntegrationTypes ¶ added in v1.5.0
func (rb *ByProjectKeyDeploymentsRequestMethodGet) IntegrationTypes(v []IntegrationType) *ByProjectKeyDeploymentsRequestMethodGet
func (*ByProjectKeyDeploymentsRequestMethodGet) Limit ¶
func (rb *ByProjectKeyDeploymentsRequestMethodGet) Limit(v int) *ByProjectKeyDeploymentsRequestMethodGet
func (*ByProjectKeyDeploymentsRequestMethodGet) Offset ¶
func (rb *ByProjectKeyDeploymentsRequestMethodGet) Offset(v int) *ByProjectKeyDeploymentsRequestMethodGet
func (*ByProjectKeyDeploymentsRequestMethodGet) Sort ¶
func (rb *ByProjectKeyDeploymentsRequestMethodGet) Sort(v []string) *ByProjectKeyDeploymentsRequestMethodGet
func (*ByProjectKeyDeploymentsRequestMethodGet) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsRequestMethodGet
func (*ByProjectKeyDeploymentsRequestMethodGet) WithQueryParams ¶
func (rb *ByProjectKeyDeploymentsRequestMethodGet) WithQueryParams(input ByProjectKeyDeploymentsRequestMethodGetInput) *ByProjectKeyDeploymentsRequestMethodGet
type ByProjectKeyDeploymentsRequestMethodGetInput ¶
type ByProjectKeyDeploymentsRequestMethodGetInput struct { IntegrationTypes []IntegrationType Limit *int Offset *int Sort []string }
func (*ByProjectKeyDeploymentsRequestMethodGetInput) Values ¶
func (input *ByProjectKeyDeploymentsRequestMethodGetInput) Values() url.Values
type ByProjectKeyDeploymentsRequestMethodPost ¶
type ByProjectKeyDeploymentsRequestMethodPost struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyDeploymentsRequestMethodPost) Dump ¶
func (r *ByProjectKeyDeploymentsRequestMethodPost) Dump() map[string]interface{}
func (*ByProjectKeyDeploymentsRequestMethodPost) Execute ¶
func (rb *ByProjectKeyDeploymentsRequestMethodPost) Execute(ctx context.Context) (result *Deployment, err error)
* * Specific error codes: * - [ConnectorStagedNotPreviewable](ctp:connect:type:ConnectorStagedNotPreviewableError) * - [DeploymentUnsupportedRegion](ctp:connect:type:DeploymentUnsupportedRegionError) * - [DeploymentUnknownApplicationConfiguration](ctp:connect:type:DeploymentUnknownApplicationConfigurationError) * - [DeploymentUnknownApplicationConfigurationKey](ctp:connect:type:DeploymentUnknownApplicationConfigurationKeyError) * - [DeploymentApplicationDoNotBelong](ctp:connect:type:DeploymentApplicationDoNotBelongError) * - [DeploymentMustIncludeApplication](ctp:connect:type:DeploymentMustIncludeApplicationError) * - [DeploymentApplicationRequired](ctp:connect:type:DeploymentApplicationRequiredError) *
func (*ByProjectKeyDeploymentsRequestMethodPost) WithHeaders ¶
func (rb *ByProjectKeyDeploymentsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyDeploymentsRequestMethodPost
type ByProjectKeyRequestBuilder ¶
type ByProjectKeyRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ByProjectKeyRequestBuilder) Deployments ¶
func (rb *ByProjectKeyRequestBuilder) Deployments() *ByProjectKeyDeploymentsRequestBuilder
type CertificationInfo ¶
type CertificationInfo struct { // Comments made during the certification process. Comments []CertificationInfoComment `json:"comments"` }
type CertificationInfoComment ¶
type CertificationInfoComment struct { // The commercetools Composable Commerce Project key associated with the person making the comment. UserId string `json:"userId"` // Date and time (UTC) the comment was added. Datetime time.Time `json:"datetime"` // The body text of the comment. Comment string `json:"comment"` }
* * Contains metadata and body text of a comment made during the certification process. *
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(cfg *ClientConfig) (*Client, error)
NewClient creates a new client based on the provided ClientConfig
func (*Client) Connectors ¶
func (c *Client) Connectors() *ConnectorsRequestBuilder
func (*Client) WithProjectKey ¶
func (c *Client) WithProjectKey(projectKey string) *ByProjectKeyRequestBuilder
* * The Project endpoint is used to retrieve certain information from a project.
type ClientConfig ¶
type ConcurrentModificationError ¶
type ConcurrentModificationError struct { // `"Object id=$resourceId or key=$resourceKey has a different version than expected. Expected: $expectedVersion - Actual: $currentVersion)"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` // Expected version of the resource. ExpectedVersion int `json:"expectedVersion"` // Current version of the resource. CurrentVersion *int `json:"currentVersion,omitempty"` }
* * Returned when the request conflicts with the current state of the involved resources. Typically, the request attempts to modify a resource that is out of date (that is modified by another client since it was last retrieved). * The client application should resolve the conflict (with or without involving the end-user) before retrying the request. *
func (*ConcurrentModificationError) DecodeStruct ¶
func (obj *ConcurrentModificationError) DecodeStruct(src map[string]interface{}) error
func (ConcurrentModificationError) Error ¶
func (obj ConcurrentModificationError) Error() string
func (ConcurrentModificationError) MarshalJSON ¶
func (obj ConcurrentModificationError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ConcurrentModificationError) UnmarshalJSON ¶
func (obj *ConcurrentModificationError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConfigurationKeySecured ¶ added in v1.4.0
type ConfigurationKeySecured struct { // Name of the environment variable. Key string `json:"key"` // Description of the environment variable. Description string `json:"description"` // Indicates if the environment variable is required. Required *bool `json:"required,omitempty"` }
* * The name and description of a secret environment variable. *
type ConfigurationKeyStandard ¶ added in v1.4.0
type ConfigurationKeyStandard struct { // Name of the environment variable. Key string `json:"key"` // Description of the environment variable. Description string `json:"description"` // Default value of the environment variable. Default *string `json:"default,omitempty"` // Indicates if the environment variable is required. Required *bool `json:"required,omitempty"` }
* * The name, description, and default value of a standard environment variable. *
type ConfigurationValue ¶
type Connector ¶
type Connector struct { // Unique identifier of the Connector. ID string `json:"id"` // User-defined unique identifier of the Connector. Key *string `json:"key,omitempty"` // Current version of the Connector. Version int `json:"version"` // Name of the Connector. Name string `json:"name"` // Description of the Connector. Description *string `json:"description,omitempty"` // Type of integration provided by the Connector. Can be used to filter search and query results. IntegrationTypes []IntegrationType `json:"integrationTypes"` // Owner of the Connector. Creator Creator `json:"creator"` // GitHub repository details of the Connector. Repository Repository `json:"repository"` // Configurations needed by Connectors for hosting. Loaded as environment variables in the workload. Configurations []ConnectorConfigurationApplication `json:"configurations"` // If `true`, only Composable Commerce Projects specified in `privateProjects` can access the Connector. Private bool `json:"private"` // If not empty, Connectors can only be deployed in these Regions. If empty, Connectors can be deployed in any [supported Region](hosts-and-authorization#hosts). SupportedRegions []Region `json:"supportedRegions"` // If `true`, the Connector is certified. Certified bool `json:"certified"` // URL to the documentation of the Connector. DocumentationUrl *string `json:"documentationUrl,omitempty"` }
func (Connector) MarshalJSON ¶
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorAddCertificationCommentAction ¶
type ConnectorAddCertificationCommentAction struct { // Comment to add. Comment string `json:"comment"` }
* * Add a comment during the certification process of the Connector. *
func (ConnectorAddCertificationCommentAction) MarshalJSON ¶
func (obj ConnectorAddCertificationCommentAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorAddPrivateProjectAction ¶
type ConnectorAddPrivateProjectAction struct { // The Composable Commerce Project to add to `privateProjects`. PrivateProject string `json:"privateProject"` }
* * Allow a Composable Commerce Project to access a private Connector. * * Attempting to add a `privateProject` to a non-private ConnectorStaged returns the [ConnectorStagedNotPrivate](ctp:connect:type:ConnectorStagedNotPrivateError) error. *
func (ConnectorAddPrivateProjectAction) MarshalJSON ¶
func (obj ConnectorAddPrivateProjectAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorAlreadyCertifiedError ¶
type ConnectorAlreadyCertifiedError struct { // `"The ConnectorStaged is already certified"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when trying to certify a Connector that is already certified. * * The error is returned as a failed response to the [Publish](ctp:connect:type:ConnectorPublishAction) update action only when certification is required. *
func (*ConnectorAlreadyCertifiedError) DecodeStruct ¶
func (obj *ConnectorAlreadyCertifiedError) DecodeStruct(src map[string]interface{}) error
func (ConnectorAlreadyCertifiedError) Error ¶
func (obj ConnectorAlreadyCertifiedError) Error() string
func (ConnectorAlreadyCertifiedError) MarshalJSON ¶
func (obj ConnectorAlreadyCertifiedError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ConnectorAlreadyCertifiedError) UnmarshalJSON ¶
func (obj *ConnectorAlreadyCertifiedError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConnectorConfigurationApplication ¶
type ConnectorConfigurationApplication struct { // Name of the Connect application. ApplicationName string `json:"applicationName"` // The Connect application type. ApplicationType string `json:"applicationType"` // Contains the name, description, and default values of standard environment variables. StandardConfiguration []ConfigurationKeyStandard `json:"standardConfiguration"` // Contains the name and description of secret environment variables. SecuredConfiguration []ConfigurationKeySecured `json:"securedConfiguration"` }
* * The configuration of a Connect application. These values are automatically obtained from the connect.yaml file in the GitHub repository. *
type ConnectorDraft ¶
type ConnectorDraft struct { // User-defined unique identifier of the Connector. Key *string `json:"key,omitempty"` // Name of the Connector. Name string `json:"name"` // Description of the Connector. Description *string `json:"description,omitempty"` // Type of integration provided by the Connector. Can be used to filter search and query results. IntegrationTypes []IntegrationType `json:"integrationTypes"` // Owner of the Connector. Creator Creator `json:"creator"` // GitHub repository details of the Connector. Repository Repository `json:"repository"` // If provided, Connectors can only be deployed in these Regions. If not provided, Connectors can be deployed in any [supported Region](hosts-and-authorization#hosts). SupportedRegions []Region `json:"supportedRegions"` // Composable Commerce Projects that can access the Connector. If empty, only the creator can access this Connector. PrivateProjects []string `json:"privateProjects"` // URL to the documentation of the Connector. DocumentationUrl *string `json:"documentationUrl,omitempty"` }
func (ConnectorDraft) MarshalJSON ¶
func (obj ConnectorDraft) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorPublishAction ¶ added in v1.4.0
type ConnectorPublishAction struct { // If `true`, the ConnectorStaged enters the certification process. After completing the certification process, the Connector will become publicly available. If `false`, the published Connector becomes private and is available for deployment to Projects listed in `ConnectorStaged.privateProjects`. Certification bool `json:"certification"` }
* * Starts the Connector publishing process. You will be unable to update the Connector until the process completes. *
func (ConnectorPublishAction) MarshalJSON ¶ added in v1.4.0
func (obj ConnectorPublishAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorReference ¶
type ConnectorReference struct { // Unique identifier of the referenced Connector. ID *string `json:"id,omitempty"` // User-defined unique identifier of the referenced Connector. Key *string `json:"key,omitempty"` // If `true`, the previewable [ConnectorStaged](ctp:connect:type:ConnectorStaged) will be referenced instead of the published Connector. The `isPreviewable` field of the [ConnectorStaged](ctp:connect:type:ConnectorStaged) must be `true` to reference a previewable ConnectorStaged. Staged *bool `json:"staged,omitempty"` // Version of the referenced Connector. Version *int `json:"version,omitempty"` }
* * Reference to a Connector. Either `id` or `key` is required.
type ConnectorReferenceNotFoundError ¶ added in v1.4.0
type ConnectorReferenceNotFoundError struct { // `"Connector '$identifier' with version $version not found"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the referenced Connector was not found. *
func (*ConnectorReferenceNotFoundError) DecodeStruct ¶ added in v1.4.0
func (obj *ConnectorReferenceNotFoundError) DecodeStruct(src map[string]interface{}) error
func (ConnectorReferenceNotFoundError) Error ¶ added in v1.4.0
func (obj ConnectorReferenceNotFoundError) Error() string
func (ConnectorReferenceNotFoundError) MarshalJSON ¶ added in v1.4.0
func (obj ConnectorReferenceNotFoundError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ConnectorReferenceNotFoundError) UnmarshalJSON ¶ added in v1.4.0
func (obj *ConnectorReferenceNotFoundError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConnectorRemovePrivateProjectAction ¶
type ConnectorRemovePrivateProjectAction struct { // The Composable Commerce Project to remove from `privateProjects`. PrivateProject string `json:"privateProject"` }
* * Remove a Composable Commerce Project's access to a private Connector. * * Attempting to remove a `privateProject` from a non-private ConnectorStaged returns the [ConnectorStagedNotPrivate](ctp:connect:type:ConnectorStagedNotPrivateError) error. *
func (ConnectorRemovePrivateProjectAction) MarshalJSON ¶
func (obj ConnectorRemovePrivateProjectAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorReport ¶ added in v1.4.0
type ConnectorReport struct { // Contains information, error, and warning notices. Entries []ConnectorReportEntry `json:"entries"` }
* * Contains report entries for publish/preview requests.
type ConnectorReportEntry ¶ added in v1.4.0
type ConnectorReportEntry struct { // The report entry type. Type ConnectorReportEntryType `json:"type"` // The title of the report entry. Title string `json:"title"` // The message related to the report entry. Message *string `json:"message,omitempty"` // When the report entry was created. CreatedAt time.Time `json:"createdAt"` }
* * Describes an information, error, or warning notice.
type ConnectorReportEntryType ¶ added in v1.4.0
type ConnectorReportEntryType string
* * The type of message being reported. *
const ( ConnectorReportEntryTypeInformation ConnectorReportEntryType = "Information" ConnectorReportEntryTypeWarning ConnectorReportEntryType = "Warning" ConnectorReportEntryTypeError ConnectorReportEntryType = "Error" )
type ConnectorSearchPagedQueryResponse ¶ added in v1.4.0
type ConnectorSearchPagedQueryResponse struct { // The maximum number of Connectors returned. Limit int `json:"limit"` // The offset of the Connectors returned. Offset int `json:"offset"` // The number of Connectors returned. Count int `json:"count"` // The total number of Connectors matching the query. Total int `json:"total"` // Connectors matching the query. Results []Connector `json:"results"` }
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of Connector(ctp:connect:type:Connector). *
type ConnectorSetCreatorCompanyAction ¶
type ConnectorSetCreatorCompanyAction struct { // Value to set. CreatorCompany string `json:"creatorCompany"` }
* * Updates the company of the creator. *
func (ConnectorSetCreatorCompanyAction) MarshalJSON ¶
func (obj ConnectorSetCreatorCompanyAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetCreatorEmailAction ¶
type ConnectorSetCreatorEmailAction struct { // Value to set. CreatorEmail string `json:"creatorEmail"` }
* * Updates the email address of the creator. *
func (ConnectorSetCreatorEmailAction) MarshalJSON ¶
func (obj ConnectorSetCreatorEmailAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetCreatorLogoAction ¶ added in v1.4.0
type ConnectorSetCreatorLogoAction struct { // Value to set. LogoUrl string `json:"logoUrl"` }
* * Updates the logo of the creator. *
func (ConnectorSetCreatorLogoAction) MarshalJSON ¶ added in v1.4.0
func (obj ConnectorSetCreatorLogoAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetCreatorNameAction ¶
type ConnectorSetCreatorNameAction struct { // Value to set. CreatorName string `json:"creatorName"` }
* * Updates the name of the creator. *
func (ConnectorSetCreatorNameAction) MarshalJSON ¶
func (obj ConnectorSetCreatorNameAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetCreatorNoOfContributorsAction ¶ added in v1.4.0
type ConnectorSetCreatorNoOfContributorsAction struct { // Value to set. CreatorNoOfContributors int `json:"creatorNoOfContributors"` }
* * Updates the number of contributors of the creator. *
func (ConnectorSetCreatorNoOfContributorsAction) MarshalJSON ¶ added in v1.4.0
func (obj ConnectorSetCreatorNoOfContributorsAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetCreatorSupportUrlAction ¶ added in v1.4.0
type ConnectorSetCreatorSupportUrlAction struct { // Value to set. CreatorSupportUrl string `json:"creatorSupportUrl"` }
* * Updates the support URL of the creator. *
func (ConnectorSetCreatorSupportUrlAction) MarshalJSON ¶ added in v1.4.0
func (obj ConnectorSetCreatorSupportUrlAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetCreatorTitleAction ¶
type ConnectorSetCreatorTitleAction struct { // Value to set. CreatorTitle string `json:"creatorTitle"` }
* * Updates the title of the creator. *
func (ConnectorSetCreatorTitleAction) MarshalJSON ¶
func (obj ConnectorSetCreatorTitleAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetDescriptionAction ¶
type ConnectorSetDescriptionAction struct { // Value to set. Description string `json:"description"` }
* * Updates the description of the Connector. *
func (ConnectorSetDescriptionAction) MarshalJSON ¶
func (obj ConnectorSetDescriptionAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetDocumentationUrlAction ¶ added in v1.4.0
type ConnectorSetDocumentationUrlAction struct { // Value to set. DocumentationUrl string `json:"documentationUrl"` }
* * Updates the documentation URL of the Connector. *
func (ConnectorSetDocumentationUrlAction) MarshalJSON ¶ added in v1.4.0
func (obj ConnectorSetDocumentationUrlAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetIntegrationTypesAction ¶ added in v1.5.0
type ConnectorSetIntegrationTypesAction struct { // New value to set. IntegrationTypes []IntegrationType `json:"integrationTypes"` }
* * Updates the integration types of the Connector. *
func (ConnectorSetIntegrationTypesAction) MarshalJSON ¶ added in v1.5.0
func (obj ConnectorSetIntegrationTypesAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetNameAction ¶
type ConnectorSetNameAction struct { // Value to set. Name string `json:"name"` }
* * Updates the name of the Connector. *
func (ConnectorSetNameAction) MarshalJSON ¶
func (obj ConnectorSetNameAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetRepositoryAction ¶
type ConnectorSetRepositoryAction struct { // New HTTPS or SSH GitHub URL to assign to the Connector. Url string `json:"url"` // New Git tag to assign to the Connector. Tag string `json:"tag"` }
* * Updates the GitHub repository details of the Connector. *
func (ConnectorSetRepositoryAction) MarshalJSON ¶
func (obj ConnectorSetRepositoryAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSetSupportedRegionsAction ¶
type ConnectorSetSupportedRegionsAction struct { // New value to set. Regions []Region `json:"regions"` }
* * Updates the regions that the Connector can be deployed in. *
func (ConnectorSetSupportedRegionsAction) MarshalJSON ¶
func (obj ConnectorSetSupportedRegionsAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorSpecificationFileNotFoundError ¶ added in v1.4.0
type ConnectorSpecificationFileNotFoundError struct { // `"The file connect.yaml at $url with the tag $tag was not found"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the Connector specification file was not found. *
func (*ConnectorSpecificationFileNotFoundError) DecodeStruct ¶ added in v1.4.0
func (obj *ConnectorSpecificationFileNotFoundError) DecodeStruct(src map[string]interface{}) error
func (ConnectorSpecificationFileNotFoundError) Error ¶ added in v1.4.0
func (obj ConnectorSpecificationFileNotFoundError) Error() string
func (ConnectorSpecificationFileNotFoundError) MarshalJSON ¶ added in v1.4.0
func (obj ConnectorSpecificationFileNotFoundError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ConnectorSpecificationFileNotFoundError) UnmarshalJSON ¶ added in v1.4.0
func (obj *ConnectorSpecificationFileNotFoundError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConnectorSpecificationFileNotValidError ¶ added in v1.4.0
type ConnectorSpecificationFileNotValidError struct { // `"The file connect.yaml at $url with the tag $tag is not valid"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the Connector specification file is not valid. *
func (*ConnectorSpecificationFileNotValidError) DecodeStruct ¶ added in v1.4.0
func (obj *ConnectorSpecificationFileNotValidError) DecodeStruct(src map[string]interface{}) error
func (ConnectorSpecificationFileNotValidError) Error ¶ added in v1.4.0
func (obj ConnectorSpecificationFileNotValidError) Error() string
func (ConnectorSpecificationFileNotValidError) MarshalJSON ¶ added in v1.4.0
func (obj ConnectorSpecificationFileNotValidError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ConnectorSpecificationFileNotValidError) UnmarshalJSON ¶ added in v1.4.0
func (obj *ConnectorSpecificationFileNotValidError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConnectorStaged ¶
type ConnectorStaged struct { // Unique identifier of the Connector. ID string `json:"id"` // User-defined unique identifier of the Connector. Key *string `json:"key,omitempty"` // Current version of the Connector. Version int `json:"version"` // Name of the Connector. Name string `json:"name"` // Description of the Connector. Description string `json:"description"` // Type of integration provided by the Connector. Can be used to filter search and query results. IntegrationTypes []IntegrationType `json:"integrationTypes"` // Owner of the Connector. Creator Creator `json:"creator"` // GitHub repository details of the Connector. Repository Repository `json:"repository"` // Configurations needed by Connectors for hosting. Loaded as environment variables in the workload. Configurations []ConnectorConfigurationApplication `json:"configurations"` // If `true`, only Composable Commerce Projects specified in `privateProjects` can access the Connector. Private bool `json:"private"` // If `private` is true, only these Composable Commerce Projects can access the Connector. PrivateProjects []string `json:"privateProjects"` // If not empty, Connectors can only be deployed in these Regions. If empty, Connectors can be deployed in any [supported Region](hosts-and-authorization#hosts). SupportedRegions []Region `json:"supportedRegions"` // Comments made during the certification process. CertificationInfo *CertificationInfo `json:"certificationInfo,omitempty"` // Current status of the Connector. Status string `json:"status"` // The publishing request report of the Connector. PublishingReport *ConnectorReport `json:"publishingReport,omitempty"` // If `true`, the Connector is published and ready for use. AlreadyListed bool `json:"alreadyListed"` // If `true`, the ConnectorStaged data is different from the production [Connector](ctp:connect:type:Connector) data. HasChanges bool `json:"hasChanges"` // The previewable status of the ConnectorStaged. IsPreviewable string `json:"isPreviewable"` // The previewable request report. PreviewableReport *ConnectorReport `json:"previewableReport,omitempty"` // URL to the documentation of the Connector. DocumentationUrl *string `json:"documentationUrl,omitempty"` }
type ConnectorStagedInCertificationError ¶
type ConnectorStagedInCertificationError struct { // `"The ConnectorStaged is already in certification"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when trying to publish a Connector that requires certification but is already in the certification process. * * The error is returned as a failed response to the [Publish](ctp:connect:type:ConnectorPublishAction) update actiononly when certification is required. *
func (*ConnectorStagedInCertificationError) DecodeStruct ¶
func (obj *ConnectorStagedInCertificationError) DecodeStruct(src map[string]interface{}) error
func (ConnectorStagedInCertificationError) Error ¶
func (obj ConnectorStagedInCertificationError) Error() string
func (ConnectorStagedInCertificationError) MarshalJSON ¶
func (obj ConnectorStagedInCertificationError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ConnectorStagedInCertificationError) UnmarshalJSON ¶
func (obj *ConnectorStagedInCertificationError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConnectorStagedNotPreviewableError ¶
type ConnectorStagedNotPreviewableError struct { // `"Connector id=$resourceId or key=$resourceKey with version $version is not previewable"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when a ConnectorStaged to be deployed is not previewable. * * The error is returned as a failed response to the [Create a Deployment](ctp:connect:endpoint:/{projectKey}/deployments:POST) request. *
func (*ConnectorStagedNotPreviewableError) DecodeStruct ¶
func (obj *ConnectorStagedNotPreviewableError) DecodeStruct(src map[string]interface{}) error
func (ConnectorStagedNotPreviewableError) Error ¶
func (obj ConnectorStagedNotPreviewableError) Error() string
func (ConnectorStagedNotPreviewableError) MarshalJSON ¶
func (obj ConnectorStagedNotPreviewableError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ConnectorStagedNotPreviewableError) UnmarshalJSON ¶
func (obj *ConnectorStagedNotPreviewableError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConnectorStagedNotPrivateError ¶
type ConnectorStagedNotPrivateError struct { // `"The operation is not valid because ConnectorStaged with id=$resourceId or key=$resourceKey is not private"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when attempting to change the `privateProjects` of a non-private ConnectorStaged. * * The error is returned as a failed response to the [Add Project to Private Connector](ctp:connect:type:ConnectorAddPrivateProjectAction) and [Remove Project from Private Connector](ctp:connect:type:ConnectorRemovePrivateProjectAction) update actions. *
func (*ConnectorStagedNotPrivateError) DecodeStruct ¶
func (obj *ConnectorStagedNotPrivateError) DecodeStruct(src map[string]interface{}) error
func (ConnectorStagedNotPrivateError) Error ¶
func (obj ConnectorStagedNotPrivateError) Error() string
func (ConnectorStagedNotPrivateError) MarshalJSON ¶
func (obj ConnectorStagedNotPrivateError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ConnectorStagedNotPrivateError) UnmarshalJSON ¶
func (obj *ConnectorStagedNotPrivateError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConnectorStagedPagedQueryResponse ¶ added in v1.4.0
type ConnectorStagedPagedQueryResponse struct { // The maximum number of the ConnectorStaged returned. Limit int `json:"limit"` // The offset of the ConnectorStaged returned. Offset int `json:"offset"` // The number of ConnectorStaged returned. Count int `json:"count"` // The total number of ConnectorStaged matching the query. Total int `json:"total"` // ConnectorStaged matching the query. Results []ConnectorStaged `json:"results"` }
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of ConnectorStaged(ctp:connect:type:ConnectorStaged). *
type ConnectorStagedPreviewRequestUnderProcessError ¶
type ConnectorStagedPreviewRequestUnderProcessError struct { // `"The ConnectorStaged preview request is already in progress"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when attempting to request previewable status of a ConnectorStaged that is currently being reviewed for previewable status. * * The error is returned as a failed response to the [Preview Connector](ctp:connect:type:ConnectorUpdatePreviewableAction) update action. *
func (*ConnectorStagedPreviewRequestUnderProcessError) DecodeStruct ¶
func (obj *ConnectorStagedPreviewRequestUnderProcessError) DecodeStruct(src map[string]interface{}) error
func (ConnectorStagedPreviewRequestUnderProcessError) Error ¶
func (obj ConnectorStagedPreviewRequestUnderProcessError) Error() string
func (ConnectorStagedPreviewRequestUnderProcessError) MarshalJSON ¶
func (obj ConnectorStagedPreviewRequestUnderProcessError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ConnectorStagedPreviewRequestUnderProcessError) UnmarshalJSON ¶
func (obj *ConnectorStagedPreviewRequestUnderProcessError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConnectorStatus ¶
type ConnectorStatus string
* * Indicates the current status of the ConnectorStaged. *
const ( ConnectorStatusDraft ConnectorStatus = "Draft" ConnectorStatusProcessing ConnectorStatus = "Processing" ConnectorStatusReadyForCertification ConnectorStatus = "ReadyForCertification" ConnectorStatusInCertification ConnectorStatus = "InCertification" ConnectorStatusPublished ConnectorStatus = "Published" ConnectorStatusFailed ConnectorStatus = "Failed" )
type ConnectorUnlistAction ¶
type ConnectorUnlistAction struct { }
* * Removes a certified and listed Connector from search results and listings. This update action does not affect deployed instances of the Connector. *
func (ConnectorUnlistAction) MarshalJSON ¶
func (obj ConnectorUnlistAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorUpdate ¶
type ConnectorUpdate struct { // Expected version of the Connector on which the changes apply. Version int `json:"version"` // Update actions to be performed on the Connector. Actions []ConnectorUpdateAction `json:"actions"` }
func (*ConnectorUpdate) UnmarshalJSON ¶
func (obj *ConnectorUpdate) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ConnectorUpdateAction ¶
type ConnectorUpdateAction interface{}
type ConnectorUpdatePreviewableAction ¶
type ConnectorUpdatePreviewableAction struct { }
* * Requests the previewable status of a ConnectorStaged. A previewable ConnectorStaged can be used in a Deployment for testing and preview purposes. * * After using this update action, the status of `isPreviewable` will change to `pending`. Following validation, the status of `isPreviewable` will change to `true` if the previewable status is granted, or `false` if it is rejected. * In the case of a `false` status, contact our [support team](https://commercetools.atlassian.net/servicedesk/customer/portal/27) regarding any issues raised during the validation process. * * Requesting the previewable status for a ConnectorStaged that is currently being reviewed returns the [ConnectorStagedPreviewRequestUnderProcess](ctp:connect:type:ConnectorStagedPreviewRequestUnderProcessError) error. *
func (ConnectorUpdatePreviewableAction) MarshalJSON ¶
func (obj ConnectorUpdatePreviewableAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type ConnectorsByIDRequestBuilder ¶
type ConnectorsByIDRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ConnectorsByIDRequestBuilder) Get ¶
func (rb *ConnectorsByIDRequestBuilder) Get() *ConnectorsByIDRequestMethodGet
type ConnectorsByIDRequestMethodGet ¶
type ConnectorsByIDRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ConnectorsByIDRequestMethodGet) Dump ¶
func (r *ConnectorsByIDRequestMethodGet) Dump() map[string]interface{}
func (*ConnectorsByIDRequestMethodGet) Execute ¶
func (rb *ConnectorsByIDRequestMethodGet) Execute(ctx context.Context) (result *Connector, err error)
func (*ConnectorsByIDRequestMethodGet) WithHeaders ¶
func (rb *ConnectorsByIDRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsByIDRequestMethodGet
type ConnectorsDraftsByIDRequestBuilder ¶
type ConnectorsDraftsByIDRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ConnectorsDraftsByIDRequestBuilder) Get ¶
func (rb *ConnectorsDraftsByIDRequestBuilder) Get() *ConnectorsDraftsByIDRequestMethodGet
func (*ConnectorsDraftsByIDRequestBuilder) Post ¶
func (rb *ConnectorsDraftsByIDRequestBuilder) Post(body ConnectorUpdate) *ConnectorsDraftsByIDRequestMethodPost
type ConnectorsDraftsByIDRequestMethodGet ¶
type ConnectorsDraftsByIDRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ConnectorsDraftsByIDRequestMethodGet) Dump ¶
func (r *ConnectorsDraftsByIDRequestMethodGet) Dump() map[string]interface{}
func (*ConnectorsDraftsByIDRequestMethodGet) Execute ¶
func (rb *ConnectorsDraftsByIDRequestMethodGet) Execute(ctx context.Context) (result *ConnectorStaged, err error)
func (*ConnectorsDraftsByIDRequestMethodGet) WithHeaders ¶
func (rb *ConnectorsDraftsByIDRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsDraftsByIDRequestMethodGet
type ConnectorsDraftsByIDRequestMethodPost ¶
type ConnectorsDraftsByIDRequestMethodPost struct {
// contains filtered or unexported fields
}
func (*ConnectorsDraftsByIDRequestMethodPost) Dump ¶
func (r *ConnectorsDraftsByIDRequestMethodPost) Dump() map[string]interface{}
func (*ConnectorsDraftsByIDRequestMethodPost) Execute ¶
func (rb *ConnectorsDraftsByIDRequestMethodPost) Execute(ctx context.Context) (result *ConnectorStaged, err error)
func (*ConnectorsDraftsByIDRequestMethodPost) WithHeaders ¶
func (rb *ConnectorsDraftsByIDRequestMethodPost) WithHeaders(headers http.Header) *ConnectorsDraftsByIDRequestMethodPost
type ConnectorsDraftsKeyByKeyRequestBuilder ¶
type ConnectorsDraftsKeyByKeyRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ConnectorsDraftsKeyByKeyRequestBuilder) Post ¶
func (rb *ConnectorsDraftsKeyByKeyRequestBuilder) Post(body ConnectorUpdate) *ConnectorsDraftsKeyByKeyRequestMethodPost
type ConnectorsDraftsKeyByKeyRequestMethodGet ¶
type ConnectorsDraftsKeyByKeyRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ConnectorsDraftsKeyByKeyRequestMethodGet) Dump ¶
func (r *ConnectorsDraftsKeyByKeyRequestMethodGet) Dump() map[string]interface{}
func (*ConnectorsDraftsKeyByKeyRequestMethodGet) Execute ¶
func (rb *ConnectorsDraftsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ConnectorStaged, err error)
func (*ConnectorsDraftsKeyByKeyRequestMethodGet) WithHeaders ¶
func (rb *ConnectorsDraftsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsDraftsKeyByKeyRequestMethodGet
type ConnectorsDraftsKeyByKeyRequestMethodPost ¶
type ConnectorsDraftsKeyByKeyRequestMethodPost struct {
// contains filtered or unexported fields
}
func (*ConnectorsDraftsKeyByKeyRequestMethodPost) Dump ¶
func (r *ConnectorsDraftsKeyByKeyRequestMethodPost) Dump() map[string]interface{}
func (*ConnectorsDraftsKeyByKeyRequestMethodPost) Execute ¶
func (rb *ConnectorsDraftsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ConnectorStaged, err error)
func (*ConnectorsDraftsKeyByKeyRequestMethodPost) WithHeaders ¶
func (rb *ConnectorsDraftsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ConnectorsDraftsKeyByKeyRequestMethodPost
type ConnectorsDraftsRequestBuilder ¶
type ConnectorsDraftsRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ConnectorsDraftsRequestBuilder) Get ¶
func (rb *ConnectorsDraftsRequestBuilder) Get() *ConnectorsDraftsRequestMethodGet
func (*ConnectorsDraftsRequestBuilder) Post ¶
func (rb *ConnectorsDraftsRequestBuilder) Post(body ConnectorDraft) *ConnectorsDraftsRequestMethodPost
func (*ConnectorsDraftsRequestBuilder) WithId ¶
func (rb *ConnectorsDraftsRequestBuilder) WithId(id string) *ConnectorsDraftsByIDRequestBuilder
func (*ConnectorsDraftsRequestBuilder) WithKey ¶
func (rb *ConnectorsDraftsRequestBuilder) WithKey(key string) *ConnectorsDraftsKeyByKeyRequestBuilder
type ConnectorsDraftsRequestMethodGet ¶
type ConnectorsDraftsRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ConnectorsDraftsRequestMethodGet) Dump ¶
func (r *ConnectorsDraftsRequestMethodGet) Dump() map[string]interface{}
func (*ConnectorsDraftsRequestMethodGet) Execute ¶
func (rb *ConnectorsDraftsRequestMethodGet) Execute(ctx context.Context) (result *ConnectorStagedPagedQueryResponse, err error)
func (*ConnectorsDraftsRequestMethodGet) IntegrationTypes ¶ added in v1.5.0
func (rb *ConnectorsDraftsRequestMethodGet) IntegrationTypes(v []IntegrationType) *ConnectorsDraftsRequestMethodGet
func (*ConnectorsDraftsRequestMethodGet) Limit ¶
func (rb *ConnectorsDraftsRequestMethodGet) Limit(v int) *ConnectorsDraftsRequestMethodGet
func (*ConnectorsDraftsRequestMethodGet) Offset ¶
func (rb *ConnectorsDraftsRequestMethodGet) Offset(v int) *ConnectorsDraftsRequestMethodGet
func (*ConnectorsDraftsRequestMethodGet) Sort ¶
func (rb *ConnectorsDraftsRequestMethodGet) Sort(v []string) *ConnectorsDraftsRequestMethodGet
func (*ConnectorsDraftsRequestMethodGet) WithHeaders ¶
func (rb *ConnectorsDraftsRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsDraftsRequestMethodGet
func (*ConnectorsDraftsRequestMethodGet) WithQueryParams ¶
func (rb *ConnectorsDraftsRequestMethodGet) WithQueryParams(input ConnectorsDraftsRequestMethodGetInput) *ConnectorsDraftsRequestMethodGet
type ConnectorsDraftsRequestMethodGetInput ¶
type ConnectorsDraftsRequestMethodGetInput struct { IntegrationTypes []IntegrationType Limit *int Offset *int Sort []string }
func (*ConnectorsDraftsRequestMethodGetInput) Values ¶
func (input *ConnectorsDraftsRequestMethodGetInput) Values() url.Values
type ConnectorsDraftsRequestMethodPost ¶
type ConnectorsDraftsRequestMethodPost struct {
// contains filtered or unexported fields
}
func (*ConnectorsDraftsRequestMethodPost) Dump ¶
func (r *ConnectorsDraftsRequestMethodPost) Dump() map[string]interface{}
func (*ConnectorsDraftsRequestMethodPost) Execute ¶
func (rb *ConnectorsDraftsRequestMethodPost) Execute(ctx context.Context) (result *ConnectorStaged, err error)
func (*ConnectorsDraftsRequestMethodPost) WithHeaders ¶
func (rb *ConnectorsDraftsRequestMethodPost) WithHeaders(headers http.Header) *ConnectorsDraftsRequestMethodPost
type ConnectorsKeyByKeyRequestBuilder ¶
type ConnectorsKeyByKeyRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ConnectorsKeyByKeyRequestBuilder) Get ¶
func (rb *ConnectorsKeyByKeyRequestBuilder) Get() *ConnectorsKeyByKeyRequestMethodGet
type ConnectorsKeyByKeyRequestMethodGet ¶
type ConnectorsKeyByKeyRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ConnectorsKeyByKeyRequestMethodGet) Dump ¶
func (r *ConnectorsKeyByKeyRequestMethodGet) Dump() map[string]interface{}
func (*ConnectorsKeyByKeyRequestMethodGet) Execute ¶
func (rb *ConnectorsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Connector, err error)
func (*ConnectorsKeyByKeyRequestMethodGet) WithHeaders ¶
func (rb *ConnectorsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsKeyByKeyRequestMethodGet
type ConnectorsRequestBuilder ¶
type ConnectorsRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ConnectorsRequestBuilder) Drafts ¶
func (rb *ConnectorsRequestBuilder) Drafts() *ConnectorsDraftsRequestBuilder
func (*ConnectorsRequestBuilder) Search ¶
func (rb *ConnectorsRequestBuilder) Search() *ConnectorsSearchRequestBuilder
func (*ConnectorsRequestBuilder) WithId ¶
func (rb *ConnectorsRequestBuilder) WithId(id string) *ConnectorsByIDRequestBuilder
func (*ConnectorsRequestBuilder) WithKey ¶
func (rb *ConnectorsRequestBuilder) WithKey(key string) *ConnectorsKeyByKeyRequestBuilder
type ConnectorsSearchRequestBuilder ¶
type ConnectorsSearchRequestBuilder struct {
// contains filtered or unexported fields
}
func (*ConnectorsSearchRequestBuilder) Get ¶
func (rb *ConnectorsSearchRequestBuilder) Get() *ConnectorsSearchRequestMethodGet
* * Retrieves all available Connectors.
type ConnectorsSearchRequestMethodGet ¶
type ConnectorsSearchRequestMethodGet struct {
// contains filtered or unexported fields
}
func (*ConnectorsSearchRequestMethodGet) CreatorCompany ¶
func (rb *ConnectorsSearchRequestMethodGet) CreatorCompany(v string) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) Dump ¶
func (r *ConnectorsSearchRequestMethodGet) Dump() map[string]interface{}
func (*ConnectorsSearchRequestMethodGet) Execute ¶
func (rb *ConnectorsSearchRequestMethodGet) Execute(ctx context.Context) (result *ConnectorSearchPagedQueryResponse, err error)
* * Retrieves all available Connectors.
func (*ConnectorsSearchRequestMethodGet) ID ¶
func (rb *ConnectorsSearchRequestMethodGet) ID(v []string) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) IntegrationTypes ¶ added in v1.5.0
func (rb *ConnectorsSearchRequestMethodGet) IntegrationTypes(v []IntegrationType) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) Key ¶
func (rb *ConnectorsSearchRequestMethodGet) Key(v []string) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) Limit ¶
func (rb *ConnectorsSearchRequestMethodGet) Limit(v int) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) Offset ¶
func (rb *ConnectorsSearchRequestMethodGet) Offset(v int) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) Private ¶
func (rb *ConnectorsSearchRequestMethodGet) Private(v bool) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) Sort ¶
func (rb *ConnectorsSearchRequestMethodGet) Sort(v []string) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) Text ¶
func (rb *ConnectorsSearchRequestMethodGet) Text(v string) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) WithHeaders ¶
func (rb *ConnectorsSearchRequestMethodGet) WithHeaders(headers http.Header) *ConnectorsSearchRequestMethodGet
func (*ConnectorsSearchRequestMethodGet) WithQueryParams ¶
func (rb *ConnectorsSearchRequestMethodGet) WithQueryParams(input ConnectorsSearchRequestMethodGetInput) *ConnectorsSearchRequestMethodGet
type ConnectorsSearchRequestMethodGetInput ¶
type ConnectorsSearchRequestMethodGetInput struct { Text *string Limit *int Offset *int Sort []string Private *bool CreatorCompany *string ID []string Key []string IntegrationTypes []IntegrationType }
func (*ConnectorsSearchRequestMethodGetInput) Values ¶
func (input *ConnectorsSearchRequestMethodGetInput) Values() url.Values
type Creator ¶
type Creator struct { // Name of the person who owns the Connector. Name *string `json:"name,omitempty"` // Title of the person who owns the Connector. Title *string `json:"title,omitempty"` // Contact email address of the creator. Email string `json:"email"` // Name of the company that owns the Connector. Company *string `json:"company,omitempty"` // URL to a logo image used to represent the creator. LogoUrl *string `json:"logoUrl,omitempty"` // Number of contributors currently working for the company. NoOfContributors *int `json:"noOfContributors,omitempty"` // URL to the support website of the Connector. SupportUrl *string `json:"supportUrl,omitempty"` }
* * Details of the individual or organization who developed the Connector. *
type Date ¶
Date holds date information for Commercetools API format
func (*Date) MarshalJSON ¶
MarshalJSON marshals into the commercetools date format
func (*Date) UnmarshalJSON ¶
UnmarshalJSON decodes JSON data into a Date struct
type DecodeStruct ¶
type Deployment ¶
type Deployment struct { // Unique identifier of the Deployment. ID string `json:"id"` // User-defined unique identifier of the Deployment. Key *string `json:"key,omitempty"` // Current version of the Deployment. Version int `json:"version"` // Details of the [Connector](ctp:connect:type:Connector) being deployed. Connector DeploymentConnector `json:"connector"` // Build reference id and outcome of the Deployment. Details DeploymentDetails `json:"details"` // Region of the Deployment. DeployedRegion string `json:"deployedRegion"` // Application deployments needed by the connector for hosting and configuration, refer to Connector configurations for details. Applications []ApplicationDeployment `json:"applications"` // If `true`, the Deployment is a preview. Preview bool `json:"preview"` // The current status of the Deployment. Status string `json:"status"` }
type DeploymentApplicationDoNotBelongError ¶ added in v1.5.0
type DeploymentApplicationDoNotBelongError struct { // `"Deployment with id=$resourceId or key=$resourceKey does not include application: $applicationName"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when attempting to add an application that does not belong to the Deployment. *
func (*DeploymentApplicationDoNotBelongError) DecodeStruct ¶ added in v1.5.0
func (obj *DeploymentApplicationDoNotBelongError) DecodeStruct(src map[string]interface{}) error
func (DeploymentApplicationDoNotBelongError) Error ¶ added in v1.5.0
func (obj DeploymentApplicationDoNotBelongError) Error() string
func (DeploymentApplicationDoNotBelongError) MarshalJSON ¶ added in v1.5.0
func (obj DeploymentApplicationDoNotBelongError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*DeploymentApplicationDoNotBelongError) UnmarshalJSON ¶ added in v1.5.0
func (obj *DeploymentApplicationDoNotBelongError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type DeploymentApplicationRequiredError ¶ added in v1.5.0
type DeploymentApplicationRequiredError struct { // `"A Deployment requires at least one application"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when a Deployment does not contain any applications. *
func (*DeploymentApplicationRequiredError) DecodeStruct ¶ added in v1.5.0
func (obj *DeploymentApplicationRequiredError) DecodeStruct(src map[string]interface{}) error
func (DeploymentApplicationRequiredError) Error ¶ added in v1.5.0
func (obj DeploymentApplicationRequiredError) Error() string
func (DeploymentApplicationRequiredError) MarshalJSON ¶ added in v1.5.0
func (obj DeploymentApplicationRequiredError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*DeploymentApplicationRequiredError) UnmarshalJSON ¶ added in v1.5.0
func (obj *DeploymentApplicationRequiredError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type DeploymentConfigurationApplication ¶
type DeploymentConfigurationApplication struct { // Name of the application. Should match the value of `name` within the connect.yaml file of the Connect application. ApplicationName string `json:"applicationName"` // Contains values of keys that are saved in plain text. Can be accessed after being set. StandardConfiguration []ConfigurationValue `json:"standardConfiguration"` // Contains values of secret keys. Cannot be accessed after being set. SecuredConfiguration []ConfigurationValue `json:"securedConfiguration"` }
* * Describes the configuration set of a given application. *
type DeploymentConnector ¶
type DeploymentConnector struct { // `id` of the Connector. ID string `json:"id"` // User-defined unique identifier of the Connector. Key *string `json:"key,omitempty"` // Version of the Connector. Version int `json:"version"` // Name of the Connector. Name string `json:"name"` // Description of the Connector. Description *string `json:"description,omitempty"` // Connector integration type list. IntegrationTypes []IntegrationType `json:"integrationTypes"` // Owner of the Connector. Creator DeploymentCreator `json:"creator"` // Details of the GitHub repository that contains the Connect applications. Repository Repository `json:"repository"` // If `true`, the Connector is certified. Certified bool `json:"certified"` }
* * The details of the deployed Connector(ctp:connect:type:Connector).
type DeploymentConnectorUpdateFailureError ¶ added in v1.5.0
type DeploymentConnectorUpdateFailureError struct { // `"Deployment with id=$resourceId or key=$resourceKey failed while trying to update Connector id=$resourceId or key=$resourceKey (cause: $cause)"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when updating a Connector fails during [redeployment](ctp:connect:type:DeploymentRedeploy). *
func (*DeploymentConnectorUpdateFailureError) DecodeStruct ¶ added in v1.5.0
func (obj *DeploymentConnectorUpdateFailureError) DecodeStruct(src map[string]interface{}) error
func (DeploymentConnectorUpdateFailureError) Error ¶ added in v1.5.0
func (obj DeploymentConnectorUpdateFailureError) Error() string
func (DeploymentConnectorUpdateFailureError) MarshalJSON ¶ added in v1.5.0
func (obj DeploymentConnectorUpdateFailureError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*DeploymentConnectorUpdateFailureError) UnmarshalJSON ¶ added in v1.5.0
func (obj *DeploymentConnectorUpdateFailureError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type DeploymentCreator ¶ added in v1.4.0
type DeploymentCreator struct { // Name of the person who owns the Connector. Name *string `json:"name,omitempty"` // Title of the person who owns the Connector. Title *string `json:"title,omitempty"` // Contact email address of the creator. Email string `json:"email"` // Name of the company that owns the Connector. Company *string `json:"company,omitempty"` // Number of contributors currently working for the company. NoOfContributors *int `json:"noOfContributors,omitempty"` }
* * The details of the deployed DeploymentConnector(ctp:connect:type:DeploymentConnector) creator.
type DeploymentDetails ¶
type DeploymentDetails struct { // The build details of deployed applications. Build DeploymentDetailsBuild `json:"build"` }
* * Additional details about the deployed Connector.
type DeploymentDetailsBuild ¶
type DeploymentDetailsBuild struct { // The build execution id of the deployed application. ID string `json:"id"` // The build report of the deployed Connector. Report *DeploymentReport `json:"report,omitempty"` }
type DeploymentDraft ¶
type DeploymentDraft struct { // User-defined unique identifier for the Deployment. Key *string `json:"key,omitempty"` // Reference to the [Connector](ctp:connect:type:Connector) being deployed. Connector ConnectorReference `json:"connector"` // Configuration values needed by the [Connector](ctp:connect:type:Connector) for hosting. Keys should match those in the Connector's `configurations` field. Configurations []DeploymentConfigurationApplication `json:"configurations"` // Region of Deployment. Region string `json:"region"` }
func (DeploymentDraft) MarshalJSON ¶
func (obj DeploymentDraft) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type DeploymentInvalidStatusTransitionError ¶
type DeploymentInvalidStatusTransitionError struct { // `"Invalid status change\: Already deploying"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the Deployment operation results in a invalid status transition. * * The error is returned as a failed response to the [Redeploy](ctp:connect:type:DeploymentRedeploy) update action. * * The message will contain `Already queued`, `Already deploying`, or `Already undeploying` based on the DeploymentStatus(ctp:connect:type:DeploymentStatus) of the Deployment. *
func (*DeploymentInvalidStatusTransitionError) DecodeStruct ¶
func (obj *DeploymentInvalidStatusTransitionError) DecodeStruct(src map[string]interface{}) error
func (DeploymentInvalidStatusTransitionError) Error ¶
func (obj DeploymentInvalidStatusTransitionError) Error() string
func (DeploymentInvalidStatusTransitionError) MarshalJSON ¶
func (obj DeploymentInvalidStatusTransitionError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*DeploymentInvalidStatusTransitionError) UnmarshalJSON ¶
func (obj *DeploymentInvalidStatusTransitionError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type DeploymentLog ¶
type DeploymentLog struct { Type string `json:"type"` // Unique identifier of the [Deployment](ctp:connect:type:Deployment). DeploymentId string `json:"deploymentId"` // Name of the Connect application. ApplicationName string `json:"applicationName"` // Severity of the log message. Severity string `json:"severity"` // Timestamp of the log message. Timestamp time.Time `json:"timestamp"` // Event details of the log message. Details interface{} `json:"details"` }
* * The data representation of a Deployment log. *
type DeploymentLogCursorPagedQueryResponse ¶ added in v1.4.0
type DeploymentLogCursorPagedQueryResponse struct { // Array of DeploymentLog objects. Data []DeploymentLog `json:"data"` // The next page token. Next string `json:"next"` }
* * A cursor paged query result containing an array of DeploymentLog(ctp:connect:type:DeploymentLog). *
type DeploymentLogSeverity ¶ added in v1.4.0
type DeploymentLogSeverity string
* * The severity of the log message.
const ( DeploymentLogSeverityDEFAULT DeploymentLogSeverity = "DEFAULT" DeploymentLogSeverityDEBUG DeploymentLogSeverity = "DEBUG" DeploymentLogSeverityINFO DeploymentLogSeverity = "INFO" DeploymentLogSeverityNOTICE DeploymentLogSeverity = "NOTICE" DeploymentLogSeverityWARNING DeploymentLogSeverity = "WARNING" DeploymentLogSeverityERROR DeploymentLogSeverity = "ERROR" DeploymentLogSeverityCRITICAL DeploymentLogSeverity = "CRITICAL" DeploymentLogSeverityALERT DeploymentLogSeverity = "ALERT" DeploymentLogSeverityEMERGENCY DeploymentLogSeverity = "EMERGENCY" )
type DeploymentMustIncludeApplicationError ¶ added in v1.5.0
type DeploymentMustIncludeApplicationError struct { // `"Deployment with id=$resourceId or key=$resourceKey must include application: $applicationName"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when attempting to remove an application that belongs to the Deployment. *
func (*DeploymentMustIncludeApplicationError) DecodeStruct ¶ added in v1.5.0
func (obj *DeploymentMustIncludeApplicationError) DecodeStruct(src map[string]interface{}) error
func (DeploymentMustIncludeApplicationError) Error ¶ added in v1.5.0
func (obj DeploymentMustIncludeApplicationError) Error() string
func (DeploymentMustIncludeApplicationError) MarshalJSON ¶ added in v1.5.0
func (obj DeploymentMustIncludeApplicationError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*DeploymentMustIncludeApplicationError) UnmarshalJSON ¶ added in v1.5.0
func (obj *DeploymentMustIncludeApplicationError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type DeploymentPagedQueryResponse ¶ added in v1.4.0
type DeploymentPagedQueryResponse struct { // The limit of the Deployments returned. Limit int `json:"limit"` // The offset of the Deployments returned. Offset int `json:"offset"` // The number of Deployments returned. Count int `json:"count"` // The total number of Deployments available. Total int `json:"total"` // Deployments matching the query. Results []Deployment `json:"results"` }
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of Deployment(ctp:connect:type:Deployment). *
type DeploymentRedeployAction ¶
type DeploymentRedeployAction struct { // Whether the scripts execution should be skipped during redeployment. SkipScripts *bool `json:"skipScripts,omitempty"` // New configuration values for Deployment. If empty, any existing value is unchanged. ConfigurationValues []DeploymentConfigurationApplication `json:"configurationValues"` // Whether the Deployment Connector should be updated to its latest state during redeployment. UpdateConnector *bool `json:"updateConnector,omitempty"` }
* * Updates configuration values and redeploys a Deployment in `Draft`, `Deployed`, `Failed`, or `UndeployFailed` states. The new configuration values must include at least one valid application. Ensure that all deployment configuration keys and values match those specified in the application's `connect.yaml` file. * * Specific error codes: * - [DeploymentUnknownApplicationConfiguration](ctp:connect:type:DeploymentUnknownApplicationConfigurationError) * - [DeploymentUnknownApplicationConfigurationKey](ctp:connect:type:DeploymentUnknownApplicationConfigurationKeyError) * - [DeploymentInvalidStatusTransition](ctp:connect:type:DeploymentInvalidStatusTransitionError) * - [DeploymentApplicationDoNotBelong](ctp:connect:type:DeploymentApplicationDoNotBelongError) * - [DeploymentMustIncludeApplication](ctp:connect:type:DeploymentMustIncludeApplicationError) * - [DeploymentConnectorUpdateFailure](ctp:connect:type:DeploymentConnectorUpdateFailureError) *
func (DeploymentRedeployAction) MarshalJSON ¶
func (obj DeploymentRedeployAction) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
type DeploymentReport ¶ added in v1.4.0
type DeploymentReport struct { // Contains informations, errors and warnings about the Connector deployment. Entries []DeploymentReportEntry `json:"entries"` }
* * Describes a report of the Connector deployment process.
type DeploymentReportEntry ¶ added in v1.4.0
type DeploymentReportEntry struct { // The report entry type. Type DeploymentReportEntryType `json:"type"` // The title of the report entry. Title string `json:"title"` // The message related to the report entry. Message *string `json:"message,omitempty"` // The name of the Connect application related to the entry. Application *string `json:"application,omitempty"` // When the report entry was created. CreatedAt time.Time `json:"createdAt"` }
* * Describes an information, error, or warning in the deployment report.
type DeploymentReportEntryType ¶ added in v1.4.0
type DeploymentReportEntryType string
* * The type of message being reported. *
const ( DeploymentReportEntryTypeInformation DeploymentReportEntryType = "Information" DeploymentReportEntryTypeWarning DeploymentReportEntryType = "Warning" DeploymentReportEntryTypeError DeploymentReportEntryType = "Error" )
type DeploymentStatus ¶
type DeploymentStatus string
* * Indicates the current status of the Deployment. *
const ( DeploymentStatusDraft DeploymentStatus = "Draft" DeploymentStatusQueued DeploymentStatus = "Queued" DeploymentStatusDeploying DeploymentStatus = "Deploying" DeploymentStatusDeployed DeploymentStatus = "Deployed" DeploymentStatusFailed DeploymentStatus = "Failed" DeploymentStatusUndeploying DeploymentStatus = "Undeploying" DeploymentStatusUndeployFailed DeploymentStatus = "UndeployFailed" )
type DeploymentUnknownApplicationConfigurationError ¶
type DeploymentUnknownApplicationConfigurationError struct { // `"Deployment does not require configuration for application named '$unknownApplicationName'."` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the Deployment contains configuration values that are not defined in the Connect application's connect.yaml file. * * The error is returned as a failed response to the [Redeploy](ctp:connect:type:DeploymentRedeploy) update action and [Create a Deployment](ctp:connect:endpoint:/{projectKey}/deployments:POST) request. *
func (*DeploymentUnknownApplicationConfigurationError) DecodeStruct ¶
func (obj *DeploymentUnknownApplicationConfigurationError) DecodeStruct(src map[string]interface{}) error
func (DeploymentUnknownApplicationConfigurationError) Error ¶
func (obj DeploymentUnknownApplicationConfigurationError) Error() string
func (DeploymentUnknownApplicationConfigurationError) MarshalJSON ¶
func (obj DeploymentUnknownApplicationConfigurationError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*DeploymentUnknownApplicationConfigurationError) UnmarshalJSON ¶
func (obj *DeploymentUnknownApplicationConfigurationError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type DeploymentUnknownApplicationConfigurationKeyError ¶
type DeploymentUnknownApplicationConfigurationKeyError struct { // `"Deployment does not require (secret|standard) configuration with key $configurationKey for application named $applicationName."` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the Deployment contains a configuration key that is not defined in the Connect application's connect.yaml file. * * The error is returned as a failed response to the [Redeploy](ctp:connect:type:DeploymentRedeploy) update action and [Create a Deployment](ctp:connect:endpoint:/{projectKey}/deployments:POST) request. *
func (*DeploymentUnknownApplicationConfigurationKeyError) DecodeStruct ¶
func (obj *DeploymentUnknownApplicationConfigurationKeyError) DecodeStruct(src map[string]interface{}) error
func (DeploymentUnknownApplicationConfigurationKeyError) Error ¶
func (obj DeploymentUnknownApplicationConfigurationKeyError) Error() string
func (DeploymentUnknownApplicationConfigurationKeyError) MarshalJSON ¶
func (obj DeploymentUnknownApplicationConfigurationKeyError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*DeploymentUnknownApplicationConfigurationKeyError) UnmarshalJSON ¶
func (obj *DeploymentUnknownApplicationConfigurationKeyError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type DeploymentUnsupportedRegionError ¶
type DeploymentUnsupportedRegionError struct { // `"Deployment unsupported region $region"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the Deployment region is not supported. * * The error is returned as a failed response to the [Create a Deployment](ctp:connect:endpoint:/{projectKey}/deployments:POST) request. *
func (*DeploymentUnsupportedRegionError) DecodeStruct ¶
func (obj *DeploymentUnsupportedRegionError) DecodeStruct(src map[string]interface{}) error
func (DeploymentUnsupportedRegionError) Error ¶
func (obj DeploymentUnsupportedRegionError) Error() string
func (DeploymentUnsupportedRegionError) MarshalJSON ¶
func (obj DeploymentUnsupportedRegionError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*DeploymentUnsupportedRegionError) UnmarshalJSON ¶
func (obj *DeploymentUnsupportedRegionError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type DeploymentUpdate ¶
type DeploymentUpdate struct { // Expected version of the Deployment on which the changes apply. Version int `json:"version"` // Update actions to be performed on the Deployment. Actions []DeploymentUpdateAction `json:"actions"` }
func (*DeploymentUpdate) UnmarshalJSON ¶
func (obj *DeploymentUpdate) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type DeploymentUpdateAction ¶
type DeploymentUpdateAction interface{}
type DuplicateFieldError ¶
type DuplicateFieldError struct { // `"A duplicate value $duplicateValue exists for field $field."` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` // Name of the conflicting field. Field string `json:"field"` // Conflicting duplicate value. DuplicateValue interface{} `json:"duplicateValue"` }
* * Returned when a field value conflicts with an existing value causing a duplicate. *
func (*DuplicateFieldError) DecodeStruct ¶
func (obj *DuplicateFieldError) DecodeStruct(src map[string]interface{}) error
func (DuplicateFieldError) Error ¶
func (obj DuplicateFieldError) Error() string
func (DuplicateFieldError) MarshalJSON ¶
func (obj DuplicateFieldError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*DuplicateFieldError) UnmarshalJSON ¶
func (obj *DuplicateFieldError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type ErrorObject ¶
type ErrorObject interface{}
* * Represents a single error. Multiple errors may be included in an ErrorResponse(ctp:connect:type:ErrorResponse).
type ErrorResponse ¶
type ErrorResponse struct { // HTTP status code corresponding to the error. StatusCode int `json:"statusCode"` // First error message in the `errors` array. Message string `json:"message"` // Errors returned for a request. // // A single error response can contain multiple errors if the errors are related to the same HTTP status code such as `400`. Errors []ErrorObject `json:"errors"` }
* * Base representation of an error response containing common fields to all errors. *
func (ErrorResponse) Error ¶
func (obj ErrorResponse) Error() string
func (ErrorResponse) MarshalJSON ¶
func (obj ErrorResponse) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ErrorResponse) UnmarshalJSON ¶
func (obj *ErrorResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type FieldValueNotFoundError ¶ added in v1.4.0
type FieldValueNotFoundError struct { // `"The value $value for the $field field was not found"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` // Name of the field. Field string `json:"field"` // Conflicting value. Value interface{} `json:"value"` }
* * Returned when a value for a field is not found. *
func (*FieldValueNotFoundError) DecodeStruct ¶ added in v1.4.0
func (obj *FieldValueNotFoundError) DecodeStruct(src map[string]interface{}) error
func (FieldValueNotFoundError) Error ¶ added in v1.4.0
func (obj FieldValueNotFoundError) Error() string
func (FieldValueNotFoundError) MarshalJSON ¶ added in v1.4.0
func (obj FieldValueNotFoundError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*FieldValueNotFoundError) UnmarshalJSON ¶ added in v1.4.0
func (obj *FieldValueNotFoundError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type GeneralError ¶
type GeneralError struct { // Description about any known details of the problem, for example, `"Write operations are temporarily unavailable"`. Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when a server-side problem occurs before or after data persistence. In some cases, the requested action may successfully complete after the error is returned. Therefore, it is recommended to verify the status of the requested resource after receiving a 500 error. * * If you encounter this error, report it using the [Support Portal](https://commercetools.atlassian.net/servicedesk/customer/portal/27). *
func (*GeneralError) DecodeStruct ¶
func (obj *GeneralError) DecodeStruct(src map[string]interface{}) error
func (GeneralError) Error ¶
func (obj GeneralError) Error() string
func (GeneralError) MarshalJSON ¶
func (obj GeneralError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*GeneralError) UnmarshalJSON ¶
func (obj *GeneralError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type GenericRequestError ¶
func (GenericRequestError) Error ¶
func (e GenericRequestError) Error() string
type GitRepositoryNotReachableError ¶ added in v1.4.0
type GitRepositoryNotReachableError struct { // `"Repository with the tag is not reachable"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the GitHub repository is unreachable or not found. *
func (*GitRepositoryNotReachableError) DecodeStruct ¶ added in v1.4.0
func (obj *GitRepositoryNotReachableError) DecodeStruct(src map[string]interface{}) error
func (GitRepositoryNotReachableError) Error ¶ added in v1.4.0
func (obj GitRepositoryNotReachableError) Error() string
func (GitRepositoryNotReachableError) MarshalJSON ¶ added in v1.4.0
func (obj GitRepositoryNotReachableError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*GitRepositoryNotReachableError) UnmarshalJSON ¶ added in v1.4.0
func (obj *GitRepositoryNotReachableError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type IntegrationType ¶ added in v1.5.0
type IntegrationType string
* * The type of integration provided by a Connector. *
const ( IntegrationTypeTax IntegrationType = "tax" IntegrationTypeMarketplace IntegrationType = "marketplace" IntegrationTypeOms IntegrationType = "oms" IntegrationTypePsp IntegrationType = "psp" IntegrationTypePim IntegrationType = "pim" IntegrationTypePromotion IntegrationType = "promotion" IntegrationTypeSearch IntegrationType = "search" IntegrationTypeErp IntegrationType = "erp" IntegrationTypeCrm IntegrationType = "crm" IntegrationTypeEmail IntegrationType = "email" IntegrationTypeAnalytics IntegrationType = "analytics" IntegrationTypeShipping IntegrationType = "shipping" IntegrationTypeOther IntegrationType = "other" )
type InvalidJsonInputError ¶
type InvalidJsonInputError struct { // `"Request body does not contain valid JSON."` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` // Further explanation about why the JSON is invalid. DetailedErrorMessage string `json:"detailedErrorMessage"` }
* * Returned when an invalid JSON input has been sent. * Either the JSON is syntactically incorrect or does not conform to the expected shape (for example is missing a required field). * * The client application should validate the input according to the constraints described in the error message before sending the request. *
func (*InvalidJsonInputError) DecodeStruct ¶
func (obj *InvalidJsonInputError) DecodeStruct(src map[string]interface{}) error
func (InvalidJsonInputError) Error ¶
func (obj InvalidJsonInputError) Error() string
func (InvalidJsonInputError) MarshalJSON ¶
func (obj InvalidJsonInputError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*InvalidJsonInputError) UnmarshalJSON ¶
func (obj *InvalidJsonInputError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type InvalidPathParamError ¶
type InvalidPathParamError struct { // `"Request path param is not valid"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` // Further explanation about why the path parameter is invalid. DetailedErrorMessage string `json:"detailedErrorMessage"` }
* * Returned when an invalid path parameter has been sent. *
func (*InvalidPathParamError) DecodeStruct ¶
func (obj *InvalidPathParamError) DecodeStruct(src map[string]interface{}) error
func (InvalidPathParamError) Error ¶
func (obj InvalidPathParamError) Error() string
func (InvalidPathParamError) MarshalJSON ¶
func (obj InvalidPathParamError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*InvalidPathParamError) UnmarshalJSON ¶
func (obj *InvalidPathParamError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type InvalidQueryParamError ¶
type InvalidQueryParamError struct { // `"Request query param is not valid"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` // Further explanation about why the query parameter is invalid. DetailedErrorMessage string `json:"detailedErrorMessage"` }
* * Returned when an invalid query parameter has been sent. *
func (*InvalidQueryParamError) DecodeStruct ¶
func (obj *InvalidQueryParamError) DecodeStruct(src map[string]interface{}) error
func (InvalidQueryParamError) Error ¶
func (obj InvalidQueryParamError) Error() string
func (InvalidQueryParamError) MarshalJSON ¶
func (obj InvalidQueryParamError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*InvalidQueryParamError) UnmarshalJSON ¶
func (obj *InvalidQueryParamError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type IsPreviewable ¶
type IsPreviewable string
* * The previewable status of the ConnectorStaged. *
const ( IsPreviewableTrue IsPreviewable = "true" IsPreviewableFalse IsPreviewable = "false" IsPreviewablePending IsPreviewable = "pending" IsPreviewableNone IsPreviewable = "none" )
type Region ¶
type Region string
* * The host Region of a commercetools Composable Commerce Project. For more information, see [Hosts](hosts-and-authorization#hosts). *
type Repository ¶
type Repository struct { // HTTPS or SSH GitHub URL of the GitHub repository. Private repositories must use an SSH URL. Url string `json:"url"` // Git tag of the release to use. Tag string `json:"tag"` }
* * Details of the GitHub repository that contains the Connect applications. *
type ResourceNotFoundError ¶
type ResourceNotFoundError struct { // `"Deployment with id=$resourceId or key=$resourceKey does not exist"` Message string `json:"message"` // Error-specific additional fields. ExtraValues map[string]interface{} `json:"-"` }
* * Returned when the resource addressed by the request URL does not exist. *
func (*ResourceNotFoundError) DecodeStruct ¶
func (obj *ResourceNotFoundError) DecodeStruct(src map[string]interface{}) error
func (ResourceNotFoundError) Error ¶
func (obj ResourceNotFoundError) Error() string
func (ResourceNotFoundError) MarshalJSON ¶
func (obj ResourceNotFoundError) MarshalJSON() ([]byte, error)
MarshalJSON override to set the discriminator value or remove optional nil slices
func (*ResourceNotFoundError) UnmarshalJSON ¶
func (obj *ResourceNotFoundError) UnmarshalJSON(data []byte) error
UnmarshalJSON override to deserialize correct attribute types based on the discriminator value
type SetUserAgentTransport ¶
type SetUserAgentTransport struct { T http.RoundTripper // contains filtered or unexported fields }
Source Files ¶
- client.go
- client_api_root.go
- client_by_project_key.go
- client_connectors_connectors.go
- client_connectors_connectors_by_id.go
- client_connectors_connectors_by_id_get.go
- client_connectors_connectors_key_by_key.go
- client_connectors_connectors_key_by_key_get.go
- client_deployments_by_project_key_deployments.go
- client_deployments_by_project_key_deployments_by_id.go
- client_deployments_by_project_key_deployments_by_id_delete.go
- client_deployments_by_project_key_deployments_by_id_get.go
- client_deployments_by_project_key_deployments_by_id_post.go
- client_deployments_by_project_key_deployments_get.go
- client_deployments_by_project_key_deployments_key_by_key.go
- client_deployments_by_project_key_deployments_key_by_key_delete.go
- client_deployments_by_project_key_deployments_key_by_key_get.go
- client_deployments_by_project_key_deployments_key_by_key_post.go
- client_deployments_by_project_key_deployments_post.go
- client_drafts_connectors_drafts.go
- client_drafts_connectors_drafts_by_id.go
- client_drafts_connectors_drafts_by_id_get.go
- client_drafts_connectors_drafts_by_id_post.go
- client_drafts_connectors_drafts_get.go
- client_drafts_connectors_drafts_key_by_key.go
- client_drafts_connectors_drafts_key_by_key_get.go
- client_drafts_connectors_drafts_key_by_key_post.go
- client_drafts_connectors_drafts_post.go
- client_logs_by_project_key_deployments_by_id_logs.go
- client_logs_by_project_key_deployments_by_id_logs_get.go
- client_logs_by_project_key_deployments_key_by_key_logs.go
- client_logs_by_project_key_deployments_key_by_key_logs_get.go
- client_search_connectors_search.go
- client_search_connectors_search_get.go
- date.go
- errors.go
- types_common.go
- types_connector.go
- types_deployment.go
- types_error.go
- utils.go