platform

package
v1.5.2 Latest Latest
Warning

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

 Go to latest Published: May 17, 2024 License: MIT Imports: 16 Imported by: 10

Documentation ¶

Index ¶

Constants ¶

View Source 
const Version = "1.5.0"

Version identifies the current library version. Should match the git tag

Variables ¶

View Source 
var ErrNotFound = errors.New("resource not found")

Functions ¶

func GetUserAgent ¶ 

func GetUserAgent() string

Types ¶

type AWSLambdaDestination ¶ 

type AWSLambdaDestination struct {
	// Amazon Resource Name (ARN) of the Lambda function in the format `arn:aws:lambda:<region>:<accountid>:function:<functionName>`. Use the format `arn:aws:lambda:<region>:<accountid>:function:<functionName>:<functionAlias/version>` to point to a specific version of the function.
	Arn string `json:"arn"`
	// Partially hidden on retrieval for security reasons.
	AccessKey string `json:"accessKey"`
	// Partially hidden on retrieval for security reasons.
	AccessSecret string `json:"accessSecret"`
}

* * We recommend creating an Identify and Access Management (IAM) user with an `accessKey` and `accessSecret` pair, specifically for each Extension that only has the `lambda:InvokeFunction` permission on this function. *

func (AWSLambdaDestination) MarshalJSON ¶ 

func (obj AWSLambdaDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Address ¶ 

type Address struct {
	// Unique identifier of the Address.
	//
	// It is not recommended to set it manually since the API overwrites this ID when creating an Address for a [Customer](ctp:api:type:Customer).
	// Use `key` instead and omit this field from the request to let the API generate the ID for the Address.
	ID *string `json:"id,omitempty"`
	// User-defined identifier of the Address that must be unique when multiple addresses are referenced in [BusinessUnits](ctp:api:type:BusinessUnit), [Customers](ctp:api:type:Customer), and `itemShippingAddresses` (LineItem-specific addresses) of a [Cart](ctp:api:type:Cart), [Order](ctp:api:type:Order), [QuoteRequest](ctp:api:type:QuoteRequest), or [Quote](ctp:api:type:Quote).
	Key *string `json:"key,omitempty"`
	// Name of the country.
	Country string `json:"country"`
	// Title of the contact, for example 'Dr.'
	Title *string `json:"title,omitempty"`
	// Salutation of the contact, for example 'Mr.' or 'Ms.'
	Salutation *string `json:"salutation,omitempty"`
	// Given name (first name) of the contact.
	FirstName *string `json:"firstName,omitempty"`
	// Family name (last name) of the contact.
	LastName *string `json:"lastName,omitempty"`
	// Name of the street.
	StreetName *string `json:"streetName,omitempty"`
	// Street number.
	StreetNumber *string `json:"streetNumber,omitempty"`
	// Further information on the street address.
	AdditionalStreetInfo *string `json:"additionalStreetInfo,omitempty"`
	// Postal code.
	PostalCode *string `json:"postalCode,omitempty"`
	// Name of the city.
	City *string `json:"city,omitempty"`
	// Name of the region.
	Region *string `json:"region,omitempty"`
	// Name of the state, for example, Colorado.
	State *string `json:"state,omitempty"`
	// Name of the company.
	Company *string `json:"company,omitempty"`
	// Name of the department.
	Department *string `json:"department,omitempty"`
	// Number or name of the building.
	Building *string `json:"building,omitempty"`
	// Number or name of the apartment.
	Apartment *string `json:"apartment,omitempty"`
	// Post office box number.
	POBox *string `json:"pOBox,omitempty"`
	// Phone number of the contact.
	Phone *string `json:"phone,omitempty"`
	// Mobile phone number of the contact.
	Mobile *string `json:"mobile,omitempty"`
	// Email address of the contact.
	Email *string `json:"email,omitempty"`
	// Fax number of the contact.
	Fax *string `json:"fax,omitempty"`
	// Further information on the Address.
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`
	// ID for the contact used in an external system.
	ExternalId *string `json:"externalId,omitempty"`
	// Custom Fields defined for the Address.
	Custom *CustomFields `json:"custom,omitempty"`
}

* * Address type returned by read methods. * Optionally, the `custom` field can be present in addition to the fields of a BaseAddress(ctp:api:type:BaseAddress). *

type AddressDraft ¶ 

type AddressDraft struct {
	// Unique identifier of the Address.
	//
	// It is not recommended to set it manually since the API overwrites this ID when creating an Address for a [Customer](ctp:api:type:Customer).
	// Use `key` instead and omit this field from the request to let the API generate the ID for the Address.
	ID *string `json:"id,omitempty"`
	// User-defined identifier of the Address that must be unique when multiple addresses are referenced in [BusinessUnits](ctp:api:type:BusinessUnit), [Customers](ctp:api:type:Customer), and `itemShippingAddresses` (LineItem-specific addresses) of a [Cart](ctp:api:type:Cart), [Order](ctp:api:type:Order), [QuoteRequest](ctp:api:type:QuoteRequest), or [Quote](ctp:api:type:Quote).
	Key *string `json:"key,omitempty"`
	// Name of the country.
	Country string `json:"country"`
	// Title of the contact, for example 'Dr.'
	Title *string `json:"title,omitempty"`
	// Salutation of the contact, for example 'Mr.' or 'Ms.'
	Salutation *string `json:"salutation,omitempty"`
	// Given name (first name) of the contact.
	FirstName *string `json:"firstName,omitempty"`
	// Family name (last name) of the contact.
	LastName *string `json:"lastName,omitempty"`
	// Name of the street.
	StreetName *string `json:"streetName,omitempty"`
	// Street number.
	StreetNumber *string `json:"streetNumber,omitempty"`
	// Further information on the street address.
	AdditionalStreetInfo *string `json:"additionalStreetInfo,omitempty"`
	// Postal code.
	PostalCode *string `json:"postalCode,omitempty"`
	// Name of the city.
	City *string `json:"city,omitempty"`
	// Name of the region.
	Region *string `json:"region,omitempty"`
	// Name of the state, for example, Colorado.
	State *string `json:"state,omitempty"`
	// Name of the company.
	Company *string `json:"company,omitempty"`
	// Name of the department.
	Department *string `json:"department,omitempty"`
	// Number or name of the building.
	Building *string `json:"building,omitempty"`
	// Number or name of the apartment.
	Apartment *string `json:"apartment,omitempty"`
	// Post office box number.
	POBox *string `json:"pOBox,omitempty"`
	// Phone number of the contact.
	Phone *string `json:"phone,omitempty"`
	// Mobile phone number of the contact.
	Mobile *string `json:"mobile,omitempty"`
	// Email address of the contact.
	Email *string `json:"email,omitempty"`
	// Fax number of the contact.
	Fax *string `json:"fax,omitempty"`
	// Further information on the Address.
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`
	// ID for the contact used in an external system.
	ExternalId *string `json:"externalId,omitempty"`
	// Custom Fields defined for the Address.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * Address type to be used on write methods. * Optionally, use the `custom` field in addition to the fields of a BaseAddress(ctp:api:type:BaseAddress). *

type AnonymousCartSignInMode ¶ 

type AnonymousCartSignInMode string
const (
	AnonymousCartSignInModeMergeWithExistingCustomerCart AnonymousCartSignInMode = "MergeWithExistingCustomerCart"
	AnonymousCartSignInModeUseAsNewActiveCustomerCart    AnonymousCartSignInMode = "UseAsNewActiveCustomerCart"
)

type AnonymousIdAlreadyInUseError ¶ 

type AnonymousIdAlreadyInUseError struct {
	// `"The given anonymous ID is already in use."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the anonymous ID is being used by another resource. * * The client application should choose another anonymous ID or retrieve an automatically generated one. *

func (*AnonymousIdAlreadyInUseError) DecodeStruct ¶ added in v1.1.0 

func (obj *AnonymousIdAlreadyInUseError) DecodeStruct(src map[string]interface{}) error

func (AnonymousIdAlreadyInUseError) Error ¶ 

func (obj AnonymousIdAlreadyInUseError) Error() string

func (AnonymousIdAlreadyInUseError) MarshalJSON ¶ 

func (obj AnonymousIdAlreadyInUseError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AnonymousIdAlreadyInUseError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *AnonymousIdAlreadyInUseError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApiClient ¶ 

type ApiClient struct {
	// The OAuth2 `client_id` that can be used to [obtain an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
	ID string `json:"id"`
	// Name of the APIClient.
	Name string `json:"name"`
	// Whitespace-separated list of [OAuth scopes](/../api/scopes) that can be used when [obtaining an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
	Scope string `json:"scope"`
	// Only shown once in the response of creating the APIClient.
	// This is the OAuth2 `client_secret` that can be used to [obtain an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
	Secret *string `json:"secret,omitempty"`
	// Date of the last day this APIClient was used to [obtain an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
	LastUsedAt *Date `json:"lastUsedAt,omitempty"`
	// If set, the Client will be deleted on (or shortly after) this point in time.
	DeleteAt *time.Time `json:"deleteAt,omitempty"`
	// Date and time (UTC) the APIClient was initially created at.
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the [APIClientDraft](ctp:api:type:ApiClientDraft). If not present the default value applies.
	AccessTokenValiditySeconds *int `json:"accessTokenValiditySeconds,omitempty"`
	// Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the [APIClientDraft](ctp:api:type:ApiClientDraft). If not present the default value applies.
	RefreshTokenValiditySeconds *int `json:"refreshTokenValiditySeconds,omitempty"`
}

type ApiClientDraft ¶ 

type ApiClientDraft struct {
	// Name of the APIClient.
	Name string `json:"name"`
	// Whitespace-separated list of [OAuth scopes](/../api/scopes) that can be used when [obtaining an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
	Scope string `json:"scope"`
	// If set, the Client will be deleted after the specified amount of days.
	DeleteDaysAfterCreation *int `json:"deleteDaysAfterCreation,omitempty"`
	// Expiration time in seconds for each access token obtained by the APIClient. If not set the default value applies.
	AccessTokenValiditySeconds *int `json:"accessTokenValiditySeconds,omitempty"`
	// Inactivity expiration time in seconds for each refresh token obtained by the APIClient. The expiration time for refresh tokens is restarted each time the token is used. If not set the default value applies.
	RefreshTokenValiditySeconds *int `json:"refreshTokenValiditySeconds,omitempty"`
}

type ApiClientPagedQueryResponse ¶ 

type ApiClientPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// APIClients matching the query.
	Results []ApiClient `json:"results"`
}

* * [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of [APIClient](ctp:api:type:ApiClient). *

type ApprovalFlow ¶ added in v1.4.0 

type ApprovalFlow struct {
	// Unique identifier of the Approval Flow.
	ID string `json:"id"`
	// Current version of the Approval Flow.
	Version int `json:"version"`
	// Date and time (UTC) the Approval Flow was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Approval Flow was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// [Order](ctp:api:type:Order) that needs to be approved.
	Order OrderReference `json:"order"`
	// [Business Unit](ctp:api:type:BusinessUnit) the Approval Flow belongs to.
	BusinessUnit BusinessUnitKeyReference `json:"businessUnit"`
	// Approval Rules that matched the [Order](ctp:api:type:Order).
	Rules []ApprovalRule `json:"rules"`
	// Indicates whether the Approval Flow is under review, approved, or rejected.
	Status ApprovalFlowStatus `json:"status"`
	// Present when the [status](ctp:api:type:ApprovalFlowStatus) of the Approval Flow is `Rejected`.
	Rejection *ApprovalFlowRejection `json:"rejection,omitempty"`
	// Existing approvals in the Approval Flow.
	Approvals []ApprovalFlowApproval `json:"approvals"`
	// Associate Roles that can approve according to the approver hierarchy tiers defined in `rules`.
	// Associates are allowed to reject even after they have given approval, as long as the current approver hierarchy tier still contains their role.
	EligibleApprovers []RuleApprover `json:"eligibleApprovers"`
	// Associate Roles required for approval based on the approver hierarchy tiers defined in `rules` across all remaining tiers.
	PendingApprovers []RuleApprover `json:"pendingApprovers"`
	// Associate Roles required for approval based on the approver hierarchy tiers defined in `rules` only for the currently active tier(s).
	CurrentTierPendingApprovers []RuleApprover `json:"currentTierPendingApprovers"`
	// Custom Fields on the Approval Flow.
	Custom *CustomFields `json:"custom,omitempty"`
}

type ApprovalFlowApproval ¶ added in v1.4.0 

type ApprovalFlowApproval struct {
	// Associate who approved the [Approval Flow](ctp:api:type:ApprovalFlow).
	Approver Associate `json:"approver"`
	// Date and time (UTC) when the [Approval Flow](ctp:api:type:ApprovalFlow) was approved at.
	ApprovedAt time.Time `json:"approvedAt"`
}

type ApprovalFlowApproveAction ¶ added in v1.4.0 

type ApprovalFlowApproveAction struct {
}

* * This update action allows an Associate(ctp:api:type:Associate) to approve an Approval Flow. The process takes into account all [Associate Roles](ctp:api:type:AssociateRole) held by the Associate, aligning with the matched [Approval Rules](ctp:api:type:ApprovalRule) and their respective approver hierarchies. * * When every required Associate has given their approval, the Approval Flow achieves a fully approved state, automatically updating its status to `Approved`. An Associate is eligible to approve only if their roles are within tiers of the Approval Rule hierarchy that are yet to be fully approved or rejected. As such, an Associate may be able to give their approval more than once. *

func (ApprovalFlowApproveAction) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowApproveAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalFlowApprovedMessage ¶ added in v1.4.0 

type ApprovalFlowApprovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Reference](ctp:api:type:Reference) to the [Customer](ctp:api:type:Customer) who approved the [Approval Flow](/projects/approval-flows).
	Associate CustomerReference `json:"associate"`
	// [Reference](ctp:api:type:Reference) to the [Order](ctp:api:type:Order) that received the approval.
	Order OrderReference `json:"order"`
}

* * Generated after an [approval in the Approval Flow](/projects/approval-flows#approve). *

func (ApprovalFlowApprovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowApprovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalFlowApprovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalFlowApprovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalFlowApprovedMessagePayload ¶ added in v1.4.0 

type ApprovalFlowApprovedMessagePayload struct {
	// [Reference](ctp:api:type:Reference) to the [Customer](ctp:api:type:Customer) who approved the [Approval Flow](/projects/approval-flows).
	Associate CustomerReference `json:"associate"`
	// [Reference](ctp:api:type:Reference) to the [Order](ctp:api:type:Order) that received the approval.
	Order OrderReference `json:"order"`
}

* * Generated after an [approval in the Approval Flow](/projects/approval-flows#approve). *

func (ApprovalFlowApprovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowApprovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalFlowCompletedMessage ¶ added in v1.4.0 

type ApprovalFlowCompletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Final status of the [Approval Flow](ctp:api:type:ApprovalFlow).
	Status ApprovalFlowStatus `json:"status"`
	// [Reference](ctp:api:type:Reference) to the [Order](ctp:api:type:Order) related to the completed [Approval Flow](ctp:api:type:ApprovalFlow).
	Order OrderReference `json:"order"`
}

* * Generated after an [Approval Flow](ctp:api:type:ApprovalFlow) is completed and reaches a final status. *

func (ApprovalFlowCompletedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowCompletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalFlowCompletedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalFlowCompletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalFlowCompletedMessagePayload ¶ added in v1.4.0 

type ApprovalFlowCompletedMessagePayload struct {
	// Final status of the [Approval Flow](ctp:api:type:ApprovalFlow).
	Status ApprovalFlowStatus `json:"status"`
	// [Reference](ctp:api:type:Reference) to the [Order](ctp:api:type:Order) related to the completed [Approval Flow](ctp:api:type:ApprovalFlow).
	Order OrderReference `json:"order"`
}

* * Generated after an [Approval Flow](ctp:api:type:ApprovalFlow) is completed and reaches a final status. *

func (ApprovalFlowCompletedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowCompletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalFlowCreatedMessage ¶ added in v1.4.0 

type ApprovalFlowCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Approval Flow](ctp:api:type:ApprovalFlow) that was created.
	ApprovalFlow ApprovalFlow `json:"approvalFlow"`
}

* * Generated after an [Approval Flow](ctp:api:type:ApprovalFlow) is created. *

func (ApprovalFlowCreatedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalFlowCreatedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalFlowCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalFlowCreatedMessagePayload ¶ added in v1.4.0 

type ApprovalFlowCreatedMessagePayload struct {
	// The [Approval Flow](ctp:api:type:ApprovalFlow) that was created.
	ApprovalFlow ApprovalFlow `json:"approvalFlow"`
}

* * Generated after an [Approval Flow](ctp:api:type:ApprovalFlow) is created. *

func (ApprovalFlowCreatedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalFlowPagedQueryResponse ¶ added in v1.4.0 

type ApprovalFlowPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Approval Flows matching the query.
	Results []ApprovalFlow `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of ApprovalFlow(ctp:api:type:ApprovalFlow). *

type ApprovalFlowRejectAction ¶ added in v1.4.0 

type ApprovalFlowRejectAction struct {
	// The reason for the rejection of the [Approval Flow](ctp:api:type:ApprovalFlow).
	Reason *string `json:"reason,omitempty"`
}

* * This update action allows an Associate(ctp:api:type:Associate) to reject an Approval Flow, setting its status to `Rejected`. * The process takes into account all [Associate Roles](ctp:api:type:AssociateRole) held by the Associate, aligning with the matched [Approval Rules](ctp:api:type:ApprovalRule) and their respective approver hierarchies. * Even a single rejection in the process will result in the rejection of the entire Approval Flow. * * An Associate is eligible to reject only if their roles are within tiers of the Approval Rule hierarchy that are yet to be rejected. An Associate may alter a prior approval into a rejection. *

func (ApprovalFlowRejectAction) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowRejectAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalFlowRejectedMessage ¶ added in v1.4.0 

type ApprovalFlowRejectedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Reference](ctp:api:type:Reference) to the [Customer](ctp:api:type:Customer) who rejected the [Approval Flow](/projects/approval-flows).
	Associate CustomerReference `json:"associate"`
	// Description of the reason why the [Approval Flow](ctp:api:type:ApprovalFlow) was rejected.
	RejectionReason *string `json:"rejectionReason,omitempty"`
	// [Reference](ctp:api:type:Reference) to the [Order](ctp:api:type:Order) that received the rejection.
	Order OrderReference `json:"order"`
}

* * Generated after an [Approval Flow is rejected](/projects/approval-flows#reject). *

func (ApprovalFlowRejectedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowRejectedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalFlowRejectedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalFlowRejectedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalFlowRejectedMessagePayload ¶ added in v1.4.0 

type ApprovalFlowRejectedMessagePayload struct {
	// [Reference](ctp:api:type:Reference) to the [Customer](ctp:api:type:Customer) who rejected the [Approval Flow](/projects/approval-flows).
	Associate CustomerReference `json:"associate"`
	// Description of the reason why the [Approval Flow](ctp:api:type:ApprovalFlow) was rejected.
	RejectionReason *string `json:"rejectionReason,omitempty"`
	// [Reference](ctp:api:type:Reference) to the [Order](ctp:api:type:Order) that received the rejection.
	Order OrderReference `json:"order"`
}

* * Generated after an [Approval Flow is rejected](/projects/approval-flows#reject). *

func (ApprovalFlowRejectedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalFlowRejectedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalFlowRejection ¶ added in v1.4.0 

type ApprovalFlowRejection struct {
	// Associate who rejected the [Approval Flow](ctp:api:type:ApprovalFlow).
	Rejecter Associate `json:"rejecter"`
	// Date and time (UTC) when the [Approval Flow](ctp:api:type:ApprovalFlow) was rejected at.
	RejectedAt time.Time `json:"rejectedAt"`
	// The reason for the rejection of the [Approval Flow](ctp:api:type:ApprovalFlow).
	Reason *string `json:"reason,omitempty"`
}

type ApprovalFlowSetCustomFieldAction ¶ added in v1.5.0 

type ApprovalFlowSetCustomFieldAction struct {
	// Name of the [Custom Field](ctp:api:type:CustomFields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (ApprovalFlowSetCustomFieldAction) MarshalJSON ¶ added in v1.5.0 

func (obj ApprovalFlowSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalFlowSetCustomTypeAction ¶ added in v1.5.0 

type ApprovalFlowSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the ApprovalFlow with [Custom Fields](ctp:api:type:CustomFields).
	// If absent, any existing Type and Custom Fields are removed from the ApprovalFlow.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](ctp:api:type:CustomFields) fields for the ApprovalFlow.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ApprovalFlowSetCustomTypeAction) MarshalJSON ¶ added in v1.5.0 

func (obj ApprovalFlowSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalFlowStatus ¶ added in v1.4.0 

type ApprovalFlowStatus string

* * Indicates whether the [Approval Flow](ctp:api:type:ApprovalFlow) is under review, approved, or rejected. * 

const (
	ApprovalFlowStatusPending  ApprovalFlowStatus = "Pending"
	ApprovalFlowStatusApproved ApprovalFlowStatus = "Approved"
	ApprovalFlowStatusRejected ApprovalFlowStatus = "Rejected"
)

type ApprovalFlowUpdate ¶ added in v1.4.0 

type ApprovalFlowUpdate struct {
	// Expected version of the [Approval Flow](ctp:api:type:ApprovalFlow) to which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the [Approval Flow](ctp:api:type:ApprovalFlow).
	Actions []ApprovalFlowUpdateAction `json:"actions"`
}

func (*ApprovalFlowUpdate) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalFlowUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalFlowUpdateAction ¶ added in v1.4.0 

type ApprovalFlowUpdateAction interface{}

type ApprovalRule ¶ added in v1.4.0 

type ApprovalRule struct {
	// Unique identifier of the Approval Rule.
	ID string `json:"id"`
	// Current version of the Approval Rule.
	Version int `json:"version"`
	// Date and time (UTC) the Approval Rule was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Approval Rule was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// User-defined unique identifier of the Approval Rule. Must be unique within a [Business Unit](ctp:api:type:BusinessUnit).
	Key *string `json:"key,omitempty"`
	// Name of the Approval Rule.
	Name string `json:"name"`
	// Description of the Approval Rule.
	Description *string `json:"description,omitempty"`
	// Indicates whether the Approval Rule should be matched against [Orders](ctp:api:type:Order) or not.
	Status ApprovalRuleStatus `json:"status"`
	// The [Order Predicate](/../api/projects/predicates#order-predicates) describing the [Orders](ctp:api:type:Order) the Approval Rule should match against.
	Predicate string `json:"predicate"`
	// The hierarchy of approvers within the Approval Rule.
	Approvers ApproverHierarchy `json:"approvers"`
	// The [Associate Roles](ctp:api:type:AssociateRole) customers must hold for their Order to require approval.
	Requesters []RuleRequester `json:"requesters"`
	// The [Business Unit](ctp:api:type:BusinessUnit) the Approval Rule belongs to.
	BusinessUnit BusinessUnitKeyReference `json:"businessUnit"`
}

type ApprovalRuleApproversSetMessage ¶ added in v1.4.0 

type ApprovalRuleApproversSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Approver hierarchy of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Approvers](ctp:api:type:ApprovalRuleSetApproversAction) update action.
	Approvers ApproverHierarchy `json:"approvers"`
	// Approver hierarchy of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Approvers](ctp:api:type:ApprovalRuleSetApproversAction) update action.
	OldApprovers ApproverHierarchy `json:"oldApprovers"`
}

* * Generated after a successful [Set Approvers](ctp:api:type:ApprovalRuleSetApproversAction) update action. *

func (ApprovalRuleApproversSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleApproversSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalRuleApproversSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalRuleApproversSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalRuleApproversSetMessagePayload ¶ added in v1.4.0 

type ApprovalRuleApproversSetMessagePayload struct {
	// Approver hierarchy of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Approvers](ctp:api:type:ApprovalRuleSetApproversAction) update action.
	Approvers ApproverHierarchy `json:"approvers"`
	// Approver hierarchy of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Approvers](ctp:api:type:ApprovalRuleSetApproversAction) update action.
	OldApprovers ApproverHierarchy `json:"oldApprovers"`
}

* * Generated after a successful [Set Approvers](ctp:api:type:ApprovalRuleSetApproversAction) update action. *

func (ApprovalRuleApproversSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleApproversSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleCreatedMessage ¶ added in v1.4.0 

type ApprovalRuleCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Approval Rule](ctp:api:type:ApprovalRule) that was created.
	ApprovalRule ApprovalRule `json:"approvalRule"`
}

* * Generated after an [Approval Rule](ctp:api:type:ApprovalRule) is created. *

func (ApprovalRuleCreatedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalRuleCreatedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalRuleCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalRuleCreatedMessagePayload ¶ added in v1.4.0 

type ApprovalRuleCreatedMessagePayload struct {
	// The [Approval Rule](ctp:api:type:ApprovalRule) that was created.
	ApprovalRule ApprovalRule `json:"approvalRule"`
}

* * Generated after an [Approval Rule](ctp:api:type:ApprovalRule) is created. *

func (ApprovalRuleCreatedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleDescriptionSetMessage ¶ added in v1.4.0 

type ApprovalRuleDescriptionSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Description of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Description](ctp:api:type:ApprovalRuleSetDescriptionAction) update action.
	Description *string `json:"description,omitempty"`
	// Description of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Description](ctp:api:type:ApprovalRuleSetDescriptionAction) update action.
	OldDescription *string `json:"oldDescription,omitempty"`
}

* * Generated after a successful [Set Description](ctp:api:type:ApprovalRuleSetDescriptionAction) update action. *

func (ApprovalRuleDescriptionSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleDescriptionSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalRuleDescriptionSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalRuleDescriptionSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalRuleDescriptionSetMessagePayload ¶ added in v1.4.0 

type ApprovalRuleDescriptionSetMessagePayload struct {
	// Description of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Description](ctp:api:type:ApprovalRuleSetDescriptionAction) update action.
	Description *string `json:"description,omitempty"`
	// Description of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Description](ctp:api:type:ApprovalRuleSetDescriptionAction) update action.
	OldDescription *string `json:"oldDescription,omitempty"`
}

* * Generated after a successful [Set Description](ctp:api:type:ApprovalRuleSetDescriptionAction) update action. *

func (ApprovalRuleDescriptionSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleDescriptionSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleDraft ¶ added in v1.4.0 

type ApprovalRuleDraft struct {
	// User-defined unique identifier of the Approval Rule. Uniqueness is enforced within the Business Unit.
	Key *string `json:"key,omitempty"`
	// Name of the Approval Rule.
	Name string `json:"name"`
	// Description of the Approval Rule.
	Description *string `json:"description,omitempty"`
	// Indicates whether the Approval Rule should be matched against [Orders](ctp:api:type:Order) or not.
	Status ApprovalRuleStatus `json:"status"`
	// The [predicate](/../api/predicates/predicate-operators) describing the [Orders](ctp:api:type:Order) the Approval Rule should match against.
	Predicate string `json:"predicate"`
	// The hierarchy of approvers within the Approval Rule.
	Approvers ApproverHierarchyDraft `json:"approvers"`
	// The [Associate Roles](ctp:api:type:AssociateRole) customers must hold for their Order to require approval.
	Requesters []RuleRequesterDraft `json:"requesters"`
}

type ApprovalRuleKeySetMessage ¶ added in v1.4.0 

type ApprovalRuleKeySetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Description of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Key](ctp:api:type:ApprovalRuleSetKeyAction) update action.
	Key *string `json:"key,omitempty"`
	// Description of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Key](ctp:api:type:ApprovalRuleSetKeyAction) update action.
	OldKey *string `json:"oldKey,omitempty"`
}

* * Generated after a successful [Set Key](ctp:api:type:ApprovalRuleSetKeyAction) update action. *

func (ApprovalRuleKeySetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleKeySetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalRuleKeySetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalRuleKeySetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalRuleKeySetMessagePayload ¶ added in v1.4.0 

type ApprovalRuleKeySetMessagePayload struct {
	// Description of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Key](ctp:api:type:ApprovalRuleSetKeyAction) update action.
	Key *string `json:"key,omitempty"`
	// Description of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Key](ctp:api:type:ApprovalRuleSetKeyAction) update action.
	OldKey *string `json:"oldKey,omitempty"`
}

* * Generated after a successful [Set Key](ctp:api:type:ApprovalRuleSetKeyAction) update action. *

func (ApprovalRuleKeySetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleKeySetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleNameSetMessage ¶ added in v1.4.0 

type ApprovalRuleNameSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Name](ctp:api:type:ApprovalRuleSetNameAction) update action.
	Name string `json:"name"`
	// Name of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Name](ctp:api:type:ApprovalRuleSetNameAction) update action.
	OldName string `json:"oldName"`
}

* * Generated after a successful [Set Name](ctp:api:type:ApprovalRuleSetNameAction) update action. *

func (ApprovalRuleNameSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleNameSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalRuleNameSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalRuleNameSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalRuleNameSetMessagePayload ¶ added in v1.4.0 

type ApprovalRuleNameSetMessagePayload struct {
	// Name of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Name](ctp:api:type:ApprovalRuleSetNameAction) update action.
	Name string `json:"name"`
	// Name of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Name](ctp:api:type:ApprovalRuleSetNameAction) update action.
	OldName string `json:"oldName"`
}

* * Generated after a successful [Set Name](ctp:api:type:ApprovalRuleSetNameAction) update action. *

func (ApprovalRuleNameSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleNameSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRulePagedQueryResponse ¶ added in v1.4.0 

type ApprovalRulePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Approval Rules matching the query.
	Results []ApprovalRule `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of ApprovalRule(ctp:api:type:ApprovalRule). *

type ApprovalRulePredicateSetMessage ¶ added in v1.4.0 

type ApprovalRulePredicateSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Predicate](ctp:api:type:ApprovalRuleSetPredicateAction) update action.
	Predicate string `json:"predicate"`
	// Name of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Predicate](ctp:api:type:ApprovalRuleSetPredicateAction) update action.
	OldPredicate string `json:"oldPredicate"`
}

* * Generated after a successful [Set Predicate](ctp:api:type:ApprovalRuleSetPredicateAction) update action. *

func (ApprovalRulePredicateSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRulePredicateSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalRulePredicateSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalRulePredicateSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalRulePredicateSetMessagePayload ¶ added in v1.4.0 

type ApprovalRulePredicateSetMessagePayload struct {
	// Name of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Predicate](ctp:api:type:ApprovalRuleSetPredicateAction) update action.
	Predicate string `json:"predicate"`
	// Name of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Predicate](ctp:api:type:ApprovalRuleSetPredicateAction) update action.
	OldPredicate string `json:"oldPredicate"`
}

* * Generated after a successful [Set Predicate](ctp:api:type:ApprovalRuleSetPredicateAction) update action. *

func (ApprovalRulePredicateSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRulePredicateSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleRequestersSetMessage ¶ added in v1.4.0 

type ApprovalRuleRequestersSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// RuleRequester of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Requester](ctp:api:type:ApprovalRuleSetRequestersAction) update action.
	Requesters []RuleRequester `json:"requesters"`
	// RuleRequester of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Requester](ctp:api:type:ApprovalRuleSetRequestersAction) update action.
	OldRequesters []RuleRequester `json:"oldRequesters"`
}

* * Generated after a successful [Set Requester](ctp:api:type:ApprovalRuleSetRequestersAction) update action. *

func (ApprovalRuleRequestersSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleRequestersSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalRuleRequestersSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalRuleRequestersSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalRuleRequestersSetMessagePayload ¶ added in v1.4.0 

type ApprovalRuleRequestersSetMessagePayload struct {
	// RuleRequester of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Requester](ctp:api:type:ApprovalRuleSetRequestersAction) update action.
	Requesters []RuleRequester `json:"requesters"`
	// RuleRequester of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Requester](ctp:api:type:ApprovalRuleSetRequestersAction) update action.
	OldRequesters []RuleRequester `json:"oldRequesters"`
}

* * Generated after a successful [Set Requester](ctp:api:type:ApprovalRuleSetRequestersAction) update action. *

func (ApprovalRuleRequestersSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleRequestersSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleSetApproversAction ¶ added in v1.4.0 

type ApprovalRuleSetApproversAction struct {
	// New approvers to set for the Approval Rule.
	Approvers ApproverHierarchyDraft `json:"approvers"`
}

* * Setting the approvers for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleApproversSet](ctp:api:type:ApprovalRuleApproversSetMessage) Message. *

func (ApprovalRuleSetApproversAction) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleSetApproversAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleSetDescriptionAction ¶ added in v1.4.0 

type ApprovalRuleSetDescriptionAction struct {
	// New description to set for the Approval Rule.
	Description *string `json:"description,omitempty"`
}

* * Setting the description for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleDescriptionSet](ctp:api:type:ApprovalRuleDescriptionSetMessage) Message. *

func (ApprovalRuleSetDescriptionAction) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleSetKeyAction ¶ added in v1.4.0 

type ApprovalRuleSetKeyAction struct {
	// Value to set. Must be unique within a Business Unit. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

* * Setting the key for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleKeySet](ctp:api:type:ApprovalRuleKeySetMessage) Message. *

func (ApprovalRuleSetKeyAction) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleSetNameAction ¶ added in v1.4.0 

type ApprovalRuleSetNameAction struct {
	// New name to set for the Approval Rule.
	Name string `json:"name"`
}

* * Setting the name for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleNameSet](ctp:api:type:ApprovalRuleNameSetMessage) Message. *

func (ApprovalRuleSetNameAction) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleSetNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleSetPredicateAction ¶ added in v1.4.0 

type ApprovalRuleSetPredicateAction struct {
	// A valid [Order Predicate](/../api/projects/predicates#order-predicates) to set for the Approval Rule.
	Predicate string `json:"predicate"`
}

* * Setting the [Order Predicate](/../api/projects/predicates#order-predicates) for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRulePredicateSet](ctp:api:type:ApprovalRulePredicateSetMessage) Message. *

func (ApprovalRuleSetPredicateAction) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleSetPredicateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleSetRequestersAction ¶ added in v1.4.0 

type ApprovalRuleSetRequestersAction struct {
	// New requesters to set for the Approval Rule.
	Requesters []RuleRequesterDraft `json:"requesters"`
}

* * Sets the requesters for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleRequestersSet](ctp:api:type:ApprovalRuleRequestersSetMessage) Message. *

func (ApprovalRuleSetRequestersAction) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleSetRequestersAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleSetStatusAction ¶ added in v1.4.0 

type ApprovalRuleSetStatusAction struct {
	// New status to set for the Approval Rule.
	Status ApprovalRuleStatus `json:"status"`
}

* * Setting the status for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleStatusSet](ctp:api:type:ApprovalRuleStatusSetMessage) Message. *

func (ApprovalRuleSetStatusAction) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleSetStatusAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleStatus ¶ added in v1.4.0 

type ApprovalRuleStatus string

* * Indicates whether the Approval Rule should be matched against [Orders](ctp:api:type:Order) or not. * 

const (
	ApprovalRuleStatusActive   ApprovalRuleStatus = "Active"
	ApprovalRuleStatusInactive ApprovalRuleStatus = "Inactive"
)

type ApprovalRuleStatusSetMessage ¶ added in v1.4.0 

type ApprovalRuleStatusSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Status of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Status](ctp:api:type:ApprovalRuleSetStatusAction) update action.
	Status ApprovalRuleStatus `json:"status"`
	// Status of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Status](ctp:api:type:ApprovalRuleSetStatusAction) update action.
	OldStatus ApprovalRuleStatus `json:"oldStatus"`
}

* * Generated after a successful [Set Status](ctp:api:type:ApprovalRuleSetStatusAction) update action. *

func (ApprovalRuleStatusSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleStatusSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ApprovalRuleStatusSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalRuleStatusSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalRuleStatusSetMessagePayload ¶ added in v1.4.0 

type ApprovalRuleStatusSetMessagePayload struct {
	// Status of the [ApprovalRule](ctp:api:type:ApprovalRule) after the [Set Status](ctp:api:type:ApprovalRuleSetStatusAction) update action.
	Status ApprovalRuleStatus `json:"status"`
	// Status of the [ApprovalRule](ctp:api:type:ApprovalRule) before the [Set Status](ctp:api:type:ApprovalRuleSetStatusAction) update action.
	OldStatus ApprovalRuleStatus `json:"oldStatus"`
}

* * Generated after a successful [Set Status](ctp:api:type:ApprovalRuleSetStatusAction) update action. *

func (ApprovalRuleStatusSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj ApprovalRuleStatusSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ApprovalRuleUpdate ¶ added in v1.4.0 

type ApprovalRuleUpdate struct {
	// Expected version of the [ApprovalRule](ctp:api:type:ApprovalRule) to which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the [ApprovalRule](ctp:api:type:ApprovalRule).
	Actions []ApprovalRuleUpdateAction `json:"actions"`
}

func (*ApprovalRuleUpdate) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ApprovalRuleUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ApprovalRuleUpdateAction ¶ added in v1.4.0 

type ApprovalRuleUpdateAction interface{}

type ApproverConjunction ¶ added in v1.4.0 

type ApproverConjunction struct {
	// All of the nested disjunctions must be approved in order for the conjunction to be considered approved.
	And []ApproverDisjunction `json:"and"`
}

type ApproverConjunctionDraft ¶ added in v1.4.0 

type ApproverConjunctionDraft struct {
	// All of the nested disjunctions must be approved in order for the conjunction to be considered approved.
	// The total count of approvers across the nested disjunctions must not exceed 10.
	And []ApproverDisjunctionDraft `json:"and"`
}

type ApproverDisjunction ¶ added in v1.4.0 

type ApproverDisjunction struct {
	// Any of the nested approvers must approve in order for the disjunction to be considered approved.
	Or []RuleApprover `json:"or"`
}

type ApproverDisjunctionDraft ¶ added in v1.4.0 

type ApproverDisjunctionDraft struct {
	// Any of the nested approvers must approve in order for the disjunction to be considered approved.
	Or []RuleApproverDraft `json:"or"`
}

type ApproverHierarchy ¶ added in v1.4.0 

type ApproverHierarchy struct {
	// All of the nested conjunctions must be approved in order for the hierarchy to be considered approved.
	Tiers []ApproverConjunction `json:"tiers"`
}

* * Describes the order in which [Associates](ctp:api:type:Associate) can approve the matched Order(ctp:api:type:Order). *

type ApproverHierarchyDraft ¶ added in v1.4.0 

type ApproverHierarchyDraft struct {
	// Nested conjunctions representing tiers of approvers in a hierarchy.
	Tiers []ApproverConjunctionDraft `json:"tiers"`
}

* * Describes the sequence in which [Associates](ctp:api:type:Associate) can approve an Order(ctp:api:type:Order). *

type Asset ¶ 

type Asset struct {
	// Unique identifier of the Asset.
	ID      string        `json:"id"`
	Sources []AssetSource `json:"sources"`
	// Name of the Asset.
	Name LocalizedString `json:"name"`
	// Description of the Asset.
	Description *LocalizedString `json:"description,omitempty"`
	// Keywords for categorizing and organizing Assets.
	Tags []string `json:"tags"`
	// Custom Fields defined for the Asset.
	Custom *CustomFields `json:"custom,omitempty"`
	// User-defined identifier of the Asset. It is unique per [Category](ctp:api:type:Category) or [ProductVariant](ctp:api:type:ProductVariant).
	Key *string `json:"key,omitempty"`
}

func (Asset) MarshalJSON ¶ 

func (obj Asset) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssetDimensions ¶ 

type AssetDimensions struct {
	// Width of the Asset source.
	W int `json:"w"`
	// Height of the Asset source.
	H int `json:"h"`
}

* * Dimensions of the Asset source specified by the number of pixels. *

type AssetDraft ¶ 

type AssetDraft struct {
	Sources []AssetSource `json:"sources"`
	// Name of the Asset.
	Name LocalizedString `json:"name"`
	// Description of the Asset.
	Description *LocalizedString `json:"description,omitempty"`
	// Keywords for categorizing and organizing Assets.
	Tags []string `json:"tags"`
	// Custom Fields defined for the Asset.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// User-defined identifier for the Asset. Must be unique per [Category](ctp:api:type:Category) or [ProductVariant](ctp:api:type:ProductVariant).
	Key *string `json:"key,omitempty"`
}

func (AssetDraft) MarshalJSON ¶ 

func (obj AssetDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssetSource ¶ 

type AssetSource struct {
	// URI of the AssetSource.
	Uri string `json:"uri"`
	// User-defined identifier of the AssetSource. Must be unique per [Asset](ctp:api:type:Asset).
	Key *string `json:"key,omitempty"`
	// Width and height of the AssetSource.
	Dimensions *AssetDimensions `json:"dimensions,omitempty"`
	// Indicates the type of content, for example `application/pdf`.
	ContentType *string `json:"contentType,omitempty"`
}

* * Representation of an Asset(#asset) in a specific format, for example a video in a certain encoding, or an image in a certain resolution. *

type AssignedProductReference ¶ 

type AssignedProductReference struct {
	// Reference to a Product that is assigned to the Product Selection.
	Product ProductReference `json:"product"`
	// The Variants of the Product that are included from the Product Selection.
	//
	// This field may exist only in Product Selections with `Individual` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
	// In absence of this field, all Variants are deemed to be included.
	VariantSelection ProductVariantSelection `json:"variantSelection,omitempty"`
	// The Variants of the Product that are excluded from the Product Selection.
	//
	// This field may exist only in Product Selections with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
	// In absence of this field, all Variants are deemed to be excluded.
	VariantExclusion *ProductVariantExclusion `json:"variantExclusion,omitempty"`
}

func (*AssignedProductReference) UnmarshalJSON ¶ added in v1.2.0 

func (obj *AssignedProductReference) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssignedProductSelection ¶ 

type AssignedProductSelection struct {
	// Reference to the Product Selection that this assignment is part of.
	ProductSelection ProductSelectionReference `json:"productSelection"`
	// Defines which Variants of the Product will be included in the Product Selection.
	//
	// This field is only available for assignments to a Product Selection with `Individual` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
	VariantSelection ProductVariantSelection `json:"variantSelection,omitempty"`
	// Defines which Variants of the Product will be excluded from the Product Selection.
	//
	// This field is only available for assignments to a Product Selection with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
	VariantExclusion *ProductVariantExclusion `json:"variantExclusion,omitempty"`
	// Date and time (UTC) this assignment was initially created.
	CreatedAt time.Time `json:"createdAt"`
}

func (*AssignedProductSelection) UnmarshalJSON ¶ added in v1.2.0 

func (obj *AssignedProductSelection) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssignedProductSelectionPagedQueryResponse ¶ 

type AssignedProductSelectionPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/general-concepts#strong-consistency).
	// Unlike other endpoints, the Product Selection endpoint does not return this field by default.
	// To get `total`, pass the query parameter `withTotal` set to `true`.
	// When the results are filtered with a [Query Predicate](/predicates/query), `total` is subject to a [limit](/limits#queries).
	Total *int `json:"total,omitempty"`
	// References to ProductSelection that are assigned to the Product.
	Results []AssignedProductSelection `json:"results"`
}

* * [PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of AssignedProductSelection(ctp:api:type:AssignedProductSelection). *

type Associate ¶ added in v1.2.0 

type Associate struct {
	// Roles assigned to the Associate within a Business Unit.
	AssociateRoleAssignments []AssociateRoleAssignment `json:"associateRoleAssignments"`
	// Deprecated type. Use `associateRoleAssignments` instead.
	Roles []AssociateRoleDeprecated `json:"roles"`
	// The [Customer](ctp:api:type:Customer) that acts as an Associate in the Business Unit.
	Customer CustomerReference `json:"customer"`
}

func (Associate) MarshalJSON ¶ added in v1.4.0 

func (obj Associate) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateDraft ¶ added in v1.2.0 

type AssociateDraft struct {
	// Roles assigned to the Associate within a Business Unit.
	AssociateRoleAssignments []AssociateRoleAssignmentDraft `json:"associateRoleAssignments"`
	// Deprecated type. Use `associateRoleAssignments` instead.
	Roles []AssociateRoleDeprecated `json:"roles"`
	// The [Customer](ctp:api:type:Customer) to be part of the Business Unit.
	Customer CustomerResourceIdentifier `json:"customer"`
}

func (AssociateDraft) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateMissingPermissionError ¶ added in v1.3.0 

type AssociateMissingPermissionError struct {
	// - When an action is performed by an Associate: `"Associate '$idOfAssociate' has no rights to $action in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredPermission'."`
	// - When an action is performed for another Associate, like [viewing their Cart](/projects/associate-carts#get-cart-in-businessunit): `"Associate '$idOfAssociate' has no rights to $action for customer '$idOfCustomer' in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredPermission'."`
	// - When viewing an entity: `"Associate '$idOfAssociate' has no rights to $action in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredViewMyPermission' or '$requiredViewOthersPermission'."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// [ResourceIdentifier](ctp:api:type:CustomerResourceIdentifier) to the [Associate](ctp:api:type:Associate) that tried to perform the action.
	Associate CustomerResourceIdentifier `json:"associate"`
	// [ResourceIdentifier](ctp:api:type:BusinessUnitResourceIdentifier) to the [BusinessUnit](ctp:api:type:BusinessUnit).
	BusinessUnit BusinessUnitResourceIdentifier `json:"businessUnit"`
	// [ResourceIdentifier](ctp:api:type:CustomerResourceIdentifier) of the [Associate](ctp:api:type:Associate) on whose behalf the action is performed.
	AssociateOnBehalf *CustomerResourceIdentifier `json:"associateOnBehalf,omitempty"`
	// The Permissions that the [Associate](ctp:api:type:Associate) performing the action lacks. At least one of these Permissions is needed.
	Permissions []Permission `json:"permissions"`
}

* * Returned when an Associate(/projects/business-units#associate) is missing a Permission(/projects/associate-roles#ctp:api:type:Permission) on a [B2B resource](/associates-overview#b2b-resources). *

func (*AssociateMissingPermissionError) DecodeStruct ¶ added in v1.3.0 

func (obj *AssociateMissingPermissionError) DecodeStruct(src map[string]interface{}) error

func (AssociateMissingPermissionError) Error ¶ added in v1.3.0 

func (obj AssociateMissingPermissionError) Error() string

func (AssociateMissingPermissionError) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateMissingPermissionError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AssociateMissingPermissionError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *AssociateMissingPermissionError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssociateRole ¶ added in v1.2.0 

type AssociateRole struct {
	// Unique identifier of the AssociateRole.
	ID string `json:"id"`
	// Current version of the AssociateRole.
	Version int `json:"version"`
	// Date and time (UTC) the AssociateRole was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the AssociateRole was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the AssociateRole.
	Key string `json:"key"`
	// Whether the AssociateRole can be assigned to an Associate by a [buyer](/../api/associates-overview#buyer). If false, the AssociateRole can only be assigned using the [general endpoint](/../api/associates-overview#through-the-general-endpoints).
	BuyerAssignable bool `json:"buyerAssignable"`
	// Name of the AssociateRole.
	Name *string `json:"name,omitempty"`
	// List of Permissions for the AssociateRole.
	Permissions []Permission `json:"permissions"`
	// Custom Fields for the AssociateRole.
	Custom *CustomFields `json:"custom,omitempty"`
}

type AssociateRoleAddPermissionAction ¶ added in v1.3.0 

type AssociateRoleAddPermissionAction struct {
	// Permission to be added to the AssociateRole.
	Permission Permission `json:"permission"`
}

* * Adding a Permission to an AssociateRole(ctp:api:type:AssociateRole) generates an [AssociateRolePermissionAdded](ctp:api:type:AssociateRolePermissionAddedMessage) Message. *

func (AssociateRoleAddPermissionAction) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleAddPermissionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleAssignment ¶ added in v1.3.0 

type AssociateRoleAssignment struct {
	// Role the Associate holds within a Business Unit.
	AssociateRole AssociateRoleKeyReference `json:"associateRole"`
	// Determines whether the AssociateRoleAssignment can be inherited by child Business Units.
	Inheritance AssociateRoleInheritanceMode `json:"inheritance"`
}

type AssociateRoleAssignmentDraft ¶ added in v1.3.0 

type AssociateRoleAssignmentDraft struct {
	// Role the Associate holds within a Business Unit.
	AssociateRole AssociateRoleResourceIdentifier `json:"associateRole"`
	// Determines whether the AssociateRoleAssignment can be inherited by child Business Units.
	Inheritance *AssociateRoleInheritanceMode `json:"inheritance,omitempty"`
}

type AssociateRoleBuyerAssignableChangedMessage ¶ added in v1.3.0 

type AssociateRoleBuyerAssignableChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The new value of the `buyerAssignable` field of the AssociateRole.
	BuyerAssignable bool `json:"buyerAssignable"`
}

* * Generated after a successful [Change BuyerAssignable](ctp:api:type:AssociateRoleChangeBuyerAssignableAction) update action. *

func (AssociateRoleBuyerAssignableChangedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleBuyerAssignableChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AssociateRoleBuyerAssignableChangedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *AssociateRoleBuyerAssignableChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssociateRoleBuyerAssignableChangedMessagePayload ¶ added in v1.3.0 

type AssociateRoleBuyerAssignableChangedMessagePayload struct {
	// The new value of the `buyerAssignable` field of the AssociateRole.
	BuyerAssignable bool `json:"buyerAssignable"`
}

* * Generated after a successful [Change BuyerAssignable](ctp:api:type:AssociateRoleChangeBuyerAssignableAction) update action. *

func (AssociateRoleBuyerAssignableChangedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleBuyerAssignableChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleChangeBuyerAssignableAction ¶ added in v1.3.0 

type AssociateRoleChangeBuyerAssignableAction struct {
	// The new value of the `buyerAssignable` field of the AssociateRole.
	BuyerAssignable bool `json:"buyerAssignable"`
}

* * Changing the `buyerAssignable` value of an AssociateRole generates an [AssociateRoleBuyerAssignableChanged](ctp:api:type:AssociateRoleBuyerAssignableChangedMessage) Message. *

func (AssociateRoleChangeBuyerAssignableAction) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleChangeBuyerAssignableAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleCreatedMessage ¶ added in v1.3.0 

type AssociateRoleCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [AssociateRole](ctp:api:type:AssociateRole) that was created.
	AssociateRole AssociateRole `json:"associateRole"`
}

* * Generated after a successful [Create AssociateRole](ctp:api:endpoint:/{projectKey}/associate-roles:POST) request. *

func (AssociateRoleCreatedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AssociateRoleCreatedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *AssociateRoleCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssociateRoleCreatedMessagePayload ¶ added in v1.3.0 

type AssociateRoleCreatedMessagePayload struct {
	// The [AssociateRole](ctp:api:type:AssociateRole) that was created.
	AssociateRole AssociateRole `json:"associateRole"`
}

* * Generated after a successful [Create AssociateRole](ctp:api:endpoint:/{projectKey}/associate-roles:POST) request. *

func (AssociateRoleCreatedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleDeletedMessage ¶ added in v1.3.0 

type AssociateRoleDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete AssociateRole](/projects/associate-roles#delete-associaterole) request. *

func (AssociateRoleDeletedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AssociateRoleDeletedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *AssociateRoleDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssociateRoleDeletedMessagePayload ¶ added in v1.3.0 

type AssociateRoleDeletedMessagePayload struct {
}

* * Generated after a successful [Delete AssociateRole](/projects/associate-roles#delete-associaterole) request. *

func (AssociateRoleDeletedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleDeprecated ¶ added in v1.3.0 

type AssociateRoleDeprecated string

* * Roles defining how an Associate(ctp:api:type:Associate) can interact with a Business Unit. * 

const (
	AssociateRoleDeprecatedAdmin AssociateRoleDeprecated = "Admin"
	AssociateRoleDeprecatedBuyer AssociateRoleDeprecated = "Buyer"
)

type AssociateRoleDraft ¶ added in v1.3.0 

type AssociateRoleDraft struct {
	// User-defined unique identifier for the AssociateRole.
	Key string `json:"key"`
	// Name of the AssociateRole.
	Name *string `json:"name,omitempty"`
	// Whether the AssociateRole can be assigned to an Associate by a [buyer](/../api/associates-overview#buyer).
	BuyerAssignable *bool `json:"buyerAssignable,omitempty"`
	// List of Permissions for the AssociateRole.
	Permissions []Permission `json:"permissions"`
	// Custom Fields for the AssociateRole.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (AssociateRoleDraft) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleInheritanceMode ¶ added in v1.3.0 

type AssociateRoleInheritanceMode string

* * Determines whether an AssociateRoleAssignment(ctp:api:type:AssociateRoleAssignment) can be inherited by child Business Units. * 

const (
	AssociateRoleInheritanceModeEnabled  AssociateRoleInheritanceMode = "Enabled"
	AssociateRoleInheritanceModeDisabled AssociateRoleInheritanceMode = "Disabled"
)

type AssociateRoleKeyReference ¶ added in v1.3.0 

type AssociateRoleKeyReference struct {
	// Unique and immutable key of the referenced [AssociateRole](ctp:api:type:AssociateRole).
	Key string `json:"key"`
}

* * Reference(ctp:api:type:Reference) to an AssociateRole(ctp:api:type:AssociateRole) by its key. *

func (AssociateRoleKeyReference) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleKeyReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleNameChangedMessage ¶ added in v1.3.0 

type AssociateRoleNameChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Updated name of the [AssociateRole](ctp:api:type:AssociateRole).
	Name string `json:"name"`
}

* * Generated after a successful [Set Name](ctp:api:type:AssociateRoleSetNameAction) update action. *

func (AssociateRoleNameChangedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleNameChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AssociateRoleNameChangedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *AssociateRoleNameChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssociateRoleNameChangedMessagePayload ¶ added in v1.3.0 

type AssociateRoleNameChangedMessagePayload struct {
	// Updated name of the [AssociateRole](ctp:api:type:AssociateRole).
	Name string `json:"name"`
}

* * Generated after a successful [Set Name](ctp:api:type:AssociateRoleSetNameAction) update action. *

func (AssociateRoleNameChangedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleNameChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRolePagedQueryResponse ¶ added in v1.3.0 

type AssociateRolePagedQueryResponse struct {
	// Number of requested [results](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of elements [skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [AssociateRoles](ctp:api:type:AssociateRole) matching the query.
	Results []AssociateRole `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of AssociateRole(ctp:api:type:AssociateRole). *

type AssociateRolePermissionAddedMessage ¶ added in v1.3.0 

type AssociateRolePermissionAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Permission that was added to the AssociateRole.
	Permission Permission `json:"permission"`
}

* * Generated after a successful [Add Permissions](ctp:api:type:AssociateRoleAddPermissionAction) update action. *

func (AssociateRolePermissionAddedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRolePermissionAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AssociateRolePermissionAddedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *AssociateRolePermissionAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssociateRolePermissionAddedMessagePayload ¶ added in v1.3.0 

type AssociateRolePermissionAddedMessagePayload struct {
	// The Permission that was added to the AssociateRole.
	Permission Permission `json:"permission"`
}

* * Generated after a successful [Add Permissions](ctp:api:type:AssociateRoleAddPermissionAction) update action. *

func (AssociateRolePermissionAddedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRolePermissionAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRolePermissionRemovedMessage ¶ added in v1.3.0 

type AssociateRolePermissionRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Permission that was removed from the AssociateRole.
	Permission Permission `json:"permission"`
}

* * Generated after a successful [Remove Permissions](ctp:api:type:AssociateRoleRemovePermissionAction) update action. *

func (AssociateRolePermissionRemovedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRolePermissionRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AssociateRolePermissionRemovedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *AssociateRolePermissionRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssociateRolePermissionRemovedMessagePayload ¶ added in v1.3.0 

type AssociateRolePermissionRemovedMessagePayload struct {
	// The Permission that was removed from the AssociateRole.
	Permission Permission `json:"permission"`
}

* * Generated after a successful [Remove Permissions](ctp:api:type:AssociateRoleRemovePermissionAction) update action. *

func (AssociateRolePermissionRemovedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRolePermissionRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRolePermissionsSetMessage ¶ added in v1.3.0 

type AssociateRolePermissionsSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Permission assigned to the AssociateRole.
	Permissions []Permission `json:"permissions"`
}

* * Generated after a successful [Set Permissions](ctp:api:type:AssociateRoleSetPermissionsAction) update action. *

func (AssociateRolePermissionsSetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRolePermissionsSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AssociateRolePermissionsSetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *AssociateRolePermissionsSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssociateRolePermissionsSetMessagePayload ¶ added in v1.3.0 

type AssociateRolePermissionsSetMessagePayload struct {
	// Permission assigned to the AssociateRole.
	Permissions []Permission `json:"permissions"`
}

* * Generated after a successful [Set Permissions](ctp:api:type:AssociateRoleSetPermissionsAction) update action. *

func (AssociateRolePermissionsSetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRolePermissionsSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleReference ¶ added in v1.3.0 

type AssociateRoleReference struct {
	// Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole).
	ID string `json:"id"`
	// Contains the representation of the expanded AssociateRole. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for AssociateRole.
	Obj *AssociateRole `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to an AssociateRole(ctp:api:type:AssociateRole). *

func (AssociateRoleReference) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleRemovePermissionAction ¶ added in v1.3.0 

type AssociateRoleRemovePermissionAction struct {
	// Permission to be removed from the AssociateRole.
	Permission Permission `json:"permission"`
}

* * Removing a Permission from an AssociateRole(ctp:api:type:AssociateRole) generates an [AssociateRolePermissionRemoved](ctp:api:type:AssociateRolePermissionRemovedMessage) Message. *

func (AssociateRoleRemovePermissionAction) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleRemovePermissionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleResourceIdentifier ¶ added in v1.3.0 

type AssociateRoleResourceIdentifier struct {
	// Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// Unique key of the referenced [AssociateRole](ctp:api:type:AssociateRole). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:TypeResourceIdentifier) of an AssociateRole(ctp:api:type:AssociateRole). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (AssociateRoleResourceIdentifier) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleSetCustomFieldAction ¶ added in v1.3.0 

type AssociateRoleSetCustomFieldAction struct {
	// Name of the [Custom Field](ctp:api:type:CustomFields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Trying to remove a field that does not exist will fail with an [InvalidOperationError](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (AssociateRoleSetCustomFieldAction) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleSetCustomTypeAction ¶ added in v1.3.0 

type AssociateRoleSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the AssociateRole with [Custom Fields](ctp:api:type:CustomFields).
	// If absent, any existing Type and Custom Fields are removed from the AssociateRole.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](ctp:api:type:CustomFields) for the AssociateRole.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (AssociateRoleSetCustomTypeAction) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleSetNameAction ¶ added in v1.3.0 

type AssociateRoleSetNameAction struct {
	// New name to set.
	// If `name` is absent or `null`, the existing name, if any, will be removed.
	Name *string `json:"name,omitempty"`
}

* * Updating the name of an AssociateRole(ctp:api:type:AssociateRole) generates an [AssociateRoleNameSet](ctp:api:type:AssociateRoleNameSetMessage) Message. *

func (AssociateRoleSetNameAction) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleSetNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleSetPermissionsAction ¶ added in v1.3.0 

type AssociateRoleSetPermissionsAction struct {
	// Overrides the current list of Permissions for the AssociateRole.
	Permissions []Permission `json:"permissions"`
}

* * Updating the Permissions on an AssociateRole(ctp:api:type:AssociateRole) generates an [AssociateRolePermissionsSet](ctp:api:type:AssociateRolePermissionsSetMessage) Message. *

func (AssociateRoleSetPermissionsAction) MarshalJSON ¶ added in v1.3.0 

func (obj AssociateRoleSetPermissionsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AssociateRoleUpdate ¶ added in v1.3.0 

type AssociateRoleUpdate struct {
	// Expected version of the AssociateRole on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the AssociateRole.
	Actions []AssociateRoleUpdateAction `json:"actions"`
}

func (*AssociateRoleUpdate) UnmarshalJSON ¶ added in v1.3.0 

func (obj *AssociateRoleUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AssociateRoleUpdateAction ¶ added in v1.3.0 

type AssociateRoleUpdateAction interface{}

type Attribute ¶ 

type Attribute struct {
	// Name of the Attribute.
	Name string `json:"name"`
	// The [AttributeType](ctp:api:type:AttributeType) determines the format of the Attribute `value` to be provided:
	//
	// - For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType),
	//   use the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects,
	//   or the complete objects as `value`.
	// - For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), use the [LocalizedString](ctp:api:type:LocalizedString) object as `value`.
	// - For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, use the [Money](ctp:api:type:Money) object as `value`.
	// - For [Set Type](ctp:api:type:AttributeSetType) Attributes, use the entire `set` object  as `value`.
	// - For [Nested Type](ctp:api:type:AttributeNestedType) Attributes, use the list of values of all Attributes of the nested Product as `value`.
	// - For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, use the [Reference](ctp:api:type:Reference) object as `value`.
	Value interface{} `json:"value"`
}

type AttributeBooleanType ¶ 

type AttributeBooleanType struct {
}

* * Attribute type for Boolean values. Valid values for the Attribute are `true` and `false` (JSON Boolean). *

func (AttributeBooleanType) MarshalJSON ¶ 

func (obj AttributeBooleanType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeConstraintEnum ¶ 

type AttributeConstraintEnum string

* * Specifies how an Attribute (or a set of Attributes) should be validated across all variants of a Product: * 

const (
	AttributeConstraintEnumNone              AttributeConstraintEnum = "None"
	AttributeConstraintEnumUnique            AttributeConstraintEnum = "Unique"
	AttributeConstraintEnumCombinationUnique AttributeConstraintEnum = "CombinationUnique"
	AttributeConstraintEnumSameForAll        AttributeConstraintEnum = "SameForAll"
)

type AttributeConstraintEnumDraft ¶ 

type AttributeConstraintEnumDraft string
const (
	AttributeConstraintEnumDraftNone AttributeConstraintEnumDraft = "None"
)

type AttributeDateTimeType ¶ 

type AttributeDateTimeType struct {
}

func (AttributeDateTimeType) MarshalJSON ¶ 

func (obj AttributeDateTimeType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeDateType ¶ 

type AttributeDateType struct {
}

func (AttributeDateType) MarshalJSON ¶ 

func (obj AttributeDateType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeDefinition ¶ 

type AttributeDefinition struct {
	// Describes the Type of the Attribute.
	Type AttributeType `json:"type"`
	// User-defined name of the Attribute that is unique within the [Project](ctp:api:type:Project).
	Name string `json:"name"`
	// Human-readable label for the Attribute.
	Label LocalizedString `json:"label"`
	// If `true`, the Attribute must have a value on a [ProductVariant](ctp:api:type:ProductVariant).
	IsRequired bool `json:"isRequired"`
	// Specifies how Attributes are validated across all variants of a Product.
	AttributeConstraint AttributeConstraintEnum `json:"attributeConstraint"`
	// Provides additional Attribute information to aid content managers configure Product details.
	InputTip *LocalizedString `json:"inputTip,omitempty"`
	// Provides a visual representation directive for values of this Attribute (only relevant for [AttributeTextType](ctp:api:type:AttributeTextType) and [AttributeLocalizableTextType](ctp:api:type:AttributeLocalizableTextType)).
	InputHint TextInputHint `json:"inputHint"`
	// If `true`, the Attribute's values are available for the [Product Projections Search API](/../api/projects/products-search) for use in full-text search queries, filters, and facets.
	//
	// Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
	// The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).
	// This constraint is enforced at both [Product creation](ctp:api:endpoint:/{projectKey}/products:POST) and [Product update](/../api/projects/products#update-product).
	// If the length of the input exceeds the maximum size, an [InvalidField](ctp:api:type:InvalidFieldError) error is returned.
	IsSearchable bool `json:"isSearchable"`
}

* * Describes a Product Attribute and allows you to define meta-information associated with the Attribute (like whether it should be searchable, or its constraints). *

func (*AttributeDefinition) UnmarshalJSON ¶ 

func (obj *AttributeDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AttributeDefinitionAlreadyExistsError ¶ 

type AttributeDefinitionAlreadyExistsError struct {
	// `"An attribute definition with name $attributeName already exists on product type $productTypeName."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of the Product Type containing the conflicting name.
	ConflictingProductTypeId string `json:"conflictingProductTypeId"`
	// Name of the Product Type containing the conflicting name.
	ConflictingProductTypeName string `json:"conflictingProductTypeName"`
	// Name of the conflicting Attribute.
	ConflictingAttributeName string `json:"conflictingAttributeName"`
}

* * Returned when the `name` of the AttributeDefinition(ctp:api:type:AttributeDefinition) conflicts with an existing Attribute. * * The error is returned as a failed response to the [Create ProductType](ctp:api:endpoint:/{projectKey}/product-types:POST) request or [Change AttributeDefinition Name](ctp:api:type:ProductTypeChangeAttributeNameAction) update action. *

func (*AttributeDefinitionAlreadyExistsError) DecodeStruct ¶ added in v1.1.0 

func (obj *AttributeDefinitionAlreadyExistsError) DecodeStruct(src map[string]interface{}) error

func (AttributeDefinitionAlreadyExistsError) Error ¶ 

func (obj AttributeDefinitionAlreadyExistsError) Error() string

func (AttributeDefinitionAlreadyExistsError) MarshalJSON ¶ 

func (obj AttributeDefinitionAlreadyExistsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AttributeDefinitionAlreadyExistsError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *AttributeDefinitionAlreadyExistsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AttributeDefinitionDraft ¶ 

type AttributeDefinitionDraft struct {
	// Describes the Type of the Attribute.
	//
	// When the `type` is different for an AttributeDefinition using the same name in multiple ProductTypes, an [AttributeDefinitionTypeConflict](ctp:api:type:AttributeDefinitionTypeConflictError) error is returned.
	Type AttributeType `json:"type"`
	// User-defined name of the Attribute that is unique with the [Project](ctp:api:type:Project).
	//
	// When using the same `name` for an Attribute in multiple ProductTypes, all fields of the AttributeDefinition of this Attribute must be the same across the ProductTypes, else an [AttributeDefinitionAlreadyExists](ctp:api:type:AttributeDefinitionAlreadyExistsError) error is returned.
	// An exception to this are the values of an `enum` or `lenum` Type and sets thereof.
	Name string `json:"name"`
	// Human-readable label for the Attribute.
	Label LocalizedString `json:"label"`
	// Set to `true` if the Attribute is required to have a value on a [ProductVariant](ctp:api:type:ProductVariant).
	IsRequired bool `json:"isRequired"`
	// Specifies how an Attribute or a combination of Attributes should be validated across all variants of a Product.
	AttributeConstraint *AttributeConstraintEnum `json:"attributeConstraint,omitempty"`
	// Provides additional information about the Attribute that aids content managers when setting Product details.
	InputTip *LocalizedString `json:"inputTip,omitempty"`
	// Provides a visual representation directive for values of this Attribute (only relevant for [AttributeTextType](ctp:api:type:AttributeTextType) and [AttributeLocalizableTextType](ctp:api:type:AttributeLocalizableTextType)).
	InputHint *TextInputHint `json:"inputHint,omitempty"`
	// Set to `true` if the Attribute's values should be available in the [Product Projections Search API](/../api/projects/products-search) and can be used in full-text search queries, filters, and facets.
	// Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
	// The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).
	// This constraint is enforced at both Product creation and Product update.
	// If the length of the input exceeds the maximum size, an InvalidField error is returned.
	IsSearchable *bool `json:"isSearchable,omitempty"`
}

* * Specify the Attribute to be created with the ProductTypeDraft(ctp:api:type:ProductTypeDraft). *

func (*AttributeDefinitionDraft) UnmarshalJSON ¶ 

func (obj *AttributeDefinitionDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AttributeDefinitionTypeConflictError ¶ 

type AttributeDefinitionTypeConflictError struct {
	// `"The attribute with name $attributeName has a different type on product type $productTypeName."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of the Product Type containing the conflicting name.
	ConflictingProductTypeId string `json:"conflictingProductTypeId"`
	// Name of the Product Type containing the conflicting name.
	ConflictingProductTypeName string `json:"conflictingProductTypeName"`
	// Name of the conflicting Attribute.
	ConflictingAttributeName string `json:"conflictingAttributeName"`
}

* * Returned when the `type` is different for an AttributeDefinition using the same `name` in multiple Product Types. * * The error is returned as a failed response to the [Create ProductType](ctp:api:endpoint:/{projectKey}/product-types:POST) request. *

func (*AttributeDefinitionTypeConflictError) DecodeStruct ¶ added in v1.1.0 

func (obj *AttributeDefinitionTypeConflictError) DecodeStruct(src map[string]interface{}) error

func (AttributeDefinitionTypeConflictError) Error ¶ 

func (obj AttributeDefinitionTypeConflictError) Error() string

func (AttributeDefinitionTypeConflictError) MarshalJSON ¶ 

func (obj AttributeDefinitionTypeConflictError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AttributeDefinitionTypeConflictError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *AttributeDefinitionTypeConflictError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AttributeEnumType ¶ 

type AttributeEnumType struct {
	// Available values that can be assigned to Products.
	Values []AttributePlainEnumValue `json:"values"`
}

* * Attribute type for plain enum values. Useful for predefined language-agnostic values selectable in drop downs when only one value should be selected. Use AttributeSetType(ctp:api:type:AttributeSetType) of AttributeEnumType instead if multiple values can be selected from the list. *

func (AttributeEnumType) MarshalJSON ¶ 

func (obj AttributeEnumType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeGroup ¶ added in v1.2.0 

type AttributeGroup struct {
	// Platform-generated unique identifier of the AttributeGroup.
	ID string `json:"id"`
	// Current version of the AttributeGroup.
	Version int `json:"version"`
	// Date and time (UTC) the AttributeGroup was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the AttributeGroup was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Name of the AttributeGroup.
	Name LocalizedString `json:"name"`
	// Description of the AttributeGroup.
	Description *LocalizedString `json:"description,omitempty"`
	// [Attributes](ctp:api:type:AttributeDefinition) with unique values.
	Attributes []AttributeReference `json:"attributes"`
	// User-defined unique identifier of the AttributeGroup.
	Key *string `json:"key,omitempty"`
}

type AttributeGroupAddAttributeAction ¶ added in v1.2.0 

type AttributeGroupAddAttributeAction struct {
	// Value to add.
	Attribute AttributeReference `json:"attribute"`
}

func (AttributeGroupAddAttributeAction) MarshalJSON ¶ added in v1.2.0 

func (obj AttributeGroupAddAttributeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeGroupChangeNameAction ¶ added in v1.2.0 

type AttributeGroupChangeNameAction struct {
	// New value to set.
	// Must not be empty.
	Name LocalizedString `json:"name"`
}

func (AttributeGroupChangeNameAction) MarshalJSON ¶ added in v1.2.0 

func (obj AttributeGroupChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeGroupDraft ¶ added in v1.2.0 

type AttributeGroupDraft struct {
	// Name of the AttributeGroup.
	Name LocalizedString `json:"name"`
	// Description of the AttributeGroup.
	Description *LocalizedString `json:"description,omitempty"`
	// [Attributes](ctp:api:type:AttributeDefinition) with unique values.
	Attributes []AttributeReference `json:"attributes"`
	// User-defined unique identifier for the AttributeGroup.
	Key *string `json:"key,omitempty"`
}

type AttributeGroupPagedQueryResponse ¶ added in v1.2.0 

type AttributeGroupPagedQueryResponse struct {
	// Number of results requested in the query request.
	Limit int `json:"limit"`
	// Offset supplied by the client or the server default.
	// It is the number of elements skipped, not a page number.
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [AttributeGroups](ctp:api:type:AttributeGroup) matching the query.
	Results []AttributeGroup `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of AttributeGroup(ctp:api:type:AttributeGroup). *

type AttributeGroupReference ¶ added in v1.2.0 

type AttributeGroupReference struct {
	// Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup).
	ID string `json:"id"`
	// Contains the representation of the expanded AttributeGroup. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for AttributeGroup.
	Obj *AttributeGroup `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to an AttributeGroup(ctp:api:type:AttributeGroup). *

func (AttributeGroupReference) MarshalJSON ¶ added in v1.2.0 

func (obj AttributeGroupReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeGroupRemoveAttributeAction ¶ added in v1.2.0 

type AttributeGroupRemoveAttributeAction struct {
	// Value to remove.
	Attribute AttributeReference `json:"attribute"`
}

func (AttributeGroupRemoveAttributeAction) MarshalJSON ¶ added in v1.2.0 

func (obj AttributeGroupRemoveAttributeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeGroupResourceIdentifier ¶ added in v1.2.0 

type AttributeGroupResourceIdentifier struct {
	// Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to an AttributeGroup(ctp:api:type:AttributeGroup). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (AttributeGroupResourceIdentifier) MarshalJSON ¶ added in v1.2.0 

func (obj AttributeGroupResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeGroupSetAttributesAction ¶ added in v1.2.0 

type AttributeGroupSetAttributesAction struct {
	// New unique values to set.
	Attributes []AttributeReference `json:"attributes"`
}

func (AttributeGroupSetAttributesAction) MarshalJSON ¶ added in v1.2.0 

func (obj AttributeGroupSetAttributesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeGroupSetDescriptionAction ¶ added in v1.2.0 

type AttributeGroupSetDescriptionAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (AttributeGroupSetDescriptionAction) MarshalJSON ¶ added in v1.2.0 

func (obj AttributeGroupSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeGroupSetKeyAction ¶ added in v1.2.0 

type AttributeGroupSetKeyAction struct {
	// If `key` is absent or `null`, the existing key, if any, will be removed.
	Key *string `json:"key,omitempty"`
}

func (AttributeGroupSetKeyAction) MarshalJSON ¶ added in v1.2.0 

func (obj AttributeGroupSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeGroupUpdate ¶ added in v1.2.0 

type AttributeGroupUpdate struct {
	// Expected version of the AttributeGroup on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the AttributeGroup.
	Actions []AttributeGroupUpdateAction `json:"actions"`
}

func (*AttributeGroupUpdate) UnmarshalJSON ¶ added in v1.2.0 

func (obj *AttributeGroupUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AttributeGroupUpdateAction ¶ added in v1.2.0 

type AttributeGroupUpdateAction interface{}

type AttributeLocalizableTextType ¶ 

type AttributeLocalizableTextType struct {
}

* * Attribute type for LocalizedString(ctp:api:type:LocalizedString) values. *

func (AttributeLocalizableTextType) MarshalJSON ¶ 

func (obj AttributeLocalizableTextType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeLocalizedEnumType ¶ 

type AttributeLocalizedEnumType struct {
	// Available values that can be assigned to Products.
	Values []AttributeLocalizedEnumValue `json:"values"`
}

* * Attribute type for localized enum values. Useful for predefined language-specific values selectable in drop-down menus if only one value can be selected. Use AttributeSetType(ctp:api:type:AttributeSetType) of AttributeLocalizedEnumValue instead if multiple values can be selected. *

func (AttributeLocalizedEnumType) MarshalJSON ¶ 

func (obj AttributeLocalizedEnumType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeLocalizedEnumValue ¶ 

type AttributeLocalizedEnumValue struct {
	// Key of the value used as a programmatic identifier, for example in facets & filters.
	Key string `json:"key"`
	// Descriptive, localized label of the value.
	Label LocalizedString `json:"label"`
}

* * A localized enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned. *

type AttributeMoneyType ¶ 

type AttributeMoneyType struct {
}

func (AttributeMoneyType) MarshalJSON ¶ 

func (obj AttributeMoneyType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeNameDoesNotExistError ¶ 

type AttributeNameDoesNotExistError struct {
	// `"Attribute definition for $attributeName does not exist on type $typeName."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Non-existent Attribute name.
	InvalidAttributeName string `json:"invalidAttributeName"`
}

* * Returned when an AttributeDefinition(ctp:api:type:AttributeDefinition) does not exist for an Attribute `name`. * * The error is returned as a failed response to the [Change AttributeDefinition Name](ctp:api:type:ProductTypeChangeAttributeNameAction) update action. *

func (*AttributeNameDoesNotExistError) DecodeStruct ¶ added in v1.1.0 

func (obj *AttributeNameDoesNotExistError) DecodeStruct(src map[string]interface{}) error

func (AttributeNameDoesNotExistError) Error ¶ 

func (obj AttributeNameDoesNotExistError) Error() string

func (AttributeNameDoesNotExistError) MarshalJSON ¶ 

func (obj AttributeNameDoesNotExistError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AttributeNameDoesNotExistError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *AttributeNameDoesNotExistError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AttributeNestedType ¶ 

type AttributeNestedType struct {
	// Attributes that can be stored as nested Attributes of the current Attribute.
	TypeReference ProductTypeReference `json:"typeReference"`
}

* * Attribute type for nesting Attributes based on some existing ProductType. It does not support `isSearchable` and is not supported in queries. The only supported AttributeConstraint is `None`. *

func (AttributeNestedType) MarshalJSON ¶ 

func (obj AttributeNestedType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeNumberType ¶ 

type AttributeNumberType struct {
}

func (AttributeNumberType) MarshalJSON ¶ 

func (obj AttributeNumberType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributePlainEnumValue ¶ 

type AttributePlainEnumValue struct {
	// Key of the value used as a programmatic identifier, for example in facets & filters.
	Key string `json:"key"`
	// Descriptive label of the value.
	Label string `json:"label"`
}

* * A plain enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned. *

type AttributeReference ¶ added in v1.2.0 

type AttributeReference struct {
	// The Attribute's `name` as given in its [AttributeDefinition](ctp:api:type:AttributeDefinition).
	Key string `json:"key"`
}

type AttributeReferenceType ¶ 

type AttributeReferenceType struct {
	// Name of the resource type that the value should reference.
	ReferenceTypeId AttributeReferenceTypeId `json:"referenceTypeId"`
}

func (AttributeReferenceType) MarshalJSON ¶ 

func (obj AttributeReferenceType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeReferenceTypeId ¶ added in v1.2.0 

type AttributeReferenceTypeId string

* * Name of the resource type that the value should reference. Supported resource type identifiers: * 

const (
	AttributeReferenceTypeIdAssociateRole    AttributeReferenceTypeId = "associate-role"
	AttributeReferenceTypeIdBusinessUnit     AttributeReferenceTypeId = "business-unit"
	AttributeReferenceTypeIdCart             AttributeReferenceTypeId = "cart"
	AttributeReferenceTypeIdCartDiscount     AttributeReferenceTypeId = "cart-discount"
	AttributeReferenceTypeIdCategory         AttributeReferenceTypeId = "category"
	AttributeReferenceTypeIdChannel          AttributeReferenceTypeId = "channel"
	AttributeReferenceTypeIdCustomer         AttributeReferenceTypeId = "customer"
	AttributeReferenceTypeIdKeyValueDocument AttributeReferenceTypeId = "key-value-document"
	AttributeReferenceTypeIdOrder            AttributeReferenceTypeId = "order"
	AttributeReferenceTypeIdProduct          AttributeReferenceTypeId = "product"
	AttributeReferenceTypeIdProductType      AttributeReferenceTypeId = "product-type"
	AttributeReferenceTypeIdReview           AttributeReferenceTypeId = "review"
	AttributeReferenceTypeIdShippingMethod   AttributeReferenceTypeId = "shipping-method"
	AttributeReferenceTypeIdState            AttributeReferenceTypeId = "state"
	AttributeReferenceTypeIdZone             AttributeReferenceTypeId = "zone"
)

type AttributeSetType ¶ 

type AttributeSetType struct {
	// Attribute type of the elements in the set.
	ElementType AttributeType `json:"elementType"`
}

* * AttributeType that defines a set (without duplicate elements) with values of the given `elementType`. It does not support `isRequired`. Since this type itself is an AttributeType, it is possible to construct an AttributeSetType of an AttributeSetType of any AttributeType, and to continue with this iteration until terminating with any non-AttributeSetType. In case the AttributeSetType iteration terminates with an AttributeNestedType(ctp:api:type:AttributeNestedType), the iteration can have 5 steps at maximum. *

func (AttributeSetType) MarshalJSON ¶ 

func (obj AttributeSetType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*AttributeSetType) UnmarshalJSON ¶ 

func (obj *AttributeSetType) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AttributeTextType ¶ 

type AttributeTextType struct {
}

* * Attribute type for plain text values. *

func (AttributeTextType) MarshalJSON ¶ 

func (obj AttributeTextType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeTimeType ¶ 

type AttributeTimeType struct {
}

func (AttributeTimeType) MarshalJSON ¶ 

func (obj AttributeTimeType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeType ¶ 

type AttributeType interface{}

* * Umbrella type for specific attribute types discriminated by property `name`.

type AuthErrorResponse ¶ added in v1.2.0 

type AuthErrorResponse struct {
	// HTTP status code corresponding to the error.
	StatusCode int `json:"statusCode"`
	// First error message in the `errors` array.
	Message string `json:"message"`
	// Authentication and authorization-related errors returned for a request.
	Errors []ErrorObject `json:"errors"`
	// Error code as per the [OAuth 2.0 specification](https://datatracker.ietf.org/doc/html/rfc6749#section-5.2). For example: `"access_denied"`.
	ErrorMessage string `json:"error"`
	// Plain text description of the first error.
	ErrorDescription *string `json:"error_description,omitempty"`
}

* * Represents errors related to authentication and authorization in a format conforming to the [OAuth 2.0 specification](https://datatracker.ietf.org/doc/html/rfc6749#section-5.2). *

func (AuthErrorResponse) Error ¶ added in v1.2.0 

func (obj AuthErrorResponse) Error() string

func (*AuthErrorResponse) UnmarshalJSON ¶ added in v1.2.0 

func (obj *AuthErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type AuthenticationMode ¶ 

type AuthenticationMode string
const (
	AuthenticationModePassword     AuthenticationMode = "Password"
	AuthenticationModeExternalAuth AuthenticationMode = "ExternalAuth"
)

type AuthorizationHeaderAuthentication ¶ 

type AuthorizationHeaderAuthentication struct {
	// Partially hidden on retrieval for security reasons.
	HeaderValue string `json:"headerValue"`
}

* * The `Authorization` header will be set to the content of `headerValue`. The authentication scheme (such as `Basic` or `Bearer`) should be included in the `headerValue`. * * For example, the `headerValue` for [Basic Authentication](https://datatracker.ietf.org/doc/html/rfc7617) should be set to `Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==`. *

func (AuthorizationHeaderAuthentication) MarshalJSON ¶ 

func (obj AuthorizationHeaderAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AwsAuthenticationMode ¶ added in v1.2.0 

type AwsAuthenticationMode string

* * Defines the method of authentication for AWS SQS and SNS Destinations. 

const (
	AwsAuthenticationModeCredentials AwsAuthenticationMode = "Credentials"
	AwsAuthenticationModeIAM         AwsAuthenticationMode = "IAM"
)

type AzureEventGridDestination ¶ 

type AzureEventGridDestination struct {
	// URI of the topic.
	Uri string `json:"uri"`
	// Partially hidden on retrieval for security reasons.
	AccessKey string `json:"accessKey"`
}

* * [Azure Event Grid](https://azure.microsoft.com/en-us/products/event-grid/) can be used to push messages to Azure Functions, HTTP endpoints (webhooks), and several other Azure tools. Event Grid can only be used with the CloudEventsFormat(ctp:api:type:CloudEventsFormat). * To set up a Subscription with Azure Event Grid, first create a topic in the [Azure Portal](https://azure.microsoft.com/en-us/get-started/azure-portal/). To allow Composable Commerce to push messages to your topic, provide an [access key](https://docs.microsoft.com/en-us/azure/event-grid/get-access-keys). *

func (AzureEventGridDestination) MarshalJSON ¶ 

func (obj AzureEventGridDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AzureFunctionsAuthentication ¶ 

type AzureFunctionsAuthentication struct {
	// Partially hidden on retrieval for security reasons.
	Key string `json:"key"`
}

* * To protect your Azure Function, set its `authLevel` to `function` and provide the function's key to be used inside the `x-functions-key` header. For more information, see the [Azure Functions documentation](https://docs.microsoft.com/en-us/azure/azure-functions/functions-bindings-http-webhook#keys). * * To protect the secret key from being exposed, remove the code parameter and secret key from the URL. For example, use `https://foo.azurewebsites.net/api/bar` instead of * `https://foo.azurewebsites.net/api/bar?code=secret`. *

func (AzureFunctionsAuthentication) MarshalJSON ¶ 

func (obj AzureFunctionsAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AzureServiceBusDestination ¶ 

type AzureServiceBusDestination struct {
	// SharedAccessKey is partially hidden on retrieval for security reasons.
	ConnectionString string `json:"connectionString"`
}

* * [Azure Service Bus](https://azure.microsoft.com/en-us/products/service-bus/) can be used as a pull-queue with [Queues](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-queues-topics-subscriptions#queues), or to fan-out messages with [Topics and Subscriptions](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-queues-topics-subscriptions). * To set up a Subscription with Azure Service Bus, first create a queue/topic in the [Azure Portal](https://azure.microsoft.com/en-us/get-started/azure-portal/) with a Shared Access Policy including the `Send` permission. *

func (AzureServiceBusDestination) MarshalJSON ¶ 

func (obj AzureServiceBusDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

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 ¶ added in v1.1.0 

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 ¶ added in v1.1.0 

func (obj *BadGatewayError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BaseAddress ¶ 

type BaseAddress struct {
	// Unique identifier of the Address.
	//
	// It is not recommended to set it manually since the API overwrites this ID when creating an Address for a [Customer](ctp:api:type:Customer).
	// Use `key` instead and omit this field from the request to let the API generate the ID for the Address.
	ID *string `json:"id,omitempty"`
	// User-defined identifier of the Address that must be unique when multiple addresses are referenced in [BusinessUnits](ctp:api:type:BusinessUnit), [Customers](ctp:api:type:Customer), and `itemShippingAddresses` (LineItem-specific addresses) of a [Cart](ctp:api:type:Cart), [Order](ctp:api:type:Order), [QuoteRequest](ctp:api:type:QuoteRequest), or [Quote](ctp:api:type:Quote).
	Key *string `json:"key,omitempty"`
	// Name of the country.
	Country string `json:"country"`
	// Title of the contact, for example 'Dr.'
	Title *string `json:"title,omitempty"`
	// Salutation of the contact, for example 'Mr.' or 'Ms.'
	Salutation *string `json:"salutation,omitempty"`
	// Given name (first name) of the contact.
	FirstName *string `json:"firstName,omitempty"`
	// Family name (last name) of the contact.
	LastName *string `json:"lastName,omitempty"`
	// Name of the street.
	StreetName *string `json:"streetName,omitempty"`
	// Street number.
	StreetNumber *string `json:"streetNumber,omitempty"`
	// Further information on the street address.
	AdditionalStreetInfo *string `json:"additionalStreetInfo,omitempty"`
	// Postal code.
	PostalCode *string `json:"postalCode,omitempty"`
	// Name of the city.
	City *string `json:"city,omitempty"`
	// Name of the region.
	Region *string `json:"region,omitempty"`
	// Name of the state, for example, Colorado.
	State *string `json:"state,omitempty"`
	// Name of the company.
	Company *string `json:"company,omitempty"`
	// Name of the department.
	Department *string `json:"department,omitempty"`
	// Number or name of the building.
	Building *string `json:"building,omitempty"`
	// Number or name of the apartment.
	Apartment *string `json:"apartment,omitempty"`
	// Post office box number.
	POBox *string `json:"pOBox,omitempty"`
	// Phone number of the contact.
	Phone *string `json:"phone,omitempty"`
	// Mobile phone number of the contact.
	Mobile *string `json:"mobile,omitempty"`
	// Email address of the contact.
	Email *string `json:"email,omitempty"`
	// Fax number of the contact.
	Fax *string `json:"fax,omitempty"`
	// Further information on the Address.
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`
	// ID for the contact used in an external system.
	ExternalId *string `json:"externalId,omitempty"`
}

* * Polymorphic base type that represents a postal address and contact details. * Depending on the read or write action, it can be either Address(ctp:api:type:Address) or AddressDraft(ctp:api:type:AddressDraft) that * only differ in the data type for the optional `custom` field. *

type BaseResource ¶ 

type BaseResource struct {
	ID             string    `json:"id"`
	Version        int       `json:"version"`
	CreatedAt      time.Time `json:"createdAt"`
	LastModifiedAt time.Time `json:"lastModifiedAt"`
}

type BusinessUnit ¶ added in v1.2.0 

type BusinessUnit interface{}

* * Generic type to model the fields that all types of Business Units have in common. *

type BusinessUnitAddAddressAction ¶ added in v1.2.0 

type BusinessUnitAddAddressAction struct {
	// Address to add to the addresses of the [Business Unit](ctp:api:type:BusinessUnit).
	Address BaseAddress `json:"address"`
}

* * Adding an address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAddressAdded](ctp:api:type:BusinessUnitAddressAddedMessage) Message. *

func (BusinessUnitAddAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddAssociateAction ¶ added in v1.2.0 

type BusinessUnitAddAssociateAction struct {
	// The Associate to add.
	Associate AssociateDraft `json:"associate"`
}

* * Adding an Associate to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAssociateAdded](ctp:api:type:BusinessUnitAssociateAddedMessage) Message. *

func (BusinessUnitAddAssociateAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddAssociateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddBillingAddressIdAction ¶ added in v1.2.0 

type BusinessUnitAddBillingAddressIdAction struct {
	// ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to add as a billing address. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Adding a billing address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressAdded](ctp:api:type:BusinessUnitBillingAddressAddedMessage) Message. *

func (BusinessUnitAddBillingAddressIdAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddBillingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddShippingAddressIdAction ¶ added in v1.2.0 

type BusinessUnitAddShippingAddressIdAction struct {
	// ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Adding a shipping address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressAdded](ctp:api:type:BusinessUnitShippingAddressAddedMessage) Message. *

func (BusinessUnitAddShippingAddressIdAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddShippingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddStoreAction ¶ added in v1.2.0 

type BusinessUnitAddStoreAction struct {
	// [Store](ctp:api:type:Store) to add.
	Store StoreResourceIdentifier `json:"store"`
}

* * Adding a Store(ctp:api:type:Store) to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitStoreAdded](ctp:api:type:BusinessUnitStoreAddedMessage) Message. * Only applicable when `storeMode` is `Explicit`. *

func (BusinessUnitAddStoreAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddStoreAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddressAddedMessage ¶ added in v1.2.0 

type BusinessUnitAddressAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The address that was added to the [Business Unit](ctp:api:type:BusinessUnit).
	Address Address `json:"address"`
}

* * Generated after a successful [Add Address](ctp:api:type:BusinessUnitAddAddressAction) update action. *

func (BusinessUnitAddressAddedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddressAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAddressAddedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitAddressAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAddressAddedMessagePayload ¶ added in v1.2.0 

type BusinessUnitAddressAddedMessagePayload struct {
	// The address that was added to the [Business Unit](ctp:api:type:BusinessUnit).
	Address Address `json:"address"`
}

* * Generated after a successful [Add Address](ctp:api:type:BusinessUnitAddAddressAction) update action. *

func (BusinessUnitAddressAddedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddressAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddressChangedMessage ¶ added in v1.2.0 

type BusinessUnitAddressChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Updated address of the Business Unit.
	Address Address `json:"address"`
}

* * Generated after a successful [Change Address](ctp:api:type:BusinessUnitChangeAddressAction) update action. *

func (BusinessUnitAddressChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddressChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAddressChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitAddressChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAddressChangedMessagePayload ¶ added in v1.2.0 

type BusinessUnitAddressChangedMessagePayload struct {
	// Updated address of the Business Unit.
	Address Address `json:"address"`
}

* * Generated after a successful [Change Address](ctp:api:type:BusinessUnitChangeAddressAction) update action. *

func (BusinessUnitAddressChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddressChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddressCustomFieldAddedMessage ¶ added in v1.4.0 

type BusinessUnitAddressCustomFieldAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. If a Custom Field already exists with the same name, a [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message is generated instead. *

func (BusinessUnitAddressCustomFieldAddedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomFieldAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAddressCustomFieldAddedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitAddressCustomFieldAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAddressCustomFieldAddedMessagePayload ¶ added in v1.4.0 

type BusinessUnitAddressCustomFieldAddedMessagePayload struct {
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. If a Custom Field already exists with the same name, a [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message is generated instead. *

func (BusinessUnitAddressCustomFieldAddedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomFieldAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddressCustomFieldChangedMessage ¶ added in v1.4.0 

type BusinessUnitAddressCustomFieldChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
	OldValue interface{} `json:"oldValue,omitempty"`
}

* * Generated after changing an existing Custom Field on an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. *

func (BusinessUnitAddressCustomFieldChangedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomFieldChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAddressCustomFieldChangedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitAddressCustomFieldChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAddressCustomFieldChangedMessagePayload ¶ added in v1.4.0 

type BusinessUnitAddressCustomFieldChangedMessagePayload struct {
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
	OldValue interface{} `json:"oldValue,omitempty"`
}

* * Generated after changing an existing Custom Field on an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. *

func (BusinessUnitAddressCustomFieldChangedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomFieldChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddressCustomFieldRemovedMessage ¶ added in v1.4.0 

type BusinessUnitAddressCustomFieldRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. *

func (BusinessUnitAddressCustomFieldRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomFieldRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAddressCustomFieldRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitAddressCustomFieldRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAddressCustomFieldRemovedMessagePayload ¶ added in v1.4.0 

type BusinessUnitAddressCustomFieldRemovedMessagePayload struct {
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. *

func (BusinessUnitAddressCustomFieldRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomFieldRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddressCustomTypeRemovedMessage ¶ added in v1.4.0 

type BusinessUnitAddressCustomTypeRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after removing a Custom Type from an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action. *

func (BusinessUnitAddressCustomTypeRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomTypeRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAddressCustomTypeRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitAddressCustomTypeRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAddressCustomTypeRemovedMessagePayload ¶ added in v1.4.0 

type BusinessUnitAddressCustomTypeRemovedMessagePayload struct {
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after removing a Custom Type from an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action. *

func (BusinessUnitAddressCustomTypeRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomTypeRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddressCustomTypeSetMessage ¶ added in v1.4.0 

type BusinessUnitAddressCustomTypeSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Custom Fields that were set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after adding a Custom Type to an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action. *

func (BusinessUnitAddressCustomTypeSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomTypeSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAddressCustomTypeSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitAddressCustomTypeSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAddressCustomTypeSetMessagePayload ¶ added in v1.4.0 

type BusinessUnitAddressCustomTypeSetMessagePayload struct {
	// The Custom Fields that were set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after adding a Custom Type to an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action. *

func (BusinessUnitAddressCustomTypeSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitAddressCustomTypeSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAddressRemovedMessage ¶ added in v1.2.0 

type BusinessUnitAddressRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The address that was removed from the [Business Unit](ctp:api:type:BusinessUnit).
	Address Address `json:"address"`
}

* * Generated after a successful [Remove Address](ctp:api:type:BusinessUnitRemoveAddressAction) update action. *

func (BusinessUnitAddressRemovedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddressRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAddressRemovedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitAddressRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAddressRemovedMessagePayload ¶ added in v1.2.0 

type BusinessUnitAddressRemovedMessagePayload struct {
	// The address that was removed from the [Business Unit](ctp:api:type:BusinessUnit).
	Address Address `json:"address"`
}

* * Generated after a successful [Remove Address](ctp:api:type:BusinessUnitRemoveAddressAction) update action. *

func (BusinessUnitAddressRemovedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAddressRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAssociateAddedMessage ¶ added in v1.2.0 

type BusinessUnitAssociateAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Associate](ctp:api:type:Associate) that was added to the [Business Unit](ctp:api:type:BusinessUnit).
	Associate Associate `json:"associate"`
}

* * Generated after a successful [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action. *

func (BusinessUnitAssociateAddedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAssociateAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAssociateAddedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitAssociateAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAssociateAddedMessagePayload ¶ added in v1.2.0 

type BusinessUnitAssociateAddedMessagePayload struct {
	// The [Associate](ctp:api:type:Associate) that was added to the [Business Unit](ctp:api:type:BusinessUnit).
	Associate Associate `json:"associate"`
}

* * Generated after a successful [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action. *

func (BusinessUnitAssociateAddedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAssociateAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAssociateChangedMessage ¶ added in v1.2.0 

type BusinessUnitAssociateChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Associate](ctp:api:type:Associate) that was updated.
	Associate Associate `json:"associate"`
}

* * Generated after a successful [Change Associate](ctp:api:type:BusinessUnitChangeAssociateAction) update action. *

func (BusinessUnitAssociateChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAssociateChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAssociateChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitAssociateChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAssociateChangedMessagePayload ¶ added in v1.2.0 

type BusinessUnitAssociateChangedMessagePayload struct {
	// The [Associate](ctp:api:type:Associate) that was updated.
	Associate Associate `json:"associate"`
}

* * Generated after a successful [Change Associate](ctp:api:type:BusinessUnitChangeAssociateAction) update action. *

func (BusinessUnitAssociateChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAssociateChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAssociateMode ¶ added in v1.3.0 

type BusinessUnitAssociateMode string

* * Determines whether a Business Unit can inherit Associates from a parent. * 

const (
	BusinessUnitAssociateModeExplicit              BusinessUnitAssociateMode = "Explicit"
	BusinessUnitAssociateModeExplicitAndFromParent BusinessUnitAssociateMode = "ExplicitAndFromParent"
)

type BusinessUnitAssociateModeChangedMessage ¶ added in v1.3.0 

type BusinessUnitAssociateModeChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [BusinessUnitAssociateMode](ctp:api:type:BusinessUnitAssociateMode) of the Business Unit after the [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action.
	AssociateMode BusinessUnitAssociateMode `json:"associateMode"`
	// [BusinessUnitAssociateMode](ctp:api:type:BusinessUnitAssociateMode) of the Business Unit before the [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action.
	OldAssociateMode BusinessUnitAssociateMode `json:"oldAssociateMode"`
}

* * Generated after a successful [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action. *

func (BusinessUnitAssociateModeChangedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj BusinessUnitAssociateModeChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAssociateModeChangedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *BusinessUnitAssociateModeChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAssociateModeChangedMessagePayload ¶ added in v1.3.0 

type BusinessUnitAssociateModeChangedMessagePayload struct {
	// [BusinessUnitAssociateMode](ctp:api:type:BusinessUnitAssociateMode) of the Business Unit after the [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action.
	AssociateMode BusinessUnitAssociateMode `json:"associateMode"`
	// [BusinessUnitAssociateMode](ctp:api:type:BusinessUnitAssociateMode) of the Business Unit before the [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action.
	OldAssociateMode BusinessUnitAssociateMode `json:"oldAssociateMode"`
}

* * Generated after a successful [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action. *

func (BusinessUnitAssociateModeChangedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj BusinessUnitAssociateModeChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAssociateRemovedMessage ¶ added in v1.2.0 

type BusinessUnitAssociateRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Associate](ctp:api:type:Associate) that was removed from the [Business Unit](ctp:api:type:BusinessUnit).
	Associate Associate `json:"associate"`
}

* * Generated after a successful [Remove Associate](ctp:api:type:BusinessUnitRemoveAssociateAction) update action. *

func (BusinessUnitAssociateRemovedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAssociateRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAssociateRemovedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitAssociateRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAssociateRemovedMessagePayload ¶ added in v1.2.0 

type BusinessUnitAssociateRemovedMessagePayload struct {
	// The [Associate](ctp:api:type:Associate) that was removed from the [Business Unit](ctp:api:type:BusinessUnit).
	Associate Associate `json:"associate"`
}

* * Generated after a successful [Remove Associate](ctp:api:type:BusinessUnitRemoveAssociateAction) update action. *

func (BusinessUnitAssociateRemovedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAssociateRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitAssociatesSetMessage ¶ added in v1.2.0 

type BusinessUnitAssociatesSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The list of [Associates](ctp:api:type:Associate) that was updated on the [Business Unit](ctp:api:type:BusinessUnit).
	Associates []Associate `json:"associates"`
}

* * Generated after a successful [Set Associates](ctp:api:type:BusinessUnitSetAssociatesAction) update action. *

func (BusinessUnitAssociatesSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAssociatesSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitAssociatesSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitAssociatesSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitAssociatesSetMessagePayload ¶ added in v1.2.0 

type BusinessUnitAssociatesSetMessagePayload struct {
	// The list of [Associates](ctp:api:type:Associate) that was updated on the [Business Unit](ctp:api:type:BusinessUnit).
	Associates []Associate `json:"associates"`
}

* * Generated after a successful [Set Associates](ctp:api:type:BusinessUnitSetAssociatesAction) update action. *

func (BusinessUnitAssociatesSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitAssociatesSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitBillingAddressAddedMessage ¶ added in v1.2.0 

type BusinessUnitBillingAddressAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The address that was added to the [Business Unit](ctp:api:type:BusinessUnit) as billing address.
	Address Address `json:"address"`
}

* * Generated after a successful [Add Billing Address Identifier](ctp:api:type:BusinessUnitAddBillingAddressIdAction) update action. *

func (BusinessUnitBillingAddressAddedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitBillingAddressAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitBillingAddressAddedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitBillingAddressAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitBillingAddressAddedMessagePayload ¶ added in v1.2.0 

type BusinessUnitBillingAddressAddedMessagePayload struct {
	// The address that was added to the [Business Unit](ctp:api:type:BusinessUnit) as billing address.
	Address Address `json:"address"`
}

* * Generated after a successful [Add Billing Address Identifier](ctp:api:type:BusinessUnitAddBillingAddressIdAction) update action. *

func (BusinessUnitBillingAddressAddedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitBillingAddressAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitBillingAddressRemovedMessage ¶ added in v1.2.0 

type BusinessUnitBillingAddressRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The address that was removed from the billing addresses of the [Business Unit](ctp:api:type:BusinessUnit).
	Address Address `json:"address"`
}

* * Generated after a successful [Remove Billing Address Identifier](ctp:api:type:BusinessUnitRemoveBillingAddressIdAction) update action. *

func (BusinessUnitBillingAddressRemovedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitBillingAddressRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitBillingAddressRemovedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitBillingAddressRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitBillingAddressRemovedMessagePayload ¶ added in v1.2.0 

type BusinessUnitBillingAddressRemovedMessagePayload struct {
	// The address that was removed from the billing addresses of the [Business Unit](ctp:api:type:BusinessUnit).
	Address Address `json:"address"`
}

* * Generated after a successful [Remove Billing Address Identifier](ctp:api:type:BusinessUnitRemoveBillingAddressIdAction) update action. *

func (BusinessUnitBillingAddressRemovedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitBillingAddressRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitChangeAddressAction ¶ added in v1.2.0 

type BusinessUnitChangeAddressAction struct {
	// ID of the address to change. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to change. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
	// New address to set.
	Address BaseAddress `json:"address"`
}

* * Changing the address on a Business Unit generates the [BusinessUnitAddressChanged](ctp:api:type:BusinessUnitAddressChangedMessage) Message. *

func (BusinessUnitChangeAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitChangeAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitChangeAssociateAction ¶ added in v1.2.0 

type BusinessUnitChangeAssociateAction struct {
	// New version of an existing Associate.
	Associate AssociateDraft `json:"associate"`
}

* * Updating the Associate(ctp:api:type:Associate) on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAssociateChanged](ctp:api:type:BusinessUnitAssociateChangedMessage) Message. *

func (BusinessUnitChangeAssociateAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitChangeAssociateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitChangeAssociateModeAction ¶ added in v1.3.0 

type BusinessUnitChangeAssociateModeAction struct {
	// The new value for `associateMode`.
	AssociateMode BusinessUnitAssociateMode `json:"associateMode"`
}

* * Only Business Units of type `Division` can be changed to `ExplicitAndFromParent`. * This update action generates a [BusinessUnitAssociateModeChanged](ctp:api:type:BusinessUnitAssociateModeChangedMessage) Message. *

func (BusinessUnitChangeAssociateModeAction) MarshalJSON ¶ added in v1.3.0 

func (obj BusinessUnitChangeAssociateModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitChangeNameAction ¶ added in v1.2.0 

type BusinessUnitChangeNameAction struct {
	// New name to set.
	Name string `json:"name"`
}

* * Updating the name on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitNameChanged](ctp:api:type:BusinessUnitNameChangedMessage) Message. *

func (BusinessUnitChangeNameAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitChangeParentUnitAction ¶ added in v1.2.0 

type BusinessUnitChangeParentUnitAction struct {
	// New parent unit of the [Business Unit](ctp:api:type:BusinessUnit). The new parent unit must have the same top-level unit as the old parent unit.
	ParentUnit BusinessUnitResourceIdentifier `json:"parentUnit"`
}

* * Changing the parent of a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitParentChanged](ctp:api:type:BusinessUnitParentChangedMessage) Message. *

func (BusinessUnitChangeParentUnitAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitChangeParentUnitAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitChangeStatusAction ¶ added in v1.2.0 

type BusinessUnitChangeStatusAction struct {
	// New status to set.
	Status string `json:"status"`
}

* * Changing the status of a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitStatusChanged](ctp:api:type:BusinessUnitStatusChangedMessage) Message. *

func (BusinessUnitChangeStatusAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitChangeStatusAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitConfiguration ¶ added in v1.2.0 

type BusinessUnitConfiguration struct {
	// Status of Business Units created using the [My Business Unit endpoint](ctp:api:endpoint:/{projectKey}/me/business-units:POST).
	MyBusinessUnitStatusOnCreation BusinessUnitConfigurationStatus `json:"myBusinessUnitStatusOnCreation"`
	// Default [Associate Role](ctp:api:type:AssociateRole) assigned to the Associate creating a Business Unit using the [My Business Unit endpoint](ctp:api:endpoint:/{projectKey}/me/business-units:POST).
	MyBusinessUnitAssociateRoleOnCreation *AssociateRoleKeyReference `json:"myBusinessUnitAssociateRoleOnCreation,omitempty"`
}

type BusinessUnitConfigurationStatus ¶ added in v1.2.0 

type BusinessUnitConfigurationStatus string

* * Default value for [Business Unit Status](ctp:api:type:BusinessUnitStatus) configured though [Project settings](/../api/projects/project#change-my-business-unit-status-on-creation). 

const (
	BusinessUnitConfigurationStatusActive   BusinessUnitConfigurationStatus = "Active"
	BusinessUnitConfigurationStatusInactive BusinessUnitConfigurationStatus = "Inactive"
)

type BusinessUnitContactEmailSetMessage ¶ added in v1.2.0 

type BusinessUnitContactEmailSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The contact email that was updated on the [Business Unit](ctp:api:type:BusinessUnit).
	ContactEmail *string `json:"contactEmail,omitempty"`
}

* * Generated after a successful [Set Contact Email](ctp:api:type:BusinessUnitSetContactEmailAction) update action. *

func (BusinessUnitContactEmailSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitContactEmailSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitContactEmailSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitContactEmailSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitContactEmailSetMessagePayload ¶ added in v1.2.0 

type BusinessUnitContactEmailSetMessagePayload struct {
	// The contact email that was updated on the [Business Unit](ctp:api:type:BusinessUnit).
	ContactEmail *string `json:"contactEmail,omitempty"`
}

* * Generated after a successful [Set Contact Email](ctp:api:type:BusinessUnitSetContactEmailAction) update action. *

func (BusinessUnitContactEmailSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitContactEmailSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitCreatedMessage ¶ added in v1.2.0 

type BusinessUnitCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Business Unit](ctp:api:type:BusinessUnit) that was created.
	BusinessUnit BusinessUnit `json:"businessUnit"`
}

* * Generated after a successful [Create BusinessUnit](ctp:api:endpoint:/{projectKey}/business-units:POST) request. *

func (BusinessUnitCreatedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitCreatedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitCreatedMessagePayload ¶ added in v1.2.0 

type BusinessUnitCreatedMessagePayload struct {
	// The [Business Unit](ctp:api:type:BusinessUnit) that was created.
	BusinessUnit BusinessUnit `json:"businessUnit"`
}

* * Generated after a successful [Create BusinessUnit](ctp:api:endpoint:/{projectKey}/business-units:POST) request. *

func (BusinessUnitCreatedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitCreatedMessagePayload) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitCreatedMessagePayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitCustomFieldAddedMessage ¶ added in v1.4.0 

type BusinessUnitCustomFieldAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. If a Custom Field already exists with the same name, a [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message is generated instead. *

func (BusinessUnitCustomFieldAddedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomFieldAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitCustomFieldAddedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitCustomFieldAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitCustomFieldAddedMessagePayload ¶ added in v1.4.0 

type BusinessUnitCustomFieldAddedMessagePayload struct {
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. If a Custom Field already exists with the same name, a [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message is generated instead. *

func (BusinessUnitCustomFieldAddedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomFieldAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitCustomFieldChangedMessage ¶ added in v1.4.0 

type BusinessUnitCustomFieldChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
	OldValue interface{} `json:"oldValue,omitempty"`
}

* * Generated after changing an existing Custom Field on a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. *

func (BusinessUnitCustomFieldChangedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomFieldChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitCustomFieldChangedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitCustomFieldChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitCustomFieldChangedMessagePayload ¶ added in v1.4.0 

type BusinessUnitCustomFieldChangedMessagePayload struct {
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
	OldValue interface{} `json:"oldValue,omitempty"`
}

* * Generated after changing an existing Custom Field on a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. *

func (BusinessUnitCustomFieldChangedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomFieldChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitCustomFieldRemovedMessage ¶ added in v1.4.0 

type BusinessUnitCustomFieldRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. *

func (BusinessUnitCustomFieldRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomFieldRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitCustomFieldRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitCustomFieldRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitCustomFieldRemovedMessagePayload ¶ added in v1.4.0 

type BusinessUnitCustomFieldRemovedMessagePayload struct {
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. *

func (BusinessUnitCustomFieldRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomFieldRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitCustomTypeRemovedMessage ¶ added in v1.4.0 

type BusinessUnitCustomTypeRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after removing a Custom Type from a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action. *

func (BusinessUnitCustomTypeRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomTypeRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitCustomTypeRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitCustomTypeRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitCustomTypeRemovedMessagePayload ¶ added in v1.4.0 

type BusinessUnitCustomTypeRemovedMessagePayload struct {
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after removing a Custom Type from a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action. *

func (BusinessUnitCustomTypeRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomTypeRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitCustomTypeSetMessage ¶ added in v1.4.0 

type BusinessUnitCustomTypeSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Custom Fields that were set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after adding a Custom Type to a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action. *

func (BusinessUnitCustomTypeSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomTypeSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitCustomTypeSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitCustomTypeSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitCustomTypeSetMessagePayload ¶ added in v1.4.0 

type BusinessUnitCustomTypeSetMessagePayload struct {
	// The Custom Fields that were set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after adding a Custom Type to a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action. *

func (BusinessUnitCustomTypeSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitCustomTypeSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitDefaultBillingAddressSetMessage ¶ added in v1.2.0 

type BusinessUnitDefaultBillingAddressSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The address that was set as the default billing address.
	Address *Address `json:"address,omitempty"`
}

* * Generated after a successful [Set Default Billing Address](ctp:api:type:BusinessUnitSetDefaultBillingAddressAction) update action. *

func (BusinessUnitDefaultBillingAddressSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitDefaultBillingAddressSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitDefaultBillingAddressSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitDefaultBillingAddressSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitDefaultBillingAddressSetMessagePayload ¶ added in v1.2.0 

type BusinessUnitDefaultBillingAddressSetMessagePayload struct {
	// The address that was set as the default billing address.
	Address *Address `json:"address,omitempty"`
}

* * Generated after a successful [Set Default Billing Address](ctp:api:type:BusinessUnitSetDefaultBillingAddressAction) update action. *

func (BusinessUnitDefaultBillingAddressSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitDefaultBillingAddressSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitDefaultShippingAddressSetMessage ¶ added in v1.2.0 

type BusinessUnitDefaultShippingAddressSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The address that was set as the default shipping address.
	Address *Address `json:"address,omitempty"`
}

* * Generated after a successful [Set Default Shipping Address](ctp:api:type:BusinessUnitSetDefaultShippingAddressAction) update action. *

func (BusinessUnitDefaultShippingAddressSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitDefaultShippingAddressSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitDefaultShippingAddressSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitDefaultShippingAddressSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitDefaultShippingAddressSetMessagePayload ¶ added in v1.2.0 

type BusinessUnitDefaultShippingAddressSetMessagePayload struct {
	// The address that was set as the default shipping address.
	Address *Address `json:"address,omitempty"`
}

* * Generated after a successful [Set Default Shipping Address](ctp:api:type:BusinessUnitSetDefaultShippingAddressAction) update action. *

func (BusinessUnitDefaultShippingAddressSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitDefaultShippingAddressSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitDeletedMessage ¶ added in v1.2.0 

type BusinessUnitDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete BusinessUnit](/projects/business-units#delete-businessunit) request. *

func (BusinessUnitDeletedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitDeletedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitDeletedMessagePayload ¶ added in v1.2.0 

type BusinessUnitDeletedMessagePayload struct {
}

* * Generated after a successful [Delete BusinessUnit](/projects/business-units#delete-businessunit) request. *

func (BusinessUnitDeletedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitDraft ¶ added in v1.2.0 

type BusinessUnitDraft interface{}

* * Generic draft type to model those fields all Business Units have in common. The additional fields required for creating a Company(ctp:api:type:Company) or Division(ctp:api:type:Division) are represented on CompanyDraft(ctp:api:type:CompanyDraft) and DivisionDraft(ctp:api:type:DivisionDraft). *

type BusinessUnitKeyReference ¶ added in v1.2.0 

type BusinessUnitKeyReference struct {
	// Unique and immutable key of the referenced [BusinessUnit](ctp:api:type:BusinessUnit).
	Key string `json:"key"`
}

* * Reference(ctp:api:type:Reference) to a BusinessUnit(ctp:api:type:BusinessUnit) by its key. *

func (BusinessUnitKeyReference) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitKeyReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitNameChangedMessage ¶ added in v1.2.0 

type BusinessUnitNameChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Updated name of the [Business Unit](ctp:api:type:BusinessUnit).
	Name string `json:"name"`
}

* * Generated after a successful [Change Name](ctp:api:type:BusinessUnitChangeNameAction) update action. *

func (BusinessUnitNameChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitNameChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitNameChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitNameChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitNameChangedMessagePayload ¶ added in v1.2.0 

type BusinessUnitNameChangedMessagePayload struct {
	// Updated name of the [Business Unit](ctp:api:type:BusinessUnit).
	Name string `json:"name"`
}

* * Generated after a successful [Change Name](ctp:api:type:BusinessUnitChangeNameAction) update action. *

func (BusinessUnitNameChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitNameChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitPagedQueryResponse ¶ added in v1.2.0 

type BusinessUnitPagedQueryResponse struct {
	// Number of requested [results](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of elements [skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [BusinessUnits](ctp:api:type:BusinessUnit) matching the query.
	Results []BusinessUnit `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of BusinessUnit(ctp:api:type:BusinessUnit). *

func (*BusinessUnitPagedQueryResponse) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitPagedQueryResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitParentChangedMessage ¶ added in v1.4.0 

type BusinessUnitParentChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Parent unit of the [Business Unit](ctp:api:type:BusinessUnit) before the [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action.
	OldParentUnit *BusinessUnitKeyReference `json:"oldParentUnit,omitempty"`
	// Parent unit of the [Business Unit](ctp:api:type:BusinessUnit) after the [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action.
	NewParentUnit *BusinessUnitKeyReference `json:"newParentUnit,omitempty"`
}

* * Generated after a successful [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action. *

func (BusinessUnitParentChangedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitParentChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitParentChangedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *BusinessUnitParentChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitParentChangedMessagePayload ¶ added in v1.4.0 

type BusinessUnitParentChangedMessagePayload struct {
	// Parent unit of the [Business Unit](ctp:api:type:BusinessUnit) before the [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action.
	OldParentUnit *BusinessUnitKeyReference `json:"oldParentUnit,omitempty"`
	// Parent unit of the [Business Unit](ctp:api:type:BusinessUnit) after the [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action.
	NewParentUnit *BusinessUnitKeyReference `json:"newParentUnit,omitempty"`
}

* * Generated after a successful [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action. *

func (BusinessUnitParentChangedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj BusinessUnitParentChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitReference ¶ added in v1.2.0 

type BusinessUnitReference struct {
	// Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit).
	ID string `json:"id"`
	// Contains the representation of the expanded BusinessUnit. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for BusinessUnit.
	Obj BusinessUnit `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a BusinessUnit(ctp:api:type:BusinessUnit). *

func (BusinessUnitReference) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitReference) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitReference) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitRemoveAddressAction ¶ added in v1.2.0 

type BusinessUnitRemoveAddressAction struct {
	// ID of the address to be removed. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to be removed. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removing the address from a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAddressRemoved](ctp:api:type:BusinessUnitAddressRemovedMessage) Message. *

func (BusinessUnitRemoveAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitRemoveAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitRemoveAssociateAction ¶ added in v1.2.0 

type BusinessUnitRemoveAssociateAction struct {
	// [Associate](ctp:api:type:Associate) to remove.
	Customer CustomerResourceIdentifier `json:"customer"`
}

* * Removing an Associate(ctp:api:type:Associate) from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAssociateRemoved](ctp:api:type:BusinessUnitAssociateRemovedMessage) Message. *

func (BusinessUnitRemoveAssociateAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitRemoveAssociateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitRemoveBillingAddressIdAction ¶ added in v1.2.0 

type BusinessUnitRemoveBillingAddressIdAction struct {
	// ID of the address to be removed from `billingAddressIds`. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to be removed from `billingAddressIds`. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removing a billing address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressRemoved](ctp:api:type:BusinessUnitBillingAddressRemovedMessage) Message. *

func (BusinessUnitRemoveBillingAddressIdAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitRemoveBillingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitRemoveShippingAddressIdAction ¶ added in v1.2.0 

type BusinessUnitRemoveShippingAddressIdAction struct {
	// ID of the address to be removed from `shippingAddressIds`. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to be removed from `shippingAddressIds`. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removing a shipping address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressRemoved](ctp:api:type:BusinessUnitShippingAddressRemovedMessage) Message. *

func (BusinessUnitRemoveShippingAddressIdAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitRemoveShippingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitRemoveStoreAction ¶ added in v1.2.0 

type BusinessUnitRemoveStoreAction struct {
	// [Store](ctp:api:type:Store) to remove.
	Store StoreResourceIdentifier `json:"store"`
}

* * Removes a Store from the Business Unit. * Newly created [Carts](ctp:api:type:Cart) and [Orders](ctp:api:type:Order) can no longer reference the removed Store for the Business Unit. * We recommend cleaning up unordered Carts that still have the Store assigned after calling this update action since those cannot be converted to Orders. * Orders created before the Store was removed remain unchanged. * Generates a [BusinessUnitStoreRemoved](ctp:api:type:BusinessUnitStoreRemovedMessage) Message. * Only applicable when `storeMode` is `Explicit`. *

func (BusinessUnitRemoveStoreAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitRemoveStoreAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitResourceIdentifier ¶ added in v1.2.0 

type BusinessUnitResourceIdentifier struct {
	// Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// Unique key of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a BusinessUnit(ctp:api:type:BusinessUnit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (BusinessUnitResourceIdentifier) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetAddressCustomFieldAction ¶ added in v1.2.0 

type BusinessUnitSetAddressCustomFieldAction struct {
	// ID of the address to be extended.
	AddressId string `json:"addressId"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

* * Adding a Custom Field to an Address of a Business Unit generates the [BusinessUnitAddressCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitAddressCustomFieldRemoved](ctp:api:type:BusinessUnitAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message. *

func (BusinessUnitSetAddressCustomFieldAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetAddressCustomTypeAction ¶ added in v1.2.0 

type BusinessUnitSetAddressCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the `address` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `address`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) for the `address`.
	Fields *FieldContainer `json:"fields,omitempty"`
	// ID of the address to be extended.
	AddressId string `json:"addressId"`
}

* * Adding or updating a Custom Type on an Address of a Business Unit generates the [BusinessUnitAddressCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, and removing one generates the [BusinessUnitAddressCustomTypeRemoved](ctp:api:type:BusinessUnitAddressCustomTypeRemovedMessage) Message. *

func (BusinessUnitSetAddressCustomTypeAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetAssociatesAction ¶ added in v1.2.0 

type BusinessUnitSetAssociatesAction struct {
	// The new list of Associates. If not provided, any existing list is removed.
	Associates []AssociateDraft `json:"associates"`
}

* * Changes the Associates of a [Business Unit](ctp:api:type:BusinessUnit), generates a [BusinessUnitAssociatesSet](ctp:api:type:BusinessUnitAssociatesSetMessage) Message. *

func (BusinessUnitSetAssociatesAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetAssociatesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetContactEmailAction ¶ added in v1.2.0 

type BusinessUnitSetContactEmailAction struct {
	// Email to set.
	// If `contactEmail` is absent or `null`, the existing contact email, if any, will be removed.
	ContactEmail *string `json:"contactEmail,omitempty"`
}

* * Setting the contact email on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitContactEmailSet](ctp:api:type:BusinessUnitContactEmailSetMessage) Message. *

func (BusinessUnitSetContactEmailAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetContactEmailAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetCustomFieldAction ¶ added in v1.2.0 

type BusinessUnitSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields) to add, update, or remove.
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

* * Adding a Custom Field to a Business Unit generates the [BusinessUnitCustomFieldAdded](ctp:api:type:BusinessUnitCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitCustomFieldRemoved](ctp:api:type:BusinessUnitCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message. *

func (BusinessUnitSetCustomFieldAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetCustomTypeAction ¶ added in v1.2.0 

type BusinessUnitSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the BusinessUnit with [Custom Fields](ctp:api:type:CustomFields).
	// If absent, any existing Type and Custom Fields are removed from the BusinessUnit.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) for the BusinessUnit.
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * Adding or updating a Custom Type on a Business Unit generates the [BusinessUnitCustomTypeSet](ctp:api:type:BusinessUnitCustomTypeSetMessage) Message, removing one generates the [BusinessUnitCustomTypeRemoved](ctp:api:type:BusinessUnitCustomTypeRemovedMessage) Message. *

func (BusinessUnitSetCustomTypeAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetDefaultBillingAddressAction ¶ added in v1.2.0 

type BusinessUnitSetDefaultBillingAddressAction struct {
	// ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to add as a billing address. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Setting the default billing address on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitDefaultBillingAddressSet](ctp:api:type:BusinessUnitDefaultBillingAddressSetMessage) Message. *

func (BusinessUnitSetDefaultBillingAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetDefaultBillingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetDefaultShippingAddressAction ¶ added in v1.2.0 

type BusinessUnitSetDefaultShippingAddressAction struct {
	// ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Setting the default shipping address on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitDefaultShippingAddressSet](ctp:api:type:BusinessUnitDefaultShippingAddressSetMessage) Message. *

func (BusinessUnitSetDefaultShippingAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetDefaultShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetStoreModeAction ¶ added in v1.2.0 

type BusinessUnitSetStoreModeAction struct {
	// Set to `Explicit` to specify Stores for the Business Unit. Set to `FromParent` to inherit Stores from a parent.
	StoreMode BusinessUnitStoreMode `json:"storeMode"`
	// Set the [Stores](ctp:api:type:Store) the Business Unit is associated with. Can only be set if `storeMode` is `Explicit`.
	Stores []StoreResourceIdentifier `json:"stores"`
}

* * Only Business Units of type `Division` can be have a store mode of `FromParent`. Changing the `storeMode` to `FromParent` empties the `stores` array on the BusinessUnit. * This update action generates a [BusinessUnitStoreModeChanged](ctp:api:type:BusinessUnitStoreModeChangedMessage) Message. *

func (BusinessUnitSetStoreModeAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetStoreModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitSetStoresAction ¶ added in v1.2.0 

type BusinessUnitSetStoresAction struct {
	// [Stores](ctp:api:type:Store) to set. Overrides the current list of Stores.
	Stores []StoreResourceIdentifier `json:"stores"`
}

* * Sets the Stores of the Business Unit. Can only be set if the Business Unit `storeMode` is `Explicit`. * [Carts](ctp:api:type:Cart) and [Orders](ctp:api:type:Order) created after the Set Stores update must use the new Stores of * the Business Unit and, if set, their [Product Selections](ctp:api:type:ProductSelection), and [Channels](ctp:api:type:Channel). * Orders created before the Set Stores update action remain unchanged. * Setting the Stores on a Business Unit generates a [BusinessUnitStoresSet](ctp:api:type:BusinessUnitStoresSetMessage) Message. *

func (BusinessUnitSetStoresAction) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitSetStoresAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitShippingAddressAddedMessage ¶ added in v1.2.0 

type BusinessUnitShippingAddressAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The address that was added to the [Business Unit](ctp:api:type:BusinessUnit) as shipping address.
	Address Address `json:"address"`
}

* * Generated after a successful [Add Shipping Address Identifier](ctp:api:type:BusinessUnitAddShippingAddressIdAction) update action. *

func (BusinessUnitShippingAddressAddedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitShippingAddressAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitShippingAddressAddedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitShippingAddressAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitShippingAddressAddedMessagePayload ¶ added in v1.2.0 

type BusinessUnitShippingAddressAddedMessagePayload struct {
	// The address that was added to the [Business Unit](ctp:api:type:BusinessUnit) as shipping address.
	Address Address `json:"address"`
}

* * Generated after a successful [Add Shipping Address Identifier](ctp:api:type:BusinessUnitAddShippingAddressIdAction) update action. *

func (BusinessUnitShippingAddressAddedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitShippingAddressAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitShippingAddressRemovedMessage ¶ added in v1.2.0 

type BusinessUnitShippingAddressRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The address that was removed from shipping addresses of the [Business Unit](ctp:api:type:BusinessUnit).
	Address Address `json:"address"`
}

* * Generated after a successful [Remove Shipping Address Identifier](ctp:api:type:BusinessUnitRemoveShippingAddressIdAction) update action. *

func (BusinessUnitShippingAddressRemovedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitShippingAddressRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitShippingAddressRemovedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitShippingAddressRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitShippingAddressRemovedMessagePayload ¶ added in v1.2.0 

type BusinessUnitShippingAddressRemovedMessagePayload struct {
	// The address that was removed from shipping addresses of the [Business Unit](ctp:api:type:BusinessUnit).
	Address Address `json:"address"`
}

* * Generated after a successful [Remove Shipping Address Identifier](ctp:api:type:BusinessUnitRemoveShippingAddressIdAction) update action. *

func (BusinessUnitShippingAddressRemovedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitShippingAddressRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitStatus ¶ added in v1.2.0 

type BusinessUnitStatus string

* * Indicates whether the Business Unit can be edited and used in [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), or [Quotes](ctp:api:type:Quote). * 

const (
	BusinessUnitStatusActive   BusinessUnitStatus = "Active"
	BusinessUnitStatusInactive BusinessUnitStatus = "Inactive"
)

type BusinessUnitStatusChangedMessage ¶ added in v1.2.0 

type BusinessUnitStatusChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Updated status of the [Business Unit](ctp:api:type:BusinessUnit).
	Active BusinessUnitStatus `json:"active"`
}

* * Generated after a successful [Change Status](ctp:api:type:BusinessUnitChangeStatusAction) update action. *

func (BusinessUnitStatusChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStatusChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitStatusChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitStatusChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitStatusChangedMessagePayload ¶ added in v1.2.0 

type BusinessUnitStatusChangedMessagePayload struct {
	// Updated status of the [Business Unit](ctp:api:type:BusinessUnit).
	Active BusinessUnitStatus `json:"active"`
}

* * Generated after a successful [Change Status](ctp:api:type:BusinessUnitChangeStatusAction) update action. *

func (BusinessUnitStatusChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStatusChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitStoreAddedMessage ¶ added in v1.2.0 

type BusinessUnitStoreAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Store](ctp:api:type:Store) that was added to the [Business Unit](ctp:api:type:BusinessUnit).
	Store StoreKeyReference `json:"store"`
}

* * Generated after a successful [Add Store](ctp:api:type:BusinessUnitAddStoreAction) update action. *

func (BusinessUnitStoreAddedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStoreAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitStoreAddedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitStoreAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitStoreAddedMessagePayload ¶ added in v1.2.0 

type BusinessUnitStoreAddedMessagePayload struct {
	// The [Store](ctp:api:type:Store) that was added to the [Business Unit](ctp:api:type:BusinessUnit).
	Store StoreKeyReference `json:"store"`
}

* * Generated after a successful [Add Store](ctp:api:type:BusinessUnitAddStoreAction) update action. *

func (BusinessUnitStoreAddedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStoreAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitStoreMode ¶ added in v1.2.0 

type BusinessUnitStoreMode string

* * Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit. * 

const (
	BusinessUnitStoreModeExplicit   BusinessUnitStoreMode = "Explicit"
	BusinessUnitStoreModeFromParent BusinessUnitStoreMode = "FromParent"
)

type BusinessUnitStoreModeChangedMessage ¶ added in v1.2.0 

type BusinessUnitStoreModeChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Stores](ctp:api:type:Store) of the [Business Unit](ctp:api:type:BusinessUnit) after the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
	Stores []StoreKeyReference `json:"stores"`
	// [BusinessUnitStoreMode](ctp:api:type:BusinessUnitStoreMode) of the Business Unit after the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
	StoreMode BusinessUnitStoreMode `json:"storeMode"`
	// [Stores](ctp:api:type:Store) of the [Business Unit](ctp:api:type:BusinessUnit) before the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
	OldStores []StoreKeyReference `json:"oldStores"`
	// [BusinessUnitStoreMode](ctp:api:type:BusinessUnitStoreMode) of the Business Unit before the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
	OldStoreMode BusinessUnitStoreMode `json:"oldStoreMode"`
}

* * Generated after a successful [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action. *

func (BusinessUnitStoreModeChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStoreModeChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitStoreModeChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitStoreModeChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitStoreModeChangedMessagePayload ¶ added in v1.2.0 

type BusinessUnitStoreModeChangedMessagePayload struct {
	// [Stores](ctp:api:type:Store) of the [Business Unit](ctp:api:type:BusinessUnit) after the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
	Stores []StoreKeyReference `json:"stores"`
	// [BusinessUnitStoreMode](ctp:api:type:BusinessUnitStoreMode) of the Business Unit after the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
	StoreMode BusinessUnitStoreMode `json:"storeMode"`
	// [Stores](ctp:api:type:Store) of the [Business Unit](ctp:api:type:BusinessUnit) before the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
	OldStores []StoreKeyReference `json:"oldStores"`
	// [BusinessUnitStoreMode](ctp:api:type:BusinessUnitStoreMode) of the Business Unit before the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
	OldStoreMode BusinessUnitStoreMode `json:"oldStoreMode"`
}

* * Generated after a successful [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action. *

func (BusinessUnitStoreModeChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStoreModeChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitStoreRemovedMessage ¶ added in v1.2.0 

type BusinessUnitStoreRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Store](ctp:api:type:Store) that was removed from the [Business Unit](ctp:api:type:BusinessUnit).
	Store StoreKeyReference `json:"store"`
}

* * Generated after a successful [Remove Store](ctp:api:type:BusinessUnitRemoveStoreAction) update action. *

func (BusinessUnitStoreRemovedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStoreRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitStoreRemovedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitStoreRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitStoreRemovedMessagePayload ¶ added in v1.2.0 

type BusinessUnitStoreRemovedMessagePayload struct {
	// The [Store](ctp:api:type:Store) that was removed from the [Business Unit](ctp:api:type:BusinessUnit).
	Store StoreKeyReference `json:"store"`
}

* * Generated after a successful [Remove Store](ctp:api:type:BusinessUnitRemoveStoreAction) update action. *

func (BusinessUnitStoreRemovedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStoreRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitStoresSetMessage ¶ added in v1.2.0 

type BusinessUnitStoresSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Stores](ctp:api:type:Store) of the [Business Unit](ctp:api:type:BusinessUnit) after the [Set Stores](ctp:api:type:BusinessUnitSetStoresAction) update action.
	Stores []StoreKeyReference `json:"stores"`
}

* * Generated after a successful [Set Stores](ctp:api:type:BusinessUnitSetStoresAction) update action. *

func (BusinessUnitStoresSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStoresSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*BusinessUnitStoresSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitStoresSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitStoresSetMessagePayload ¶ added in v1.2.0 

type BusinessUnitStoresSetMessagePayload struct {
	// [Stores](ctp:api:type:Store) of the [Business Unit](ctp:api:type:BusinessUnit) after the [Set Stores](ctp:api:type:BusinessUnitSetStoresAction) update action.
	Stores []StoreKeyReference `json:"stores"`
}

* * Generated after a successful [Set Stores](ctp:api:type:BusinessUnitSetStoresAction) update action. *

func (BusinessUnitStoresSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj BusinessUnitStoresSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitType ¶ added in v1.2.0 

type BusinessUnitType string

* * The type of the Business Unit indicating its position in a hierarchy. * 

const (
	BusinessUnitTypeCompany  BusinessUnitType = "Company"
	BusinessUnitTypeDivision BusinessUnitType = "Division"
)

type BusinessUnitUpdate ¶ added in v1.2.0 

type BusinessUnitUpdate struct {
	// Expected version of the BusinessUnit on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the BusinessUnit.
	Actions []BusinessUnitUpdateAction `json:"actions"`
}

func (*BusinessUnitUpdate) UnmarshalJSON ¶ added in v1.2.0 

func (obj *BusinessUnitUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type BusinessUnitUpdateAction ¶ added in v1.2.0 

type BusinessUnitUpdateAction interface{}

type ByProjectKeyApiClientsByIDRequestBuilder ¶ 

type ByProjectKeyApiClientsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyApiClientsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyApiClientsByIDRequestBuilder) Delete() *ByProjectKeyApiClientsByIDRequestMethodDelete

func (*ByProjectKeyApiClientsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyApiClientsByIDRequestBuilder) Get() *ByProjectKeyApiClientsByIDRequestMethodGet

func (*ByProjectKeyApiClientsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyApiClientsByIDRequestBuilder) Head() *ByProjectKeyApiClientsByIDRequestMethodHead

* * Checks if an API Client exists for a given `id`. Returns a `200 OK` status if the API Client exists or a `404 Not Found` otherwise.

type ByProjectKeyApiClientsByIDRequestMethodDelete ¶ 

type ByProjectKeyApiClientsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyApiClientsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyApiClientsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyApiClientsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyApiClientsByIDRequestMethodDelete) Execute(ctx context.Context) (result *ApiClient, err error)

func (*ByProjectKeyApiClientsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyApiClientsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyApiClientsByIDRequestMethodDelete

type ByProjectKeyApiClientsByIDRequestMethodGet ¶ 

type ByProjectKeyApiClientsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyApiClientsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyApiClientsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyApiClientsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyApiClientsByIDRequestMethodGet) Execute(ctx context.Context) (result *ApiClient, err error)

func (*ByProjectKeyApiClientsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyApiClientsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyApiClientsByIDRequestMethodGet

type ByProjectKeyApiClientsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyApiClientsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyApiClientsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyApiClientsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyApiClientsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyApiClientsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an API Client exists for a given `id`. Returns a `200 OK` status if the API Client exists or a `404 Not Found` otherwise.

func (*ByProjectKeyApiClientsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyApiClientsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyApiClientsByIDRequestMethodHead

type ByProjectKeyApiClientsRequestBuilder ¶ 

type ByProjectKeyApiClientsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyApiClientsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyApiClientsRequestBuilder) Get() *ByProjectKeyApiClientsRequestMethodGet

func (*ByProjectKeyApiClientsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyApiClientsRequestBuilder) Head() *ByProjectKeyApiClientsRequestMethodHead

* * Checks if an API Client exists for a given Query Predicate. Returns a `200 OK` status if any API Clients match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyApiClientsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyApiClientsRequestBuilder) Post(body ApiClientDraft) *ByProjectKeyApiClientsRequestMethodPost

func (*ByProjectKeyApiClientsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyApiClientsRequestBuilder) WithId(id string) *ByProjectKeyApiClientsByIDRequestBuilder

type ByProjectKeyApiClientsRequestMethodGet ¶ 

type ByProjectKeyApiClientsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyApiClientsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyApiClientsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyApiClientsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) Execute(ctx context.Context) (result *ApiClientPagedQueryResponse, err error)

func (*ByProjectKeyApiClientsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) Expand(v []string) *ByProjectKeyApiClientsRequestMethodGet

func (*ByProjectKeyApiClientsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) Limit(v int) *ByProjectKeyApiClientsRequestMethodGet

func (*ByProjectKeyApiClientsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) Offset(v int) *ByProjectKeyApiClientsRequestMethodGet

func (*ByProjectKeyApiClientsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyApiClientsRequestMethodGet

func (*ByProjectKeyApiClientsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) Sort(v []string) *ByProjectKeyApiClientsRequestMethodGet

func (*ByProjectKeyApiClientsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) Where(v []string) *ByProjectKeyApiClientsRequestMethodGet

func (*ByProjectKeyApiClientsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyApiClientsRequestMethodGet

func (*ByProjectKeyApiClientsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) WithQueryParams(input ByProjectKeyApiClientsRequestMethodGetInput) *ByProjectKeyApiClientsRequestMethodGet

func (*ByProjectKeyApiClientsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodGet) WithTotal(v bool) *ByProjectKeyApiClientsRequestMethodGet

type ByProjectKeyApiClientsRequestMethodGetInput ¶ 

type ByProjectKeyApiClientsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyApiClientsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyApiClientsRequestMethodGetInput) Values() url.Values

type ByProjectKeyApiClientsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyApiClientsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyApiClientsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyApiClientsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyApiClientsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyApiClientsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an API Client exists for a given Query Predicate. Returns a `200 OK` status if any API Clients match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyApiClientsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyApiClientsRequestMethodHead) Where(v []string) *ByProjectKeyApiClientsRequestMethodHead

func (*ByProjectKeyApiClientsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyApiClientsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyApiClientsRequestMethodHead

func (*ByProjectKeyApiClientsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyApiClientsRequestMethodHead) WithQueryParams(input ByProjectKeyApiClientsRequestMethodHeadInput) *ByProjectKeyApiClientsRequestMethodHead

type ByProjectKeyApiClientsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyApiClientsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyApiClientsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyApiClientsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyApiClientsRequestMethodPost ¶ 

type ByProjectKeyApiClientsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyApiClientsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyApiClientsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyApiClientsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodPost) Execute(ctx context.Context) (result *ApiClient, err error)

func (*ByProjectKeyApiClientsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodPost) Expand(v []string) *ByProjectKeyApiClientsRequestMethodPost

func (*ByProjectKeyApiClientsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyApiClientsRequestMethodPost

func (*ByProjectKeyApiClientsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyApiClientsRequestMethodPost) WithQueryParams(input ByProjectKeyApiClientsRequestMethodPostInput) *ByProjectKeyApiClientsRequestMethodPost

type ByProjectKeyApiClientsRequestMethodPostInput ¶ 

type ByProjectKeyApiClientsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyApiClientsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyApiClientsRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead

* * Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestBuilder) Post(body BusinessUnitUpdate) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead

* * Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestBuilder) Post(body BusinessUnitUpdate) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead

* * Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) Post(body BusinessUnitDraft) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) WithId ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) WithId(id string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) WithKey ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder) WithKey(key string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyRequestBuilder

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Execute(ctx context.Context) (result *BusinessUnitPagedQueryResponse, err error)

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Limit ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Limit(v int) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Offset ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Offset(v int) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) PredicateVar ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Sort ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Sort(v []string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Where ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) WithTotal ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet) WithTotal(v bool) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHeadInput) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestBuilder ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestBuilder) Get ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestBuilder) Post ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestBuilder) Post(body ApprovalFlowUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) Execute(ctx context.Context) (result *ApprovalFlow, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGetInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGetInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) Execute(ctx context.Context) (result *ApprovalFlow, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPostInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPostInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestBuilder ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestBuilder) Get ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestBuilder) WithId ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestBuilder) WithId(id string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsByIDRequestBuilder

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Execute(ctx context.Context) (result *ApprovalFlowPagedQueryResponse, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Limit ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Limit(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Offset ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Offset(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) PredicateVar ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Sort ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Sort(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) WithTotal ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet) WithTotal(v bool) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGetInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGetInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestBuilder ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestBuilder) Get ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestBuilder) Post ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestBuilder) Post(body ApprovalRuleUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) Execute(ctx context.Context) (result *ApprovalRule, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGetInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGetInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) Execute(ctx context.Context) (result *ApprovalRule, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPostInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPostInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestBuilder ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestBuilder) Get ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestBuilder) Post ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestBuilder) Post(body ApprovalRuleUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ApprovalRule, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGetInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGetInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ApprovalRule, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPostInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPostInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder) Get ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder) Post ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder) Post(body ApprovalRuleDraft) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder) WithId ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder) WithId(id string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesByIDRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder) WithKey ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder) WithKey(key string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesKeyByKeyRequestBuilder

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Execute(ctx context.Context) (result *ApprovalRulePagedQueryResponse, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Limit ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Limit(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Offset ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Offset(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) PredicateVar ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Sort ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Sort(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) WithTotal ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet) WithTotal(v bool) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGetInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGetInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) Execute(ctx context.Context) (result *ApprovalRule, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPostInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPostInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder) Delete ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder) Delete() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead

* * Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder) Post(body CartUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) DataErasure ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) Version ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) Version(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDeleteInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDelete

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDeleteInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDeleteInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder) Delete ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder) Delete() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead

* * Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder) Post(body CartUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) DataErasure ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) Version ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDelete

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDeleteInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestBuilder) Post(body ReplicaCartDraft) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost

* * Creates a new Cart by replicating an existing Cart or Order. Can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order. * * The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` CartState(ctp:api:type:CartState). * * The new Cart does not contain Payments or Deliveries. The State(ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. * * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * Creates a new Cart by replicating an existing Cart or Order. Can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order. * * The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` CartState(ctp:api:type:CartState). * * The new Cart does not contain Payments or Deliveries. The State(ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. * * If the Cart exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) Post(body CartDraft) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost

* * Creates a Cart(ctp:api:type:Cart) in the BusinessUnit(ctp:api:type:BusinessUnit) referenced by `businessUnitKey`. As such, the `businessUnit` field on CartDraft(ctp:api:type:CartDraft) is ignored for this request. * Creating a Cart can fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the referenced ShippingMethod(ctp:api:type:ShippingMethod) in the CartDraft(ctp:api:type:CartDraft) has a predicate that does not match the Cart. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) Replicate ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) Replicate() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) WithId ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) WithId(id string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) WithKey ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder) WithKey(key string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Execute(ctx context.Context) (result *CartPagedQueryResponse, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Limit ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Limit(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Offset ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Offset(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) PredicateVar ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Sort ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Sort(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Where ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) WithTotal ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet) WithTotal(v bool) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHeadInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * Creates a Cart(ctp:api:type:Cart) in the BusinessUnit(ctp:api:type:BusinessUnit) referenced by `businessUnitKey`. As such, the `businessUnit` field on CartDraft(ctp:api:type:CartDraft) is ignored for this request. * Creating a Cart can fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the referenced ShippingMethod(ctp:api:type:ShippingMethod) in the CartDraft(ctp:api:type:CartDraft) has a predicate that does not match the Cart. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet

* * If the Order exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestBuilder) Post(body OrderUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost

* * If the Order exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet

* * If the Order exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead

* * Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestBuilder) Post(body OrderUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost

* * If the Order exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestBuilder) Post(body OrderFromQuoteDraft) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost

* * Creates an Order from a Quote(ctp:api:type:Cart) in a BusinessUnit(ctp:api:type:BusinessUnit). * Creating an Order fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Quote does not reference the same BusinessUnit as the `businessUnitKey` path parameter. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * Creates an Order from a Quote(ctp:api:type:Cart) in a BusinessUnit(ctp:api:type:BusinessUnit). * Creating an Order fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Quote does not reference the same BusinessUnit as the `businessUnitKey` path parameter. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) OrderQuote ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) OrderQuote() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) Post(body OrderFromCartDraft) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost

* * Creates an Order from a Cart(ctp:api:type:Cart) in a BusinessUnit(ctp:api:type:BusinessUnit). * The Cart must have a shipping address set before creating an Order. * Creating an Order fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Cart does not reference the same BusinessUnit as the `businessUnitKey` path parameter. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) WithId ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) WithId(id string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) WithOrderNumber ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder) WithOrderNumber(orderNumber string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberRequestBuilder

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Execute(ctx context.Context) (result *OrderPagedQueryResponse, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Limit ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Limit(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Offset ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Offset(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) PredicateVar ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Sort ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Sort(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Where ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) WithTotal ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet) WithTotal(v bool) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHeadInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodHeadInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * Creates an Order from a Cart(ctp:api:type:Cart) in a BusinessUnit(ctp:api:type:BusinessUnit). * The Cart must have a shipping address set before creating an Order. * Creating an Order fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Cart does not reference the same BusinessUnit as the `businessUnitKey` path parameter. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet

* * If the QuoteRequest exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead

* * Checks if a QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestBuilder) Post(body QuoteRequestUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost

* * If the QuoteRequest exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) Execute(ctx context.Context) (result *QuoteRequest, err error)

* * If the QuoteRequest exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) Execute(ctx context.Context) (result *QuoteRequest, err error)

* * If the QuoteRequest exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet

* * If the QuoteRequest exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead

* * Checks if a QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestBuilder) Post(body QuoteRequestUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost

* * If the QuoteRequest exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *QuoteRequest, err error)

* * If the QuoteRequest exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *QuoteRequest, err error)

* * If the QuoteRequest exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead

* * Checks if a QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) Post(body QuoteRequestDraft) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost

* * Creates a QuoteRequest in a BusinessUnit(ctp:api:type:BusinessUnit). Creating QuoteRequest fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Cart does not reference the same BusinessUnit as the `businessUnitKey` path parameter.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) WithId ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) WithId(id string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) WithKey ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder) WithKey(key string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyRequestBuilder

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Execute(ctx context.Context) (result *QuoteRequestPagedQueryResponse, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Limit ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Limit(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Offset ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Offset(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) PredicateVar ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Sort ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Sort(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Where ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) WithTotal ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet) WithTotal(v bool) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHeadInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) Execute(ctx context.Context) (result *QuoteRequest, err error)

* * Creates a QuoteRequest in a BusinessUnit(ctp:api:type:BusinessUnit). Creating QuoteRequest fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Cart does not reference the same BusinessUnit as the `businessUnitKey` path parameter.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet

* * If the Quote exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead

* * Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestBuilder) Post(body QuoteUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost

* * If the Quote exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) Execute(ctx context.Context) (result *Quote, err error)

* * If the Quote exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) Execute(ctx context.Context) (result *Quote, err error)

* * If the Quote exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet

* * If the Quote exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead

* * Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestBuilder) Post(body QuoteUpdate) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost

* * If the Quote exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Quote, err error)

* * If the Quote exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Quote, err error)

* * If the Quote exists in the Project(ctp:api:type:Project) but does not reference the requested BusinessUnit(ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPostInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPost

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder) Get() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder) Head() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead

* * Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder) WithId ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder) WithId(id string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder) WithKey ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder) WithKey(key string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyRequestBuilder

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Execute(ctx context.Context) (result *QuotePagedQueryResponse, err error)

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Expand(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Limit ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Limit(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Offset ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Offset(v int) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) PredicateVar ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Sort ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Sort(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Where ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGetInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) WithTotal ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet) WithTotal(v bool) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGet

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodGetInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) Where(v []string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead) WithQueryParams(input ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHeadInput) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHead

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) ApprovalFlows ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) ApprovalFlows() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalFlowsRequestBuilder

* * Approval Flows connect Orders that require approval with the Approval Rules that initiate the approval requirement. * They represent the approval process by including information about approvals, rejections, and all involved parties. *

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) ApprovalRules ¶ added in v1.4.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) ApprovalRules() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyApprovalRulesRequestBuilder

* * An Approval Rule describes the conditions determining whether an Order that matches the predicate needs approval by an approver before it can be ordered by an requester within a Business Unit.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) Carts ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) Carts() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder

* * A shopping cart holds product variants and can be ordered.

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) Orders ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) Orders() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) QuoteRequests ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) QuoteRequests() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsRequestBuilder

func (*ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) Quotes ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) Quotes() *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesRequestBuilder

* * A quote holds the negotiated offer.

type ByProjectKeyAsAssociateByAssociateIdRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateByAssociateIdRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateByAssociateIdRequestBuilder) BusinessUnits ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdRequestBuilder) BusinessUnits() *ByProjectKeyAsAssociateByAssociateIdBusinessUnitsRequestBuilder

* * A Business Unit can represent a Company or a Division.

func (*ByProjectKeyAsAssociateByAssociateIdRequestBuilder) InBusinessUnitKeyWithBusinessUnitKeyValue ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateByAssociateIdRequestBuilder) InBusinessUnitKeyWithBusinessUnitKeyValue(businessUnitKey string) *ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyRequestBuilder

type ByProjectKeyAsAssociateRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAsAssociateRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAsAssociateRequestBuilder) WithAssociateIdValue ¶ added in v1.3.0 

func (rb *ByProjectKeyAsAssociateRequestBuilder) WithAssociateIdValue(associateId string) *ByProjectKeyAsAssociateByAssociateIdRequestBuilder

type ByProjectKeyAssociateRolesByIDRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesByIDRequestBuilder) Delete ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestBuilder) Delete() *ByProjectKeyAssociateRolesByIDRequestMethodDelete

func (*ByProjectKeyAssociateRolesByIDRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestBuilder) Get() *ByProjectKeyAssociateRolesByIDRequestMethodGet

func (*ByProjectKeyAssociateRolesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestBuilder) Head() *ByProjectKeyAssociateRolesByIDRequestMethodHead

* * Checks if an AssociateRole exists for a given `id`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAssociateRolesByIDRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestBuilder) Post(body AssociateRoleUpdate) *ByProjectKeyAssociateRolesByIDRequestMethodPost

type ByProjectKeyAssociateRolesByIDRequestMethodDelete ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesByIDRequestMethodDelete) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAssociateRolesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesByIDRequestMethodDelete) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodDelete) Execute(ctx context.Context) (result *AssociateRole, err error)

func (*ByProjectKeyAssociateRolesByIDRequestMethodDelete) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyAssociateRolesByIDRequestMethodDelete

func (*ByProjectKeyAssociateRolesByIDRequestMethodDelete) Version ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodDelete) Version(v int) *ByProjectKeyAssociateRolesByIDRequestMethodDelete

func (*ByProjectKeyAssociateRolesByIDRequestMethodDelete) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesByIDRequestMethodDelete

func (*ByProjectKeyAssociateRolesByIDRequestMethodDelete) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyAssociateRolesByIDRequestMethodDeleteInput) *ByProjectKeyAssociateRolesByIDRequestMethodDelete

type ByProjectKeyAssociateRolesByIDRequestMethodDeleteInput ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyAssociateRolesByIDRequestMethodDeleteInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAssociateRolesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyAssociateRolesByIDRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesByIDRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAssociateRolesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesByIDRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodGet) Execute(ctx context.Context) (result *AssociateRole, err error)

func (*ByProjectKeyAssociateRolesByIDRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyAssociateRolesByIDRequestMethodGet

func (*ByProjectKeyAssociateRolesByIDRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesByIDRequestMethodGet

func (*ByProjectKeyAssociateRolesByIDRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyAssociateRolesByIDRequestMethodGetInput) *ByProjectKeyAssociateRolesByIDRequestMethodGet

type ByProjectKeyAssociateRolesByIDRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAssociateRolesByIDRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAssociateRolesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyAssociateRolesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAssociateRolesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAssociateRolesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an AssociateRole exists for a given `id`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAssociateRolesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesByIDRequestMethodHead

type ByProjectKeyAssociateRolesByIDRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesByIDRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAssociateRolesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesByIDRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodPost) Execute(ctx context.Context) (result *AssociateRole, err error)

func (*ByProjectKeyAssociateRolesByIDRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyAssociateRolesByIDRequestMethodPost

func (*ByProjectKeyAssociateRolesByIDRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesByIDRequestMethodPost

func (*ByProjectKeyAssociateRolesByIDRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyAssociateRolesByIDRequestMethodPostInput) *ByProjectKeyAssociateRolesByIDRequestMethodPost

type ByProjectKeyAssociateRolesByIDRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAssociateRolesByIDRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAssociateRolesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyAssociateRolesKeyByKeyRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestBuilder) Delete ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestBuilder) Delete() *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete

* * Deleting an AssociateRole generates the [AssociateRoleDeleted](ctp:api:type:AssociateRoleDeletedMessage) Message. An AssociateRole can only be deleted if it is not assigned to any [Associates](ctp:api:type:Associate). *

func (*ByProjectKeyAssociateRolesKeyByKeyRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestBuilder) Get() *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet

func (*ByProjectKeyAssociateRolesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestBuilder) Head() *ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead

* * Checks if an AssociateRole exists for a given `key`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAssociateRolesKeyByKeyRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestBuilder) Post(body AssociateRoleUpdate) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *AssociateRole, err error)

* * Deleting an AssociateRole generates the [AssociateRoleDeleted](ctp:api:type:AssociateRoleDeletedMessage) Message. An AssociateRole can only be deleted if it is not assigned to any [Associates](ctp:api:type:Associate). *

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) Version ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyAssociateRolesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDelete

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodDeleteInput ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAssociateRolesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *AssociateRole, err error)

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyAssociateRolesKeyByKeyRequestMethodGetInput) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGet

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAssociateRolesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an AssociateRole exists for a given `key`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodHead

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *AssociateRole, err error)

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyAssociateRolesKeyByKeyRequestMethodPostInput) *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPost

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAssociateRolesKeyByKeyRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAssociateRolesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyAssociateRolesRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestBuilder) Get() *ByProjectKeyAssociateRolesRequestMethodGet

func (*ByProjectKeyAssociateRolesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesRequestBuilder) Head() *ByProjectKeyAssociateRolesRequestMethodHead

* * Checks if an AssociateRole exists for a given Query Predicate. Returns a `200 OK` status if any AssociateRole match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAssociateRolesRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestBuilder) Post(body AssociateRoleDraft) *ByProjectKeyAssociateRolesRequestMethodPost

* * Creating a Associate Role generates the [AssociateRoleCreated](ctp:api:type:AssociateRoleCreatedMessage) Message. *

func (*ByProjectKeyAssociateRolesRequestBuilder) WithId ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestBuilder) WithId(id string) *ByProjectKeyAssociateRolesByIDRequestBuilder

func (*ByProjectKeyAssociateRolesRequestBuilder) WithKey ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestBuilder) WithKey(key string) *ByProjectKeyAssociateRolesKeyByKeyRequestBuilder

type ByProjectKeyAssociateRolesRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAssociateRolesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) Execute(ctx context.Context) (result *AssociateRolePagedQueryResponse, err error)

func (*ByProjectKeyAssociateRolesRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) Expand(v []string) *ByProjectKeyAssociateRolesRequestMethodGet

func (*ByProjectKeyAssociateRolesRequestMethodGet) Limit ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) Limit(v int) *ByProjectKeyAssociateRolesRequestMethodGet

func (*ByProjectKeyAssociateRolesRequestMethodGet) Offset ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) Offset(v int) *ByProjectKeyAssociateRolesRequestMethodGet

func (*ByProjectKeyAssociateRolesRequestMethodGet) PredicateVar ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyAssociateRolesRequestMethodGet

func (*ByProjectKeyAssociateRolesRequestMethodGet) Sort ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) Sort(v []string) *ByProjectKeyAssociateRolesRequestMethodGet

func (*ByProjectKeyAssociateRolesRequestMethodGet) Where ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) Where(v []string) *ByProjectKeyAssociateRolesRequestMethodGet

func (*ByProjectKeyAssociateRolesRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesRequestMethodGet

func (*ByProjectKeyAssociateRolesRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) WithQueryParams(input ByProjectKeyAssociateRolesRequestMethodGetInput) *ByProjectKeyAssociateRolesRequestMethodGet

func (*ByProjectKeyAssociateRolesRequestMethodGet) WithTotal ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodGet) WithTotal(v bool) *ByProjectKeyAssociateRolesRequestMethodGet

type ByProjectKeyAssociateRolesRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyAssociateRolesRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAssociateRolesRequestMethodGetInput) Values() url.Values

type ByProjectKeyAssociateRolesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAssociateRolesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAssociateRolesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an AssociateRole exists for a given Query Predicate. Returns a `200 OK` status if any AssociateRole match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAssociateRolesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodHead) Where(v []string) *ByProjectKeyAssociateRolesRequestMethodHead

func (*ByProjectKeyAssociateRolesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesRequestMethodHead

func (*ByProjectKeyAssociateRolesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodHead) WithQueryParams(input ByProjectKeyAssociateRolesRequestMethodHeadInput) *ByProjectKeyAssociateRolesRequestMethodHead

type ByProjectKeyAssociateRolesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyAssociateRolesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyAssociateRolesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAssociateRolesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyAssociateRolesRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAssociateRolesRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyAssociateRolesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAssociateRolesRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodPost) Execute(ctx context.Context) (result *AssociateRole, err error)

* * Creating a Associate Role generates the [AssociateRoleCreated](ctp:api:type:AssociateRoleCreatedMessage) Message. *

func (*ByProjectKeyAssociateRolesRequestMethodPost) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodPost) Expand(v []string) *ByProjectKeyAssociateRolesRequestMethodPost

func (*ByProjectKeyAssociateRolesRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAssociateRolesRequestMethodPost

func (*ByProjectKeyAssociateRolesRequestMethodPost) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyAssociateRolesRequestMethodPost) WithQueryParams(input ByProjectKeyAssociateRolesRequestMethodPostInput) *ByProjectKeyAssociateRolesRequestMethodPost

type ByProjectKeyAssociateRolesRequestMethodPostInput ¶ added in v1.3.0 

type ByProjectKeyAssociateRolesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAssociateRolesRequestMethodPostInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyAssociateRolesRequestMethodPostInput) Values() url.Values

type ByProjectKeyAttributeGroupsByIDRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsByIDRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestBuilder) Delete() *ByProjectKeyAttributeGroupsByIDRequestMethodDelete

func (*ByProjectKeyAttributeGroupsByIDRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestBuilder) Get() *ByProjectKeyAttributeGroupsByIDRequestMethodGet

func (*ByProjectKeyAttributeGroupsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestBuilder) Head() *ByProjectKeyAttributeGroupsByIDRequestMethodHead

* * Checks if an AttributeGroup exists for a given `id`. Returns a `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAttributeGroupsByIDRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestBuilder) Post(body AttributeGroupUpdate) *ByProjectKeyAttributeGroupsByIDRequestMethodPost

type ByProjectKeyAttributeGroupsByIDRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyAttributeGroupsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodDelete) Execute(ctx context.Context) (result *AttributeGroup, err error)

func (*ByProjectKeyAttributeGroupsByIDRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyAttributeGroupsByIDRequestMethodDelete

func (*ByProjectKeyAttributeGroupsByIDRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodDelete) Version(v int) *ByProjectKeyAttributeGroupsByIDRequestMethodDelete

func (*ByProjectKeyAttributeGroupsByIDRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsByIDRequestMethodDelete

func (*ByProjectKeyAttributeGroupsByIDRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyAttributeGroupsByIDRequestMethodDeleteInput) *ByProjectKeyAttributeGroupsByIDRequestMethodDelete

type ByProjectKeyAttributeGroupsByIDRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyAttributeGroupsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyAttributeGroupsByIDRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyAttributeGroupsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodGet) Execute(ctx context.Context) (result *AttributeGroup, err error)

func (*ByProjectKeyAttributeGroupsByIDRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyAttributeGroupsByIDRequestMethodGet

func (*ByProjectKeyAttributeGroupsByIDRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsByIDRequestMethodGet

func (*ByProjectKeyAttributeGroupsByIDRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyAttributeGroupsByIDRequestMethodGetInput) *ByProjectKeyAttributeGroupsByIDRequestMethodGet

type ByProjectKeyAttributeGroupsByIDRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyAttributeGroupsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyAttributeGroupsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAttributeGroupsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAttributeGroupsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an AttributeGroup exists for a given `id`. Returns a `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAttributeGroupsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsByIDRequestMethodHead

type ByProjectKeyAttributeGroupsByIDRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyAttributeGroupsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodPost) Execute(ctx context.Context) (result *AttributeGroup, err error)

func (*ByProjectKeyAttributeGroupsByIDRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyAttributeGroupsByIDRequestMethodPost

func (*ByProjectKeyAttributeGroupsByIDRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsByIDRequestMethodPost

func (*ByProjectKeyAttributeGroupsByIDRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyAttributeGroupsByIDRequestMethodPostInput) *ByProjectKeyAttributeGroupsByIDRequestMethodPost

type ByProjectKeyAttributeGroupsByIDRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAttributeGroupsByIDRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyAttributeGroupsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder) Delete() *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder) Get() *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder) Head() *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead

* * Checks if an AttributeGroup exists for a given `key`. Returns `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder) Post(body AttributeGroupUpdate) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *AttributeGroup, err error)

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDelete

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *AttributeGroup, err error)

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGetInput) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGet

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an AttributeGroup exists for a given `key`. Returns `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodHead

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *AttributeGroup, err error)

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPostInput) *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPost

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyAttributeGroupsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyAttributeGroupsRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestBuilder) Get() *ByProjectKeyAttributeGroupsRequestMethodGet

func (*ByProjectKeyAttributeGroupsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsRequestBuilder) Head() *ByProjectKeyAttributeGroupsRequestMethodHead

* * Checks if an AttributeGroup exists for a given Query Predicate. Returns `200 OK` status if any AttributeGroups match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAttributeGroupsRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestBuilder) Post(body AttributeGroupDraft) *ByProjectKeyAttributeGroupsRequestMethodPost

func (*ByProjectKeyAttributeGroupsRequestBuilder) WithId ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestBuilder) WithId(id string) *ByProjectKeyAttributeGroupsByIDRequestBuilder

func (*ByProjectKeyAttributeGroupsRequestBuilder) WithKey ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestBuilder) WithKey(key string) *ByProjectKeyAttributeGroupsKeyByKeyRequestBuilder

type ByProjectKeyAttributeGroupsRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyAttributeGroupsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) Execute(ctx context.Context) (result *AttributeGroupPagedQueryResponse, err error)

func (*ByProjectKeyAttributeGroupsRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) Expand(v []string) *ByProjectKeyAttributeGroupsRequestMethodGet

func (*ByProjectKeyAttributeGroupsRequestMethodGet) Limit ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) Limit(v int) *ByProjectKeyAttributeGroupsRequestMethodGet

func (*ByProjectKeyAttributeGroupsRequestMethodGet) Offset ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) Offset(v int) *ByProjectKeyAttributeGroupsRequestMethodGet

func (*ByProjectKeyAttributeGroupsRequestMethodGet) PredicateVar ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyAttributeGroupsRequestMethodGet

func (*ByProjectKeyAttributeGroupsRequestMethodGet) Sort ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) Sort(v []string) *ByProjectKeyAttributeGroupsRequestMethodGet

func (*ByProjectKeyAttributeGroupsRequestMethodGet) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) Where(v []string) *ByProjectKeyAttributeGroupsRequestMethodGet

func (*ByProjectKeyAttributeGroupsRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsRequestMethodGet

func (*ByProjectKeyAttributeGroupsRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) WithQueryParams(input ByProjectKeyAttributeGroupsRequestMethodGetInput) *ByProjectKeyAttributeGroupsRequestMethodGet

func (*ByProjectKeyAttributeGroupsRequestMethodGet) WithTotal ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodGet) WithTotal(v bool) *ByProjectKeyAttributeGroupsRequestMethodGet

type ByProjectKeyAttributeGroupsRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyAttributeGroupsRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyAttributeGroupsRequestMethodGetInput) Values() url.Values

type ByProjectKeyAttributeGroupsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyAttributeGroupsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyAttributeGroupsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an AttributeGroup exists for a given Query Predicate. Returns `200 OK` status if any AttributeGroups match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyAttributeGroupsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodHead) Where(v []string) *ByProjectKeyAttributeGroupsRequestMethodHead

func (*ByProjectKeyAttributeGroupsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsRequestMethodHead

func (*ByProjectKeyAttributeGroupsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodHead) WithQueryParams(input ByProjectKeyAttributeGroupsRequestMethodHeadInput) *ByProjectKeyAttributeGroupsRequestMethodHead

type ByProjectKeyAttributeGroupsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyAttributeGroupsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyAttributeGroupsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyAttributeGroupsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyAttributeGroupsRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyAttributeGroupsRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyAttributeGroupsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyAttributeGroupsRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodPost) Execute(ctx context.Context) (result *AttributeGroup, err error)

func (*ByProjectKeyAttributeGroupsRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodPost) Expand(v []string) *ByProjectKeyAttributeGroupsRequestMethodPost

func (*ByProjectKeyAttributeGroupsRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyAttributeGroupsRequestMethodPost

func (*ByProjectKeyAttributeGroupsRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyAttributeGroupsRequestMethodPost) WithQueryParams(input ByProjectKeyAttributeGroupsRequestMethodPostInput) *ByProjectKeyAttributeGroupsRequestMethodPost

type ByProjectKeyAttributeGroupsRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyAttributeGroupsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyAttributeGroupsRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyAttributeGroupsRequestMethodPostInput) Values() url.Values

type ByProjectKeyBusinessUnitsByIDRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsByIDRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestBuilder) Delete() *ByProjectKeyBusinessUnitsByIDRequestMethodDelete

func (*ByProjectKeyBusinessUnitsByIDRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestBuilder) Get() *ByProjectKeyBusinessUnitsByIDRequestMethodGet

func (*ByProjectKeyBusinessUnitsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestBuilder) Head() *ByProjectKeyBusinessUnitsByIDRequestMethodHead

* * Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyBusinessUnitsByIDRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestBuilder) Post(body BusinessUnitUpdate) *ByProjectKeyBusinessUnitsByIDRequestMethodPost

type ByProjectKeyBusinessUnitsByIDRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyBusinessUnitsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodDelete) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyBusinessUnitsByIDRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyBusinessUnitsByIDRequestMethodDelete

func (*ByProjectKeyBusinessUnitsByIDRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodDelete) Version(v int) *ByProjectKeyBusinessUnitsByIDRequestMethodDelete

func (*ByProjectKeyBusinessUnitsByIDRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsByIDRequestMethodDelete

func (*ByProjectKeyBusinessUnitsByIDRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyBusinessUnitsByIDRequestMethodDeleteInput) *ByProjectKeyBusinessUnitsByIDRequestMethodDelete

type ByProjectKeyBusinessUnitsByIDRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyBusinessUnitsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyBusinessUnitsByIDRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyBusinessUnitsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodGet) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyBusinessUnitsByIDRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyBusinessUnitsByIDRequestMethodGet

func (*ByProjectKeyBusinessUnitsByIDRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsByIDRequestMethodGet

func (*ByProjectKeyBusinessUnitsByIDRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyBusinessUnitsByIDRequestMethodGetInput) *ByProjectKeyBusinessUnitsByIDRequestMethodGet

type ByProjectKeyBusinessUnitsByIDRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyBusinessUnitsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyBusinessUnitsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyBusinessUnitsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyBusinessUnitsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyBusinessUnitsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsByIDRequestMethodHead

type ByProjectKeyBusinessUnitsByIDRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyBusinessUnitsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodPost) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyBusinessUnitsByIDRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyBusinessUnitsByIDRequestMethodPost

func (*ByProjectKeyBusinessUnitsByIDRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsByIDRequestMethodPost

func (*ByProjectKeyBusinessUnitsByIDRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyBusinessUnitsByIDRequestMethodPostInput) *ByProjectKeyBusinessUnitsByIDRequestMethodPost

type ByProjectKeyBusinessUnitsByIDRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyBusinessUnitsByIDRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyBusinessUnitsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder) Delete() *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder) Get() *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder) Head() *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead

* * Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder) Post(body BusinessUnitUpdate) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDelete

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGetInput) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGet

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodHead

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPostInput) *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPost

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyBusinessUnitsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyBusinessUnitsRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestBuilder) Get() *ByProjectKeyBusinessUnitsRequestMethodGet

func (*ByProjectKeyBusinessUnitsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsRequestBuilder) Head() *ByProjectKeyBusinessUnitsRequestMethodHead

* * Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyBusinessUnitsRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestBuilder) Post(body BusinessUnitDraft) *ByProjectKeyBusinessUnitsRequestMethodPost

func (*ByProjectKeyBusinessUnitsRequestBuilder) WithId ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestBuilder) WithId(id string) *ByProjectKeyBusinessUnitsByIDRequestBuilder

func (*ByProjectKeyBusinessUnitsRequestBuilder) WithKey ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestBuilder) WithKey(key string) *ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder

type ByProjectKeyBusinessUnitsRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyBusinessUnitsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) Execute(ctx context.Context) (result *BusinessUnitPagedQueryResponse, err error)

func (*ByProjectKeyBusinessUnitsRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) Expand(v []string) *ByProjectKeyBusinessUnitsRequestMethodGet

func (*ByProjectKeyBusinessUnitsRequestMethodGet) Limit ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) Limit(v int) *ByProjectKeyBusinessUnitsRequestMethodGet

func (*ByProjectKeyBusinessUnitsRequestMethodGet) Offset ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) Offset(v int) *ByProjectKeyBusinessUnitsRequestMethodGet

func (*ByProjectKeyBusinessUnitsRequestMethodGet) PredicateVar ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyBusinessUnitsRequestMethodGet

func (*ByProjectKeyBusinessUnitsRequestMethodGet) Sort ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) Sort(v []string) *ByProjectKeyBusinessUnitsRequestMethodGet

func (*ByProjectKeyBusinessUnitsRequestMethodGet) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) Where(v []string) *ByProjectKeyBusinessUnitsRequestMethodGet

func (*ByProjectKeyBusinessUnitsRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsRequestMethodGet

func (*ByProjectKeyBusinessUnitsRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) WithQueryParams(input ByProjectKeyBusinessUnitsRequestMethodGetInput) *ByProjectKeyBusinessUnitsRequestMethodGet

func (*ByProjectKeyBusinessUnitsRequestMethodGet) WithTotal ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodGet) WithTotal(v bool) *ByProjectKeyBusinessUnitsRequestMethodGet

type ByProjectKeyBusinessUnitsRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyBusinessUnitsRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyBusinessUnitsRequestMethodGetInput) Values() url.Values

type ByProjectKeyBusinessUnitsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyBusinessUnitsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyBusinessUnitsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyBusinessUnitsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodHead) Where(v []string) *ByProjectKeyBusinessUnitsRequestMethodHead

func (*ByProjectKeyBusinessUnitsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsRequestMethodHead

func (*ByProjectKeyBusinessUnitsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodHead) WithQueryParams(input ByProjectKeyBusinessUnitsRequestMethodHeadInput) *ByProjectKeyBusinessUnitsRequestMethodHead

type ByProjectKeyBusinessUnitsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyBusinessUnitsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyBusinessUnitsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyBusinessUnitsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyBusinessUnitsRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyBusinessUnitsRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyBusinessUnitsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyBusinessUnitsRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodPost) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyBusinessUnitsRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodPost) Expand(v []string) *ByProjectKeyBusinessUnitsRequestMethodPost

func (*ByProjectKeyBusinessUnitsRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyBusinessUnitsRequestMethodPost

func (*ByProjectKeyBusinessUnitsRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyBusinessUnitsRequestMethodPost) WithQueryParams(input ByProjectKeyBusinessUnitsRequestMethodPostInput) *ByProjectKeyBusinessUnitsRequestMethodPost

type ByProjectKeyBusinessUnitsRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyBusinessUnitsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyBusinessUnitsRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyBusinessUnitsRequestMethodPostInput) Values() url.Values

type ByProjectKeyCartDiscountsByIDRequestBuilder ¶ 

type ByProjectKeyCartDiscountsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestBuilder) Delete() *ByProjectKeyCartDiscountsByIDRequestMethodDelete

* * Deleting a Cart Discount produces the [CartDiscountDeleted](ctp:api:type:CartDiscountDeletedMessage) Message.

func (*ByProjectKeyCartDiscountsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestBuilder) Get() *ByProjectKeyCartDiscountsByIDRequestMethodGet

func (*ByProjectKeyCartDiscountsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsByIDRequestBuilder) Head() *ByProjectKeyCartDiscountsByIDRequestMethodHead

* * Checks if a CartDiscount exists for a given `id`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCartDiscountsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestBuilder) Post(body CartDiscountUpdate) *ByProjectKeyCartDiscountsByIDRequestMethodPost

type ByProjectKeyCartDiscountsByIDRequestMethodDelete ¶ 

type ByProjectKeyCartDiscountsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCartDiscountsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodDelete) Execute(ctx context.Context) (result *CartDiscount, err error)

* * Deleting a Cart Discount produces the [CartDiscountDeleted](ctp:api:type:CartDiscountDeletedMessage) Message.

func (*ByProjectKeyCartDiscountsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyCartDiscountsByIDRequestMethodDelete

func (*ByProjectKeyCartDiscountsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodDelete) Version(v int) *ByProjectKeyCartDiscountsByIDRequestMethodDelete

func (*ByProjectKeyCartDiscountsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsByIDRequestMethodDelete

func (*ByProjectKeyCartDiscountsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyCartDiscountsByIDRequestMethodDeleteInput) *ByProjectKeyCartDiscountsByIDRequestMethodDelete

type ByProjectKeyCartDiscountsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyCartDiscountsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyCartDiscountsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCartDiscountsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCartDiscountsByIDRequestMethodGet ¶ 

type ByProjectKeyCartDiscountsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCartDiscountsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodGet) Execute(ctx context.Context) (result *CartDiscount, err error)

func (*ByProjectKeyCartDiscountsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyCartDiscountsByIDRequestMethodGet

func (*ByProjectKeyCartDiscountsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsByIDRequestMethodGet

func (*ByProjectKeyCartDiscountsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyCartDiscountsByIDRequestMethodGetInput) *ByProjectKeyCartDiscountsByIDRequestMethodGet

type ByProjectKeyCartDiscountsByIDRequestMethodGetInput ¶ 

type ByProjectKeyCartDiscountsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCartDiscountsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCartDiscountsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyCartDiscountsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCartDiscountsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCartDiscountsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CartDiscount exists for a given `id`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCartDiscountsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsByIDRequestMethodHead

type ByProjectKeyCartDiscountsByIDRequestMethodPost ¶ 

type ByProjectKeyCartDiscountsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCartDiscountsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodPost) Execute(ctx context.Context) (result *CartDiscount, err error)

func (*ByProjectKeyCartDiscountsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyCartDiscountsByIDRequestMethodPost

func (*ByProjectKeyCartDiscountsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsByIDRequestMethodPost

func (*ByProjectKeyCartDiscountsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCartDiscountsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyCartDiscountsByIDRequestMethodPostInput) *ByProjectKeyCartDiscountsByIDRequestMethodPost

type ByProjectKeyCartDiscountsByIDRequestMethodPostInput ¶ 

type ByProjectKeyCartDiscountsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCartDiscountsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCartDiscountsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyCartDiscountsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyCartDiscountsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestBuilder) Delete() *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete

* * Deleting a Cart Discount produces the [CartDiscountDeleted](ctp:api:type:CartDiscountDeletedMessage) Message.

func (*ByProjectKeyCartDiscountsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestBuilder) Get() *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet

func (*ByProjectKeyCartDiscountsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestBuilder) Head() *ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead

* * Checks if a CartDiscount exists for a given `key`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCartDiscountsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestBuilder) Post(body CartDiscountUpdate) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *CartDiscount, err error)

* * Deleting a Cart Discount produces the [CartDiscountDeleted](ctp:api:type:CartDiscountDeletedMessage) Message.

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyCartDiscountsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDelete

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCartDiscountsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *CartDiscount, err error)

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyCartDiscountsKeyByKeyRequestMethodGetInput) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGet

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCartDiscountsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CartDiscount exists for a given `key`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodHead

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *CartDiscount, err error)

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyCartDiscountsKeyByKeyRequestMethodPostInput) *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPost

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyCartDiscountsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCartDiscountsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCartDiscountsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyCartDiscountsRequestBuilder ¶ 

type ByProjectKeyCartDiscountsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCartDiscountsRequestBuilder) Get() *ByProjectKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyCartDiscountsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsRequestBuilder) Head() *ByProjectKeyCartDiscountsRequestMethodHead

* * Checks if a CartDiscount exists for a given Query Predicate. Returns a `200 OK` status if any CartDiscounts match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyCartDiscountsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCartDiscountsRequestBuilder) Post(body CartDiscountDraft) *ByProjectKeyCartDiscountsRequestMethodPost

* * Creating a Cart Discount produces the [CartDiscountCreated](ctp:api:type:CartDiscountCreatedMessage) Message.

func (*ByProjectKeyCartDiscountsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyCartDiscountsRequestBuilder) WithId(id string) *ByProjectKeyCartDiscountsByIDRequestBuilder

func (*ByProjectKeyCartDiscountsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyCartDiscountsRequestBuilder) WithKey(key string) *ByProjectKeyCartDiscountsKeyByKeyRequestBuilder

type ByProjectKeyCartDiscountsRequestMethodGet ¶ 

type ByProjectKeyCartDiscountsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCartDiscountsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) Execute(ctx context.Context) (result *CartDiscountPagedQueryResponse, err error)

func (*ByProjectKeyCartDiscountsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) Expand(v []string) *ByProjectKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyCartDiscountsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) Limit(v int) *ByProjectKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyCartDiscountsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) Offset(v int) *ByProjectKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyCartDiscountsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyCartDiscountsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) Sort(v []string) *ByProjectKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyCartDiscountsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) Where(v []string) *ByProjectKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyCartDiscountsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyCartDiscountsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) WithQueryParams(input ByProjectKeyCartDiscountsRequestMethodGetInput) *ByProjectKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyCartDiscountsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodGet) WithTotal(v bool) *ByProjectKeyCartDiscountsRequestMethodGet

type ByProjectKeyCartDiscountsRequestMethodGetInput ¶ 

type ByProjectKeyCartDiscountsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyCartDiscountsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCartDiscountsRequestMethodGetInput) Values() url.Values

type ByProjectKeyCartDiscountsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCartDiscountsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCartDiscountsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CartDiscount exists for a given Query Predicate. Returns a `200 OK` status if any CartDiscounts match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyCartDiscountsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsRequestMethodHead) Where(v []string) *ByProjectKeyCartDiscountsRequestMethodHead

func (*ByProjectKeyCartDiscountsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsRequestMethodHead

func (*ByProjectKeyCartDiscountsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyCartDiscountsRequestMethodHead) WithQueryParams(input ByProjectKeyCartDiscountsRequestMethodHeadInput) *ByProjectKeyCartDiscountsRequestMethodHead

type ByProjectKeyCartDiscountsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyCartDiscountsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyCartDiscountsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyCartDiscountsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyCartDiscountsRequestMethodPost ¶ 

type ByProjectKeyCartDiscountsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartDiscountsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCartDiscountsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCartDiscountsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodPost) Execute(ctx context.Context) (result *CartDiscount, err error)

* * Creating a Cart Discount produces the [CartDiscountCreated](ctp:api:type:CartDiscountCreatedMessage) Message.

func (*ByProjectKeyCartDiscountsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodPost) Expand(v []string) *ByProjectKeyCartDiscountsRequestMethodPost

func (*ByProjectKeyCartDiscountsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCartDiscountsRequestMethodPost

func (*ByProjectKeyCartDiscountsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCartDiscountsRequestMethodPost) WithQueryParams(input ByProjectKeyCartDiscountsRequestMethodPostInput) *ByProjectKeyCartDiscountsRequestMethodPost

type ByProjectKeyCartDiscountsRequestMethodPostInput ¶ 

type ByProjectKeyCartDiscountsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCartDiscountsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCartDiscountsRequestMethodPostInput) Values() url.Values

type ByProjectKeyCartsByIDRequestBuilder ¶ 

type ByProjectKeyCartsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCartsByIDRequestBuilder) Delete() *ByProjectKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyCartsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCartsByIDRequestBuilder) Get() *ByProjectKeyCartsByIDRequestMethodGet

* * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyCartsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsByIDRequestBuilder) Head() *ByProjectKeyCartsByIDRequestMethodHead

* * Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCartsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCartsByIDRequestBuilder) Post(body CartUpdate) *ByProjectKeyCartsByIDRequestMethodPost

type ByProjectKeyCartsByIDRequestMethodDelete ¶ 

type ByProjectKeyCartsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyCartsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCartsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCartsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyCartsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyCartsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodDelete) Version(v int) *ByProjectKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyCartsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyCartsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyCartsByIDRequestMethodDeleteInput) *ByProjectKeyCartsByIDRequestMethodDelete

type ByProjectKeyCartsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyCartsByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyCartsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCartsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCartsByIDRequestMethodGet ¶ 

type ByProjectKeyCartsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCartsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCartsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyCartsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyCartsByIDRequestMethodGet

func (*ByProjectKeyCartsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCartsByIDRequestMethodGet

func (*ByProjectKeyCartsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyCartsByIDRequestMethodGetInput) *ByProjectKeyCartsByIDRequestMethodGet

type ByProjectKeyCartsByIDRequestMethodGetInput ¶ 

type ByProjectKeyCartsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCartsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCartsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyCartsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCartsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCartsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCartsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCartsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCartsByIDRequestMethodHead

type ByProjectKeyCartsByIDRequestMethodPost ¶ 

type ByProjectKeyCartsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCartsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCartsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyCartsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyCartsByIDRequestMethodPost

func (*ByProjectKeyCartsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCartsByIDRequestMethodPost

func (*ByProjectKeyCartsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCartsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyCartsByIDRequestMethodPostInput) *ByProjectKeyCartsByIDRequestMethodPost

type ByProjectKeyCartsByIDRequestMethodPostInput ¶ 

type ByProjectKeyCartsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCartsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCartsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyCartsCustomerIdByCustomerIdRequestBuilder ¶ 

type ByProjectKeyCartsCustomerIdByCustomerIdRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCartsCustomerIdByCustomerIdRequestBuilder) Get() *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet

* * Retrieves the recently modified active Cart of a Customer with CartOrigin(ctp:api:type:CartOrigin) `Customer`. If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsCustomerIdByCustomerIdRequestBuilder) Head() *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead

* * Checks if a Cart of a Customer exists. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

type ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet ¶ 

type ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * Retrieves the recently modified active Cart of a Customer with CartOrigin(ctp:api:type:CartOrigin) `Customer`. If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) Expand(v []string) *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet) WithQueryParams(input ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGetInput) *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGet

type ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGetInput ¶ 

type ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodGetInput) Values() url.Values

type ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart of a Customer exists. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCartsCustomerIdByCustomerIdRequestMethodHead

type ByProjectKeyCartsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyCartsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestBuilder) Delete() *ByProjectKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCartsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestBuilder) Get() *ByProjectKeyCartsKeyByKeyRequestMethodGet

* * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyCartsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsKeyByKeyRequestBuilder) Head() *ByProjectKeyCartsKeyByKeyRequestMethodHead

* * Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCartsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestBuilder) Post(body CartUpdate) *ByProjectKeyCartsKeyByKeyRequestMethodPost

type ByProjectKeyCartsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyCartsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsKeyByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCartsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCartsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCartsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyCartsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCartsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCartsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCartsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyCartsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyCartsKeyByKeyRequestMethodDelete

type ByProjectKeyCartsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyCartsKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyCartsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCartsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCartsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyCartsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCartsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCartsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyCartsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyCartsKeyByKeyRequestMethodGet

func (*ByProjectKeyCartsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCartsKeyByKeyRequestMethodGet

func (*ByProjectKeyCartsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyCartsKeyByKeyRequestMethodGetInput) *ByProjectKeyCartsKeyByKeyRequestMethodGet

type ByProjectKeyCartsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyCartsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCartsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCartsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyCartsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCartsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCartsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCartsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCartsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCartsKeyByKeyRequestMethodHead

type ByProjectKeyCartsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyCartsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCartsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCartsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyCartsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyCartsKeyByKeyRequestMethodPost

func (*ByProjectKeyCartsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCartsKeyByKeyRequestMethodPost

func (*ByProjectKeyCartsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCartsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyCartsKeyByKeyRequestMethodPostInput) *ByProjectKeyCartsKeyByKeyRequestMethodPost

type ByProjectKeyCartsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyCartsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCartsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCartsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyCartsReplicateRequestBuilder ¶ 

type ByProjectKeyCartsReplicateRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsReplicateRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCartsReplicateRequestBuilder) Post(body ReplicaCartDraft) *ByProjectKeyCartsReplicateRequestMethodPost

* * Creates a new Cart by replicating an existing Cart or Order. Can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order. * * The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` CartState(ctp:api:type:CartState). * * The new Cart does not contain Payments or Deliveries. The State(ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. *

type ByProjectKeyCartsReplicateRequestMethodPost ¶ 

type ByProjectKeyCartsReplicateRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsReplicateRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCartsReplicateRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCartsReplicateRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCartsReplicateRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * Creates a new Cart by replicating an existing Cart or Order. Can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order. * * The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` CartState(ctp:api:type:CartState). * * The new Cart does not contain Payments or Deliveries. The State(ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. *

func (*ByProjectKeyCartsReplicateRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCartsReplicateRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCartsReplicateRequestMethodPost

type ByProjectKeyCartsRequestBuilder ¶ 

type ByProjectKeyCartsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCartsRequestBuilder) Get() *ByProjectKeyCartsRequestMethodGet

func (*ByProjectKeyCartsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsRequestBuilder) Head() *ByProjectKeyCartsRequestMethodHead

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyCartsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCartsRequestBuilder) Post(body CartDraft) *ByProjectKeyCartsRequestMethodPost

* * Creating a Cart fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) error if the * ShippingMethod(ctp:api:type:ShippingMethod) referenced in the CartDraft * has a `predicate` that does not match the Cart. *

func (*ByProjectKeyCartsRequestBuilder) Replicate ¶ 

func (rb *ByProjectKeyCartsRequestBuilder) Replicate() *ByProjectKeyCartsReplicateRequestBuilder

func (*ByProjectKeyCartsRequestBuilder) WithCustomerId ¶ 

func (rb *ByProjectKeyCartsRequestBuilder) WithCustomerId(customerId string) *ByProjectKeyCartsCustomerIdByCustomerIdRequestBuilder

func (*ByProjectKeyCartsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyCartsRequestBuilder) WithId(id string) *ByProjectKeyCartsByIDRequestBuilder

func (*ByProjectKeyCartsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyCartsRequestBuilder) WithKey(key string) *ByProjectKeyCartsKeyByKeyRequestBuilder

type ByProjectKeyCartsRequestMethodGet ¶ 

type ByProjectKeyCartsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCartsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCartsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) Execute(ctx context.Context) (result *CartPagedQueryResponse, err error)

func (*ByProjectKeyCartsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) Expand(v []string) *ByProjectKeyCartsRequestMethodGet

func (*ByProjectKeyCartsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) Limit(v int) *ByProjectKeyCartsRequestMethodGet

func (*ByProjectKeyCartsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) Offset(v int) *ByProjectKeyCartsRequestMethodGet

func (*ByProjectKeyCartsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyCartsRequestMethodGet

func (*ByProjectKeyCartsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) Sort(v []string) *ByProjectKeyCartsRequestMethodGet

func (*ByProjectKeyCartsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) Where(v []string) *ByProjectKeyCartsRequestMethodGet

func (*ByProjectKeyCartsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCartsRequestMethodGet

func (*ByProjectKeyCartsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) WithQueryParams(input ByProjectKeyCartsRequestMethodGetInput) *ByProjectKeyCartsRequestMethodGet

func (*ByProjectKeyCartsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyCartsRequestMethodGet) WithTotal(v bool) *ByProjectKeyCartsRequestMethodGet

type ByProjectKeyCartsRequestMethodGetInput ¶ 

type ByProjectKeyCartsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyCartsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCartsRequestMethodGetInput) Values() url.Values

type ByProjectKeyCartsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCartsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCartsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCartsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyCartsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsRequestMethodHead) Where(v []string) *ByProjectKeyCartsRequestMethodHead

func (*ByProjectKeyCartsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCartsRequestMethodHead

func (*ByProjectKeyCartsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyCartsRequestMethodHead) WithQueryParams(input ByProjectKeyCartsRequestMethodHeadInput) *ByProjectKeyCartsRequestMethodHead

type ByProjectKeyCartsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyCartsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyCartsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyCartsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyCartsRequestMethodPost ¶ 

type ByProjectKeyCartsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCartsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCartsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCartsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCartsRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * Creating a Cart fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) error if the * ShippingMethod(ctp:api:type:ShippingMethod) referenced in the CartDraft * has a `predicate` that does not match the Cart. *

func (*ByProjectKeyCartsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCartsRequestMethodPost) Expand(v []string) *ByProjectKeyCartsRequestMethodPost

func (*ByProjectKeyCartsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCartsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCartsRequestMethodPost

func (*ByProjectKeyCartsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCartsRequestMethodPost) WithQueryParams(input ByProjectKeyCartsRequestMethodPostInput) *ByProjectKeyCartsRequestMethodPost

type ByProjectKeyCartsRequestMethodPostInput ¶ 

type ByProjectKeyCartsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCartsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCartsRequestMethodPostInput) Values() url.Values

type ByProjectKeyCategoriesByIDRequestBuilder ¶ 

type ByProjectKeyCategoriesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestBuilder) Delete() *ByProjectKeyCategoriesByIDRequestMethodDelete

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestBuilder) Get() *ByProjectKeyCategoriesByIDRequestMethodGet

* * Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesByIDRequestBuilder) Head() *ByProjectKeyCategoriesByIDRequestMethodHead

* * Checks if a Category exists for a given `id`. Returns a `200 OK` status if the Category exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCategoriesByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestBuilder) Post(body CategoryUpdate) *ByProjectKeyCategoriesByIDRequestMethodPost

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. *

type ByProjectKeyCategoriesByIDRequestMethodDelete ¶ 

type ByProjectKeyCategoriesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCategoriesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodDelete) Execute(ctx context.Context) (result *Category, err error)

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyCategoriesByIDRequestMethodDelete

func (*ByProjectKeyCategoriesByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodDelete) Version(v int) *ByProjectKeyCategoriesByIDRequestMethodDelete

func (*ByProjectKeyCategoriesByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCategoriesByIDRequestMethodDelete

func (*ByProjectKeyCategoriesByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyCategoriesByIDRequestMethodDeleteInput) *ByProjectKeyCategoriesByIDRequestMethodDelete

type ByProjectKeyCategoriesByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyCategoriesByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyCategoriesByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCategoriesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCategoriesByIDRequestMethodGet ¶ 

type ByProjectKeyCategoriesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCategoriesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodGet) Execute(ctx context.Context) (result *Category, err error)

* * Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyCategoriesByIDRequestMethodGet

func (*ByProjectKeyCategoriesByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCategoriesByIDRequestMethodGet

func (*ByProjectKeyCategoriesByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyCategoriesByIDRequestMethodGetInput) *ByProjectKeyCategoriesByIDRequestMethodGet

type ByProjectKeyCategoriesByIDRequestMethodGetInput ¶ 

type ByProjectKeyCategoriesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCategoriesByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCategoriesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyCategoriesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCategoriesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCategoriesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Category exists for a given `id`. Returns a `200 OK` status if the Category exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCategoriesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCategoriesByIDRequestMethodHead

type ByProjectKeyCategoriesByIDRequestMethodPost ¶ 

type ByProjectKeyCategoriesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCategoriesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodPost) Execute(ctx context.Context) (result *Category, err error)

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyCategoriesByIDRequestMethodPost

func (*ByProjectKeyCategoriesByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCategoriesByIDRequestMethodPost

func (*ByProjectKeyCategoriesByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCategoriesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyCategoriesByIDRequestMethodPostInput) *ByProjectKeyCategoriesByIDRequestMethodPost

type ByProjectKeyCategoriesByIDRequestMethodPostInput ¶ 

type ByProjectKeyCategoriesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCategoriesByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCategoriesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyCategoriesKeyByKeyRequestBuilder ¶ 

type ByProjectKeyCategoriesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestBuilder) Delete() *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestBuilder) Get() *ByProjectKeyCategoriesKeyByKeyRequestMethodGet

* * Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestBuilder) Head() *ByProjectKeyCategoriesKeyByKeyRequestMethodHead

* * Checks if a Category exists for a given `key`. Returns a `200 OK` status if the Category exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCategoriesKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestBuilder) Post(body CategoryUpdate) *ByProjectKeyCategoriesKeyByKeyRequestMethodPost

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. *

type ByProjectKeyCategoriesKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyCategoriesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Category, err error)

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyCategoriesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyCategoriesKeyByKeyRequestMethodDelete

type ByProjectKeyCategoriesKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyCategoriesKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCategoriesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCategoriesKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyCategoriesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCategoriesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Category, err error)

* * Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyCategoriesKeyByKeyRequestMethodGet

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCategoriesKeyByKeyRequestMethodGet

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyCategoriesKeyByKeyRequestMethodGetInput) *ByProjectKeyCategoriesKeyByKeyRequestMethodGet

type ByProjectKeyCategoriesKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyCategoriesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCategoriesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyCategoriesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCategoriesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCategoriesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Category exists for a given `key`. Returns a `200 OK` status if the Category exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCategoriesKeyByKeyRequestMethodHead

type ByProjectKeyCategoriesKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyCategoriesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCategoriesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Category, err error)

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyCategoriesKeyByKeyRequestMethodPost

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCategoriesKeyByKeyRequestMethodPost

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCategoriesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyCategoriesKeyByKeyRequestMethodPostInput) *ByProjectKeyCategoriesKeyByKeyRequestMethodPost

type ByProjectKeyCategoriesKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyCategoriesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCategoriesKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCategoriesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyCategoriesRequestBuilder ¶ 

type ByProjectKeyCategoriesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCategoriesRequestBuilder) Get() *ByProjectKeyCategoriesRequestMethodGet

* * Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesRequestBuilder) Head() *ByProjectKeyCategoriesRequestMethodHead

* * Checks if a Category exists for on a given Query Predicate. Returns a `200 OK` status if any Categories match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyCategoriesRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCategoriesRequestBuilder) Post(body CategoryDraft) *ByProjectKeyCategoriesRequestMethodPost

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. * * Creating a Category produces the [CategoryCreated](ctp:api:type:CategoryCreatedMessage) Message. *

func (*ByProjectKeyCategoriesRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyCategoriesRequestBuilder) WithId(id string) *ByProjectKeyCategoriesByIDRequestBuilder

func (*ByProjectKeyCategoriesRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyCategoriesRequestBuilder) WithKey(key string) *ByProjectKeyCategoriesKeyByKeyRequestBuilder

type ByProjectKeyCategoriesRequestMethodGet ¶ 

type ByProjectKeyCategoriesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCategoriesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) Execute(ctx context.Context) (result *CategoryPagedQueryResponse, err error)

* * Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required. *

func (*ByProjectKeyCategoriesRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) Expand(v []string) *ByProjectKeyCategoriesRequestMethodGet

func (*ByProjectKeyCategoriesRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) Limit(v int) *ByProjectKeyCategoriesRequestMethodGet

func (*ByProjectKeyCategoriesRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) Offset(v int) *ByProjectKeyCategoriesRequestMethodGet

func (*ByProjectKeyCategoriesRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyCategoriesRequestMethodGet

func (*ByProjectKeyCategoriesRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) Sort(v []string) *ByProjectKeyCategoriesRequestMethodGet

func (*ByProjectKeyCategoriesRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) Where(v []string) *ByProjectKeyCategoriesRequestMethodGet

func (*ByProjectKeyCategoriesRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCategoriesRequestMethodGet

func (*ByProjectKeyCategoriesRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) WithQueryParams(input ByProjectKeyCategoriesRequestMethodGetInput) *ByProjectKeyCategoriesRequestMethodGet

func (*ByProjectKeyCategoriesRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodGet) WithTotal(v bool) *ByProjectKeyCategoriesRequestMethodGet

type ByProjectKeyCategoriesRequestMethodGetInput ¶ 

type ByProjectKeyCategoriesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyCategoriesRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCategoriesRequestMethodGetInput) Values() url.Values

type ByProjectKeyCategoriesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCategoriesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCategoriesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Category exists for on a given Query Predicate. Returns a `200 OK` status if any Categories match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyCategoriesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesRequestMethodHead) Where(v []string) *ByProjectKeyCategoriesRequestMethodHead

func (*ByProjectKeyCategoriesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCategoriesRequestMethodHead

func (*ByProjectKeyCategoriesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyCategoriesRequestMethodHead) WithQueryParams(input ByProjectKeyCategoriesRequestMethodHeadInput) *ByProjectKeyCategoriesRequestMethodHead

type ByProjectKeyCategoriesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyCategoriesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyCategoriesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyCategoriesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyCategoriesRequestMethodPost ¶ 

type ByProjectKeyCategoriesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCategoriesRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCategoriesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCategoriesRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodPost) Execute(ctx context.Context) (result *Category, err error)

* * Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required. * * Creating a Category produces the [CategoryCreated](ctp:api:type:CategoryCreatedMessage) Message. *

func (*ByProjectKeyCategoriesRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodPost) Expand(v []string) *ByProjectKeyCategoriesRequestMethodPost

func (*ByProjectKeyCategoriesRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCategoriesRequestMethodPost

func (*ByProjectKeyCategoriesRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCategoriesRequestMethodPost) WithQueryParams(input ByProjectKeyCategoriesRequestMethodPostInput) *ByProjectKeyCategoriesRequestMethodPost

type ByProjectKeyCategoriesRequestMethodPostInput ¶ 

type ByProjectKeyCategoriesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCategoriesRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCategoriesRequestMethodPostInput) Values() url.Values

type ByProjectKeyChannelsByIDRequestBuilder ¶ 

type ByProjectKeyChannelsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyChannelsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyChannelsByIDRequestBuilder) Delete() *ByProjectKeyChannelsByIDRequestMethodDelete

func (*ByProjectKeyChannelsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyChannelsByIDRequestBuilder) Get() *ByProjectKeyChannelsByIDRequestMethodGet

func (*ByProjectKeyChannelsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyChannelsByIDRequestBuilder) Head() *ByProjectKeyChannelsByIDRequestMethodHead

* * Checks if a Channel exists for a given `id`. Returns a `200 OK` status if the Channel exists or a `404 Not Found` otherwise.

func (*ByProjectKeyChannelsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyChannelsByIDRequestBuilder) Post(body ChannelUpdate) *ByProjectKeyChannelsByIDRequestMethodPost

type ByProjectKeyChannelsByIDRequestMethodDelete ¶ 

type ByProjectKeyChannelsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyChannelsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyChannelsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyChannelsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Channel, err error)

func (*ByProjectKeyChannelsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyChannelsByIDRequestMethodDelete

func (*ByProjectKeyChannelsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodDelete) Version(v int) *ByProjectKeyChannelsByIDRequestMethodDelete

func (*ByProjectKeyChannelsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyChannelsByIDRequestMethodDelete

func (*ByProjectKeyChannelsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyChannelsByIDRequestMethodDeleteInput) *ByProjectKeyChannelsByIDRequestMethodDelete

type ByProjectKeyChannelsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyChannelsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyChannelsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyChannelsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyChannelsByIDRequestMethodGet ¶ 

type ByProjectKeyChannelsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyChannelsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyChannelsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyChannelsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodGet) Execute(ctx context.Context) (result *Channel, err error)

func (*ByProjectKeyChannelsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyChannelsByIDRequestMethodGet

func (*ByProjectKeyChannelsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyChannelsByIDRequestMethodGet

func (*ByProjectKeyChannelsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyChannelsByIDRequestMethodGetInput) *ByProjectKeyChannelsByIDRequestMethodGet

type ByProjectKeyChannelsByIDRequestMethodGetInput ¶ 

type ByProjectKeyChannelsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyChannelsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyChannelsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyChannelsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyChannelsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyChannelsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyChannelsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyChannelsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyChannelsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Channel exists for a given `id`. Returns a `200 OK` status if the Channel exists or a `404 Not Found` otherwise.

func (*ByProjectKeyChannelsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyChannelsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyChannelsByIDRequestMethodHead

type ByProjectKeyChannelsByIDRequestMethodPost ¶ 

type ByProjectKeyChannelsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyChannelsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyChannelsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyChannelsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodPost) Execute(ctx context.Context) (result *Channel, err error)

func (*ByProjectKeyChannelsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyChannelsByIDRequestMethodPost

func (*ByProjectKeyChannelsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyChannelsByIDRequestMethodPost

func (*ByProjectKeyChannelsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyChannelsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyChannelsByIDRequestMethodPostInput) *ByProjectKeyChannelsByIDRequestMethodPost

type ByProjectKeyChannelsByIDRequestMethodPostInput ¶ 

type ByProjectKeyChannelsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyChannelsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyChannelsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyChannelsRequestBuilder ¶ 

type ByProjectKeyChannelsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyChannelsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyChannelsRequestBuilder) Get() *ByProjectKeyChannelsRequestMethodGet

func (*ByProjectKeyChannelsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyChannelsRequestBuilder) Head() *ByProjectKeyChannelsRequestMethodHead

* * Checks if a Channel exists for a given Query Predicate. Returns a `200 OK` status if any Channels match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyChannelsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyChannelsRequestBuilder) Post(body ChannelDraft) *ByProjectKeyChannelsRequestMethodPost

func (*ByProjectKeyChannelsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyChannelsRequestBuilder) WithId(id string) *ByProjectKeyChannelsByIDRequestBuilder

type ByProjectKeyChannelsRequestMethodGet ¶ 

type ByProjectKeyChannelsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyChannelsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyChannelsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyChannelsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) Execute(ctx context.Context) (result *ChannelPagedQueryResponse, err error)

func (*ByProjectKeyChannelsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) Expand(v []string) *ByProjectKeyChannelsRequestMethodGet

func (*ByProjectKeyChannelsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) Limit(v int) *ByProjectKeyChannelsRequestMethodGet

func (*ByProjectKeyChannelsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) Offset(v int) *ByProjectKeyChannelsRequestMethodGet

func (*ByProjectKeyChannelsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyChannelsRequestMethodGet

func (*ByProjectKeyChannelsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) Sort(v []string) *ByProjectKeyChannelsRequestMethodGet

func (*ByProjectKeyChannelsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) Where(v []string) *ByProjectKeyChannelsRequestMethodGet

func (*ByProjectKeyChannelsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyChannelsRequestMethodGet

func (*ByProjectKeyChannelsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) WithQueryParams(input ByProjectKeyChannelsRequestMethodGetInput) *ByProjectKeyChannelsRequestMethodGet

func (*ByProjectKeyChannelsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyChannelsRequestMethodGet) WithTotal(v bool) *ByProjectKeyChannelsRequestMethodGet

type ByProjectKeyChannelsRequestMethodGetInput ¶ 

type ByProjectKeyChannelsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyChannelsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyChannelsRequestMethodGetInput) Values() url.Values

type ByProjectKeyChannelsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyChannelsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyChannelsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyChannelsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyChannelsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyChannelsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Channel exists for a given Query Predicate. Returns a `200 OK` status if any Channels match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyChannelsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyChannelsRequestMethodHead) Where(v []string) *ByProjectKeyChannelsRequestMethodHead

func (*ByProjectKeyChannelsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyChannelsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyChannelsRequestMethodHead

func (*ByProjectKeyChannelsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyChannelsRequestMethodHead) WithQueryParams(input ByProjectKeyChannelsRequestMethodHeadInput) *ByProjectKeyChannelsRequestMethodHead

type ByProjectKeyChannelsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyChannelsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyChannelsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyChannelsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyChannelsRequestMethodPost ¶ 

type ByProjectKeyChannelsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyChannelsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyChannelsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyChannelsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyChannelsRequestMethodPost) Execute(ctx context.Context) (result *Channel, err error)

func (*ByProjectKeyChannelsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyChannelsRequestMethodPost) Expand(v []string) *ByProjectKeyChannelsRequestMethodPost

func (*ByProjectKeyChannelsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyChannelsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyChannelsRequestMethodPost

func (*ByProjectKeyChannelsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyChannelsRequestMethodPost) WithQueryParams(input ByProjectKeyChannelsRequestMethodPostInput) *ByProjectKeyChannelsRequestMethodPost

type ByProjectKeyChannelsRequestMethodPostInput ¶ 

type ByProjectKeyChannelsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyChannelsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyChannelsRequestMethodPostInput) Values() url.Values

type ByProjectKeyCustomObjectsByContainerByKeyRequestBuilder ¶ 

type ByProjectKeyCustomObjectsByContainerByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestBuilder) Delete() *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestBuilder) Get() *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet

type ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete ¶ 

type ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) Execute(ctx context.Context) (result *CustomObject, err error)

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) Version(v int) *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDeleteInput) *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDelete

type ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDeleteInput struct {
	Version     *int
	Expand      []string
	DataErasure *bool
}

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet ¶ 

type ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) Execute(ctx context.Context) (result *CustomObject, err error)

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGetInput) *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGet

type ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGetInput ¶ 

type ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomObjectsByContainerByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomObjectsByContainerRequestBuilder ¶ 

type ByProjectKeyCustomObjectsByContainerRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomObjectsByContainerRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestBuilder) Get() *ByProjectKeyCustomObjectsByContainerRequestMethodGet

type ByProjectKeyCustomObjectsByContainerRequestMethodGet ¶ 

type ByProjectKeyCustomObjectsByContainerRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomObjectsByContainerRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) Execute(ctx context.Context) (result *CustomObjectPagedQueryResponse, err error)

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) Expand(v []string) *ByProjectKeyCustomObjectsByContainerRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) Limit(v int) *ByProjectKeyCustomObjectsByContainerRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) Offset(v int) *ByProjectKeyCustomObjectsByContainerRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyCustomObjectsByContainerRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) Sort(v []string) *ByProjectKeyCustomObjectsByContainerRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) Where(v []string) *ByProjectKeyCustomObjectsByContainerRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomObjectsByContainerRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) WithQueryParams(input ByProjectKeyCustomObjectsByContainerRequestMethodGetInput) *ByProjectKeyCustomObjectsByContainerRequestMethodGet

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyCustomObjectsByContainerRequestMethodGet) WithTotal(v bool) *ByProjectKeyCustomObjectsByContainerRequestMethodGet

type ByProjectKeyCustomObjectsByContainerRequestMethodGetInput ¶ 

type ByProjectKeyCustomObjectsByContainerRequestMethodGetInput struct {
	Sort         []string
	Where        []string
	Expand       []string
	PredicateVar map[string][]string
	Limit        *int
	Offset       *int
	WithTotal    *bool
}

func (*ByProjectKeyCustomObjectsByContainerRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomObjectsByContainerRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomObjectsRequestBuilder ¶ 

type ByProjectKeyCustomObjectsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomObjectsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomObjectsRequestBuilder) Get() *ByProjectKeyCustomObjectsRequestMethodGet

* * For performance reasons, it is highly advisable to query for Custom Objects in a container by using the `container` field in the `where` predicate. *

func (*ByProjectKeyCustomObjectsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomObjectsRequestBuilder) Head() *ByProjectKeyCustomObjectsRequestMethodHead

* * Checks if a CustomObject exists for a given Query Predicate. Returns a `200 OK` status if any CustomObjects match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomObjectsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomObjectsRequestBuilder) Post(body CustomObjectDraft) *ByProjectKeyCustomObjectsRequestMethodPost

* * If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented. * If the request contains a version and an object with the given container/key, then the version must match the version of the existing object. Concurrent updates to the same Custom Object returns a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error even if the version is not provided. * * Fields with `null` values will **not be saved**. *

func (*ByProjectKeyCustomObjectsRequestBuilder) WithContainer ¶ 

func (rb *ByProjectKeyCustomObjectsRequestBuilder) WithContainer(container string) *ByProjectKeyCustomObjectsByContainerRequestBuilder

func (*ByProjectKeyCustomObjectsRequestBuilder) WithContainerAndKey ¶ 

func (rb *ByProjectKeyCustomObjectsRequestBuilder) WithContainerAndKey(container string, key string) *ByProjectKeyCustomObjectsByContainerByKeyRequestBuilder

type ByProjectKeyCustomObjectsRequestMethodGet ¶ 

type ByProjectKeyCustomObjectsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomObjectsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomObjectsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomObjectsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) Execute(ctx context.Context) (result *CustomObjectPagedQueryResponse, err error)

* * For performance reasons, it is highly advisable to query for Custom Objects in a container by using the `container` field in the `where` predicate. *

func (*ByProjectKeyCustomObjectsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) Expand(v []string) *ByProjectKeyCustomObjectsRequestMethodGet

func (*ByProjectKeyCustomObjectsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) Limit(v int) *ByProjectKeyCustomObjectsRequestMethodGet

func (*ByProjectKeyCustomObjectsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) Offset(v int) *ByProjectKeyCustomObjectsRequestMethodGet

func (*ByProjectKeyCustomObjectsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyCustomObjectsRequestMethodGet

func (*ByProjectKeyCustomObjectsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) Sort(v []string) *ByProjectKeyCustomObjectsRequestMethodGet

func (*ByProjectKeyCustomObjectsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) Where(v []string) *ByProjectKeyCustomObjectsRequestMethodGet

func (*ByProjectKeyCustomObjectsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomObjectsRequestMethodGet

func (*ByProjectKeyCustomObjectsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) WithQueryParams(input ByProjectKeyCustomObjectsRequestMethodGetInput) *ByProjectKeyCustomObjectsRequestMethodGet

func (*ByProjectKeyCustomObjectsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodGet) WithTotal(v bool) *ByProjectKeyCustomObjectsRequestMethodGet

type ByProjectKeyCustomObjectsRequestMethodGetInput ¶ 

type ByProjectKeyCustomObjectsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyCustomObjectsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomObjectsRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomObjectsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCustomObjectsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomObjectsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCustomObjectsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCustomObjectsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomObjectsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CustomObject exists for a given Query Predicate. Returns a `200 OK` status if any CustomObjects match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomObjectsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomObjectsRequestMethodHead) Where(v []string) *ByProjectKeyCustomObjectsRequestMethodHead

func (*ByProjectKeyCustomObjectsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomObjectsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCustomObjectsRequestMethodHead

func (*ByProjectKeyCustomObjectsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomObjectsRequestMethodHead) WithQueryParams(input ByProjectKeyCustomObjectsRequestMethodHeadInput) *ByProjectKeyCustomObjectsRequestMethodHead

type ByProjectKeyCustomObjectsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyCustomObjectsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyCustomObjectsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyCustomObjectsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyCustomObjectsRequestMethodPost ¶ 

type ByProjectKeyCustomObjectsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomObjectsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomObjectsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomObjectsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodPost) Execute(ctx context.Context) (result *CustomObject, err error)

* * If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented. * If the request contains a version and an object with the given container/key, then the version must match the version of the existing object. Concurrent updates to the same Custom Object returns a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error even if the version is not provided. * * Fields with `null` values will **not be saved**. *

func (*ByProjectKeyCustomObjectsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodPost) Expand(v []string) *ByProjectKeyCustomObjectsRequestMethodPost

func (*ByProjectKeyCustomObjectsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomObjectsRequestMethodPost

func (*ByProjectKeyCustomObjectsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomObjectsRequestMethodPost) WithQueryParams(input ByProjectKeyCustomObjectsRequestMethodPostInput) *ByProjectKeyCustomObjectsRequestMethodPost

type ByProjectKeyCustomObjectsRequestMethodPostInput ¶ 

type ByProjectKeyCustomObjectsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCustomObjectsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCustomObjectsRequestMethodPostInput) Values() url.Values

type ByProjectKeyCustomerGroupsByIDRequestBuilder ¶ 

type ByProjectKeyCustomerGroupsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestBuilder) Delete() *ByProjectKeyCustomerGroupsByIDRequestMethodDelete

func (*ByProjectKeyCustomerGroupsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestBuilder) Get() *ByProjectKeyCustomerGroupsByIDRequestMethodGet

func (*ByProjectKeyCustomerGroupsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsByIDRequestBuilder) Head() *ByProjectKeyCustomerGroupsByIDRequestMethodHead

* * Checks if a CustomerGroup exists for a given `id`. Returns a `200 OK` status if the CustomerGroup exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomerGroupsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestBuilder) Post(body CustomerGroupUpdate) *ByProjectKeyCustomerGroupsByIDRequestMethodPost

type ByProjectKeyCustomerGroupsByIDRequestMethodDelete ¶ 

type ByProjectKeyCustomerGroupsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCustomerGroupsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodDelete) Execute(ctx context.Context) (result *CustomerGroup, err error)

func (*ByProjectKeyCustomerGroupsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyCustomerGroupsByIDRequestMethodDelete

func (*ByProjectKeyCustomerGroupsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodDelete) Version(v int) *ByProjectKeyCustomerGroupsByIDRequestMethodDelete

func (*ByProjectKeyCustomerGroupsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsByIDRequestMethodDelete

func (*ByProjectKeyCustomerGroupsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyCustomerGroupsByIDRequestMethodDeleteInput) *ByProjectKeyCustomerGroupsByIDRequestMethodDelete

type ByProjectKeyCustomerGroupsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyCustomerGroupsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCustomerGroupsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCustomerGroupsByIDRequestMethodGet ¶ 

type ByProjectKeyCustomerGroupsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomerGroupsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodGet) Execute(ctx context.Context) (result *CustomerGroup, err error)

func (*ByProjectKeyCustomerGroupsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyCustomerGroupsByIDRequestMethodGet

func (*ByProjectKeyCustomerGroupsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsByIDRequestMethodGet

func (*ByProjectKeyCustomerGroupsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyCustomerGroupsByIDRequestMethodGetInput) *ByProjectKeyCustomerGroupsByIDRequestMethodGet

type ByProjectKeyCustomerGroupsByIDRequestMethodGetInput ¶ 

type ByProjectKeyCustomerGroupsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomerGroupsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomerGroupsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCustomerGroupsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCustomerGroupsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CustomerGroup exists for a given `id`. Returns a `200 OK` status if the CustomerGroup exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomerGroupsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsByIDRequestMethodHead

type ByProjectKeyCustomerGroupsByIDRequestMethodPost ¶ 

type ByProjectKeyCustomerGroupsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomerGroupsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodPost) Execute(ctx context.Context) (result *CustomerGroup, err error)

func (*ByProjectKeyCustomerGroupsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyCustomerGroupsByIDRequestMethodPost

func (*ByProjectKeyCustomerGroupsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsByIDRequestMethodPost

func (*ByProjectKeyCustomerGroupsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomerGroupsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyCustomerGroupsByIDRequestMethodPostInput) *ByProjectKeyCustomerGroupsByIDRequestMethodPost

type ByProjectKeyCustomerGroupsByIDRequestMethodPostInput ¶ 

type ByProjectKeyCustomerGroupsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCustomerGroupsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCustomerGroupsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder) Delete() *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder) Get() *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder) Head() *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead

* * Checks if a CustomerGroup exists for a given `key`. Returns a `200 OK` status if the CustomerGroup exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder) Post(body CustomerGroupUpdate) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *CustomerGroup, err error)

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDelete

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *CustomerGroup, err error)

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGetInput) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGet

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CustomerGroup exists for a given `key`. Returns a `200 OK` status if the CustomerGroup exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodHead

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *CustomerGroup, err error)

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPostInput) *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPost

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCustomerGroupsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyCustomerGroupsRequestBuilder ¶ 

type ByProjectKeyCustomerGroupsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestBuilder) Get() *ByProjectKeyCustomerGroupsRequestMethodGet

func (*ByProjectKeyCustomerGroupsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsRequestBuilder) Head() *ByProjectKeyCustomerGroupsRequestMethodHead

* * Checks if a CustomerGroup exists for a given Query Predicate. Returns a `200 OK` status if any CustomerGroup match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomerGroupsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestBuilder) Post(body CustomerGroupDraft) *ByProjectKeyCustomerGroupsRequestMethodPost

func (*ByProjectKeyCustomerGroupsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestBuilder) WithId(id string) *ByProjectKeyCustomerGroupsByIDRequestBuilder

func (*ByProjectKeyCustomerGroupsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestBuilder) WithKey(key string) *ByProjectKeyCustomerGroupsKeyByKeyRequestBuilder

type ByProjectKeyCustomerGroupsRequestMethodGet ¶ 

type ByProjectKeyCustomerGroupsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomerGroupsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) Execute(ctx context.Context) (result *CustomerGroupPagedQueryResponse, err error)

func (*ByProjectKeyCustomerGroupsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) Expand(v []string) *ByProjectKeyCustomerGroupsRequestMethodGet

func (*ByProjectKeyCustomerGroupsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) Limit(v int) *ByProjectKeyCustomerGroupsRequestMethodGet

func (*ByProjectKeyCustomerGroupsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) Offset(v int) *ByProjectKeyCustomerGroupsRequestMethodGet

func (*ByProjectKeyCustomerGroupsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyCustomerGroupsRequestMethodGet

func (*ByProjectKeyCustomerGroupsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) Sort(v []string) *ByProjectKeyCustomerGroupsRequestMethodGet

func (*ByProjectKeyCustomerGroupsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) Where(v []string) *ByProjectKeyCustomerGroupsRequestMethodGet

func (*ByProjectKeyCustomerGroupsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsRequestMethodGet

func (*ByProjectKeyCustomerGroupsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) WithQueryParams(input ByProjectKeyCustomerGroupsRequestMethodGetInput) *ByProjectKeyCustomerGroupsRequestMethodGet

func (*ByProjectKeyCustomerGroupsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodGet) WithTotal(v bool) *ByProjectKeyCustomerGroupsRequestMethodGet

type ByProjectKeyCustomerGroupsRequestMethodGetInput ¶ 

type ByProjectKeyCustomerGroupsRequestMethodGetInput struct {
	Where        []string
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	PredicateVar map[string][]string
}

func (*ByProjectKeyCustomerGroupsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomerGroupsRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomerGroupsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCustomerGroupsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCustomerGroupsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CustomerGroup exists for a given Query Predicate. Returns a `200 OK` status if any CustomerGroup match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomerGroupsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsRequestMethodHead) Where(v []string) *ByProjectKeyCustomerGroupsRequestMethodHead

func (*ByProjectKeyCustomerGroupsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsRequestMethodHead

func (*ByProjectKeyCustomerGroupsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomerGroupsRequestMethodHead) WithQueryParams(input ByProjectKeyCustomerGroupsRequestMethodHeadInput) *ByProjectKeyCustomerGroupsRequestMethodHead

type ByProjectKeyCustomerGroupsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyCustomerGroupsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyCustomerGroupsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyCustomerGroupsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyCustomerGroupsRequestMethodPost ¶ 

type ByProjectKeyCustomerGroupsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomerGroupsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomerGroupsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomerGroupsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodPost) Execute(ctx context.Context) (result *CustomerGroup, err error)

func (*ByProjectKeyCustomerGroupsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodPost) Expand(v []string) *ByProjectKeyCustomerGroupsRequestMethodPost

func (*ByProjectKeyCustomerGroupsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomerGroupsRequestMethodPost

func (*ByProjectKeyCustomerGroupsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomerGroupsRequestMethodPost) WithQueryParams(input ByProjectKeyCustomerGroupsRequestMethodPostInput) *ByProjectKeyCustomerGroupsRequestMethodPost

type ByProjectKeyCustomerGroupsRequestMethodPostInput ¶ 

type ByProjectKeyCustomerGroupsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCustomerGroupsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCustomerGroupsRequestMethodPostInput) Values() url.Values

type ByProjectKeyCustomersByIDRequestBuilder ¶ 

type ByProjectKeyCustomersByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCustomersByIDRequestBuilder) Delete() *ByProjectKeyCustomersByIDRequestMethodDelete

* * Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message. *

func (*ByProjectKeyCustomersByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomersByIDRequestBuilder) Get() *ByProjectKeyCustomersByIDRequestMethodGet

func (*ByProjectKeyCustomersByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersByIDRequestBuilder) Head() *ByProjectKeyCustomersByIDRequestMethodHead

* * Checks if a Customer exists for a given `id`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomersByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomersByIDRequestBuilder) Post(body CustomerUpdate) *ByProjectKeyCustomersByIDRequestMethodPost

type ByProjectKeyCustomersByIDRequestMethodDelete ¶ 

type ByProjectKeyCustomersByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyCustomersByIDRequestMethodDelete

func (*ByProjectKeyCustomersByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCustomersByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCustomersByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodDelete) Execute(ctx context.Context) (result *Customer, err error)

* * Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message. *

func (*ByProjectKeyCustomersByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyCustomersByIDRequestMethodDelete

func (*ByProjectKeyCustomersByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodDelete) Version(v int) *ByProjectKeyCustomersByIDRequestMethodDelete

func (*ByProjectKeyCustomersByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCustomersByIDRequestMethodDelete

func (*ByProjectKeyCustomersByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyCustomersByIDRequestMethodDeleteInput) *ByProjectKeyCustomersByIDRequestMethodDelete

type ByProjectKeyCustomersByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyCustomersByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyCustomersByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCustomersByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCustomersByIDRequestMethodGet ¶ 

type ByProjectKeyCustomersByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomersByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomersByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyCustomersByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodGet) Expand(v []string) *ByProjectKeyCustomersByIDRequestMethodGet

func (*ByProjectKeyCustomersByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomersByIDRequestMethodGet

func (*ByProjectKeyCustomersByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodGet) WithQueryParams(input ByProjectKeyCustomersByIDRequestMethodGetInput) *ByProjectKeyCustomersByIDRequestMethodGet

type ByProjectKeyCustomersByIDRequestMethodGetInput ¶ 

type ByProjectKeyCustomersByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCustomersByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomersByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomersByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCustomersByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCustomersByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCustomersByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Customer exists for a given `id`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomersByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCustomersByIDRequestMethodHead

type ByProjectKeyCustomersByIDRequestMethodPost ¶ 

type ByProjectKeyCustomersByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomersByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomersByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyCustomersByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodPost) Expand(v []string) *ByProjectKeyCustomersByIDRequestMethodPost

func (*ByProjectKeyCustomersByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomersByIDRequestMethodPost

func (*ByProjectKeyCustomersByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersByIDRequestMethodPost) WithQueryParams(input ByProjectKeyCustomersByIDRequestMethodPostInput) *ByProjectKeyCustomersByIDRequestMethodPost

type ByProjectKeyCustomersByIDRequestMethodPostInput ¶ 

type ByProjectKeyCustomersByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCustomersByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCustomersByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyCustomersEmailConfirmRequestBuilder ¶ 

type ByProjectKeyCustomersEmailConfirmRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersEmailConfirmRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomersEmailConfirmRequestBuilder) Post(body CustomerEmailVerify) *ByProjectKeyCustomersEmailConfirmRequestMethodPost

* * Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message. *

type ByProjectKeyCustomersEmailConfirmRequestMethodPost ¶ 

type ByProjectKeyCustomersEmailConfirmRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersEmailConfirmRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomersEmailConfirmRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomersEmailConfirmRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomersEmailConfirmRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message. *

func (*ByProjectKeyCustomersEmailConfirmRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersEmailConfirmRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomersEmailConfirmRequestMethodPost

type ByProjectKeyCustomersEmailTokenByEmailTokenRequestBuilder ¶ 

type ByProjectKeyCustomersEmailTokenByEmailTokenRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersEmailTokenByEmailTokenRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomersEmailTokenByEmailTokenRequestBuilder) Get() *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet

type ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet ¶ 

type ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Expand(v []string) *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet

func (*ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet

func (*ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet) WithQueryParams(input ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput) *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGet

type ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput ¶ 

type ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomersEmailTokenRequestBuilder ¶ 

type ByProjectKeyCustomersEmailTokenRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersEmailTokenRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomersEmailTokenRequestBuilder) Post(body CustomerCreateEmailToken) *ByProjectKeyCustomersEmailTokenRequestMethodPost

* * Produces the [CustomerEmailTokenCreated](ctp:api:type:CustomerEmailTokenCreatedMessage) Message.

type ByProjectKeyCustomersEmailTokenRequestMethodPost ¶ 

type ByProjectKeyCustomersEmailTokenRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersEmailTokenRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomersEmailTokenRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomersEmailTokenRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomersEmailTokenRequestMethodPost) Execute(ctx context.Context) (result *CustomerToken, err error)

* * Produces the [CustomerEmailTokenCreated](ctp:api:type:CustomerEmailTokenCreatedMessage) Message.

func (*ByProjectKeyCustomersEmailTokenRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersEmailTokenRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomersEmailTokenRequestMethodPost

type ByProjectKeyCustomersKeyByKeyRequestBuilder ¶ 

type ByProjectKeyCustomersKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestBuilder) Delete() *ByProjectKeyCustomersKeyByKeyRequestMethodDelete

* * Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message. *

func (*ByProjectKeyCustomersKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestBuilder) Get() *ByProjectKeyCustomersKeyByKeyRequestMethodGet

func (*ByProjectKeyCustomersKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersKeyByKeyRequestBuilder) Head() *ByProjectKeyCustomersKeyByKeyRequestMethodHead

* * Checks if a Customer exists for a given `key`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomersKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestBuilder) Post(body CustomerUpdate) *ByProjectKeyCustomersKeyByKeyRequestMethodPost

type ByProjectKeyCustomersKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyCustomersKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyCustomersKeyByKeyRequestMethodDelete

func (*ByProjectKeyCustomersKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyCustomersKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Customer, err error)

* * Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message. *

func (*ByProjectKeyCustomersKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyCustomersKeyByKeyRequestMethodDelete

func (*ByProjectKeyCustomersKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyCustomersKeyByKeyRequestMethodDelete

func (*ByProjectKeyCustomersKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyCustomersKeyByKeyRequestMethodDelete

func (*ByProjectKeyCustomersKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyCustomersKeyByKeyRequestMethodDeleteInput) *ByProjectKeyCustomersKeyByKeyRequestMethodDelete

type ByProjectKeyCustomersKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyCustomersKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyCustomersKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyCustomersKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyCustomersKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomersKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyCustomersKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyCustomersKeyByKeyRequestMethodGet

func (*ByProjectKeyCustomersKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomersKeyByKeyRequestMethodGet

func (*ByProjectKeyCustomersKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyCustomersKeyByKeyRequestMethodGetInput) *ByProjectKeyCustomersKeyByKeyRequestMethodGet

type ByProjectKeyCustomersKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyCustomersKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomersKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomersKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCustomersKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCustomersKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Customer exists for a given `key`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomersKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCustomersKeyByKeyRequestMethodHead

type ByProjectKeyCustomersKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyCustomersKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomersKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyCustomersKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyCustomersKeyByKeyRequestMethodPost

func (*ByProjectKeyCustomersKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomersKeyByKeyRequestMethodPost

func (*ByProjectKeyCustomersKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyCustomersKeyByKeyRequestMethodPostInput) *ByProjectKeyCustomersKeyByKeyRequestMethodPost

type ByProjectKeyCustomersKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyCustomersKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCustomersKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCustomersKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyCustomersPasswordRequestBuilder ¶ 

type ByProjectKeyCustomersPasswordRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersPasswordRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomersPasswordRequestBuilder) Post(body CustomerChangePassword) *ByProjectKeyCustomersPasswordRequestMethodPost

* * Changing the password produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=false`. *

type ByProjectKeyCustomersPasswordRequestMethodPost ¶ 

type ByProjectKeyCustomersPasswordRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersPasswordRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomersPasswordRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomersPasswordRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomersPasswordRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * Changing the password produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=false`. *

func (*ByProjectKeyCustomersPasswordRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersPasswordRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomersPasswordRequestMethodPost

type ByProjectKeyCustomersPasswordResetRequestBuilder ¶ 

type ByProjectKeyCustomersPasswordResetRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersPasswordResetRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomersPasswordResetRequestBuilder) Post(body CustomerResetPassword) *ByProjectKeyCustomersPasswordResetRequestMethodPost

* * Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`. *

type ByProjectKeyCustomersPasswordResetRequestMethodPost ¶ 

type ByProjectKeyCustomersPasswordResetRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersPasswordResetRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomersPasswordResetRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomersPasswordResetRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomersPasswordResetRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`. *

func (*ByProjectKeyCustomersPasswordResetRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersPasswordResetRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomersPasswordResetRequestMethodPost

type ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestBuilder ¶ 

type ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestBuilder) Get() *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet

type ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet ¶ 

type ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Expand(v []string) *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet

func (*ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet

func (*ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) WithQueryParams(input ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput) *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet

type ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput ¶ 

type ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomersPasswordTokenRequestBuilder ¶ 

type ByProjectKeyCustomersPasswordTokenRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersPasswordTokenRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomersPasswordTokenRequestBuilder) Post(body CustomerCreatePasswordResetToken) *ByProjectKeyCustomersPasswordTokenRequestMethodPost

type ByProjectKeyCustomersPasswordTokenRequestMethodPost ¶ 

type ByProjectKeyCustomersPasswordTokenRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersPasswordTokenRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomersPasswordTokenRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomersPasswordTokenRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomersPasswordTokenRequestMethodPost) Execute(ctx context.Context) (result *CustomerToken, err error)

func (*ByProjectKeyCustomersPasswordTokenRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersPasswordTokenRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomersPasswordTokenRequestMethodPost

type ByProjectKeyCustomersRequestBuilder ¶ 

type ByProjectKeyCustomersRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersRequestBuilder) EmailConfirm ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) EmailConfirm() *ByProjectKeyCustomersEmailConfirmRequestBuilder

func (*ByProjectKeyCustomersRequestBuilder) EmailToken ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) EmailToken() *ByProjectKeyCustomersEmailTokenRequestBuilder

func (*ByProjectKeyCustomersRequestBuilder) Get ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) Get() *ByProjectKeyCustomersRequestMethodGet

func (*ByProjectKeyCustomersRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersRequestBuilder) Head() *ByProjectKeyCustomersRequestMethodHead

* * Checks if a Customer exists for a given Query Predicate. Returns a `200 OK` status if any Customers match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomersRequestBuilder) Password ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) Password() *ByProjectKeyCustomersPasswordRequestBuilder

func (*ByProjectKeyCustomersRequestBuilder) PasswordReset ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) PasswordReset() *ByProjectKeyCustomersPasswordResetRequestBuilder

func (*ByProjectKeyCustomersRequestBuilder) PasswordToken ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) PasswordToken() *ByProjectKeyCustomersPasswordTokenRequestBuilder

* * Produces the [CustomerPasswordTokenCreated](ctp:api:type:CustomerPasswordTokenCreatedMessage) Message.

func (*ByProjectKeyCustomersRequestBuilder) Post ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) Post(body CustomerDraft) *ByProjectKeyCustomersRequestMethodPost

* * If the `anonymousCart` field is set on the CustomerDraft(ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that Cart(ctp:api:type:Cart). * Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`. * Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. *

func (*ByProjectKeyCustomersRequestBuilder) WithEmailToken ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) WithEmailToken(emailToken string) *ByProjectKeyCustomersEmailTokenByEmailTokenRequestBuilder

func (*ByProjectKeyCustomersRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) WithId(id string) *ByProjectKeyCustomersByIDRequestBuilder

func (*ByProjectKeyCustomersRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) WithKey(key string) *ByProjectKeyCustomersKeyByKeyRequestBuilder

func (*ByProjectKeyCustomersRequestBuilder) WithPasswordToken ¶ 

func (rb *ByProjectKeyCustomersRequestBuilder) WithPasswordToken(passwordToken string) *ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestBuilder

type ByProjectKeyCustomersRequestMethodGet ¶ 

type ByProjectKeyCustomersRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyCustomersRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyCustomersRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) Execute(ctx context.Context) (result *CustomerPagedQueryResponse, err error)

func (*ByProjectKeyCustomersRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) Expand(v []string) *ByProjectKeyCustomersRequestMethodGet

func (*ByProjectKeyCustomersRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) Limit(v int) *ByProjectKeyCustomersRequestMethodGet

func (*ByProjectKeyCustomersRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) Offset(v int) *ByProjectKeyCustomersRequestMethodGet

func (*ByProjectKeyCustomersRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyCustomersRequestMethodGet

func (*ByProjectKeyCustomersRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) Sort(v []string) *ByProjectKeyCustomersRequestMethodGet

func (*ByProjectKeyCustomersRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) Where(v []string) *ByProjectKeyCustomersRequestMethodGet

func (*ByProjectKeyCustomersRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyCustomersRequestMethodGet

func (*ByProjectKeyCustomersRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) WithQueryParams(input ByProjectKeyCustomersRequestMethodGetInput) *ByProjectKeyCustomersRequestMethodGet

func (*ByProjectKeyCustomersRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyCustomersRequestMethodGet) WithTotal(v bool) *ByProjectKeyCustomersRequestMethodGet

type ByProjectKeyCustomersRequestMethodGetInput ¶ 

type ByProjectKeyCustomersRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyCustomersRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyCustomersRequestMethodGetInput) Values() url.Values

type ByProjectKeyCustomersRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyCustomersRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyCustomersRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyCustomersRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Customer exists for a given Query Predicate. Returns a `200 OK` status if any Customers match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyCustomersRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersRequestMethodHead) Where(v []string) *ByProjectKeyCustomersRequestMethodHead

func (*ByProjectKeyCustomersRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyCustomersRequestMethodHead

func (*ByProjectKeyCustomersRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyCustomersRequestMethodHead) WithQueryParams(input ByProjectKeyCustomersRequestMethodHeadInput) *ByProjectKeyCustomersRequestMethodHead

type ByProjectKeyCustomersRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyCustomersRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyCustomersRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyCustomersRequestMethodHeadInput) Values() url.Values

type ByProjectKeyCustomersRequestMethodPost ¶ 

type ByProjectKeyCustomersRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyCustomersRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyCustomersRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyCustomersRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyCustomersRequestMethodPost) Execute(ctx context.Context) (result *CustomerSignInResult, err error)

* * If the `anonymousCart` field is set on the CustomerDraft(ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that Cart(ctp:api:type:Cart). * Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`. * Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. *

func (*ByProjectKeyCustomersRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyCustomersRequestMethodPost) Expand(v []string) *ByProjectKeyCustomersRequestMethodPost

func (*ByProjectKeyCustomersRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyCustomersRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyCustomersRequestMethodPost

func (*ByProjectKeyCustomersRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyCustomersRequestMethodPost) WithQueryParams(input ByProjectKeyCustomersRequestMethodPostInput) *ByProjectKeyCustomersRequestMethodPost

type ByProjectKeyCustomersRequestMethodPostInput ¶ 

type ByProjectKeyCustomersRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyCustomersRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyCustomersRequestMethodPostInput) Values() url.Values

type ByProjectKeyDiscountCodesByIDRequestBuilder ¶ 

type ByProjectKeyDiscountCodesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestBuilder) Delete() *ByProjectKeyDiscountCodesByIDRequestMethodDelete

* * Deleting a Discount Code produces the [DiscountCodeDeleted](ctp:api:type:DiscountCodeDeletedMessage) Message. * * Deprecated scope: `manage_orders:{projectKey}` *

func (*ByProjectKeyDiscountCodesByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestBuilder) Get() *ByProjectKeyDiscountCodesByIDRequestMethodGet

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyDiscountCodesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyDiscountCodesByIDRequestBuilder) Head() *ByProjectKeyDiscountCodesByIDRequestMethodHead

* * Checks if a DiscountCode exists for a given `id`. Returns a `200 OK` status if the DiscountCode exists or a `404 Not Found` otherwise.

func (*ByProjectKeyDiscountCodesByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestBuilder) Post(body DiscountCodeUpdate) *ByProjectKeyDiscountCodesByIDRequestMethodPost

* * Deprecated scope: `manage_orders:{projectKey}`

type ByProjectKeyDiscountCodesByIDRequestMethodDelete ¶ 

type ByProjectKeyDiscountCodesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyDiscountCodesByIDRequestMethodDelete

func (*ByProjectKeyDiscountCodesByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyDiscountCodesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodDelete) Execute(ctx context.Context) (result *DiscountCode, err error)

* * Deleting a Discount Code produces the [DiscountCodeDeleted](ctp:api:type:DiscountCodeDeletedMessage) Message. * * Deprecated scope: `manage_orders:{projectKey}` *

func (*ByProjectKeyDiscountCodesByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyDiscountCodesByIDRequestMethodDelete

func (*ByProjectKeyDiscountCodesByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodDelete) Version(v int) *ByProjectKeyDiscountCodesByIDRequestMethodDelete

func (*ByProjectKeyDiscountCodesByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesByIDRequestMethodDelete

func (*ByProjectKeyDiscountCodesByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyDiscountCodesByIDRequestMethodDeleteInput) *ByProjectKeyDiscountCodesByIDRequestMethodDelete

type ByProjectKeyDiscountCodesByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyDiscountCodesByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyDiscountCodesByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyDiscountCodesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyDiscountCodesByIDRequestMethodGet ¶ 

type ByProjectKeyDiscountCodesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyDiscountCodesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodGet) Execute(ctx context.Context) (result *DiscountCode, err error)

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyDiscountCodesByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyDiscountCodesByIDRequestMethodGet

func (*ByProjectKeyDiscountCodesByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesByIDRequestMethodGet

func (*ByProjectKeyDiscountCodesByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyDiscountCodesByIDRequestMethodGetInput) *ByProjectKeyDiscountCodesByIDRequestMethodGet

type ByProjectKeyDiscountCodesByIDRequestMethodGetInput ¶ 

type ByProjectKeyDiscountCodesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyDiscountCodesByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyDiscountCodesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyDiscountCodesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyDiscountCodesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyDiscountCodesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a DiscountCode exists for a given `id`. Returns a `200 OK` status if the DiscountCode exists or a `404 Not Found` otherwise.

func (*ByProjectKeyDiscountCodesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesByIDRequestMethodHead

type ByProjectKeyDiscountCodesByIDRequestMethodPost ¶ 

type ByProjectKeyDiscountCodesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyDiscountCodesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodPost) Execute(ctx context.Context) (result *DiscountCode, err error)

* * Deprecated scope: `manage_orders:{projectKey}`

func (*ByProjectKeyDiscountCodesByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyDiscountCodesByIDRequestMethodPost

func (*ByProjectKeyDiscountCodesByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesByIDRequestMethodPost

func (*ByProjectKeyDiscountCodesByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyDiscountCodesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyDiscountCodesByIDRequestMethodPostInput) *ByProjectKeyDiscountCodesByIDRequestMethodPost

type ByProjectKeyDiscountCodesByIDRequestMethodPostInput ¶ 

type ByProjectKeyDiscountCodesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyDiscountCodesByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyDiscountCodesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyDiscountCodesKeyByKeyRequestBuilder ¶ added in v1.5.0 

type ByProjectKeyDiscountCodesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestBuilder) Delete ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestBuilder) Delete() *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete

* * Deleting a Discount Code produces the [DiscountCodeDeleted](ctp:api:type:DiscountCodeDeletedMessage) Message. * * Deprecated scope: `manage_orders:{projectKey}` *

func (*ByProjectKeyDiscountCodesKeyByKeyRequestBuilder) Get ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestBuilder) Get() *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyDiscountCodesKeyByKeyRequestBuilder) Head ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestBuilder) Head() *ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead

* * Checks if a DiscountCode exists for a given `key`. Returns a `200 OK` status if the DiscountCode exists or a `404 Not Found` otherwise.

func (*ByProjectKeyDiscountCodesKeyByKeyRequestBuilder) Post ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestBuilder) Post(body DiscountCodeUpdate) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost

* * Deprecated scope: `manage_orders:{projectKey}`

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete ¶ added in v1.5.0 

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) DataErasure ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) Dump ¶ added in v1.5.0 

func (r *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) Execute ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *DiscountCode, err error)

* * Deleting a Discount Code produces the [DiscountCodeDeleted](ctp:api:type:DiscountCodeDeletedMessage) Message. * * Deprecated scope: `manage_orders:{projectKey}` *

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) Expand ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) Version ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyDiscountCodesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDelete

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodDeleteInput ¶ added in v1.5.0 

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.5.0 

func (input *ByProjectKeyDiscountCodesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet ¶ added in v1.5.0 

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) Dump ¶ added in v1.5.0 

func (r *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) Execute ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *DiscountCode, err error)

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) Expand ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyDiscountCodesKeyByKeyRequestMethodGetInput) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGet

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodGetInput ¶ added in v1.5.0 

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodGetInput) Values ¶ added in v1.5.0 

func (input *ByProjectKeyDiscountCodesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead ¶ added in v1.5.0 

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead) Dump ¶ added in v1.5.0 

func (r *ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead) Execute ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a DiscountCode exists for a given `key`. Returns a `200 OK` status if the DiscountCode exists or a `404 Not Found` otherwise.

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodHead

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost ¶ added in v1.5.0 

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) Dump ¶ added in v1.5.0 

func (r *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) Execute ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *DiscountCode, err error)

* * Deprecated scope: `manage_orders:{projectKey}`

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) Expand ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyDiscountCodesKeyByKeyRequestMethodPostInput) *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPost

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodPostInput ¶ added in v1.5.0 

type ByProjectKeyDiscountCodesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyDiscountCodesKeyByKeyRequestMethodPostInput) Values ¶ added in v1.5.0 

func (input *ByProjectKeyDiscountCodesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyDiscountCodesRequestBuilder ¶ 

type ByProjectKeyDiscountCodesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesRequestBuilder) Get ¶ 

func (rb *ByProjectKeyDiscountCodesRequestBuilder) Get() *ByProjectKeyDiscountCodesRequestMethodGet

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyDiscountCodesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyDiscountCodesRequestBuilder) Head() *ByProjectKeyDiscountCodesRequestMethodHead

* * Checks if a DiscountCode exists for a given Query Predicate. Returns a `200 OK` status if any DiscountCodes match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyDiscountCodesRequestBuilder) Post ¶ 

func (rb *ByProjectKeyDiscountCodesRequestBuilder) Post(body DiscountCodeDraft) *ByProjectKeyDiscountCodesRequestMethodPost

* * Creating a Discount Code produces the [DiscountCodeCreated](ctp:api:type:DiscountCodeCreatedMessage) Message. * * Deprecated scope: `manage_orders:{projectKey}` *

func (*ByProjectKeyDiscountCodesRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyDiscountCodesRequestBuilder) WithId(id string) *ByProjectKeyDiscountCodesByIDRequestBuilder

func (*ByProjectKeyDiscountCodesRequestBuilder) WithKey ¶ added in v1.5.0 

func (rb *ByProjectKeyDiscountCodesRequestBuilder) WithKey(key string) *ByProjectKeyDiscountCodesKeyByKeyRequestBuilder

type ByProjectKeyDiscountCodesRequestMethodGet ¶ 

type ByProjectKeyDiscountCodesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyDiscountCodesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) Execute(ctx context.Context) (result *DiscountCodePagedQueryResponse, err error)

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyDiscountCodesRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) Expand(v []string) *ByProjectKeyDiscountCodesRequestMethodGet

func (*ByProjectKeyDiscountCodesRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) Limit(v int) *ByProjectKeyDiscountCodesRequestMethodGet

func (*ByProjectKeyDiscountCodesRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) Offset(v int) *ByProjectKeyDiscountCodesRequestMethodGet

func (*ByProjectKeyDiscountCodesRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyDiscountCodesRequestMethodGet

func (*ByProjectKeyDiscountCodesRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) Sort(v []string) *ByProjectKeyDiscountCodesRequestMethodGet

func (*ByProjectKeyDiscountCodesRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) Where(v []string) *ByProjectKeyDiscountCodesRequestMethodGet

func (*ByProjectKeyDiscountCodesRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesRequestMethodGet

func (*ByProjectKeyDiscountCodesRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) WithQueryParams(input ByProjectKeyDiscountCodesRequestMethodGetInput) *ByProjectKeyDiscountCodesRequestMethodGet

func (*ByProjectKeyDiscountCodesRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodGet) WithTotal(v bool) *ByProjectKeyDiscountCodesRequestMethodGet

type ByProjectKeyDiscountCodesRequestMethodGetInput ¶ 

type ByProjectKeyDiscountCodesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyDiscountCodesRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyDiscountCodesRequestMethodGetInput) Values() url.Values

type ByProjectKeyDiscountCodesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyDiscountCodesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyDiscountCodesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyDiscountCodesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a DiscountCode exists for a given Query Predicate. Returns a `200 OK` status if any DiscountCodes match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyDiscountCodesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyDiscountCodesRequestMethodHead) Where(v []string) *ByProjectKeyDiscountCodesRequestMethodHead

func (*ByProjectKeyDiscountCodesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyDiscountCodesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesRequestMethodHead

func (*ByProjectKeyDiscountCodesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyDiscountCodesRequestMethodHead) WithQueryParams(input ByProjectKeyDiscountCodesRequestMethodHeadInput) *ByProjectKeyDiscountCodesRequestMethodHead

type ByProjectKeyDiscountCodesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyDiscountCodesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyDiscountCodesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyDiscountCodesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyDiscountCodesRequestMethodPost ¶ 

type ByProjectKeyDiscountCodesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyDiscountCodesRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyDiscountCodesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyDiscountCodesRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodPost) Execute(ctx context.Context) (result *DiscountCode, err error)

* * Creating a Discount Code produces the [DiscountCodeCreated](ctp:api:type:DiscountCodeCreatedMessage) Message. * * Deprecated scope: `manage_orders:{projectKey}` *

func (*ByProjectKeyDiscountCodesRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodPost) Expand(v []string) *ByProjectKeyDiscountCodesRequestMethodPost

func (*ByProjectKeyDiscountCodesRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyDiscountCodesRequestMethodPost

func (*ByProjectKeyDiscountCodesRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyDiscountCodesRequestMethodPost) WithQueryParams(input ByProjectKeyDiscountCodesRequestMethodPostInput) *ByProjectKeyDiscountCodesRequestMethodPost

type ByProjectKeyDiscountCodesRequestMethodPostInput ¶ 

type ByProjectKeyDiscountCodesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyDiscountCodesRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyDiscountCodesRequestMethodPostInput) Values() url.Values

type ByProjectKeyExtensionsByIDRequestBuilder ¶ 

type ByProjectKeyExtensionsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestBuilder) Delete() *ByProjectKeyExtensionsByIDRequestMethodDelete

func (*ByProjectKeyExtensionsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestBuilder) Get() *ByProjectKeyExtensionsByIDRequestMethodGet

func (*ByProjectKeyExtensionsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsByIDRequestBuilder) Head() *ByProjectKeyExtensionsByIDRequestMethodHead

* * Checks if an Extension exists for a given `id`. Returns a `200 OK` status if the Extension exists or a `404 Not Found` otherwise.

func (*ByProjectKeyExtensionsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestBuilder) Post(body ExtensionUpdate) *ByProjectKeyExtensionsByIDRequestMethodPost

type ByProjectKeyExtensionsByIDRequestMethodDelete ¶ 

type ByProjectKeyExtensionsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyExtensionsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Extension, err error)

func (*ByProjectKeyExtensionsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestMethodDelete) Version(v int) *ByProjectKeyExtensionsByIDRequestMethodDelete

func (*ByProjectKeyExtensionsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyExtensionsByIDRequestMethodDelete

func (*ByProjectKeyExtensionsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyExtensionsByIDRequestMethodDeleteInput) *ByProjectKeyExtensionsByIDRequestMethodDelete

type ByProjectKeyExtensionsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyExtensionsByIDRequestMethodDeleteInput struct {
	Version int
}

func (*ByProjectKeyExtensionsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyExtensionsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyExtensionsByIDRequestMethodGet ¶ 

type ByProjectKeyExtensionsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyExtensionsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestMethodGet) Execute(ctx context.Context) (result *Extension, err error)

func (*ByProjectKeyExtensionsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyExtensionsByIDRequestMethodGet

type ByProjectKeyExtensionsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyExtensionsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyExtensionsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Extension exists for a given `id`. Returns a `200 OK` status if the Extension exists or a `404 Not Found` otherwise.

func (*ByProjectKeyExtensionsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyExtensionsByIDRequestMethodHead

type ByProjectKeyExtensionsByIDRequestMethodPost ¶ 

type ByProjectKeyExtensionsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyExtensionsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestMethodPost) Execute(ctx context.Context) (result *Extension, err error)

func (*ByProjectKeyExtensionsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyExtensionsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyExtensionsByIDRequestMethodPost

type ByProjectKeyExtensionsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyExtensionsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestBuilder) Delete() *ByProjectKeyExtensionsKeyByKeyRequestMethodDelete

func (*ByProjectKeyExtensionsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestBuilder) Get() *ByProjectKeyExtensionsKeyByKeyRequestMethodGet

func (*ByProjectKeyExtensionsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestBuilder) Head() *ByProjectKeyExtensionsKeyByKeyRequestMethodHead

* * Checks if an Extension exists for a given `key`. Returns a `200 OK` status if the Extension exists or a `404 Not Found` otherwise.

func (*ByProjectKeyExtensionsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestBuilder) Post(body ExtensionUpdate) *ByProjectKeyExtensionsKeyByKeyRequestMethodPost

type ByProjectKeyExtensionsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyExtensionsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Extension, err error)

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyExtensionsKeyByKeyRequestMethodDelete

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyExtensionsKeyByKeyRequestMethodDelete

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyExtensionsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyExtensionsKeyByKeyRequestMethodDelete

type ByProjectKeyExtensionsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyExtensionsKeyByKeyRequestMethodDeleteInput struct {
	Version int
}

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyExtensionsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyExtensionsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyExtensionsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyExtensionsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Extension, err error)

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyExtensionsKeyByKeyRequestMethodGet

type ByProjectKeyExtensionsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyExtensionsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyExtensionsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Extension exists for a given `key`. Returns a `200 OK` status if the Extension exists or a `404 Not Found` otherwise.

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyExtensionsKeyByKeyRequestMethodHead

type ByProjectKeyExtensionsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyExtensionsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyExtensionsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Extension, err error)

func (*ByProjectKeyExtensionsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyExtensionsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyExtensionsKeyByKeyRequestMethodPost

type ByProjectKeyExtensionsRequestBuilder ¶ 

type ByProjectKeyExtensionsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyExtensionsRequestBuilder) Get() *ByProjectKeyExtensionsRequestMethodGet

func (*ByProjectKeyExtensionsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsRequestBuilder) Head() *ByProjectKeyExtensionsRequestMethodHead

* * Checks if an Extension exists for a given Query Predicate. Returns a `200 OK` status if any Extensions match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyExtensionsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyExtensionsRequestBuilder) Post(body ExtensionDraft) *ByProjectKeyExtensionsRequestMethodPost

func (*ByProjectKeyExtensionsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyExtensionsRequestBuilder) WithId(id string) *ByProjectKeyExtensionsByIDRequestBuilder

func (*ByProjectKeyExtensionsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyExtensionsRequestBuilder) WithKey(key string) *ByProjectKeyExtensionsKeyByKeyRequestBuilder

type ByProjectKeyExtensionsRequestMethodGet ¶ 

type ByProjectKeyExtensionsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyExtensionsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodGet) Execute(ctx context.Context) (result *ExtensionPagedQueryResponse, err error)

func (*ByProjectKeyExtensionsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodGet) Limit(v int) *ByProjectKeyExtensionsRequestMethodGet

func (*ByProjectKeyExtensionsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodGet) Offset(v int) *ByProjectKeyExtensionsRequestMethodGet

func (*ByProjectKeyExtensionsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyExtensionsRequestMethodGet

func (*ByProjectKeyExtensionsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodGet) Sort(v []string) *ByProjectKeyExtensionsRequestMethodGet

func (*ByProjectKeyExtensionsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodGet) Where(v []string) *ByProjectKeyExtensionsRequestMethodGet

func (*ByProjectKeyExtensionsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyExtensionsRequestMethodGet

func (*ByProjectKeyExtensionsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodGet) WithQueryParams(input ByProjectKeyExtensionsRequestMethodGetInput) *ByProjectKeyExtensionsRequestMethodGet

func (*ByProjectKeyExtensionsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodGet) WithTotal(v bool) *ByProjectKeyExtensionsRequestMethodGet

type ByProjectKeyExtensionsRequestMethodGetInput ¶ 

type ByProjectKeyExtensionsRequestMethodGetInput struct {
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyExtensionsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyExtensionsRequestMethodGetInput) Values() url.Values

type ByProjectKeyExtensionsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyExtensionsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyExtensionsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Extension exists for a given Query Predicate. Returns a `200 OK` status if any Extensions match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyExtensionsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsRequestMethodHead) Where(v []string) *ByProjectKeyExtensionsRequestMethodHead

func (*ByProjectKeyExtensionsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyExtensionsRequestMethodHead

func (*ByProjectKeyExtensionsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyExtensionsRequestMethodHead) WithQueryParams(input ByProjectKeyExtensionsRequestMethodHeadInput) *ByProjectKeyExtensionsRequestMethodHead

type ByProjectKeyExtensionsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyExtensionsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyExtensionsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyExtensionsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyExtensionsRequestMethodPost ¶ 

type ByProjectKeyExtensionsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyExtensionsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyExtensionsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyExtensionsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodPost) Execute(ctx context.Context) (result *Extension, err error)

func (*ByProjectKeyExtensionsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyExtensionsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyExtensionsRequestMethodPost

type ByProjectKeyGraphqlRequestBuilder ¶ 

type ByProjectKeyGraphqlRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyGraphqlRequestBuilder) Post ¶ 

func (rb *ByProjectKeyGraphqlRequestBuilder) Post(body GraphQLRequest) *ByProjectKeyGraphqlRequestMethodPost

* * Execute a GraphQL query

type ByProjectKeyGraphqlRequestMethodPost ¶ 

type ByProjectKeyGraphqlRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyGraphqlRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyGraphqlRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyGraphqlRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyGraphqlRequestMethodPost) Execute(ctx context.Context) (result *GraphQLResponse, err error)

* * Execute a GraphQL query

func (*ByProjectKeyGraphqlRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyGraphqlRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyGraphqlRequestMethodPost

type ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestBuilder) Post(body MyBusinessUnitAssociateDraft) *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost

* * The My Business Unit endpoint does not support assigning existing Customers to a Business Unit. * Associates with the `UpdateAssociates` Permission(ctp:api:type:Permission) can use this endpoint to create a new Customer and associate it with the Business Unit. * If the required Permission(/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned. *

type ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost) Execute(ctx context.Context) (result *CustomerSignInResult, err error)

* * The My Business Unit endpoint does not support assigning existing Customers to a Business Unit. * Associates with the `UpdateAssociates` Permission(ctp:api:type:Permission) can use this endpoint to create a new Customer and associate it with the Business Unit. * If the required Permission(/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned. *

func (*ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestMethodPost

type ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeRequestBuilder) Customers ¶ added in v1.2.0 

func (rb *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeRequestBuilder) Customers() *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestBuilder

type ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) Me ¶ added in v1.2.0 

func (rb *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyRequestBuilder) Me() *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder) Delete ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete

* * To delete a CartDiscount, specify the `manage_cart_discounts:{projectKey}:{storeKey}` scope for all Stores associated with the CartDiscount. * * Deleting a Cart Discount produces the [CartDiscountDeleted](ctp:api:type:CartDiscountDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder) Get ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead

* * Checks if a CartDiscount exists for a given `id`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder) Post ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder) Post(body CartDiscountUpdate) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost

* * To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when [removing a Store](ctp:api:type:CartDiscountRemoveStoreAction). *

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) Execute(ctx context.Context) (result *CartDiscount, err error)

* * To delete a CartDiscount, specify the `manage_cart_discounts:{projectKey}:{storeKey}` scope for all Stores associated with the CartDiscount. * * Deleting a Cart Discount produces the [CartDiscountDeleted](ctp:api:type:CartDiscountDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) Version ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDeleteInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDeleteInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) Execute(ctx context.Context) (result *CartDiscount, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGetInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGetInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CartDiscount exists for a given `id`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) Execute(ctx context.Context) (result *CartDiscount, err error)

* * To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when [removing a Store](ctp:api:type:CartDiscountRemoveStoreAction). *

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPostInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPostInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder) Delete ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete

* * To delete a CartDiscount, specify the `manage_cart_discounts:{projectKey}:{storeKey}` scope for all Stores associated with the CartDiscount. * * Deleting a Cart Discount produces the [CartDiscountDeleted](ctp:api:type:CartDiscountDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder) Get ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead

* * Checks if a CartDiscount exists for a given `key`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder) Post ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder) Post(body CartDiscountUpdate) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost

* * To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when [removing a Store](ctp:api:type:CartDiscountRemoveStoreAction). *

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *CartDiscount, err error)

* * To delete a CartDiscount, specify the `manage_cart_discounts:{projectKey}:{storeKey}` scope for all Stores associated with the CartDiscount. * * Deleting a Cart Discount produces the [CartDiscountDeleted](ctp:api:type:CartDiscountDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) Version ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDeleteInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *CartDiscount, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGetInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGetInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CartDiscount exists for a given `key`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *CartDiscount, err error)

* * To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when [removing a Store](ctp:api:type:CartDiscountRemoveStoreAction). *

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPostInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPostInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) Get ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead

* * Checks if a CartDiscount exists for a given Query Predicate. Returns a `200 OK` status if any CartDiscounts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) Post ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) Post(body CartDiscountDraft) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost

* * When using the endpoint, the Store specified in the path and the Stores specified in the payload's `stores` field are added to the CartDiscount. * * Creating a Cart Discount produces the [CartDiscountCreated](ctp:api:type:CartDiscountCreatedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) WithId ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) WithId(id string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) WithKey ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder) WithKey(key string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Execute(ctx context.Context) (result *CartDiscountPagedQueryResponse, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Limit ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Offset ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) PredicateVar ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Sort ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) WithTotal ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGetInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGetInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a CartDiscount exists for a given Query Predicate. Returns a `200 OK` status if any CartDiscounts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHeadInput) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) Execute(ctx context.Context) (result *CartDiscount, err error)

* * When using the endpoint, the Store specified in the path and the Stores specified in the payload's `stores` field are added to the CartDiscount. * * Creating a Cart Discount produces the [CartDiscountCreated](ctp:api:type:CartDiscountCreatedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) Expand ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPostInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPostInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead

* * Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder) Post(body CartUpdate) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost

* * Updates a Cart(ctp:api:type:Cart) in the Store(ctp:api:type:Store) specified by `storeKey`. * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * Updates a Cart(ctp:api:type:Cart) in the Store(ctp:api:type:Store) specified by `storeKey`. * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet

* * Retrieves the recently modified active Cart of a Customer with CartOrigin(ctp:api:type:CartOrigin) `Customer`. If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead

* * Checks if a Cart of a Customer exists. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

type ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * Retrieves the recently modified active Cart of a Customer with CartOrigin(ctp:api:type:CartOrigin) `Customer`. If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart of a Customer exists. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead

* * Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder) Post(body CartUpdate) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder) Post(body ReplicaCartDraft) *ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost

* * Creates a new Cart by replicating an existing Cart or Order. Can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order. * * The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` CartState(ctp:api:type:CartState). * * The new Cart does not contain payments or deliveries. The State(ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. *

type ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * Creates a new Cart by replicating an existing Cart or Order. Can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order. * * The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` CartState(ctp:api:type:CartState). * * The new Cart does not contain payments or deliveries. The State(ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

* * Queries carts in a specific Store(ctp:api:type:Store).

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) Post(body CartDraft) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost

* * Creates a Cart(ctp:api:type:Cart) in the Store(ctp:api:type:Store) specified by `storeKey`. * When using this endpoint the Cart's `store` field is always set to the Store(ctp:api:type:Store) specified in the path parameter. * If the referenced ShippingMethod(ctp:api:type:ShippingMethod) in the CartDraft(ctp:api:type:CartDraft) has a predicate that does not match, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) Replicate ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) Replicate() *ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) WithCustomerId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) WithCustomerId(customerId string) *ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) WithId(id string) *ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder) WithKey(key string) *ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Execute(ctx context.Context) (result *CartPagedQueryResponse, err error)

* * Queries carts in a specific Store(ctp:api:type:Store).

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHeadInput) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * Creates a Cart(ctp:api:type:Cart) in the Store(ctp:api:type:Store) specified by `storeKey`. * When using this endpoint the Cart's `store` field is always set to the Store(ctp:api:type:Store) specified in the path parameter. * If the referenced ShippingMethod(ctp:api:type:ShippingMethod) in the CartDraft(ctp:api:type:CartDraft) has a predicate that does not match, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCartsRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete

* * Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message. * * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead

* * Checks if a Customer exists for a given `id`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder) Post(body CustomerUpdate) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost

* * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) Execute(ctx context.Context) (result *Customer, err error)

* * Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message. * * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Customer exists for a given `id`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestBuilder) Post(body CustomerEmailVerify) *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost

* * The customer verifies the email using the token value. * Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message. * * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * The customer verifies the email using the token value. * Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message. * * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet

* * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

* * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestBuilder) Post(body CustomerCreateEmailToken) *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost) Execute(ctx context.Context) (result *CustomerToken, err error)

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete

* * Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message. * * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet

* * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead

* * Checks if a Customer exists for a given `key`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder) Post(body CustomerUpdate) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Customer, err error)

* * Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message. * * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

* * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Customer exists for a given `key`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestBuilder) Post(body CustomerChangePassword) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost

* * Changing the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=false`. *

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * Changing the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=false`. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestBuilder) Post(body CustomerResetPassword) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost

* * Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`. * * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`. * * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestBuilder) Post(body CustomerCreatePasswordResetToken) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost) Execute(ctx context.Context) (result *CustomerToken, err error)

* * If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) EmailConfirm ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) EmailConfirm() *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) EmailToken ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) EmailToken() *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead

* * Checks if a Customer exists for a given Query Predicate. Returns a `200 OK` status if any Customers match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) Password ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) Password() *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) PasswordReset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) PasswordReset() *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) PasswordToken ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) PasswordToken() *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) Post(body CustomerDraft) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost

* * When using this endpoint, if omitted, the Customer `stores` field is set to the Store(ctp:api:type:Store) specified in the path parameter. * * If the `anonymousCart` field is set on the CustomerDraft(ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that Cart(ctp:api:type:Cart). * Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`. * If a Cart with a `store` field specified, the `store` field must reference the same Store(ctp:api:type:Store) specified in the `{storeKey}` path parameter. * Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) WithEmailToken ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) WithEmailToken(emailToken string) *ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) WithId(id string) *ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) WithKey(key string) *ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) WithPasswordToken ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder) WithPasswordToken(passwordToken string) *ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Execute(ctx context.Context) (result *CustomerPagedQueryResponse, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Customer exists for a given Query Predicate. Returns a `200 OK` status if any Customers match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHeadInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) Execute(ctx context.Context) (result *CustomerSignInResult, err error)

* * When using this endpoint, if omitted, the Customer `stores` field is set to the Store(ctp:api:type:Store) specified in the path parameter. * * If the `anonymousCart` field is set on the CustomerDraft(ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that Cart(ctp:api:type:Cart). * Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`. * If a Cart with a `store` field specified, the `store` field must reference the same Store(ctp:api:type:Store) specified in the `{storeKey}` path parameter. * Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyLoginRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyLoginRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyLoginRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyLoginRequestBuilder) Post(body CustomerSignin) *ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost

* * Authenticates a Customer associated with a Store(ctp:api:type:Store). For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers). * * Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in). * * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error. *

type ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost) Execute(ctx context.Context) (result *CustomerSignInResult, err error)

* * Authenticates a Customer associated with a Store(ctp:api:type:Store). For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers). * * Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in). * * If the Customer exists in the Project but the `stores` field references a different Store(ctp:api:type:Store), this method returns an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyLoginRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet

* * Retrieves the Customer's most recently modified active Cart in the Store specified by the `storeKey` path parameter. * * Carts with `Merchant` or `Quote` CartOrigin(ctp:api:type:CartOrigin) are ignored. * * If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead

* * Checks if an active Cart exists. Returns a `200 OK` status if an active Cart exists or a `404 Not Found` otherwise.

type ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * Retrieves the Customer's most recently modified active Cart in the Store specified by the `storeKey` path parameter. * * Carts with `Merchant` or `Quote` CartOrigin(ctp:api:type:CartOrigin) are ignored. * * If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an active Cart exists. Returns a `200 OK` status if an active Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead

* * Checks ifa My Cart exists for a given `id`. Returns a `200 OK` status if the My Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder) Post(body MyCartUpdate) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks ifa My Cart exists for a given `id`. Returns a `200 OK` status if the My Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder) Post(body MyCartDraft) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost

* * The `store` field in the created Cart(ctp:api:type:Cart) is set to the Store specified by the `storeKey` path parameter. * * Specific Error Codes: [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) *

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder) WithId(id string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Execute(ctx context.Context) (result *CartPagedQueryResponse, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHeadInput) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * The `store` field in the created Cart(ctp:api:type:Cart) is set to the Store specified by the `storeKey` path parameter. * * Specific Error Codes: [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) *

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestBuilder) Post(body MyCustomerEmailVerify) *ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost

* * This is the last step in the [email verification process of a Customer](/../api/projects/customers#email-verification-of-customer-in-store). *

type ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * This is the last step in the [email verification process of a Customer](/../api/projects/customers#email-verification-of-customer-in-store). *

func (*ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestBuilder) Post(body MyCustomerSignin) *ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost

* * Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store(ctp:api:type:Store). * * - If the Customer does not have a Cart, the most recently modified anonymous cart becomes the Customer's Cart. * - If the Customer already has a Cart, the most recently modified anonymous cart is handled according to AnonymousCartSignInMode(ctp:api:type:AnonymousCartSignInMode). * * If a Cart is returned as part of CustomerSignInResult(ctp:api:type:CustomerSignInResult), it has been [recalculated](ctp:api:type:MyCartRecalculateAction) with up-to-date prices, taxes, discounts, and invalid line items removed. * * If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned. *

type ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost) Execute(ctx context.Context) (result *CustomerSignInResult, err error)

* * Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store(ctp:api:type:Store). * * - If the Customer does not have a Cart, the most recently modified anonymous cart becomes the Customer's Cart. * - If the Customer already has a Cart, the most recently modified anonymous cart is handled according to AnonymousCartSignInMode(ctp:api:type:AnonymousCartSignInMode). * * If a Cart is returned as part of CustomerSignInResult(ctp:api:type:CustomerSignInResult), it has been [recalculated](ctp:api:type:MyCartRecalculateAction) with up-to-date prices, taxes, discounts, and invalid line items removed. * * If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the My Order exists or a `404 Not Found` otherwise.

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the My Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder) Post(body MyOrderFromCartDraft) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost

* * The Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction) for taxes to be calculated. When creating [B2B Orders](/associates-overview#b2b-resources), the Customer must have the `CreateMyOrdersFromMyCarts` Permission(ctp:api:type:Permission). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) * - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) *

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder) WithId(id string) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Execute(ctx context.Context) (result *OrderPagedQueryResponse, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHeadInput) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * The Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction) for taxes to be calculated. When creating [B2B Orders](/associates-overview#b2b-resources), the Customer must have the `CreateMyOrdersFromMyCarts` Permission(ctp:api:type:Permission). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) * - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) *

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestBuilder) Post(body MyCustomerChangePassword) *ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost

* * Changing the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=false`. *

func (*ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestBuilder) Reset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestBuilder) Reset() *ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * Changing the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=false`. *

func (*ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestBuilder) Post(body MyCustomerResetPassword) *ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost

* * This is the last step in the [password reset process of the authenticated Customer](/../api/projects/customers#password-reset-of-customer-in-store). * * Resetting a password produces the of the Customer [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`. *

type ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * This is the last step in the [password reset process of the authenticated Customer](/../api/projects/customers#password-reset-of-customer-in-store). * * Resetting a password produces the of the Customer [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`. *

func (*ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMePasswordResetRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) ActiveCart ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) ActiveCart() *ByProjectKeyInStoreKeyByStoreKeyMeActiveCartRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Carts ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Carts() *ByProjectKeyInStoreKeyByStoreKeyMeCartsRequestBuilder

* * A shopping cart holds product variants and can be ordered.

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) EmailConfirm ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) EmailConfirm() *ByProjectKeyInStoreKeyByStoreKeyMeEmailConfirmRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Login ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Login() *ByProjectKeyInStoreKeyByStoreKeyMeLoginRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Orders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Orders() *ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder

* * An order can be created from a order, usually after a checkout process has been completed.

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Password ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Password() *ByProjectKeyInStoreKeyByStoreKeyMePasswordRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Post(body MyCustomerUpdate) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) ShoppingLists ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) ShoppingLists() *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder

* * shopping-lists e.g. for wishlist support *

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Signup ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder) Signup() *ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDeleteInput struct {
	Version int
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGetInput struct {
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Expand       []string
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead

* * Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder) Post(body MyShoppingListUpdate) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDeleteInput struct {
	Expand      []string
	DataErasure *bool
	Version     int
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead

* * Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder) Post(body MyShoppingListUpdate) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput struct {
	Expand      []string
	DataErasure *bool
	Version     int
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead

* * Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) Post(body MyShoppingListDraft) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost

* * When using this endpoint, the `store` field of a ShoppingList is always set to the Store(ctp:api:type:Store) specified in the path parameter. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) WithId(id string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestBuilder) WithKey(key string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Execute(ctx context.Context) (result *ShoppingListPagedQueryResponse, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHeadInput) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

* * When using this endpoint, the `store` field of a ShoppingList is always set to the Store(ctp:api:type:Store) specified in the path parameter. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestBuilder) Post(body MyCustomerDraft) *ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost

* * If omitted in the request body, the Customer(ctp:api:type:Customer) `stores` field is set to the Store(ctp:api:type:Store) specified in the path parameter. * * Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. *

type ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost) Execute(ctx context.Context) (result *CustomerSignInResult, err error)

* * If omitted in the request body, the Customer(ctp:api:type:Customer) `stores` field is set to the Store(ctp:api:type:Store) specified in the path parameter. * * Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyMeSignupRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder) Post(body OrderUpdate) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead

* * Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder) Post(body OrderUpdate) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. * * Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * If the Order exists in the Project but does not have the `store` field, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) Post(body OrderFromCartDraft) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost

* * Before you create an Order, the Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction). * The shipping address is used for tax calculation for a Cart with `Platform` TaxMode(ctp:api:type:TaxMode). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) * - [ShippingMethodDoesNotMatchCart](ctp:api:type:ShippingMethodDoesNotMatchCartError) * - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) * - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) * - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) WithId(id string) *ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) WithOrderNumber ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder) WithOrderNumber(orderNumber string) *ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Execute(ctx context.Context) (result *OrderPagedQueryResponse, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHeadInput) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * Before you create an Order, the Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction). * The shipping address is used for tax calculation for a Cart with `Platform` TaxMode(ctp:api:type:TaxMode). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) * - [ShippingMethodDoesNotMatchCart](ctp:api:type:ShippingMethodDoesNotMatchCartError) * - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) * - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) * - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) *

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

* * Gets the current or staged representation of a Product(ctp:api:type:Product) by its ID in the specified Store(ctp:api:type:Store). * If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, * they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices) * and [inventory](ctp:api:type:ProductProjectionInventoryEntries). * * If ProductSelection(ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store. * * When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead

* * Checks if the current or staged representations of a Product exists for a given `id` in the specified Store(ctp:api:type:Store). Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise.

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) Execute(ctx context.Context) (result *ProductProjection, err error)

* * Gets the current or staged representation of a Product(ctp:api:type:Product) by its ID in the specified Store(ctp:api:type:Store). * If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, * they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices) * and [inventory](ctp:api:type:ProductProjectionInventoryEntries). * * If ProductSelection(ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store. * * When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) LocaleProjection ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) LocaleProjection(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) PriceChannel ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) PriceChannel(v string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) PriceCountry ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) PriceCountry(v string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) PriceCurrency ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) PriceCurrency(v string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) PriceCustomerGroup ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) PriceCustomerGroup(v string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) Staged ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) Staged(v bool) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGetInput struct {
	Staged             *bool
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Expand             []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if the current or staged representations of a Product exists for a given `id` in the specified Store(ctp:api:type:Store). Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

* * Gets the current or staged representation of a Product(ctp:api:type:Product) by its key in the specified Store(ctp:api:type:Store). * If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, * they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices) * and [inventory](ctp:api:type:ProductProjectionInventoryEntries). * * If ProductSelection(ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store. * * When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead

* * Checks if the current or staged representations of a Product exists for a given `key` in the specified Store(ctp:api:type:Store). Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise.

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ProductProjection, err error)

* * Gets the current or staged representation of a Product(ctp:api:type:Product) by its key in the specified Store(ctp:api:type:Store). * If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, * they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices) * and [inventory](ctp:api:type:ProductProjectionInventoryEntries). * * If ProductSelection(ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store. * * When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) LocaleProjection ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) LocaleProjection(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) PriceChannel ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) PriceChannel(v string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCountry ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCountry(v string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCurrency ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCurrency(v string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCustomerGroup ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCustomerGroup(v string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) Staged ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) Staged(v bool) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGetInput struct {
	Staged             *bool
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Expand             []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if the current or staged representations of a Product exists for a given `key` in the specified Store(ctp:api:type:Store). Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductProjectionsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsRequestBuilder) WithId(id string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyProductProjectionsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsRequestBuilder) WithKey(key string) *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet

* * Queries Product Selection assignments in a specific Store(ctp:api:type:Store). * * The response will include duplicate Products whenever more than one active Product Selection of the Store * includes a Product. To make clear through which Product Selection a Product is available in the Store * the response contains assignments including both the Product and the Product Selection. * Only Products of Product Selections that are activated in the Store will be returned. *

type ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Execute(ctx context.Context) (result *ProductsInStorePagedQueryResponse, err error)

* * Queries Product Selection assignments in a specific Store(ctp:api:type:Store). * * The response will include duplicate Products whenever more than one active Product Selection of the Store * includes a Product. To make clear through which Product Selection a Product is available in the Store * the response contains assignments including both the Product and the Product Selection. * Only Products of Product Selections that are activated in the Store will be returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Limit ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Offset ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) PredicateVar ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) WithTotal ¶ added in v1.2.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGetInput struct {
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Expand       []string
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestBuilder ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestBuilder) Get ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

* * Queries Product Tailoring in a specific Store(ctp:api:type:Store). *

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestBuilder) Post ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestBuilder) Post(body ProductTailoringInStoreDraft) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost

* * Creates a ProductTailoring(ctp:api:type:ProductTailoring) in the Store(ctp:api:type:Store) specified by `storeKey`. * When using this endpoint the ProductTailoring's `store` field is always set to the Store(ctp:api:type:Store) specified in the path parameter. * * Generates the [ProductTailoringCreated](ctp:api:type:ProductTailoringCreatedMessage) Message. *

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Execute(ctx context.Context) (result *ProductTailoringPagedQueryResponse, err error)

* * Queries Product Tailoring in a specific Store(ctp:api:type:Store). *

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Limit ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Offset ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) PredicateVar ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Sort ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Where ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) WithTotal ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGetInput ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGetInput struct {
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Expand       []string
	Where        []string
	PredicateVar map[string][]string
	Sort         []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGetInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Creates a ProductTailoring(ctp:api:type:ProductTailoring) in the Store(ctp:api:type:Store) specified by `storeKey`. * When using this endpoint the ProductTailoring's `store` field is always set to the Store(ctp:api:type:Store) specified in the path parameter. * * Generates the [ProductTailoringCreated](ctp:api:type:ProductTailoringCreatedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPostInput ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPostInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestBuilder ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestBuilder) Delete ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete

* * Generates the [ProductTailoringDeleted](ctp:api:type:ProductTailoringDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestBuilder) Get ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet

* * Gets the current or staged representation of a [Product Tailoring](ctp:api:type:ProductTailoring) by its Product ID in the specified Store(ctp:api:type:Store). *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestBuilder) Post ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestBuilder) Post(body ProductTailoringUpdate) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost

* * Updates the current or staged representation of a [Product Tailoring](ctp:api:type:ProductTailoring) by its Product ID in the specified Store(ctp:api:type:Store). *

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Generates the [ProductTailoringDeleted](ctp:api:type:ProductTailoringDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) Version ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDeleteInput ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDeleteInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Gets the current or staged representation of a [Product Tailoring](ctp:api:type:ProductTailoring) by its Product ID in the specified Store(ctp:api:type:Store). *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGetInput ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGetInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Updates the current or staged representation of a [Product Tailoring](ctp:api:type:ProductTailoring) by its Product ID in the specified Store(ctp:api:type:Store). *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPostInput ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPostInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDRequestBuilder ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDRequestBuilder) ProductTailoring ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDRequestBuilder) ProductTailoring() *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDProductTailoringRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestBuilder ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestBuilder) Delete ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete

* * Generates the [ProductTailoringDeleted](ctp:api:type:ProductTailoringDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestBuilder) Get ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet

* * Gets the current or staged representation of a [Product Tailoring](ctp:api:type:ProductTailoring) by its Product key in the specified Store(ctp:api:type:Store). *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestBuilder) Post ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestBuilder) Post(body ProductTailoringUpdate) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost

* * Updates the current or staged representation of a [Product Tailoring](ctp:api:type:ProductTailoring) by its Product key in the specified Store(ctp:api:type:Store). *

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Generates the [ProductTailoringDeleted](ctp:api:type:ProductTailoringDeletedMessage) Message. *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) Version ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDeleteInput ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDeleteInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Gets the current or staged representation of a [Product Tailoring](ctp:api:type:ProductTailoring) by its Product key in the specified Store(ctp:api:type:Store). *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGetInput ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGetInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Updates the current or staged representation of a [Product Tailoring](ctp:api:type:ProductTailoring) by its Product key in the specified Store(ctp:api:type:Store). *

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPostInput ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPostInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyRequestBuilder ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyRequestBuilder) ProductTailoring ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyRequestBuilder) ProductTailoring() *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyProductTailoringRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyProductsRequestBuilder ¶ added in v1.5.1 

type ByProjectKeyInStoreKeyByStoreKeyProductsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyProductsRequestBuilder) WithProductId ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsRequestBuilder) WithProductId(productId string) *ByProjectKeyInStoreKeyByStoreKeyProductsByProductIDRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyProductsRequestBuilder) WithProductKey ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyProductsRequestBuilder) WithProductKey(productKey string) *ByProjectKeyInStoreKeyByStoreKeyProductsKeyByProductKeyRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) CartDiscounts ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) CartDiscounts() *ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Carts ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Carts() *ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder

* * A shopping cart holds product variants and can be ordered.

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Customers ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Customers() *ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder

* * A Customer is a person purchasing products. Carts, Orders, * Comments and Reviews can be associated to a Customer. *

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Login ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Login() *ByProjectKeyInStoreKeyByStoreKeyLoginRequestBuilder

* * Retrieves the authenticated customer.

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Me ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Me() *ByProjectKeyInStoreKeyByStoreKeyMeRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Orders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Orders() *ByProjectKeyInStoreKeyByStoreKeyOrdersRequestBuilder

* * An order can be created from a cart, usually after a checkout process has been completed.

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ProductProjections ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ProductProjections() *ByProjectKeyInStoreKeyByStoreKeyProductProjectionsRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ProductSelectionAssignments ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ProductSelectionAssignments() *ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ProductTailoring ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ProductTailoring() *ByProjectKeyInStoreKeyByStoreKeyProductTailoringRequestBuilder

* * A Product Tailoring holds tailored data of Product in the Store.

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Products ¶ added in v1.5.1 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) Products() *ByProjectKeyInStoreKeyByStoreKeyProductsRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ShippingMethods ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ShippingMethods() *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ShoppingLists ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder) ShoppingLists() *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder

* * shopping-lists e.g. for wishlist support *

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet

* * Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given Store(ctp:api:type:Store). * Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. * This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction). *

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead

* * Checks if a ShippingMethod that can ship to the shipping address of the given Cart exists in the given Store(ctp:api:type:Store). Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) CartId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) CartId(v string) *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) Execute(ctx context.Context) (result *ShippingMethodPagedQueryResponse, err error)

* * Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given Store(ctp:api:type:Store). * Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. * This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction). *

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGetInput struct {
	CartId string
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) CartId ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) CartId(v string) *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShippingMethod that can ship to the shipping address of the given Cart exists in the given Store(ctp:api:type:Store). Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHeadInput) *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHeadInput struct {
	CartId string
}

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShippingMethodsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShippingMethodsRequestBuilder) MatchingCart ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsRequestBuilder) MatchingCart() *ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder

* * Get ShippingMethods for a cart in a store

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead

* * Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder) Post(body ShoppingListUpdate) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDeleteInput struct {
	Expand      []string
	DataErasure *bool
	Version     int
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder) Delete() *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead

* * Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder) Post(body ShoppingListUpdate) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDelete

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDeleteInput struct {
	Expand      []string
	DataErasure *bool
	Version     int
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

* * If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store(ctp:api:type:Store), * the [ResourceNotFound](/errors#404-not-found-1) error is returned. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) Get() *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) Head() *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead

* * Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) Post(body ShoppingListDraft) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost

* * When using this endpoint, the `store` field of a ShoppingList is always set to the Store(ctp:api:type:Store) specified in the path parameter. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) WithId(id string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDRequestBuilder

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestBuilder) WithKey(key string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyRequestBuilder

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Execute(ctx context.Context) (result *ShoppingListPagedQueryResponse, err error)

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Limit(v int) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Offset(v int) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Sort(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGetInput) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet) WithTotal(v bool) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGet

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGetInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodGetInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) Where(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHeadInput) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHead

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

* * When using this endpoint, the `store` field of a ShoppingList is always set to the Store(ctp:api:type:Store) specified in the path parameter. *

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) Expand(v []string) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost) WithQueryParams(input ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPostInput) *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPost

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPostInput ¶ 

type ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInStoreKeyByStoreKeyShoppingListsRequestMethodPostInput) Values() url.Values

type ByProjectKeyInventoryByIDRequestBuilder ¶ 

type ByProjectKeyInventoryByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInventoryByIDRequestBuilder) Delete() *ByProjectKeyInventoryByIDRequestMethodDelete

* * Produces the [InventoryEntryDeleted](ctp:api:type:InventoryEntryDeletedMessage) Message.

func (*ByProjectKeyInventoryByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInventoryByIDRequestBuilder) Get() *ByProjectKeyInventoryByIDRequestMethodGet

func (*ByProjectKeyInventoryByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryByIDRequestBuilder) Head() *ByProjectKeyInventoryByIDRequestMethodHead

* * Checks if an InventoryEntry exists for a given `id`. Returns a `200 OK` status if the InventoryEntry exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInventoryByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInventoryByIDRequestBuilder) Post(body InventoryEntryUpdate) *ByProjectKeyInventoryByIDRequestMethodPost

type ByProjectKeyInventoryByIDRequestMethodDelete ¶ 

type ByProjectKeyInventoryByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInventoryByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInventoryByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodDelete) Execute(ctx context.Context) (result *InventoryEntry, err error)

* * Produces the [InventoryEntryDeleted](ctp:api:type:InventoryEntryDeletedMessage) Message.

func (*ByProjectKeyInventoryByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyInventoryByIDRequestMethodDelete

func (*ByProjectKeyInventoryByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodDelete) Version(v int) *ByProjectKeyInventoryByIDRequestMethodDelete

func (*ByProjectKeyInventoryByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInventoryByIDRequestMethodDelete

func (*ByProjectKeyInventoryByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyInventoryByIDRequestMethodDeleteInput) *ByProjectKeyInventoryByIDRequestMethodDelete

type ByProjectKeyInventoryByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyInventoryByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyInventoryByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInventoryByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInventoryByIDRequestMethodGet ¶ 

type ByProjectKeyInventoryByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInventoryByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInventoryByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodGet) Execute(ctx context.Context) (result *InventoryEntry, err error)

func (*ByProjectKeyInventoryByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodGet) Expand(v []string) *ByProjectKeyInventoryByIDRequestMethodGet

func (*ByProjectKeyInventoryByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInventoryByIDRequestMethodGet

func (*ByProjectKeyInventoryByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodGet) WithQueryParams(input ByProjectKeyInventoryByIDRequestMethodGetInput) *ByProjectKeyInventoryByIDRequestMethodGet

type ByProjectKeyInventoryByIDRequestMethodGetInput ¶ 

type ByProjectKeyInventoryByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInventoryByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInventoryByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyInventoryByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInventoryByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInventoryByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInventoryByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an InventoryEntry exists for a given `id`. Returns a `200 OK` status if the InventoryEntry exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInventoryByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInventoryByIDRequestMethodHead

type ByProjectKeyInventoryByIDRequestMethodPost ¶ 

type ByProjectKeyInventoryByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInventoryByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInventoryByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodPost) Execute(ctx context.Context) (result *InventoryEntry, err error)

func (*ByProjectKeyInventoryByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodPost) Expand(v []string) *ByProjectKeyInventoryByIDRequestMethodPost

func (*ByProjectKeyInventoryByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInventoryByIDRequestMethodPost

func (*ByProjectKeyInventoryByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInventoryByIDRequestMethodPost) WithQueryParams(input ByProjectKeyInventoryByIDRequestMethodPostInput) *ByProjectKeyInventoryByIDRequestMethodPost

type ByProjectKeyInventoryByIDRequestMethodPostInput ¶ 

type ByProjectKeyInventoryByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInventoryByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInventoryByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyInventoryKeyByKeyRequestBuilder ¶ 

type ByProjectKeyInventoryKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestBuilder) Delete() *ByProjectKeyInventoryKeyByKeyRequestMethodDelete

* * Produces the [InventoryEntryDeleted](ctp:api:type:InventoryEntryDeletedMessage) Message.

func (*ByProjectKeyInventoryKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestBuilder) Get() *ByProjectKeyInventoryKeyByKeyRequestMethodGet

func (*ByProjectKeyInventoryKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryKeyByKeyRequestBuilder) Head() *ByProjectKeyInventoryKeyByKeyRequestMethodHead

* * Checks if an InventoryEntry exists for a given `key`. Returns a `200 OK` status if the InventoryEntry exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInventoryKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestBuilder) Post(body InventoryEntryUpdate) *ByProjectKeyInventoryKeyByKeyRequestMethodPost

type ByProjectKeyInventoryKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyInventoryKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyInventoryKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *InventoryEntry, err error)

* * Produces the [InventoryEntryDeleted](ctp:api:type:InventoryEntryDeletedMessage) Message.

func (*ByProjectKeyInventoryKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyInventoryKeyByKeyRequestMethodDelete

func (*ByProjectKeyInventoryKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyInventoryKeyByKeyRequestMethodDelete

func (*ByProjectKeyInventoryKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyInventoryKeyByKeyRequestMethodDelete

func (*ByProjectKeyInventoryKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyInventoryKeyByKeyRequestMethodDeleteInput) *ByProjectKeyInventoryKeyByKeyRequestMethodDelete

type ByProjectKeyInventoryKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyInventoryKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyInventoryKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyInventoryKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyInventoryKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInventoryKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *InventoryEntry, err error)

func (*ByProjectKeyInventoryKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyInventoryKeyByKeyRequestMethodGet

func (*ByProjectKeyInventoryKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInventoryKeyByKeyRequestMethodGet

func (*ByProjectKeyInventoryKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyInventoryKeyByKeyRequestMethodGetInput) *ByProjectKeyInventoryKeyByKeyRequestMethodGet

type ByProjectKeyInventoryKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyInventoryKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInventoryKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyInventoryKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInventoryKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInventoryKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an InventoryEntry exists for a given `key`. Returns a `200 OK` status if the InventoryEntry exists or a `404 Not Found` otherwise.

func (*ByProjectKeyInventoryKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInventoryKeyByKeyRequestMethodHead

type ByProjectKeyInventoryKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyInventoryKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInventoryKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *InventoryEntry, err error)

func (*ByProjectKeyInventoryKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyInventoryKeyByKeyRequestMethodPost

func (*ByProjectKeyInventoryKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInventoryKeyByKeyRequestMethodPost

func (*ByProjectKeyInventoryKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInventoryKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyInventoryKeyByKeyRequestMethodPostInput) *ByProjectKeyInventoryKeyByKeyRequestMethodPost

type ByProjectKeyInventoryKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyInventoryKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInventoryKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInventoryKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyInventoryRequestBuilder ¶ 

type ByProjectKeyInventoryRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryRequestBuilder) Get ¶ 

func (rb *ByProjectKeyInventoryRequestBuilder) Get() *ByProjectKeyInventoryRequestMethodGet

func (*ByProjectKeyInventoryRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryRequestBuilder) Head() *ByProjectKeyInventoryRequestMethodHead

* * Checks if an InventoryEntry exists for a given Query Predicate. Returns a `200 OK` status if any Inventory Entries match the Query Predicate, a `404 Not Found` otherwise.

func (*ByProjectKeyInventoryRequestBuilder) Post ¶ 

func (rb *ByProjectKeyInventoryRequestBuilder) Post(body InventoryEntryDraft) *ByProjectKeyInventoryRequestMethodPost

* * Produces the [InventoryEntryCreated](ctp:api:type:InventoryEntryCreatedMessage) Message.

func (*ByProjectKeyInventoryRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyInventoryRequestBuilder) WithId(id string) *ByProjectKeyInventoryByIDRequestBuilder

func (*ByProjectKeyInventoryRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyInventoryRequestBuilder) WithKey(key string) *ByProjectKeyInventoryKeyByKeyRequestBuilder

type ByProjectKeyInventoryRequestMethodGet ¶ 

type ByProjectKeyInventoryRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyInventoryRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyInventoryRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) Execute(ctx context.Context) (result *InventoryPagedQueryResponse, err error)

func (*ByProjectKeyInventoryRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) Expand(v []string) *ByProjectKeyInventoryRequestMethodGet

func (*ByProjectKeyInventoryRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) Limit(v int) *ByProjectKeyInventoryRequestMethodGet

func (*ByProjectKeyInventoryRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) Offset(v int) *ByProjectKeyInventoryRequestMethodGet

func (*ByProjectKeyInventoryRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyInventoryRequestMethodGet

func (*ByProjectKeyInventoryRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) Sort(v []string) *ByProjectKeyInventoryRequestMethodGet

func (*ByProjectKeyInventoryRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) Where(v []string) *ByProjectKeyInventoryRequestMethodGet

func (*ByProjectKeyInventoryRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyInventoryRequestMethodGet

func (*ByProjectKeyInventoryRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) WithQueryParams(input ByProjectKeyInventoryRequestMethodGetInput) *ByProjectKeyInventoryRequestMethodGet

func (*ByProjectKeyInventoryRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyInventoryRequestMethodGet) WithTotal(v bool) *ByProjectKeyInventoryRequestMethodGet

type ByProjectKeyInventoryRequestMethodGetInput ¶ 

type ByProjectKeyInventoryRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyInventoryRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyInventoryRequestMethodGetInput) Values() url.Values

type ByProjectKeyInventoryRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyInventoryRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyInventoryRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyInventoryRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an InventoryEntry exists for a given Query Predicate. Returns a `200 OK` status if any Inventory Entries match the Query Predicate, a `404 Not Found` otherwise.

func (*ByProjectKeyInventoryRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryRequestMethodHead) Where(v []string) *ByProjectKeyInventoryRequestMethodHead

func (*ByProjectKeyInventoryRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyInventoryRequestMethodHead

func (*ByProjectKeyInventoryRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyInventoryRequestMethodHead) WithQueryParams(input ByProjectKeyInventoryRequestMethodHeadInput) *ByProjectKeyInventoryRequestMethodHead

type ByProjectKeyInventoryRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyInventoryRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyInventoryRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyInventoryRequestMethodHeadInput) Values() url.Values

type ByProjectKeyInventoryRequestMethodPost ¶ 

type ByProjectKeyInventoryRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyInventoryRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyInventoryRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyInventoryRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyInventoryRequestMethodPost) Execute(ctx context.Context) (result *InventoryEntry, err error)

* * Produces the [InventoryEntryCreated](ctp:api:type:InventoryEntryCreatedMessage) Message.

func (*ByProjectKeyInventoryRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyInventoryRequestMethodPost) Expand(v []string) *ByProjectKeyInventoryRequestMethodPost

func (*ByProjectKeyInventoryRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyInventoryRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyInventoryRequestMethodPost

func (*ByProjectKeyInventoryRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyInventoryRequestMethodPost) WithQueryParams(input ByProjectKeyInventoryRequestMethodPostInput) *ByProjectKeyInventoryRequestMethodPost

type ByProjectKeyInventoryRequestMethodPostInput ¶ 

type ByProjectKeyInventoryRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyInventoryRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyInventoryRequestMethodPostInput) Values() url.Values

type ByProjectKeyLoginRequestBuilder ¶ 

type ByProjectKeyLoginRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyLoginRequestBuilder) Post ¶ 

func (rb *ByProjectKeyLoginRequestBuilder) Post(body CustomerSignin) *ByProjectKeyLoginRequestMethodPost

* * Authenticates a global Customer not associated with a Store. * For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers). * If the Customer is registered in a Store, use the [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) method. * * Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in). * * If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned. *

type ByProjectKeyLoginRequestMethodPost ¶ 

type ByProjectKeyLoginRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyLoginRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyLoginRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyLoginRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyLoginRequestMethodPost) Execute(ctx context.Context) (result *CustomerSignInResult, err error)

* * Authenticates a global Customer not associated with a Store. * For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers). * If the Customer is registered in a Store, use the [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) method. * * Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in). * * If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned. *

func (*ByProjectKeyLoginRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyLoginRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyLoginRequestMethodPost

type ByProjectKeyMeActiveCartRequestBuilder ¶ 

type ByProjectKeyMeActiveCartRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeActiveCartRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeActiveCartRequestBuilder) Get() *ByProjectKeyMeActiveCartRequestMethodGet

* * Retrieves the Customer's most recently modified active Cart. * Carts with `Merchant` or `Quote` CartOrigin(ctp:api:type:CartOrigin) are ignored. * * If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyMeActiveCartRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeActiveCartRequestBuilder) Head() *ByProjectKeyMeActiveCartRequestMethodHead

* * Checks if an active Cart exists. Returns a `200 OK` status if an active Cart exists or a `404 Not Found` otherwise.

type ByProjectKeyMeActiveCartRequestMethodGet ¶ 

type ByProjectKeyMeActiveCartRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeActiveCartRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeActiveCartRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeActiveCartRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeActiveCartRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

* * Retrieves the Customer's most recently modified active Cart. * Carts with `Merchant` or `Quote` CartOrigin(ctp:api:type:CartOrigin) are ignored. * * If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. *

func (*ByProjectKeyMeActiveCartRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeActiveCartRequestMethodGet) Expand(v []string) *ByProjectKeyMeActiveCartRequestMethodGet

func (*ByProjectKeyMeActiveCartRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeActiveCartRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeActiveCartRequestMethodGet

func (*ByProjectKeyMeActiveCartRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeActiveCartRequestMethodGet) WithQueryParams(input ByProjectKeyMeActiveCartRequestMethodGetInput) *ByProjectKeyMeActiveCartRequestMethodGet

type ByProjectKeyMeActiveCartRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeActiveCartRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeActiveCartRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeActiveCartRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeActiveCartRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeActiveCartRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeActiveCartRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeActiveCartRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeActiveCartRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeActiveCartRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an active Cart exists. Returns a `200 OK` status if an active Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeActiveCartRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeActiveCartRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeActiveCartRequestMethodHead

type ByProjectKeyMeBusinessUnitsByIDRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsByIDRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestBuilder) Delete() *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete

func (*ByProjectKeyMeBusinessUnitsByIDRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestBuilder) Get() *ByProjectKeyMeBusinessUnitsByIDRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestBuilder) Head() *ByProjectKeyMeBusinessUnitsByIDRequestMethodHead

* * Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeBusinessUnitsByIDRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestBuilder) Post(body MyBusinessUnitUpdate) *ByProjectKeyMeBusinessUnitsByIDRequestMethodPost

type ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) Version(v int) *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyMeBusinessUnitsByIDRequestMethodDeleteInput) *ByProjectKeyMeBusinessUnitsByIDRequestMethodDelete

type ByProjectKeyMeBusinessUnitsByIDRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeBusinessUnitsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMeBusinessUnitsByIDRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyMeBusinessUnitsByIDRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsByIDRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyMeBusinessUnitsByIDRequestMethodGetInput) *ByProjectKeyMeBusinessUnitsByIDRequestMethodGet

type ByProjectKeyMeBusinessUnitsByIDRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeBusinessUnitsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeBusinessUnitsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeBusinessUnitsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeBusinessUnitsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsByIDRequestMethodHead

type ByProjectKeyMeBusinessUnitsByIDRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyMeBusinessUnitsByIDRequestMethodPost

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsByIDRequestMethodPost

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyMeBusinessUnitsByIDRequestMethodPostInput) *ByProjectKeyMeBusinessUnitsByIDRequestMethodPost

type ByProjectKeyMeBusinessUnitsByIDRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeBusinessUnitsByIDRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeBusinessUnitsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder) Delete() *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder) Get() *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder) Head() *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead

* * Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder) Post(body MyBusinessUnitUpdate) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDelete

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGetInput) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGet

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodHead

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *BusinessUnit, err error)

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPostInput) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPost

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeBusinessUnitsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeBusinessUnitsRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestBuilder) Get() *ByProjectKeyMeBusinessUnitsRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestBuilder) Head() *ByProjectKeyMeBusinessUnitsRequestMethodHead

* * Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeBusinessUnitsRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestBuilder) Post(body MyBusinessUnitDraft) *ByProjectKeyMeBusinessUnitsRequestMethodPost

* * Automatically assigns the Associate to the Business Unit in the default [Associate Role](ctp:api:type:AssociateRole) defined in BusinessUnitConfiguration(ctp:api:type:BusinessUnitConfiguration). If there is no default Associate Role configured, this request fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) error. When creating a Division, the Associate must have the `AddChildUnits` Permission(ctp:api:type:Permission) in the parent unit. If the required Permission(/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned. *

func (*ByProjectKeyMeBusinessUnitsRequestBuilder) WithId ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestBuilder) WithId(id string) *ByProjectKeyMeBusinessUnitsByIDRequestBuilder

func (*ByProjectKeyMeBusinessUnitsRequestBuilder) WithKey ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestBuilder) WithKey(key string) *ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder

type ByProjectKeyMeBusinessUnitsRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeBusinessUnitsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) Execute(ctx context.Context) (result *BusinessUnitPagedQueryResponse, err error)

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) Expand(v []string) *ByProjectKeyMeBusinessUnitsRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) Limit ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) Limit(v int) *ByProjectKeyMeBusinessUnitsRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) Offset ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) Offset(v int) *ByProjectKeyMeBusinessUnitsRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) PredicateVar ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyMeBusinessUnitsRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) Sort ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) Sort(v []string) *ByProjectKeyMeBusinessUnitsRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) Where(v []string) *ByProjectKeyMeBusinessUnitsRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) WithQueryParams(input ByProjectKeyMeBusinessUnitsRequestMethodGetInput) *ByProjectKeyMeBusinessUnitsRequestMethodGet

func (*ByProjectKeyMeBusinessUnitsRequestMethodGet) WithTotal ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodGet) WithTotal(v bool) *ByProjectKeyMeBusinessUnitsRequestMethodGet

type ByProjectKeyMeBusinessUnitsRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyMeBusinessUnitsRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeBusinessUnitsRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeBusinessUnitsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeBusinessUnitsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeBusinessUnitsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeBusinessUnitsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodHead) Where(v []string) *ByProjectKeyMeBusinessUnitsRequestMethodHead

func (*ByProjectKeyMeBusinessUnitsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsRequestMethodHead

func (*ByProjectKeyMeBusinessUnitsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodHead) WithQueryParams(input ByProjectKeyMeBusinessUnitsRequestMethodHeadInput) *ByProjectKeyMeBusinessUnitsRequestMethodHead

type ByProjectKeyMeBusinessUnitsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyMeBusinessUnitsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyMeBusinessUnitsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyMeBusinessUnitsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyMeBusinessUnitsRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeBusinessUnitsRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeBusinessUnitsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeBusinessUnitsRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodPost) Execute(ctx context.Context) (result *BusinessUnit, err error)

* * Automatically assigns the Associate to the Business Unit in the default [Associate Role](ctp:api:type:AssociateRole) defined in BusinessUnitConfiguration(ctp:api:type:BusinessUnitConfiguration). If there is no default Associate Role configured, this request fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) error. When creating a Division, the Associate must have the `AddChildUnits` Permission(ctp:api:type:Permission) in the parent unit. If the required Permission(/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned. *

func (*ByProjectKeyMeBusinessUnitsRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodPost) Expand(v []string) *ByProjectKeyMeBusinessUnitsRequestMethodPost

func (*ByProjectKeyMeBusinessUnitsRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeBusinessUnitsRequestMethodPost

func (*ByProjectKeyMeBusinessUnitsRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeBusinessUnitsRequestMethodPost) WithQueryParams(input ByProjectKeyMeBusinessUnitsRequestMethodPostInput) *ByProjectKeyMeBusinessUnitsRequestMethodPost

type ByProjectKeyMeBusinessUnitsRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyMeBusinessUnitsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeBusinessUnitsRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeBusinessUnitsRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeCartsByIDRequestBuilder ¶ 

type ByProjectKeyMeCartsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestBuilder) Delete() *ByProjectKeyMeCartsByIDRequestMethodDelete

func (*ByProjectKeyMeCartsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestBuilder) Get() *ByProjectKeyMeCartsByIDRequestMethodGet

func (*ByProjectKeyMeCartsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsByIDRequestBuilder) Head() *ByProjectKeyMeCartsByIDRequestMethodHead

* * Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeCartsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestBuilder) Post(body MyCartUpdate) *ByProjectKeyMeCartsByIDRequestMethodPost

type ByProjectKeyMeCartsByIDRequestMethodDelete ¶ 

type ByProjectKeyMeCartsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyMeCartsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyMeCartsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyMeCartsByIDRequestMethodDelete

func (*ByProjectKeyMeCartsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodDelete) Version(v int) *ByProjectKeyMeCartsByIDRequestMethodDelete

func (*ByProjectKeyMeCartsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMeCartsByIDRequestMethodDelete

func (*ByProjectKeyMeCartsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyMeCartsByIDRequestMethodDeleteInput) *ByProjectKeyMeCartsByIDRequestMethodDelete

type ByProjectKeyMeCartsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyMeCartsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyMeCartsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyMeCartsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMeCartsByIDRequestMethodGet ¶ 

type ByProjectKeyMeCartsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeCartsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyMeCartsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyMeCartsByIDRequestMethodGet

func (*ByProjectKeyMeCartsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeCartsByIDRequestMethodGet

func (*ByProjectKeyMeCartsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyMeCartsByIDRequestMethodGetInput) *ByProjectKeyMeCartsByIDRequestMethodGet

type ByProjectKeyMeCartsByIDRequestMethodGetInput ¶ 

type ByProjectKeyMeCartsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeCartsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMeCartsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeCartsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeCartsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeCartsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeCartsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeCartsByIDRequestMethodHead

type ByProjectKeyMeCartsByIDRequestMethodPost ¶ 

type ByProjectKeyMeCartsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeCartsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyMeCartsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyMeCartsByIDRequestMethodPost

func (*ByProjectKeyMeCartsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeCartsByIDRequestMethodPost

func (*ByProjectKeyMeCartsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyMeCartsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyMeCartsByIDRequestMethodPostInput) *ByProjectKeyMeCartsByIDRequestMethodPost

type ByProjectKeyMeCartsByIDRequestMethodPostInput ¶ 

type ByProjectKeyMeCartsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeCartsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyMeCartsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeCartsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyMeCartsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestBuilder) Delete() *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeCartsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestBuilder) Get() *ByProjectKeyMeCartsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeCartsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestBuilder) Head() *ByProjectKeyMeCartsKeyByKeyRequestMethodHead

* * Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeCartsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestBuilder) Post(body MyCartUpdate) *ByProjectKeyMeCartsKeyByKeyRequestMethodPost

type ByProjectKeyMeCartsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyMeCartsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyMeCartsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyMeCartsKeyByKeyRequestMethodDelete

type ByProjectKeyMeCartsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyMeCartsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyMeCartsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMeCartsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyMeCartsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeCartsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyMeCartsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeCartsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyMeCartsKeyByKeyRequestMethodGetInput) *ByProjectKeyMeCartsKeyByKeyRequestMethodGet

type ByProjectKeyMeCartsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyMeCartsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMeCartsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeCartsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeCartsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeCartsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeCartsKeyByKeyRequestMethodHead

type ByProjectKeyMeCartsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyMeCartsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeCartsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyMeCartsKeyByKeyRequestMethodPost

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeCartsKeyByKeyRequestMethodPost

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyMeCartsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyMeCartsKeyByKeyRequestMethodPostInput) *ByProjectKeyMeCartsKeyByKeyRequestMethodPost

type ByProjectKeyMeCartsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyMeCartsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeCartsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyMeCartsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeCartsReplicateRequestBuilder ¶ 

type ByProjectKeyMeCartsReplicateRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsReplicateRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeCartsReplicateRequestBuilder) Post(body ReplicaMyCartDraft) *ByProjectKeyMeCartsReplicateRequestMethodPost

* * Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer. * This can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order. * * The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. * If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. * If the Customer switches to another Customer Group, the new Cart is updated with the new value. * It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` CartState(ctp:api:type:CartState). * * The new Cart does not contain Payments or Deliveries. The State(ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. * * In case the Cart or Order to be replicated does not belong to the authenticaed Customer, the API returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error *

type ByProjectKeyMeCartsReplicateRequestMethodPost ¶ 

type ByProjectKeyMeCartsReplicateRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsReplicateRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeCartsReplicateRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsReplicateRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeCartsReplicateRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

* * Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer. * This can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order. * * The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. * If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. * If the Customer switches to another Customer Group, the new Cart is updated with the new value. * It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` CartState(ctp:api:type:CartState). * * The new Cart does not contain Payments or Deliveries. The State(ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. * * In case the Cart or Order to be replicated does not belong to the authenticaed Customer, the API returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error *

func (*ByProjectKeyMeCartsReplicateRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeCartsReplicateRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeCartsReplicateRequestMethodPost

type ByProjectKeyMeCartsRequestBuilder ¶ 

type ByProjectKeyMeCartsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeCartsRequestBuilder) Get() *ByProjectKeyMeCartsRequestMethodGet

func (*ByProjectKeyMeCartsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsRequestBuilder) Head() *ByProjectKeyMeCartsRequestMethodHead

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeCartsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeCartsRequestBuilder) Post(body MyCartDraft) *ByProjectKeyMeCartsRequestMethodPost

func (*ByProjectKeyMeCartsRequestBuilder) Replicate ¶ 

func (rb *ByProjectKeyMeCartsRequestBuilder) Replicate() *ByProjectKeyMeCartsReplicateRequestBuilder

func (*ByProjectKeyMeCartsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyMeCartsRequestBuilder) WithId(id string) *ByProjectKeyMeCartsByIDRequestBuilder

func (*ByProjectKeyMeCartsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyMeCartsRequestBuilder) WithKey(key string) *ByProjectKeyMeCartsKeyByKeyRequestBuilder

type ByProjectKeyMeCartsRequestMethodGet ¶ 

type ByProjectKeyMeCartsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeCartsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) Execute(ctx context.Context) (result *CartPagedQueryResponse, err error)

func (*ByProjectKeyMeCartsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) Expand(v []string) *ByProjectKeyMeCartsRequestMethodGet

func (*ByProjectKeyMeCartsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) Limit(v int) *ByProjectKeyMeCartsRequestMethodGet

func (*ByProjectKeyMeCartsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) Offset(v int) *ByProjectKeyMeCartsRequestMethodGet

func (*ByProjectKeyMeCartsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyMeCartsRequestMethodGet

func (*ByProjectKeyMeCartsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) Sort(v []string) *ByProjectKeyMeCartsRequestMethodGet

func (*ByProjectKeyMeCartsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) Where(v []string) *ByProjectKeyMeCartsRequestMethodGet

func (*ByProjectKeyMeCartsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeCartsRequestMethodGet

func (*ByProjectKeyMeCartsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) WithQueryParams(input ByProjectKeyMeCartsRequestMethodGetInput) *ByProjectKeyMeCartsRequestMethodGet

func (*ByProjectKeyMeCartsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodGet) WithTotal(v bool) *ByProjectKeyMeCartsRequestMethodGet

type ByProjectKeyMeCartsRequestMethodGetInput ¶ 

type ByProjectKeyMeCartsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyMeCartsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMeCartsRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeCartsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeCartsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeCartsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeCartsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsRequestMethodHead) Where(v []string) *ByProjectKeyMeCartsRequestMethodHead

func (*ByProjectKeyMeCartsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeCartsRequestMethodHead

func (*ByProjectKeyMeCartsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyMeCartsRequestMethodHead) WithQueryParams(input ByProjectKeyMeCartsRequestMethodHeadInput) *ByProjectKeyMeCartsRequestMethodHead

type ByProjectKeyMeCartsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyMeCartsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyMeCartsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyMeCartsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyMeCartsRequestMethodPost ¶ 

type ByProjectKeyMeCartsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeCartsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeCartsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeCartsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodPost) Execute(ctx context.Context) (result *Cart, err error)

func (*ByProjectKeyMeCartsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodPost) Expand(v []string) *ByProjectKeyMeCartsRequestMethodPost

func (*ByProjectKeyMeCartsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeCartsRequestMethodPost

func (*ByProjectKeyMeCartsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyMeCartsRequestMethodPost) WithQueryParams(input ByProjectKeyMeCartsRequestMethodPostInput) *ByProjectKeyMeCartsRequestMethodPost

type ByProjectKeyMeCartsRequestMethodPostInput ¶ 

type ByProjectKeyMeCartsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeCartsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyMeCartsRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeEmailConfirmRequestBuilder ¶ 

type ByProjectKeyMeEmailConfirmRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeEmailConfirmRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeEmailConfirmRequestBuilder) Post(body MyCustomerEmailVerify) *ByProjectKeyMeEmailConfirmRequestMethodPost

* * This is the last step in the [email verification process of a Customer](/../api/projects/customers#email-verification-of-customer). *

type ByProjectKeyMeEmailConfirmRequestMethodPost ¶ 

type ByProjectKeyMeEmailConfirmRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeEmailConfirmRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeEmailConfirmRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeEmailConfirmRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeEmailConfirmRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * This is the last step in the [email verification process of a Customer](/../api/projects/customers#email-verification-of-customer). *

func (*ByProjectKeyMeEmailConfirmRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeEmailConfirmRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeEmailConfirmRequestMethodPost

type ByProjectKeyMeLoginRequestBuilder ¶ 

type ByProjectKeyMeLoginRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeLoginRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeLoginRequestBuilder) Post(body MyCustomerSignin) *ByProjectKeyMeLoginRequestMethodPost

* * Retrieves the authenticated customer (that matches the given email/password pair). * * If used with [an access token for an anonymous session](ctp:api:type:AnonymousSession), all Orders and Carts that belong to the `anonymousId` are assigned to the newly logged-in Customer. * * - If the Customer does not have a Cart yet, the most recently modified anonymous cart becomes the Customer's Cart. * - If the Customer already has a Cart, the most recently modified anonymous cart is handled in accordance with AnonymousCartSignInMode(ctp:api:type:AnonymousCartSignInMode). * * A Cart returned as part of the CustomerSignInResult(ctp:api:type:CustomerSignInResult) is [recalculated](ctp:api:type:MyCartRecalculateAction) with up-to-date prices, taxes, discounts, and invalid line items removed. * * If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned. *

type ByProjectKeyMeLoginRequestMethodPost ¶ 

type ByProjectKeyMeLoginRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeLoginRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeLoginRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeLoginRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeLoginRequestMethodPost) Execute(ctx context.Context) (result *CustomerSignInResult, err error)

* * Retrieves the authenticated customer (that matches the given email/password pair). * * If used with [an access token for an anonymous session](ctp:api:type:AnonymousSession), all Orders and Carts that belong to the `anonymousId` are assigned to the newly logged-in Customer. * * - If the Customer does not have a Cart yet, the most recently modified anonymous cart becomes the Customer's Cart. * - If the Customer already has a Cart, the most recently modified anonymous cart is handled in accordance with AnonymousCartSignInMode(ctp:api:type:AnonymousCartSignInMode). * * A Cart returned as part of the CustomerSignInResult(ctp:api:type:CustomerSignInResult) is [recalculated](ctp:api:type:MyCartRecalculateAction) with up-to-date prices, taxes, discounts, and invalid line items removed. * * If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned. *

func (*ByProjectKeyMeLoginRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeLoginRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeLoginRequestMethodPost

type ByProjectKeyMeOrdersByIDRequestBuilder ¶ 

type ByProjectKeyMeOrdersByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeOrdersByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeOrdersByIDRequestBuilder) Get() *ByProjectKeyMeOrdersByIDRequestMethodGet

func (*ByProjectKeyMeOrdersByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeOrdersByIDRequestBuilder) Head() *ByProjectKeyMeOrdersByIDRequestMethodHead

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

type ByProjectKeyMeOrdersByIDRequestMethodGet ¶ 

type ByProjectKeyMeOrdersByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeOrdersByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeOrdersByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeOrdersByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeOrdersByIDRequestMethodGet) Execute(ctx context.Context) (result *Order, err error)

func (*ByProjectKeyMeOrdersByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMeOrdersByIDRequestMethodGet) Expand(v []string) *ByProjectKeyMeOrdersByIDRequestMethodGet

func (*ByProjectKeyMeOrdersByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeOrdersByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeOrdersByIDRequestMethodGet

func (*ByProjectKeyMeOrdersByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMeOrdersByIDRequestMethodGet) WithQueryParams(input ByProjectKeyMeOrdersByIDRequestMethodGetInput) *ByProjectKeyMeOrdersByIDRequestMethodGet

type ByProjectKeyMeOrdersByIDRequestMethodGetInput ¶ 

type ByProjectKeyMeOrdersByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeOrdersByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMeOrdersByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeOrdersByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeOrdersByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeOrdersByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeOrdersByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeOrdersByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeOrdersByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeOrdersByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeOrdersByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeOrdersByIDRequestMethodHead

type ByProjectKeyMeOrdersQuotesRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyMeOrdersQuotesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeOrdersQuotesRequestBuilder) Post ¶ added in v1.3.0 

func (rb *ByProjectKeyMeOrdersQuotesRequestBuilder) Post(body MyOrderFromQuoteDraft) *ByProjectKeyMeOrdersQuotesRequestMethodPost

* * When creating [B2B Orders](/associates-overview#b2b-resources), the Customer must have the `CreateMyOrdersFromMyQuotes` Permission(ctp:api:type:Permission). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) * - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) *

type ByProjectKeyMeOrdersQuotesRequestMethodPost ¶ added in v1.3.0 

type ByProjectKeyMeOrdersQuotesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeOrdersQuotesRequestMethodPost) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyMeOrdersQuotesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeOrdersQuotesRequestMethodPost) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyMeOrdersQuotesRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * When creating [B2B Orders](/associates-overview#b2b-resources), the Customer must have the `CreateMyOrdersFromMyQuotes` Permission(ctp:api:type:Permission). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) * - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) *

func (*ByProjectKeyMeOrdersQuotesRequestMethodPost) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyMeOrdersQuotesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeOrdersQuotesRequestMethodPost

type ByProjectKeyMeOrdersRequestBuilder ¶ 

type ByProjectKeyMeOrdersRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeOrdersRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeOrdersRequestBuilder) Get() *ByProjectKeyMeOrdersRequestMethodGet

func (*ByProjectKeyMeOrdersRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeOrdersRequestBuilder) Head() *ByProjectKeyMeOrdersRequestMethodHead

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeOrdersRequestBuilder) OrderQuote ¶ added in v1.4.0 

func (rb *ByProjectKeyMeOrdersRequestBuilder) OrderQuote() *ByProjectKeyMeOrdersQuotesRequestBuilder

func (*ByProjectKeyMeOrdersRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeOrdersRequestBuilder) Post(body MyOrderFromCartDraft) *ByProjectKeyMeOrdersRequestMethodPost

* * The Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction) for taxes to be calculated. When creating [B2B Orders](/associates-overview#b2b-resources), the Customer must have the `CreateMyOrdersFromMyCarts` Permission(ctp:api:type:Permission). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) * - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) *

func (*ByProjectKeyMeOrdersRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyMeOrdersRequestBuilder) WithId(id string) *ByProjectKeyMeOrdersByIDRequestBuilder

type ByProjectKeyMeOrdersRequestMethodGet ¶ 

type ByProjectKeyMeOrdersRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeOrdersRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeOrdersRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeOrdersRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) Execute(ctx context.Context) (result *OrderPagedQueryResponse, err error)

func (*ByProjectKeyMeOrdersRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) Expand(v []string) *ByProjectKeyMeOrdersRequestMethodGet

func (*ByProjectKeyMeOrdersRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) Limit(v int) *ByProjectKeyMeOrdersRequestMethodGet

func (*ByProjectKeyMeOrdersRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) Offset(v int) *ByProjectKeyMeOrdersRequestMethodGet

func (*ByProjectKeyMeOrdersRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyMeOrdersRequestMethodGet

func (*ByProjectKeyMeOrdersRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) Sort(v []string) *ByProjectKeyMeOrdersRequestMethodGet

func (*ByProjectKeyMeOrdersRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) Where(v []string) *ByProjectKeyMeOrdersRequestMethodGet

func (*ByProjectKeyMeOrdersRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeOrdersRequestMethodGet

func (*ByProjectKeyMeOrdersRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) WithQueryParams(input ByProjectKeyMeOrdersRequestMethodGetInput) *ByProjectKeyMeOrdersRequestMethodGet

func (*ByProjectKeyMeOrdersRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodGet) WithTotal(v bool) *ByProjectKeyMeOrdersRequestMethodGet

type ByProjectKeyMeOrdersRequestMethodGetInput ¶ 

type ByProjectKeyMeOrdersRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyMeOrdersRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMeOrdersRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeOrdersRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeOrdersRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeOrdersRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeOrdersRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeOrdersRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeOrdersRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeOrdersRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyMeOrdersRequestMethodHead) Where(v []string) *ByProjectKeyMeOrdersRequestMethodHead

func (*ByProjectKeyMeOrdersRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeOrdersRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeOrdersRequestMethodHead

func (*ByProjectKeyMeOrdersRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyMeOrdersRequestMethodHead) WithQueryParams(input ByProjectKeyMeOrdersRequestMethodHeadInput) *ByProjectKeyMeOrdersRequestMethodHead

type ByProjectKeyMeOrdersRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyMeOrdersRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyMeOrdersRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyMeOrdersRequestMethodHeadInput) Values() url.Values

type ByProjectKeyMeOrdersRequestMethodPost ¶ 

type ByProjectKeyMeOrdersRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeOrdersRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeOrdersRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeOrdersRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * The Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction) for taxes to be calculated. When creating [B2B Orders](/associates-overview#b2b-resources), the Customer must have the `CreateMyOrdersFromMyCarts` Permission(ctp:api:type:Permission). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) * - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) *

func (*ByProjectKeyMeOrdersRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodPost) Expand(v []string) *ByProjectKeyMeOrdersRequestMethodPost

func (*ByProjectKeyMeOrdersRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeOrdersRequestMethodPost

func (*ByProjectKeyMeOrdersRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyMeOrdersRequestMethodPost) WithQueryParams(input ByProjectKeyMeOrdersRequestMethodPostInput) *ByProjectKeyMeOrdersRequestMethodPost

type ByProjectKeyMeOrdersRequestMethodPostInput ¶ 

type ByProjectKeyMeOrdersRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeOrdersRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyMeOrdersRequestMethodPostInput) Values() url.Values

type ByProjectKeyMePasswordRequestBuilder ¶ 

type ByProjectKeyMePasswordRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePasswordRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMePasswordRequestBuilder) Post(body MyCustomerChangePassword) *ByProjectKeyMePasswordRequestMethodPost

* * Changing the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=false`. * * If the current password does not match, an [InvalidCurrentPassword](ctp:api:type:InvalidCurrentPasswordError) error is returned. *

func (*ByProjectKeyMePasswordRequestBuilder) Reset ¶ 

func (rb *ByProjectKeyMePasswordRequestBuilder) Reset() *ByProjectKeyMePasswordResetRequestBuilder

type ByProjectKeyMePasswordRequestMethodPost ¶ 

type ByProjectKeyMePasswordRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePasswordRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMePasswordRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMePasswordRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMePasswordRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * Changing the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=false`. * * If the current password does not match, an [InvalidCurrentPassword](ctp:api:type:InvalidCurrentPasswordError) error is returned. *

func (*ByProjectKeyMePasswordRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMePasswordRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMePasswordRequestMethodPost

type ByProjectKeyMePasswordResetRequestBuilder ¶ 

type ByProjectKeyMePasswordResetRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePasswordResetRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMePasswordResetRequestBuilder) Post(body MyCustomerResetPassword) *ByProjectKeyMePasswordResetRequestMethodPost

* * This is the last step in the [password reset process of a Customer](/../api/projects/customers#password-reset-of-customer). * * Resetting a password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`. *

type ByProjectKeyMePasswordResetRequestMethodPost ¶ 

type ByProjectKeyMePasswordResetRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePasswordResetRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMePasswordResetRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMePasswordResetRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMePasswordResetRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

* * This is the last step in the [password reset process of a Customer](/../api/projects/customers#password-reset-of-customer). * * Resetting a password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`. *

func (*ByProjectKeyMePasswordResetRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMePasswordResetRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMePasswordResetRequestMethodPost

type ByProjectKeyMePaymentsByIDRequestBuilder ¶ 

type ByProjectKeyMePaymentsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePaymentsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestBuilder) Delete() *ByProjectKeyMePaymentsByIDRequestMethodDelete

* * This endpoint can only delete a Payment when it has no [Transactions](ctp:api:type:Transaction). *

func (*ByProjectKeyMePaymentsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestBuilder) Get() *ByProjectKeyMePaymentsByIDRequestMethodGet

func (*ByProjectKeyMePaymentsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMePaymentsByIDRequestBuilder) Head() *ByProjectKeyMePaymentsByIDRequestMethodHead

* * Checks if a Payment exists for a given `id`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMePaymentsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestBuilder) Post(body MyPaymentUpdate) *ByProjectKeyMePaymentsByIDRequestMethodPost

* * This endpoint can only update a Payment when it has no [Transactions](ctp:api:type:Transaction). *

type ByProjectKeyMePaymentsByIDRequestMethodDelete ¶ 

type ByProjectKeyMePaymentsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePaymentsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyMePaymentsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMePaymentsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodDelete) Execute(ctx context.Context) (result *MyPayment, err error)

* * This endpoint can only delete a Payment when it has no [Transactions](ctp:api:type:Transaction). *

func (*ByProjectKeyMePaymentsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyMePaymentsByIDRequestMethodDelete

func (*ByProjectKeyMePaymentsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodDelete) Version(v int) *ByProjectKeyMePaymentsByIDRequestMethodDelete

func (*ByProjectKeyMePaymentsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMePaymentsByIDRequestMethodDelete

func (*ByProjectKeyMePaymentsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyMePaymentsByIDRequestMethodDeleteInput) *ByProjectKeyMePaymentsByIDRequestMethodDelete

type ByProjectKeyMePaymentsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyMePaymentsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyMePaymentsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyMePaymentsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMePaymentsByIDRequestMethodGet ¶ 

type ByProjectKeyMePaymentsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePaymentsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMePaymentsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMePaymentsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodGet) Execute(ctx context.Context) (result *MyPayment, err error)

func (*ByProjectKeyMePaymentsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyMePaymentsByIDRequestMethodGet

func (*ByProjectKeyMePaymentsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMePaymentsByIDRequestMethodGet

func (*ByProjectKeyMePaymentsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyMePaymentsByIDRequestMethodGetInput) *ByProjectKeyMePaymentsByIDRequestMethodGet

type ByProjectKeyMePaymentsByIDRequestMethodGetInput ¶ 

type ByProjectKeyMePaymentsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMePaymentsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMePaymentsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyMePaymentsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMePaymentsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePaymentsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMePaymentsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMePaymentsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Payment exists for a given `id`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMePaymentsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMePaymentsByIDRequestMethodHead

type ByProjectKeyMePaymentsByIDRequestMethodPost ¶ 

type ByProjectKeyMePaymentsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePaymentsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMePaymentsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMePaymentsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodPost) Execute(ctx context.Context) (result *MyPayment, err error)

* * This endpoint can only update a Payment when it has no [Transactions](ctp:api:type:Transaction). *

func (*ByProjectKeyMePaymentsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyMePaymentsByIDRequestMethodPost

func (*ByProjectKeyMePaymentsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMePaymentsByIDRequestMethodPost

func (*ByProjectKeyMePaymentsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyMePaymentsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyMePaymentsByIDRequestMethodPostInput) *ByProjectKeyMePaymentsByIDRequestMethodPost

type ByProjectKeyMePaymentsByIDRequestMethodPostInput ¶ 

type ByProjectKeyMePaymentsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMePaymentsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyMePaymentsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyMePaymentsRequestBuilder ¶ 

type ByProjectKeyMePaymentsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePaymentsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMePaymentsRequestBuilder) Get() *ByProjectKeyMePaymentsRequestMethodGet

func (*ByProjectKeyMePaymentsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMePaymentsRequestBuilder) Head() *ByProjectKeyMePaymentsRequestMethodHead

* * Checks if a Payment exists for a given Query Predicate. Returns a `200 OK` status if any Payments match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMePaymentsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMePaymentsRequestBuilder) Post(body MyPaymentDraft) *ByProjectKeyMePaymentsRequestMethodPost

* * Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) Message. *

func (*ByProjectKeyMePaymentsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyMePaymentsRequestBuilder) WithId(id string) *ByProjectKeyMePaymentsByIDRequestBuilder

type ByProjectKeyMePaymentsRequestMethodGet ¶ 

type ByProjectKeyMePaymentsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePaymentsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMePaymentsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMePaymentsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) Execute(ctx context.Context) (result *MyPaymentPagedQueryResponse, err error)

func (*ByProjectKeyMePaymentsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) Expand(v []string) *ByProjectKeyMePaymentsRequestMethodGet

func (*ByProjectKeyMePaymentsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) Limit(v int) *ByProjectKeyMePaymentsRequestMethodGet

func (*ByProjectKeyMePaymentsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) Offset(v int) *ByProjectKeyMePaymentsRequestMethodGet

func (*ByProjectKeyMePaymentsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyMePaymentsRequestMethodGet

func (*ByProjectKeyMePaymentsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) Sort(v []string) *ByProjectKeyMePaymentsRequestMethodGet

func (*ByProjectKeyMePaymentsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) Where(v []string) *ByProjectKeyMePaymentsRequestMethodGet

func (*ByProjectKeyMePaymentsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMePaymentsRequestMethodGet

func (*ByProjectKeyMePaymentsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) WithQueryParams(input ByProjectKeyMePaymentsRequestMethodGetInput) *ByProjectKeyMePaymentsRequestMethodGet

func (*ByProjectKeyMePaymentsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodGet) WithTotal(v bool) *ByProjectKeyMePaymentsRequestMethodGet

type ByProjectKeyMePaymentsRequestMethodGetInput ¶ 

type ByProjectKeyMePaymentsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyMePaymentsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMePaymentsRequestMethodGetInput) Values() url.Values

type ByProjectKeyMePaymentsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMePaymentsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePaymentsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMePaymentsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMePaymentsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMePaymentsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Payment exists for a given Query Predicate. Returns a `200 OK` status if any Payments match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMePaymentsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyMePaymentsRequestMethodHead) Where(v []string) *ByProjectKeyMePaymentsRequestMethodHead

func (*ByProjectKeyMePaymentsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMePaymentsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMePaymentsRequestMethodHead

func (*ByProjectKeyMePaymentsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyMePaymentsRequestMethodHead) WithQueryParams(input ByProjectKeyMePaymentsRequestMethodHeadInput) *ByProjectKeyMePaymentsRequestMethodHead

type ByProjectKeyMePaymentsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyMePaymentsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyMePaymentsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyMePaymentsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyMePaymentsRequestMethodPost ¶ 

type ByProjectKeyMePaymentsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMePaymentsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMePaymentsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMePaymentsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodPost) Execute(ctx context.Context) (result *MyPayment, err error)

* * Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) Message. *

func (*ByProjectKeyMePaymentsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodPost) Expand(v []string) *ByProjectKeyMePaymentsRequestMethodPost

func (*ByProjectKeyMePaymentsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMePaymentsRequestMethodPost

func (*ByProjectKeyMePaymentsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyMePaymentsRequestMethodPost) WithQueryParams(input ByProjectKeyMePaymentsRequestMethodPostInput) *ByProjectKeyMePaymentsRequestMethodPost

type ByProjectKeyMePaymentsRequestMethodPostInput ¶ 

type ByProjectKeyMePaymentsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMePaymentsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyMePaymentsRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeQuoteRequestsByIDRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsByIDRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestBuilder) Delete() *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete

func (*ByProjectKeyMeQuoteRequestsByIDRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestBuilder) Get() *ByProjectKeyMeQuoteRequestsByIDRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestBuilder) Head() *ByProjectKeyMeQuoteRequestsByIDRequestMethodHead

* * Checks if my QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuoteRequestsByIDRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestBuilder) Post(body MyQuoteRequestUpdate) *ByProjectKeyMeQuoteRequestsByIDRequestMethodPost

type ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) Version(v int) *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyMeQuoteRequestsByIDRequestMethodDeleteInput) *ByProjectKeyMeQuoteRequestsByIDRequestMethodDelete

type ByProjectKeyMeQuoteRequestsByIDRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuoteRequestsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMeQuoteRequestsByIDRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyMeQuoteRequestsByIDRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsByIDRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyMeQuoteRequestsByIDRequestMethodGetInput) *ByProjectKeyMeQuoteRequestsByIDRequestMethodGet

type ByProjectKeyMeQuoteRequestsByIDRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuoteRequestsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeQuoteRequestsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeQuoteRequestsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeQuoteRequestsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if my QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsByIDRequestMethodHead

type ByProjectKeyMeQuoteRequestsByIDRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyMeQuoteRequestsByIDRequestMethodPost

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsByIDRequestMethodPost

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyMeQuoteRequestsByIDRequestMethodPostInput) *ByProjectKeyMeQuoteRequestsByIDRequestMethodPost

type ByProjectKeyMeQuoteRequestsByIDRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeQuoteRequestsByIDRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuoteRequestsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder) Delete() *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder) Get() *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder) Head() *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead

* * Checks if my QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder) Post(body MyQuoteRequestUpdate) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDelete

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGetInput) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGet

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if my QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodHead

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPostInput) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPost

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuoteRequestsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeQuoteRequestsRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestBuilder) Get() *ByProjectKeyMeQuoteRequestsRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestBuilder) Head() *ByProjectKeyMeQuoteRequestsRequestMethodHead

* * Checks if my QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuoteRequestsRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestBuilder) Post(body MyQuoteRequestDraft) *ByProjectKeyMeQuoteRequestsRequestMethodPost

func (*ByProjectKeyMeQuoteRequestsRequestBuilder) WithId ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestBuilder) WithId(id string) *ByProjectKeyMeQuoteRequestsByIDRequestBuilder

func (*ByProjectKeyMeQuoteRequestsRequestBuilder) WithKey ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestBuilder) WithKey(key string) *ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder

type ByProjectKeyMeQuoteRequestsRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuoteRequestsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) Execute(ctx context.Context) (result *QuoteRequestPagedQueryResponse, err error)

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) Expand(v []string) *ByProjectKeyMeQuoteRequestsRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) Limit ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) Limit(v int) *ByProjectKeyMeQuoteRequestsRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) Offset ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) Offset(v int) *ByProjectKeyMeQuoteRequestsRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) PredicateVar ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyMeQuoteRequestsRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) Sort ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) Sort(v []string) *ByProjectKeyMeQuoteRequestsRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) Where(v []string) *ByProjectKeyMeQuoteRequestsRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) WithQueryParams(input ByProjectKeyMeQuoteRequestsRequestMethodGetInput) *ByProjectKeyMeQuoteRequestsRequestMethodGet

func (*ByProjectKeyMeQuoteRequestsRequestMethodGet) WithTotal ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodGet) WithTotal(v bool) *ByProjectKeyMeQuoteRequestsRequestMethodGet

type ByProjectKeyMeQuoteRequestsRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyMeQuoteRequestsRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuoteRequestsRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeQuoteRequestsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeQuoteRequestsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeQuoteRequestsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if my QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuoteRequestsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodHead) Where(v []string) *ByProjectKeyMeQuoteRequestsRequestMethodHead

func (*ByProjectKeyMeQuoteRequestsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsRequestMethodHead

func (*ByProjectKeyMeQuoteRequestsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodHead) WithQueryParams(input ByProjectKeyMeQuoteRequestsRequestMethodHeadInput) *ByProjectKeyMeQuoteRequestsRequestMethodHead

type ByProjectKeyMeQuoteRequestsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyMeQuoteRequestsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyMeQuoteRequestsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyMeQuoteRequestsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyMeQuoteRequestsRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuoteRequestsRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuoteRequestsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeQuoteRequestsRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodPost) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyMeQuoteRequestsRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodPost) Expand(v []string) *ByProjectKeyMeQuoteRequestsRequestMethodPost

func (*ByProjectKeyMeQuoteRequestsRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeQuoteRequestsRequestMethodPost

func (*ByProjectKeyMeQuoteRequestsRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuoteRequestsRequestMethodPost) WithQueryParams(input ByProjectKeyMeQuoteRequestsRequestMethodPostInput) *ByProjectKeyMeQuoteRequestsRequestMethodPost

type ByProjectKeyMeQuoteRequestsRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyMeQuoteRequestsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeQuoteRequestsRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuoteRequestsRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeQuotesByIDRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyMeQuotesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesByIDRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestBuilder) Get() *ByProjectKeyMeQuotesByIDRequestMethodGet

func (*ByProjectKeyMeQuotesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesByIDRequestBuilder) Head() *ByProjectKeyMeQuotesByIDRequestMethodHead

* * Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuotesByIDRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestBuilder) Post(body MyQuoteUpdate) *ByProjectKeyMeQuotesByIDRequestMethodPost

type ByProjectKeyMeQuotesByIDRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyMeQuotesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesByIDRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuotesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeQuotesByIDRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodGet) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyMeQuotesByIDRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyMeQuotesByIDRequestMethodGet

func (*ByProjectKeyMeQuotesByIDRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeQuotesByIDRequestMethodGet

func (*ByProjectKeyMeQuotesByIDRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyMeQuotesByIDRequestMethodGetInput) *ByProjectKeyMeQuotesByIDRequestMethodGet

type ByProjectKeyMeQuotesByIDRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeQuotesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeQuotesByIDRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuotesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeQuotesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeQuotesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeQuotesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeQuotesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuotesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeQuotesByIDRequestMethodHead

type ByProjectKeyMeQuotesByIDRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyMeQuotesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesByIDRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuotesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeQuotesByIDRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodPost) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyMeQuotesByIDRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyMeQuotesByIDRequestMethodPost

func (*ByProjectKeyMeQuotesByIDRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeQuotesByIDRequestMethodPost

func (*ByProjectKeyMeQuotesByIDRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyMeQuotesByIDRequestMethodPostInput) *ByProjectKeyMeQuotesByIDRequestMethodPost

type ByProjectKeyMeQuotesByIDRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyMeQuotesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeQuotesByIDRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuotesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeQuotesKeyByKeyRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyMeQuotesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesKeyByKeyRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestBuilder) Get() *ByProjectKeyMeQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyMeQuotesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestBuilder) Head() *ByProjectKeyMeQuotesKeyByKeyRequestMethodHead

* * Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuotesKeyByKeyRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestBuilder) Post(body MyQuoteUpdate) *ByProjectKeyMeQuotesKeyByKeyRequestMethodPost

type ByProjectKeyMeQuotesKeyByKeyRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyMeQuotesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyMeQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyMeQuotesKeyByKeyRequestMethodGetInput) *ByProjectKeyMeQuotesKeyByKeyRequestMethodGet

type ByProjectKeyMeQuotesKeyByKeyRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeQuotesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuotesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeQuotesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeQuotesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeQuotesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeQuotesKeyByKeyRequestMethodHead

type ByProjectKeyMeQuotesKeyByKeyRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyMeQuotesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyMeQuotesKeyByKeyRequestMethodPost

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeQuotesKeyByKeyRequestMethodPost

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyMeQuotesKeyByKeyRequestMethodPostInput) *ByProjectKeyMeQuotesKeyByKeyRequestMethodPost

type ByProjectKeyMeQuotesKeyByKeyRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyMeQuotesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeQuotesKeyByKeyRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuotesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeQuotesRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyMeQuotesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestBuilder) Get() *ByProjectKeyMeQuotesRequestMethodGet

func (*ByProjectKeyMeQuotesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesRequestBuilder) Head() *ByProjectKeyMeQuotesRequestMethodHead

* * Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuotesRequestBuilder) WithId ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestBuilder) WithId(id string) *ByProjectKeyMeQuotesByIDRequestBuilder

func (*ByProjectKeyMeQuotesRequestBuilder) WithKey ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestBuilder) WithKey(key string) *ByProjectKeyMeQuotesKeyByKeyRequestBuilder

type ByProjectKeyMeQuotesRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyMeQuotesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyMeQuotesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeQuotesRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) Execute(ctx context.Context) (result *QuotePagedQueryResponse, err error)

func (*ByProjectKeyMeQuotesRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) Expand(v []string) *ByProjectKeyMeQuotesRequestMethodGet

func (*ByProjectKeyMeQuotesRequestMethodGet) Limit ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) Limit(v int) *ByProjectKeyMeQuotesRequestMethodGet

func (*ByProjectKeyMeQuotesRequestMethodGet) Offset ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) Offset(v int) *ByProjectKeyMeQuotesRequestMethodGet

func (*ByProjectKeyMeQuotesRequestMethodGet) PredicateVar ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyMeQuotesRequestMethodGet

func (*ByProjectKeyMeQuotesRequestMethodGet) Sort ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) Sort(v []string) *ByProjectKeyMeQuotesRequestMethodGet

func (*ByProjectKeyMeQuotesRequestMethodGet) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) Where(v []string) *ByProjectKeyMeQuotesRequestMethodGet

func (*ByProjectKeyMeQuotesRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeQuotesRequestMethodGet

func (*ByProjectKeyMeQuotesRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) WithQueryParams(input ByProjectKeyMeQuotesRequestMethodGetInput) *ByProjectKeyMeQuotesRequestMethodGet

func (*ByProjectKeyMeQuotesRequestMethodGet) WithTotal ¶ added in v1.2.0 

func (rb *ByProjectKeyMeQuotesRequestMethodGet) WithTotal(v bool) *ByProjectKeyMeQuotesRequestMethodGet

type ByProjectKeyMeQuotesRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyMeQuotesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyMeQuotesRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyMeQuotesRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeQuotesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeQuotesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeQuotesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeQuotesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeQuotesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeQuotesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesRequestMethodHead) Where(v []string) *ByProjectKeyMeQuotesRequestMethodHead

func (*ByProjectKeyMeQuotesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeQuotesRequestMethodHead

func (*ByProjectKeyMeQuotesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyMeQuotesRequestMethodHead) WithQueryParams(input ByProjectKeyMeQuotesRequestMethodHeadInput) *ByProjectKeyMeQuotesRequestMethodHead

type ByProjectKeyMeQuotesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyMeQuotesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyMeQuotesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyMeQuotesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyMeRequestBuilder ¶ 

type ByProjectKeyMeRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeRequestBuilder) ActiveCart ¶ 

func (rb *ByProjectKeyMeRequestBuilder) ActiveCart() *ByProjectKeyMeActiveCartRequestBuilder

func (*ByProjectKeyMeRequestBuilder) BusinessUnits ¶ added in v1.2.0 

func (rb *ByProjectKeyMeRequestBuilder) BusinessUnits() *ByProjectKeyMeBusinessUnitsRequestBuilder

* * MyBusinessUnit creates and provides access to Business Units scoped to a specific user.

func (*ByProjectKeyMeRequestBuilder) Carts ¶ 

func (rb *ByProjectKeyMeRequestBuilder) Carts() *ByProjectKeyMeCartsRequestBuilder

* * A shopping cart holds product variants and can be ordered.

func (*ByProjectKeyMeRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyMeRequestBuilder) Delete() *ByProjectKeyMeRequestMethodDelete

func (*ByProjectKeyMeRequestBuilder) EmailConfirm ¶ 

func (rb *ByProjectKeyMeRequestBuilder) EmailConfirm() *ByProjectKeyMeEmailConfirmRequestBuilder

func (*ByProjectKeyMeRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeRequestBuilder) Get() *ByProjectKeyMeRequestMethodGet

func (*ByProjectKeyMeRequestBuilder) Login ¶ 

func (rb *ByProjectKeyMeRequestBuilder) Login() *ByProjectKeyMeLoginRequestBuilder

func (*ByProjectKeyMeRequestBuilder) Orders ¶ 

func (rb *ByProjectKeyMeRequestBuilder) Orders() *ByProjectKeyMeOrdersRequestBuilder

* * An order can be created from a cart, usually after a checkout process has been completed.

func (*ByProjectKeyMeRequestBuilder) Password ¶ 

func (rb *ByProjectKeyMeRequestBuilder) Password() *ByProjectKeyMePasswordRequestBuilder

func (*ByProjectKeyMeRequestBuilder) Payments ¶ 

func (rb *ByProjectKeyMeRequestBuilder) Payments() *ByProjectKeyMePaymentsRequestBuilder

* * The My Payments endpoint creates and provides access to payments scoped to a specific user.

func (*ByProjectKeyMeRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeRequestBuilder) Post(body MyCustomerUpdate) *ByProjectKeyMeRequestMethodPost

func (*ByProjectKeyMeRequestBuilder) QuoteRequests ¶ added in v1.2.0 

func (rb *ByProjectKeyMeRequestBuilder) QuoteRequests() *ByProjectKeyMeQuoteRequestsRequestBuilder

* * The My Quote Requests endpoint creates and provides access to Quote Requests scoped to a specific user.

func (*ByProjectKeyMeRequestBuilder) Quotes ¶ added in v1.2.0 

func (rb *ByProjectKeyMeRequestBuilder) Quotes() *ByProjectKeyMeQuotesRequestBuilder

* * The My Quote endpoint provides access to Quotes scoped to a specific user.

func (*ByProjectKeyMeRequestBuilder) ShoppingLists ¶ 

func (rb *ByProjectKeyMeRequestBuilder) ShoppingLists() *ByProjectKeyMeShoppingListsRequestBuilder

* * The My Shopping Lists endpoint creates and provides access to Shopping Lists scoped to a specific user.

func (*ByProjectKeyMeRequestBuilder) Signup ¶ 

func (rb *ByProjectKeyMeRequestBuilder) Signup() *ByProjectKeyMeSignupRequestBuilder

type ByProjectKeyMeRequestMethodDelete ¶ 

type ByProjectKeyMeRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyMeRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMeRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyMeRequestMethodDelete) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyMeRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyMeRequestMethodDelete) Version(v int) *ByProjectKeyMeRequestMethodDelete

func (*ByProjectKeyMeRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyMeRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMeRequestMethodDelete

func (*ByProjectKeyMeRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyMeRequestMethodDelete) WithQueryParams(input ByProjectKeyMeRequestMethodDeleteInput) *ByProjectKeyMeRequestMethodDelete

type ByProjectKeyMeRequestMethodDeleteInput ¶ 

type ByProjectKeyMeRequestMethodDeleteInput struct {
	Version int
}

func (*ByProjectKeyMeRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyMeRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMeRequestMethodGet ¶ 

type ByProjectKeyMeRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyMeRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) Expand(v []string) *ByProjectKeyMeRequestMethodGet

func (*ByProjectKeyMeRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) Limit(v int) *ByProjectKeyMeRequestMethodGet

func (*ByProjectKeyMeRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) Offset(v int) *ByProjectKeyMeRequestMethodGet

func (*ByProjectKeyMeRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyMeRequestMethodGet

func (*ByProjectKeyMeRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) Sort(v []string) *ByProjectKeyMeRequestMethodGet

func (*ByProjectKeyMeRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) Where(v []string) *ByProjectKeyMeRequestMethodGet

func (*ByProjectKeyMeRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeRequestMethodGet

func (*ByProjectKeyMeRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) WithQueryParams(input ByProjectKeyMeRequestMethodGetInput) *ByProjectKeyMeRequestMethodGet

func (*ByProjectKeyMeRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyMeRequestMethodGet) WithTotal(v bool) *ByProjectKeyMeRequestMethodGet

type ByProjectKeyMeRequestMethodGetInput ¶ 

type ByProjectKeyMeRequestMethodGetInput struct {
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Expand       []string
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyMeRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMeRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeRequestMethodPost ¶ 

type ByProjectKeyMeRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeRequestMethodPost) Execute(ctx context.Context) (result *Customer, err error)

func (*ByProjectKeyMeRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeRequestMethodPost

type ByProjectKeyMeShoppingListsByIDRequestBuilder ¶ 

type ByProjectKeyMeShoppingListsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestBuilder) Delete() *ByProjectKeyMeShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyMeShoppingListsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestBuilder) Get() *ByProjectKeyMeShoppingListsByIDRequestMethodGet

func (*ByProjectKeyMeShoppingListsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsByIDRequestBuilder) Head() *ByProjectKeyMeShoppingListsByIDRequestMethodHead

* * Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeShoppingListsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestBuilder) Post(body MyShoppingListUpdate) *ByProjectKeyMeShoppingListsByIDRequestMethodPost

type ByProjectKeyMeShoppingListsByIDRequestMethodDelete ¶ 

type ByProjectKeyMeShoppingListsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyMeShoppingListsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodDelete) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyMeShoppingListsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyMeShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyMeShoppingListsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodDelete) Version(v int) *ByProjectKeyMeShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyMeShoppingListsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyMeShoppingListsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyMeShoppingListsByIDRequestMethodDeleteInput) *ByProjectKeyMeShoppingListsByIDRequestMethodDelete

type ByProjectKeyMeShoppingListsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyMeShoppingListsByIDRequestMethodDeleteInput struct {
	Expand  []string
	Version int
}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyMeShoppingListsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMeShoppingListsByIDRequestMethodGet ¶ 

type ByProjectKeyMeShoppingListsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeShoppingListsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodGet) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyMeShoppingListsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyMeShoppingListsByIDRequestMethodGet

func (*ByProjectKeyMeShoppingListsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsByIDRequestMethodGet

func (*ByProjectKeyMeShoppingListsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyMeShoppingListsByIDRequestMethodGetInput) *ByProjectKeyMeShoppingListsByIDRequestMethodGet

type ByProjectKeyMeShoppingListsByIDRequestMethodGetInput ¶ 

type ByProjectKeyMeShoppingListsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMeShoppingListsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeShoppingListsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeShoppingListsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeShoppingListsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeShoppingListsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsByIDRequestMethodHead

type ByProjectKeyMeShoppingListsByIDRequestMethodPost ¶ 

type ByProjectKeyMeShoppingListsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeShoppingListsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyMeShoppingListsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyMeShoppingListsByIDRequestMethodPost

func (*ByProjectKeyMeShoppingListsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsByIDRequestMethodPost

func (*ByProjectKeyMeShoppingListsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyMeShoppingListsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyMeShoppingListsByIDRequestMethodPostInput) *ByProjectKeyMeShoppingListsByIDRequestMethodPost

type ByProjectKeyMeShoppingListsByIDRequestMethodPostInput ¶ 

type ByProjectKeyMeShoppingListsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeShoppingListsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyMeShoppingListsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder) Delete() *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder) Get() *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder) Head() *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead

* * Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder) Post(body MyShoppingListUpdate) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDelete

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput struct {
	Expand  []string
	Version int
}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGetInput) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGet

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodHead

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPostInput) *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPost

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyMeShoppingListsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeShoppingListsRequestBuilder ¶ 

type ByProjectKeyMeShoppingListsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestBuilder) Get() *ByProjectKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyMeShoppingListsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsRequestBuilder) Head() *ByProjectKeyMeShoppingListsRequestMethodHead

* * Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeShoppingListsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestBuilder) Post(body MyShoppingListDraft) *ByProjectKeyMeShoppingListsRequestMethodPost

func (*ByProjectKeyMeShoppingListsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestBuilder) WithId(id string) *ByProjectKeyMeShoppingListsByIDRequestBuilder

func (*ByProjectKeyMeShoppingListsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestBuilder) WithKey(key string) *ByProjectKeyMeShoppingListsKeyByKeyRequestBuilder

type ByProjectKeyMeShoppingListsRequestMethodGet ¶ 

type ByProjectKeyMeShoppingListsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMeShoppingListsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) Execute(ctx context.Context) (result *ShoppingListPagedQueryResponse, err error)

func (*ByProjectKeyMeShoppingListsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) Expand(v []string) *ByProjectKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyMeShoppingListsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) Limit(v int) *ByProjectKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyMeShoppingListsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) Offset(v int) *ByProjectKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyMeShoppingListsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyMeShoppingListsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) Sort(v []string) *ByProjectKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyMeShoppingListsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) Where(v []string) *ByProjectKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyMeShoppingListsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyMeShoppingListsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) WithQueryParams(input ByProjectKeyMeShoppingListsRequestMethodGetInput) *ByProjectKeyMeShoppingListsRequestMethodGet

func (*ByProjectKeyMeShoppingListsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodGet) WithTotal(v bool) *ByProjectKeyMeShoppingListsRequestMethodGet

type ByProjectKeyMeShoppingListsRequestMethodGetInput ¶ 

type ByProjectKeyMeShoppingListsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyMeShoppingListsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMeShoppingListsRequestMethodGetInput) Values() url.Values

type ByProjectKeyMeShoppingListsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMeShoppingListsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMeShoppingListsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMeShoppingListsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsRequestMethodHead) Where(v []string) *ByProjectKeyMeShoppingListsRequestMethodHead

func (*ByProjectKeyMeShoppingListsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsRequestMethodHead

func (*ByProjectKeyMeShoppingListsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyMeShoppingListsRequestMethodHead) WithQueryParams(input ByProjectKeyMeShoppingListsRequestMethodHeadInput) *ByProjectKeyMeShoppingListsRequestMethodHead

type ByProjectKeyMeShoppingListsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyMeShoppingListsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyMeShoppingListsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyMeShoppingListsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyMeShoppingListsRequestMethodPost ¶ 

type ByProjectKeyMeShoppingListsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeShoppingListsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeShoppingListsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeShoppingListsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyMeShoppingListsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodPost) Expand(v []string) *ByProjectKeyMeShoppingListsRequestMethodPost

func (*ByProjectKeyMeShoppingListsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeShoppingListsRequestMethodPost

func (*ByProjectKeyMeShoppingListsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyMeShoppingListsRequestMethodPost) WithQueryParams(input ByProjectKeyMeShoppingListsRequestMethodPostInput) *ByProjectKeyMeShoppingListsRequestMethodPost

type ByProjectKeyMeShoppingListsRequestMethodPostInput ¶ 

type ByProjectKeyMeShoppingListsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyMeShoppingListsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyMeShoppingListsRequestMethodPostInput) Values() url.Values

type ByProjectKeyMeSignupRequestBuilder ¶ 

type ByProjectKeyMeSignupRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeSignupRequestBuilder) Post ¶ 

func (rb *ByProjectKeyMeSignupRequestBuilder) Post(body MyCustomerDraft) *ByProjectKeyMeSignupRequestMethodPost

* * If used with an [access token for an anonymous session](ctp:api:type:AnonymousSession), all Orders and Carts that belong to the `anonymousId` are assigned to the newly created Customer. * * Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. *

type ByProjectKeyMeSignupRequestMethodPost ¶ 

type ByProjectKeyMeSignupRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMeSignupRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyMeSignupRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyMeSignupRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyMeSignupRequestMethodPost) Execute(ctx context.Context) (result *CustomerSignInResult, err error)

* * If used with an [access token for an anonymous session](ctp:api:type:AnonymousSession), all Orders and Carts that belong to the `anonymousId` are assigned to the newly created Customer. * * Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. *

func (*ByProjectKeyMeSignupRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyMeSignupRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyMeSignupRequestMethodPost

type ByProjectKeyMessagesByIDRequestBuilder ¶ 

type ByProjectKeyMessagesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMessagesByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMessagesByIDRequestBuilder) Get() *ByProjectKeyMessagesByIDRequestMethodGet

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyMessagesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMessagesByIDRequestBuilder) Head() *ByProjectKeyMessagesByIDRequestMethodHead

* * Checks if a Message exists for a given `id`. Returns a `200 OK` status if the Message exists or a `404 Not Found` otherwise.

type ByProjectKeyMessagesByIDRequestMethodGet ¶ 

type ByProjectKeyMessagesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMessagesByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMessagesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMessagesByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMessagesByIDRequestMethodGet) Execute(ctx context.Context) (result *Message, err error)

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyMessagesByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMessagesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyMessagesByIDRequestMethodGet

func (*ByProjectKeyMessagesByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMessagesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMessagesByIDRequestMethodGet

func (*ByProjectKeyMessagesByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMessagesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyMessagesByIDRequestMethodGetInput) *ByProjectKeyMessagesByIDRequestMethodGet

type ByProjectKeyMessagesByIDRequestMethodGetInput ¶ 

type ByProjectKeyMessagesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyMessagesByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMessagesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyMessagesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMessagesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMessagesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMessagesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMessagesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMessagesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Message exists for a given `id`. Returns a `200 OK` status if the Message exists or a `404 Not Found` otherwise.

func (*ByProjectKeyMessagesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMessagesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMessagesByIDRequestMethodHead

type ByProjectKeyMessagesRequestBuilder ¶ 

type ByProjectKeyMessagesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMessagesRequestBuilder) Get ¶ 

func (rb *ByProjectKeyMessagesRequestBuilder) Get() *ByProjectKeyMessagesRequestMethodGet

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyMessagesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyMessagesRequestBuilder) Head() *ByProjectKeyMessagesRequestMethodHead

* * Checks if a Message exists for a given Query Predicate. Returns a `200 OK` status if any Messages match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMessagesRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyMessagesRequestBuilder) WithId(id string) *ByProjectKeyMessagesByIDRequestBuilder

type ByProjectKeyMessagesRequestMethodGet ¶ 

type ByProjectKeyMessagesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMessagesRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyMessagesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyMessagesRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) Execute(ctx context.Context) (result *MessagePagedQueryResponse, err error)

* * Deprecated scope: `view_orders:{projectKey}`

func (*ByProjectKeyMessagesRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) Expand(v []string) *ByProjectKeyMessagesRequestMethodGet

func (*ByProjectKeyMessagesRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) Limit(v int) *ByProjectKeyMessagesRequestMethodGet

func (*ByProjectKeyMessagesRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) Offset(v int) *ByProjectKeyMessagesRequestMethodGet

func (*ByProjectKeyMessagesRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyMessagesRequestMethodGet

func (*ByProjectKeyMessagesRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) Sort(v []string) *ByProjectKeyMessagesRequestMethodGet

func (*ByProjectKeyMessagesRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) Where(v []string) *ByProjectKeyMessagesRequestMethodGet

func (*ByProjectKeyMessagesRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyMessagesRequestMethodGet

func (*ByProjectKeyMessagesRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) WithQueryParams(input ByProjectKeyMessagesRequestMethodGetInput) *ByProjectKeyMessagesRequestMethodGet

func (*ByProjectKeyMessagesRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyMessagesRequestMethodGet) WithTotal(v bool) *ByProjectKeyMessagesRequestMethodGet

type ByProjectKeyMessagesRequestMethodGetInput ¶ 

type ByProjectKeyMessagesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyMessagesRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyMessagesRequestMethodGetInput) Values() url.Values

type ByProjectKeyMessagesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyMessagesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyMessagesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyMessagesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyMessagesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyMessagesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Message exists for a given Query Predicate. Returns a `200 OK` status if any Messages match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyMessagesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyMessagesRequestMethodHead) Where(v []string) *ByProjectKeyMessagesRequestMethodHead

func (*ByProjectKeyMessagesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyMessagesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyMessagesRequestMethodHead

func (*ByProjectKeyMessagesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyMessagesRequestMethodHead) WithQueryParams(input ByProjectKeyMessagesRequestMethodHeadInput) *ByProjectKeyMessagesRequestMethodHead

type ByProjectKeyMessagesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyMessagesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyMessagesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyMessagesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyOrdersByIDRequestBuilder ¶ 

type ByProjectKeyOrdersByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyOrdersByIDRequestBuilder) Delete() *ByProjectKeyOrdersByIDRequestMethodDelete

* * Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message. *

func (*ByProjectKeyOrdersByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyOrdersByIDRequestBuilder) Get() *ByProjectKeyOrdersByIDRequestMethodGet

func (*ByProjectKeyOrdersByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersByIDRequestBuilder) Head() *ByProjectKeyOrdersByIDRequestMethodHead

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyOrdersByIDRequestBuilder) Post(body OrderUpdate) *ByProjectKeyOrdersByIDRequestMethodPost

type ByProjectKeyOrdersByIDRequestMethodDelete ¶ 

type ByProjectKeyOrdersByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyOrdersByIDRequestMethodDelete

func (*ByProjectKeyOrdersByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyOrdersByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyOrdersByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodDelete) Execute(ctx context.Context) (result *Order, err error)

* * Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message. *

func (*ByProjectKeyOrdersByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyOrdersByIDRequestMethodDelete

func (*ByProjectKeyOrdersByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodDelete) Version(v int) *ByProjectKeyOrdersByIDRequestMethodDelete

func (*ByProjectKeyOrdersByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyOrdersByIDRequestMethodDelete

func (*ByProjectKeyOrdersByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyOrdersByIDRequestMethodDeleteInput) *ByProjectKeyOrdersByIDRequestMethodDelete

type ByProjectKeyOrdersByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyOrdersByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyOrdersByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyOrdersByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyOrdersByIDRequestMethodGet ¶ 

type ByProjectKeyOrdersByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyOrdersByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyOrdersByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodGet) Execute(ctx context.Context) (result *Order, err error)

func (*ByProjectKeyOrdersByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodGet) Expand(v []string) *ByProjectKeyOrdersByIDRequestMethodGet

func (*ByProjectKeyOrdersByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyOrdersByIDRequestMethodGet

func (*ByProjectKeyOrdersByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodGet) WithQueryParams(input ByProjectKeyOrdersByIDRequestMethodGetInput) *ByProjectKeyOrdersByIDRequestMethodGet

type ByProjectKeyOrdersByIDRequestMethodGetInput ¶ 

type ByProjectKeyOrdersByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyOrdersByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyOrdersByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyOrdersByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyOrdersByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyOrdersByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyOrdersByIDRequestMethodHead

type ByProjectKeyOrdersByIDRequestMethodPost ¶ 

type ByProjectKeyOrdersByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyOrdersByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

func (*ByProjectKeyOrdersByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodPost) Expand(v []string) *ByProjectKeyOrdersByIDRequestMethodPost

func (*ByProjectKeyOrdersByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersByIDRequestMethodPost

func (*ByProjectKeyOrdersByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersByIDRequestMethodPost) WithQueryParams(input ByProjectKeyOrdersByIDRequestMethodPostInput) *ByProjectKeyOrdersByIDRequestMethodPost

type ByProjectKeyOrdersByIDRequestMethodPostInput ¶ 

type ByProjectKeyOrdersByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyOrdersByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyOrdersEditsByIDApplyRequestBuilder ¶ 

type ByProjectKeyOrdersEditsByIDApplyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsByIDApplyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyOrdersEditsByIDApplyRequestBuilder) Post(body OrderEditApply) *ByProjectKeyOrdersEditsByIDApplyRequestMethodPost

* * Applying an OrderEdit produces the OrderEditApplied(ctp:api:type:OrderEditAppliedMessage) Message. *

type ByProjectKeyOrdersEditsByIDApplyRequestMethodPost ¶ 

type ByProjectKeyOrdersEditsByIDApplyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsByIDApplyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyOrdersEditsByIDApplyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsByIDApplyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyOrdersEditsByIDApplyRequestMethodPost) Execute(ctx context.Context) (result *OrderEdit, err error)

* * Applying an OrderEdit produces the OrderEditApplied(ctp:api:type:OrderEditAppliedMessage) Message. *

func (*ByProjectKeyOrdersEditsByIDApplyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersEditsByIDApplyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsByIDApplyRequestMethodPost

type ByProjectKeyOrdersEditsByIDRequestBuilder ¶ 

type ByProjectKeyOrdersEditsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsByIDRequestBuilder) Apply ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestBuilder) Apply() *ByProjectKeyOrdersEditsByIDApplyRequestBuilder

func (*ByProjectKeyOrdersEditsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestBuilder) Delete() *ByProjectKeyOrdersEditsByIDRequestMethodDelete

func (*ByProjectKeyOrdersEditsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestBuilder) Get() *ByProjectKeyOrdersEditsByIDRequestMethodGet

func (*ByProjectKeyOrdersEditsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsByIDRequestBuilder) Head() *ByProjectKeyOrdersEditsByIDRequestMethodHead

* * Checks if an OrderEdit exists for a given `id`. Returns a `200 OK` status if the OrderEdit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersEditsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestBuilder) Post(body OrderEditUpdate) *ByProjectKeyOrdersEditsByIDRequestMethodPost

type ByProjectKeyOrdersEditsByIDRequestMethodDelete ¶ 

type ByProjectKeyOrdersEditsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyOrdersEditsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodDelete) Execute(ctx context.Context) (result *OrderEdit, err error)

func (*ByProjectKeyOrdersEditsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyOrdersEditsByIDRequestMethodDelete

func (*ByProjectKeyOrdersEditsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodDelete) Version(v int) *ByProjectKeyOrdersEditsByIDRequestMethodDelete

func (*ByProjectKeyOrdersEditsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsByIDRequestMethodDelete

func (*ByProjectKeyOrdersEditsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyOrdersEditsByIDRequestMethodDeleteInput) *ByProjectKeyOrdersEditsByIDRequestMethodDelete

type ByProjectKeyOrdersEditsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyOrdersEditsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyOrdersEditsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyOrdersEditsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyOrdersEditsByIDRequestMethodGet ¶ 

type ByProjectKeyOrdersEditsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyOrdersEditsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodGet) Execute(ctx context.Context) (result *OrderEdit, err error)

func (*ByProjectKeyOrdersEditsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyOrdersEditsByIDRequestMethodGet

func (*ByProjectKeyOrdersEditsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsByIDRequestMethodGet

func (*ByProjectKeyOrdersEditsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyOrdersEditsByIDRequestMethodGetInput) *ByProjectKeyOrdersEditsByIDRequestMethodGet

type ByProjectKeyOrdersEditsByIDRequestMethodGetInput ¶ 

type ByProjectKeyOrdersEditsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersEditsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyOrdersEditsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyOrdersEditsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyOrdersEditsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyOrdersEditsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an OrderEdit exists for a given `id`. Returns a `200 OK` status if the OrderEdit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersEditsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsByIDRequestMethodHead

type ByProjectKeyOrdersEditsByIDRequestMethodPost ¶ 

type ByProjectKeyOrdersEditsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyOrdersEditsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodPost) Execute(ctx context.Context) (result *OrderEdit, err error)

func (*ByProjectKeyOrdersEditsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyOrdersEditsByIDRequestMethodPost

func (*ByProjectKeyOrdersEditsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsByIDRequestMethodPost

func (*ByProjectKeyOrdersEditsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersEditsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyOrdersEditsByIDRequestMethodPostInput) *ByProjectKeyOrdersEditsByIDRequestMethodPost

type ByProjectKeyOrdersEditsByIDRequestMethodPostInput ¶ 

type ByProjectKeyOrdersEditsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersEditsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyOrdersEditsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyOrdersEditsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyOrdersEditsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestBuilder) Delete() *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete

func (*ByProjectKeyOrdersEditsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestBuilder) Get() *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet

func (*ByProjectKeyOrdersEditsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestBuilder) Head() *ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead

* * Checks if an OrderEdit exists for a given `key`. Returns a `200 OK` status if the OrderEdit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersEditsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestBuilder) Post(body OrderEditUpdate) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *OrderEdit, err error)

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyOrdersEditsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDelete

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyOrdersEditsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *OrderEdit, err error)

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyOrdersEditsKeyByKeyRequestMethodGetInput) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGet

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyOrdersEditsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an OrderEdit exists for a given `key`. Returns a `200 OK` status if the OrderEdit exists or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodHead

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *OrderEdit, err error)

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyOrdersEditsKeyByKeyRequestMethodPostInput) *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPost

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyOrdersEditsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersEditsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyOrdersEditsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyOrdersEditsRequestBuilder ¶ 

type ByProjectKeyOrdersEditsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyOrdersEditsRequestBuilder) Get() *ByProjectKeyOrdersEditsRequestMethodGet

func (*ByProjectKeyOrdersEditsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsRequestBuilder) Head() *ByProjectKeyOrdersEditsRequestMethodHead

* * Checks if an OrderEdit exists for a given Query Predicate. Returns a `200 OK` status if any OrderEdits match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersEditsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyOrdersEditsRequestBuilder) Post(body OrderEditDraft) *ByProjectKeyOrdersEditsRequestMethodPost

* * You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order. *

func (*ByProjectKeyOrdersEditsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyOrdersEditsRequestBuilder) WithId(id string) *ByProjectKeyOrdersEditsByIDRequestBuilder

func (*ByProjectKeyOrdersEditsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyOrdersEditsRequestBuilder) WithKey(key string) *ByProjectKeyOrdersEditsKeyByKeyRequestBuilder

type ByProjectKeyOrdersEditsRequestMethodGet ¶ 

type ByProjectKeyOrdersEditsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyOrdersEditsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) Execute(ctx context.Context) (result *OrderEditPagedQueryResponse, err error)

func (*ByProjectKeyOrdersEditsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) Expand(v []string) *ByProjectKeyOrdersEditsRequestMethodGet

func (*ByProjectKeyOrdersEditsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) Limit(v int) *ByProjectKeyOrdersEditsRequestMethodGet

func (*ByProjectKeyOrdersEditsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) Offset(v int) *ByProjectKeyOrdersEditsRequestMethodGet

func (*ByProjectKeyOrdersEditsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyOrdersEditsRequestMethodGet

func (*ByProjectKeyOrdersEditsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) Sort(v []string) *ByProjectKeyOrdersEditsRequestMethodGet

func (*ByProjectKeyOrdersEditsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) Where(v []string) *ByProjectKeyOrdersEditsRequestMethodGet

func (*ByProjectKeyOrdersEditsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsRequestMethodGet

func (*ByProjectKeyOrdersEditsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) WithQueryParams(input ByProjectKeyOrdersEditsRequestMethodGetInput) *ByProjectKeyOrdersEditsRequestMethodGet

func (*ByProjectKeyOrdersEditsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodGet) WithTotal(v bool) *ByProjectKeyOrdersEditsRequestMethodGet

type ByProjectKeyOrdersEditsRequestMethodGetInput ¶ 

type ByProjectKeyOrdersEditsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyOrdersEditsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyOrdersEditsRequestMethodGetInput) Values() url.Values

type ByProjectKeyOrdersEditsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyOrdersEditsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyOrdersEditsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an OrderEdit exists for a given Query Predicate. Returns a `200 OK` status if any OrderEdits match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersEditsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsRequestMethodHead) Where(v []string) *ByProjectKeyOrdersEditsRequestMethodHead

func (*ByProjectKeyOrdersEditsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsRequestMethodHead

func (*ByProjectKeyOrdersEditsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersEditsRequestMethodHead) WithQueryParams(input ByProjectKeyOrdersEditsRequestMethodHeadInput) *ByProjectKeyOrdersEditsRequestMethodHead

type ByProjectKeyOrdersEditsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyOrdersEditsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyOrdersEditsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyOrdersEditsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyOrdersEditsRequestMethodPost ¶ 

type ByProjectKeyOrdersEditsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersEditsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyOrdersEditsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersEditsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodPost) Execute(ctx context.Context) (result *OrderEdit, err error)

* * You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order. *

func (*ByProjectKeyOrdersEditsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodPost) Expand(v []string) *ByProjectKeyOrdersEditsRequestMethodPost

func (*ByProjectKeyOrdersEditsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersEditsRequestMethodPost

func (*ByProjectKeyOrdersEditsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersEditsRequestMethodPost) WithQueryParams(input ByProjectKeyOrdersEditsRequestMethodPostInput) *ByProjectKeyOrdersEditsRequestMethodPost

type ByProjectKeyOrdersEditsRequestMethodPostInput ¶ 

type ByProjectKeyOrdersEditsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersEditsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyOrdersEditsRequestMethodPostInput) Values() url.Values

type ByProjectKeyOrdersImportRequestBuilder ¶ 

type ByProjectKeyOrdersImportRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersImportRequestBuilder) Post ¶ 

func (rb *ByProjectKeyOrdersImportRequestBuilder) Post(body OrderImportDraft) *ByProjectKeyOrdersImportRequestMethodPost

* * Importing an Order produces the [Order Imported](ctp:api:type:OrderImportedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) *

type ByProjectKeyOrdersImportRequestMethodPost ¶ 

type ByProjectKeyOrdersImportRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersImportRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyOrdersImportRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersImportRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyOrdersImportRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * Importing an Order produces the [Order Imported](ctp:api:type:OrderImportedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) *

func (*ByProjectKeyOrdersImportRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersImportRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersImportRequestMethodPost

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder ¶ 

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder) Delete() *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

* * Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message. *

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder) Get ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder) Get() *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder) Head() *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead

* * Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder) Post ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder) Post(body OrderUpdate) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete ¶ 

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) DataErasure(v bool) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Execute(ctx context.Context) (result *Order, err error)

* * Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message. *

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Expand(v []string) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) Version(v int) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete) WithQueryParams(input ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDelete

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput ¶ 

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet ¶ 

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Execute(ctx context.Context) (result *Order, err error)

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) Expand(v []string) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet) WithQueryParams(input ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGet

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput ¶ 

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodGetInput) Values() url.Values

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodHead

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost ¶ 

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) Expand(v []string) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost) WithQueryParams(input ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPost

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput ¶ 

type ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyOrdersOrderNumberByOrderNumberRequestMethodPostInput) Values() url.Values

type ByProjectKeyOrdersQuotesRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyOrdersQuotesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersQuotesRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyOrdersQuotesRequestBuilder) Post(body OrderFromQuoteDraft) *ByProjectKeyOrdersQuotesRequestMethodPost

* * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) * - [InvalidOperation](ctp:api:type:InvalidOperationError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) *

type ByProjectKeyOrdersQuotesRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyOrdersQuotesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersQuotesRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyOrdersQuotesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersQuotesRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyOrdersQuotesRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) * - [InvalidOperation](ctp:api:type:InvalidOperationError) * - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) *

func (*ByProjectKeyOrdersQuotesRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyOrdersQuotesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersQuotesRequestMethodPost

type ByProjectKeyOrdersRequestBuilder ¶ 

type ByProjectKeyOrdersRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersRequestBuilder) Edits ¶ 

func (rb *ByProjectKeyOrdersRequestBuilder) Edits() *ByProjectKeyOrdersEditsRequestBuilder

* * OrderEdit are containers for financial changes after an Order has been placed.

func (*ByProjectKeyOrdersRequestBuilder) Get ¶ 

func (rb *ByProjectKeyOrdersRequestBuilder) Get() *ByProjectKeyOrdersRequestMethodGet

func (*ByProjectKeyOrdersRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersRequestBuilder) Head() *ByProjectKeyOrdersRequestMethodHead

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersRequestBuilder) ImportOrder ¶ 

func (rb *ByProjectKeyOrdersRequestBuilder) ImportOrder() *ByProjectKeyOrdersImportRequestBuilder

func (*ByProjectKeyOrdersRequestBuilder) OrderQuote ¶ added in v1.2.0 

func (rb *ByProjectKeyOrdersRequestBuilder) OrderQuote() *ByProjectKeyOrdersQuotesRequestBuilder

func (*ByProjectKeyOrdersRequestBuilder) Post ¶ 

func (rb *ByProjectKeyOrdersRequestBuilder) Post(body OrderFromCartDraft) *ByProjectKeyOrdersRequestMethodPost

* * Before you create an Order, the Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction). * The shipping address is used for tax calculation for a Cart with `Platform` TaxMode(ctp:api:type:TaxMode). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) * - [ShippingMethodDoesNotMatchCart](ctp:api:type:ShippingMethodDoesNotMatchCartError) * - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) * - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) * - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) *

func (*ByProjectKeyOrdersRequestBuilder) Search ¶ 

func (rb *ByProjectKeyOrdersRequestBuilder) Search() *ByProjectKeyOrdersSearchRequestBuilder

* * This endpoint provides high performance search queries over Orders. The order search allows searching through all orders (currently supporting a limit of the 10.000.000 newest orders) in your project. *

func (*ByProjectKeyOrdersRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyOrdersRequestBuilder) WithId(id string) *ByProjectKeyOrdersByIDRequestBuilder

func (*ByProjectKeyOrdersRequestBuilder) WithOrderNumber ¶ 

func (rb *ByProjectKeyOrdersRequestBuilder) WithOrderNumber(orderNumber string) *ByProjectKeyOrdersOrderNumberByOrderNumberRequestBuilder

type ByProjectKeyOrdersRequestMethodGet ¶ 

type ByProjectKeyOrdersRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyOrdersRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyOrdersRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) Execute(ctx context.Context) (result *OrderPagedQueryResponse, err error)

func (*ByProjectKeyOrdersRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) Expand(v []string) *ByProjectKeyOrdersRequestMethodGet

func (*ByProjectKeyOrdersRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) Limit(v int) *ByProjectKeyOrdersRequestMethodGet

func (*ByProjectKeyOrdersRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) Offset(v int) *ByProjectKeyOrdersRequestMethodGet

func (*ByProjectKeyOrdersRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyOrdersRequestMethodGet

func (*ByProjectKeyOrdersRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) Sort(v []string) *ByProjectKeyOrdersRequestMethodGet

func (*ByProjectKeyOrdersRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) Where(v []string) *ByProjectKeyOrdersRequestMethodGet

func (*ByProjectKeyOrdersRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyOrdersRequestMethodGet

func (*ByProjectKeyOrdersRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) WithQueryParams(input ByProjectKeyOrdersRequestMethodGetInput) *ByProjectKeyOrdersRequestMethodGet

func (*ByProjectKeyOrdersRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyOrdersRequestMethodGet) WithTotal(v bool) *ByProjectKeyOrdersRequestMethodGet

type ByProjectKeyOrdersRequestMethodGetInput ¶ 

type ByProjectKeyOrdersRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyOrdersRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyOrdersRequestMethodGetInput) Values() url.Values

type ByProjectKeyOrdersRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyOrdersRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyOrdersRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyOrdersRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersRequestMethodHead) Execute(ctx context.Context) error

* * Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyOrdersRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersRequestMethodHead) Where(v []string) *ByProjectKeyOrdersRequestMethodHead

func (*ByProjectKeyOrdersRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyOrdersRequestMethodHead

func (*ByProjectKeyOrdersRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyOrdersRequestMethodHead) WithQueryParams(input ByProjectKeyOrdersRequestMethodHeadInput) *ByProjectKeyOrdersRequestMethodHead

type ByProjectKeyOrdersRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyOrdersRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyOrdersRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyOrdersRequestMethodHeadInput) Values() url.Values

type ByProjectKeyOrdersRequestMethodPost ¶ 

type ByProjectKeyOrdersRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyOrdersRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyOrdersRequestMethodPost) Execute(ctx context.Context) (result *Order, err error)

* * Before you create an Order, the Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction). * The shipping address is used for tax calculation for a Cart with `Platform` TaxMode(ctp:api:type:TaxMode). * * Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. * * Specific Error Codes: * * - [OutOfStock](ctp:api:type:OutOfStockError) * - [PriceChanged](ctp:api:type:PriceChangedError) * - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) * - [ShippingMethodDoesNotMatchCart](ctp:api:type:ShippingMethodDoesNotMatchCartError) * - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) * - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) * - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) *

func (*ByProjectKeyOrdersRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyOrdersRequestMethodPost) Expand(v []string) *ByProjectKeyOrdersRequestMethodPost

func (*ByProjectKeyOrdersRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersRequestMethodPost

func (*ByProjectKeyOrdersRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyOrdersRequestMethodPost) WithQueryParams(input ByProjectKeyOrdersRequestMethodPostInput) *ByProjectKeyOrdersRequestMethodPost

type ByProjectKeyOrdersRequestMethodPostInput ¶ 

type ByProjectKeyOrdersRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyOrdersRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyOrdersRequestMethodPostInput) Values() url.Values

type ByProjectKeyOrdersSearchRequestBuilder ¶ 

type ByProjectKeyOrdersSearchRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersSearchRequestBuilder) Head ¶ 

func (rb *ByProjectKeyOrdersSearchRequestBuilder) Head() *ByProjectKeyOrdersSearchRequestMethodHead

* * Checks whether a search index for the Project's Orders exists.

func (*ByProjectKeyOrdersSearchRequestBuilder) Post ¶ 

func (rb *ByProjectKeyOrdersSearchRequestBuilder) Post(body OrderSearchRequest) *ByProjectKeyOrdersSearchRequestMethodPost

type ByProjectKeyOrdersSearchRequestMethodHead ¶ 

type ByProjectKeyOrdersSearchRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersSearchRequestMethodHead) Dump ¶ 

func (r *ByProjectKeyOrdersSearchRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyOrdersSearchRequestMethodHead) Execute ¶ 

func (rb *ByProjectKeyOrdersSearchRequestMethodHead) Execute(ctx context.Context) error

* * Checks whether a search index for the Project's Orders exists.

func (*ByProjectKeyOrdersSearchRequestMethodHead) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersSearchRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyOrdersSearchRequestMethodHead

type ByProjectKeyOrdersSearchRequestMethodPost ¶ 

type ByProjectKeyOrdersSearchRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyOrdersSearchRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyOrdersSearchRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyOrdersSearchRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyOrdersSearchRequestMethodPost) Execute(ctx context.Context) (result *OrderPagedSearchResponse, err error)

func (*ByProjectKeyOrdersSearchRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyOrdersSearchRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyOrdersSearchRequestMethodPost

type ByProjectKeyPaymentsByIDRequestBuilder ¶ 

type ByProjectKeyPaymentsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestBuilder) Delete() *ByProjectKeyPaymentsByIDRequestMethodDelete

func (*ByProjectKeyPaymentsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestBuilder) Get() *ByProjectKeyPaymentsByIDRequestMethodGet

func (*ByProjectKeyPaymentsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsByIDRequestBuilder) Head() *ByProjectKeyPaymentsByIDRequestMethodHead

* * Checks if a Payment exists for a given `id`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise.

func (*ByProjectKeyPaymentsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestBuilder) Post(body PaymentUpdate) *ByProjectKeyPaymentsByIDRequestMethodPost

type ByProjectKeyPaymentsByIDRequestMethodDelete ¶ 

type ByProjectKeyPaymentsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyPaymentsByIDRequestMethodDelete

func (*ByProjectKeyPaymentsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyPaymentsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Payment, err error)

func (*ByProjectKeyPaymentsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyPaymentsByIDRequestMethodDelete

func (*ByProjectKeyPaymentsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodDelete) Version(v int) *ByProjectKeyPaymentsByIDRequestMethodDelete

func (*ByProjectKeyPaymentsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyPaymentsByIDRequestMethodDelete

func (*ByProjectKeyPaymentsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyPaymentsByIDRequestMethodDeleteInput) *ByProjectKeyPaymentsByIDRequestMethodDelete

type ByProjectKeyPaymentsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyPaymentsByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyPaymentsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyPaymentsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyPaymentsByIDRequestMethodGet ¶ 

type ByProjectKeyPaymentsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyPaymentsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodGet) Execute(ctx context.Context) (result *Payment, err error)

func (*ByProjectKeyPaymentsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyPaymentsByIDRequestMethodGet

func (*ByProjectKeyPaymentsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyPaymentsByIDRequestMethodGet

func (*ByProjectKeyPaymentsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyPaymentsByIDRequestMethodGetInput) *ByProjectKeyPaymentsByIDRequestMethodGet

type ByProjectKeyPaymentsByIDRequestMethodGetInput ¶ 

type ByProjectKeyPaymentsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyPaymentsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyPaymentsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyPaymentsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyPaymentsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyPaymentsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Payment exists for a given `id`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise.

func (*ByProjectKeyPaymentsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyPaymentsByIDRequestMethodHead

type ByProjectKeyPaymentsByIDRequestMethodPost ¶ 

type ByProjectKeyPaymentsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyPaymentsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodPost) Execute(ctx context.Context) (result *Payment, err error)

func (*ByProjectKeyPaymentsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyPaymentsByIDRequestMethodPost

func (*ByProjectKeyPaymentsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyPaymentsByIDRequestMethodPost

func (*ByProjectKeyPaymentsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyPaymentsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyPaymentsByIDRequestMethodPostInput) *ByProjectKeyPaymentsByIDRequestMethodPost

type ByProjectKeyPaymentsByIDRequestMethodPostInput ¶ 

type ByProjectKeyPaymentsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyPaymentsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyPaymentsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyPaymentsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyPaymentsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestBuilder) Delete() *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete

func (*ByProjectKeyPaymentsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestBuilder) Get() *ByProjectKeyPaymentsKeyByKeyRequestMethodGet

func (*ByProjectKeyPaymentsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestBuilder) Head() *ByProjectKeyPaymentsKeyByKeyRequestMethodHead

* * Checks if a Payment exists for a given `key`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise.

func (*ByProjectKeyPaymentsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestBuilder) Post(body PaymentUpdate) *ByProjectKeyPaymentsKeyByKeyRequestMethodPost

type ByProjectKeyPaymentsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyPaymentsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Payment, err error)

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyPaymentsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyPaymentsKeyByKeyRequestMethodDelete

type ByProjectKeyPaymentsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyPaymentsKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyPaymentsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyPaymentsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyPaymentsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyPaymentsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Payment, err error)

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyPaymentsKeyByKeyRequestMethodGet

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyPaymentsKeyByKeyRequestMethodGet

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyPaymentsKeyByKeyRequestMethodGetInput) *ByProjectKeyPaymentsKeyByKeyRequestMethodGet

type ByProjectKeyPaymentsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyPaymentsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyPaymentsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyPaymentsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyPaymentsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyPaymentsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Payment exists for a given `key`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise.

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyPaymentsKeyByKeyRequestMethodHead

type ByProjectKeyPaymentsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyPaymentsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyPaymentsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Payment, err error)

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyPaymentsKeyByKeyRequestMethodPost

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyPaymentsKeyByKeyRequestMethodPost

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyPaymentsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyPaymentsKeyByKeyRequestMethodPostInput) *ByProjectKeyPaymentsKeyByKeyRequestMethodPost

type ByProjectKeyPaymentsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyPaymentsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyPaymentsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyPaymentsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyPaymentsRequestBuilder ¶ 

type ByProjectKeyPaymentsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyPaymentsRequestBuilder) Get() *ByProjectKeyPaymentsRequestMethodGet

func (*ByProjectKeyPaymentsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsRequestBuilder) Head() *ByProjectKeyPaymentsRequestMethodHead

* * Checks if a Payment exists for a given Query Predicate. Returns a `200 OK` status if any Payments match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyPaymentsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyPaymentsRequestBuilder) Post(body PaymentDraft) *ByProjectKeyPaymentsRequestMethodPost

* * Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) Message. *

func (*ByProjectKeyPaymentsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyPaymentsRequestBuilder) WithId(id string) *ByProjectKeyPaymentsByIDRequestBuilder

func (*ByProjectKeyPaymentsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyPaymentsRequestBuilder) WithKey(key string) *ByProjectKeyPaymentsKeyByKeyRequestBuilder

type ByProjectKeyPaymentsRequestMethodGet ¶ 

type ByProjectKeyPaymentsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyPaymentsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) Execute(ctx context.Context) (result *PaymentPagedQueryResponse, err error)

func (*ByProjectKeyPaymentsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) Expand(v []string) *ByProjectKeyPaymentsRequestMethodGet

func (*ByProjectKeyPaymentsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) Limit(v int) *ByProjectKeyPaymentsRequestMethodGet

func (*ByProjectKeyPaymentsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) Offset(v int) *ByProjectKeyPaymentsRequestMethodGet

func (*ByProjectKeyPaymentsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyPaymentsRequestMethodGet

func (*ByProjectKeyPaymentsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) Sort(v []string) *ByProjectKeyPaymentsRequestMethodGet

func (*ByProjectKeyPaymentsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) Where(v []string) *ByProjectKeyPaymentsRequestMethodGet

func (*ByProjectKeyPaymentsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyPaymentsRequestMethodGet

func (*ByProjectKeyPaymentsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) WithQueryParams(input ByProjectKeyPaymentsRequestMethodGetInput) *ByProjectKeyPaymentsRequestMethodGet

func (*ByProjectKeyPaymentsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodGet) WithTotal(v bool) *ByProjectKeyPaymentsRequestMethodGet

type ByProjectKeyPaymentsRequestMethodGetInput ¶ 

type ByProjectKeyPaymentsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyPaymentsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyPaymentsRequestMethodGetInput) Values() url.Values

type ByProjectKeyPaymentsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyPaymentsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyPaymentsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Payment exists for a given Query Predicate. Returns a `200 OK` status if any Payments match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyPaymentsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsRequestMethodHead) Where(v []string) *ByProjectKeyPaymentsRequestMethodHead

func (*ByProjectKeyPaymentsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyPaymentsRequestMethodHead

func (*ByProjectKeyPaymentsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyPaymentsRequestMethodHead) WithQueryParams(input ByProjectKeyPaymentsRequestMethodHeadInput) *ByProjectKeyPaymentsRequestMethodHead

type ByProjectKeyPaymentsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyPaymentsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyPaymentsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyPaymentsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyPaymentsRequestMethodPost ¶ 

type ByProjectKeyPaymentsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyPaymentsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyPaymentsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyPaymentsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodPost) Execute(ctx context.Context) (result *Payment, err error)

* * Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) Message. *

func (*ByProjectKeyPaymentsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodPost) Expand(v []string) *ByProjectKeyPaymentsRequestMethodPost

func (*ByProjectKeyPaymentsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyPaymentsRequestMethodPost

func (*ByProjectKeyPaymentsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyPaymentsRequestMethodPost) WithQueryParams(input ByProjectKeyPaymentsRequestMethodPostInput) *ByProjectKeyPaymentsRequestMethodPost

type ByProjectKeyPaymentsRequestMethodPostInput ¶ 

type ByProjectKeyPaymentsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyPaymentsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyPaymentsRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductDiscountsByIDRequestBuilder ¶ 

type ByProjectKeyProductDiscountsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestBuilder) Delete() *ByProjectKeyProductDiscountsByIDRequestMethodDelete

func (*ByProjectKeyProductDiscountsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestBuilder) Get() *ByProjectKeyProductDiscountsByIDRequestMethodGet

func (*ByProjectKeyProductDiscountsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsByIDRequestBuilder) Head() *ByProjectKeyProductDiscountsByIDRequestMethodHead

* * Checks if a ProductDiscount exists for a given `id`. Returns a `200 OK` status if the ProductDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductDiscountsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestBuilder) Post(body ProductDiscountUpdate) *ByProjectKeyProductDiscountsByIDRequestMethodPost

type ByProjectKeyProductDiscountsByIDRequestMethodDelete ¶ 

type ByProjectKeyProductDiscountsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyProductDiscountsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodDelete) Execute(ctx context.Context) (result *ProductDiscount, err error)

func (*ByProjectKeyProductDiscountsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyProductDiscountsByIDRequestMethodDelete

func (*ByProjectKeyProductDiscountsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodDelete) Version(v int) *ByProjectKeyProductDiscountsByIDRequestMethodDelete

func (*ByProjectKeyProductDiscountsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsByIDRequestMethodDelete

func (*ByProjectKeyProductDiscountsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyProductDiscountsByIDRequestMethodDeleteInput) *ByProjectKeyProductDiscountsByIDRequestMethodDelete

type ByProjectKeyProductDiscountsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyProductDiscountsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyProductDiscountsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyProductDiscountsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductDiscountsByIDRequestMethodGet ¶ 

type ByProjectKeyProductDiscountsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductDiscountsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodGet) Execute(ctx context.Context) (result *ProductDiscount, err error)

func (*ByProjectKeyProductDiscountsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyProductDiscountsByIDRequestMethodGet

func (*ByProjectKeyProductDiscountsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsByIDRequestMethodGet

func (*ByProjectKeyProductDiscountsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyProductDiscountsByIDRequestMethodGetInput) *ByProjectKeyProductDiscountsByIDRequestMethodGet

type ByProjectKeyProductDiscountsByIDRequestMethodGetInput ¶ 

type ByProjectKeyProductDiscountsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyProductDiscountsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductDiscountsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductDiscountsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyProductDiscountsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyProductDiscountsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ProductDiscount exists for a given `id`. Returns a `200 OK` status if the ProductDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductDiscountsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsByIDRequestMethodHead

type ByProjectKeyProductDiscountsByIDRequestMethodPost ¶ 

type ByProjectKeyProductDiscountsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductDiscountsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodPost) Execute(ctx context.Context) (result *ProductDiscount, err error)

func (*ByProjectKeyProductDiscountsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyProductDiscountsByIDRequestMethodPost

func (*ByProjectKeyProductDiscountsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsByIDRequestMethodPost

func (*ByProjectKeyProductDiscountsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductDiscountsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyProductDiscountsByIDRequestMethodPostInput) *ByProjectKeyProductDiscountsByIDRequestMethodPost

type ByProjectKeyProductDiscountsByIDRequestMethodPostInput ¶ 

type ByProjectKeyProductDiscountsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductDiscountsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductDiscountsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductDiscountsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyProductDiscountsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestBuilder) Delete() *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductDiscountsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestBuilder) Get() *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductDiscountsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestBuilder) Head() *ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead

* * Checks if a ProductDiscount exists for a given `key`. Returns a `200 OK` status if the ProductDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductDiscountsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestBuilder) Post(body ProductDiscountUpdate) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *ProductDiscount, err error)

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyProductDiscountsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDelete

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyProductDiscountsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ProductDiscount, err error)

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyProductDiscountsKeyByKeyRequestMethodGetInput) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGet

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductDiscountsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ProductDiscount exists for a given `key`. Returns a `200 OK` status if the ProductDiscount exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodHead

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ProductDiscount, err error)

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyProductDiscountsKeyByKeyRequestMethodPostInput) *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPost

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyProductDiscountsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductDiscountsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductDiscountsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductDiscountsMatchingRequestBuilder ¶ 

type ByProjectKeyProductDiscountsMatchingRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsMatchingRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductDiscountsMatchingRequestBuilder) Post(body ProductDiscountMatchQuery) *ByProjectKeyProductDiscountsMatchingRequestMethodPost

* * This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price. * Given Product and Product Variant IDs and a Price, this endpoint will return the ProductDiscount(ctp:api:type:ProductDiscount) that would have been applied to that Price. * * If a Product Discount could not be found that could be applied to the Price of a Product Variant, a [NoMatchingProductDiscountFound](ctp:api:type:NoMatchingProductDiscountFoundError) error is returned. *

type ByProjectKeyProductDiscountsMatchingRequestMethodPost ¶ 

type ByProjectKeyProductDiscountsMatchingRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsMatchingRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductDiscountsMatchingRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsMatchingRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductDiscountsMatchingRequestMethodPost) Execute(ctx context.Context) (result *ProductDiscount, err error)

* * This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price. * Given Product and Product Variant IDs and a Price, this endpoint will return the ProductDiscount(ctp:api:type:ProductDiscount) that would have been applied to that Price. * * If a Product Discount could not be found that could be applied to the Price of a Product Variant, a [NoMatchingProductDiscountFound](ctp:api:type:NoMatchingProductDiscountFoundError) error is returned. *

func (*ByProjectKeyProductDiscountsMatchingRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductDiscountsMatchingRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsMatchingRequestMethodPost

type ByProjectKeyProductDiscountsRequestBuilder ¶ 

type ByProjectKeyProductDiscountsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductDiscountsRequestBuilder) Get() *ByProjectKeyProductDiscountsRequestMethodGet

func (*ByProjectKeyProductDiscountsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsRequestBuilder) Head() *ByProjectKeyProductDiscountsRequestMethodHead

* * Checks if a ProductDiscount exists for a given Query Predicate. Returns a `200 OK` status if any ProductDiscounts match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyProductDiscountsRequestBuilder) Matching ¶ 

func (rb *ByProjectKeyProductDiscountsRequestBuilder) Matching() *ByProjectKeyProductDiscountsMatchingRequestBuilder

func (*ByProjectKeyProductDiscountsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductDiscountsRequestBuilder) Post(body ProductDiscountDraft) *ByProjectKeyProductDiscountsRequestMethodPost

func (*ByProjectKeyProductDiscountsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyProductDiscountsRequestBuilder) WithId(id string) *ByProjectKeyProductDiscountsByIDRequestBuilder

func (*ByProjectKeyProductDiscountsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyProductDiscountsRequestBuilder) WithKey(key string) *ByProjectKeyProductDiscountsKeyByKeyRequestBuilder

type ByProjectKeyProductDiscountsRequestMethodGet ¶ 

type ByProjectKeyProductDiscountsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductDiscountsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) Execute(ctx context.Context) (result *ProductDiscountPagedQueryResponse, err error)

func (*ByProjectKeyProductDiscountsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) Expand(v []string) *ByProjectKeyProductDiscountsRequestMethodGet

func (*ByProjectKeyProductDiscountsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) Limit(v int) *ByProjectKeyProductDiscountsRequestMethodGet

func (*ByProjectKeyProductDiscountsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) Offset(v int) *ByProjectKeyProductDiscountsRequestMethodGet

func (*ByProjectKeyProductDiscountsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyProductDiscountsRequestMethodGet

func (*ByProjectKeyProductDiscountsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) Sort(v []string) *ByProjectKeyProductDiscountsRequestMethodGet

func (*ByProjectKeyProductDiscountsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) Where(v []string) *ByProjectKeyProductDiscountsRequestMethodGet

func (*ByProjectKeyProductDiscountsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsRequestMethodGet

func (*ByProjectKeyProductDiscountsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) WithQueryParams(input ByProjectKeyProductDiscountsRequestMethodGetInput) *ByProjectKeyProductDiscountsRequestMethodGet

func (*ByProjectKeyProductDiscountsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductDiscountsRequestMethodGet

type ByProjectKeyProductDiscountsRequestMethodGetInput ¶ 

type ByProjectKeyProductDiscountsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyProductDiscountsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductDiscountsRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductDiscountsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyProductDiscountsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyProductDiscountsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ProductDiscount exists for a given Query Predicate. Returns a `200 OK` status if any ProductDiscounts match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyProductDiscountsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsRequestMethodHead) Where(v []string) *ByProjectKeyProductDiscountsRequestMethodHead

func (*ByProjectKeyProductDiscountsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsRequestMethodHead

func (*ByProjectKeyProductDiscountsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyProductDiscountsRequestMethodHead) WithQueryParams(input ByProjectKeyProductDiscountsRequestMethodHeadInput) *ByProjectKeyProductDiscountsRequestMethodHead

type ByProjectKeyProductDiscountsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyProductDiscountsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyProductDiscountsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyProductDiscountsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyProductDiscountsRequestMethodPost ¶ 

type ByProjectKeyProductDiscountsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductDiscountsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductDiscountsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductDiscountsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodPost) Execute(ctx context.Context) (result *ProductDiscount, err error)

func (*ByProjectKeyProductDiscountsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodPost) Expand(v []string) *ByProjectKeyProductDiscountsRequestMethodPost

func (*ByProjectKeyProductDiscountsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductDiscountsRequestMethodPost

func (*ByProjectKeyProductDiscountsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductDiscountsRequestMethodPost) WithQueryParams(input ByProjectKeyProductDiscountsRequestMethodPostInput) *ByProjectKeyProductDiscountsRequestMethodPost

type ByProjectKeyProductDiscountsRequestMethodPostInput ¶ 

type ByProjectKeyProductDiscountsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductDiscountsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductDiscountsRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductProjectionsByIDRequestBuilder ¶ 

type ByProjectKeyProductProjectionsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestBuilder) Get() *ByProjectKeyProductProjectionsByIDRequestMethodGet

* * Gets the current or staged representation of a Product(ctp:api:type:Product) by its ID. When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyProductProjectionsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsByIDRequestBuilder) Head() *ByProjectKeyProductProjectionsByIDRequestMethodHead

* * Checks if the current or staged representation of a Product exists for a given `id`. Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise.

type ByProjectKeyProductProjectionsByIDRequestMethodGet ¶ 

type ByProjectKeyProductProjectionsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductProjectionsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) Execute(ctx context.Context) (result *ProductProjection, err error)

* * Gets the current or staged representation of a Product(ctp:api:type:Product) by its ID. When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) LocaleProjection ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) LocaleProjection(v []string) *ByProjectKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) PriceChannel ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) PriceChannel(v string) *ByProjectKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) PriceCountry ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) PriceCountry(v string) *ByProjectKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) PriceCurrency ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) PriceCurrency(v string) *ByProjectKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) PriceCustomerGroup(v string) *ByProjectKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) Staged ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) Staged(v bool) *ByProjectKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) StoreProjection ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) StoreProjection(v string) *ByProjectKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductProjectionsByIDRequestMethodGet

func (*ByProjectKeyProductProjectionsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyProductProjectionsByIDRequestMethodGetInput) *ByProjectKeyProductProjectionsByIDRequestMethodGet

type ByProjectKeyProductProjectionsByIDRequestMethodGetInput ¶ 

type ByProjectKeyProductProjectionsByIDRequestMethodGetInput struct {
	Staged             *bool
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	StoreProjection    *string
	Expand             []string
}

func (*ByProjectKeyProductProjectionsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductProjectionsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductProjectionsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyProductProjectionsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyProductProjectionsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductProjectionsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if the current or staged representation of a Product exists for a given `id`. Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductProjectionsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductProjectionsByIDRequestMethodHead

type ByProjectKeyProductProjectionsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyProductProjectionsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestBuilder) Get() *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

* * Gets the current or staged representation of a Product(ctp:api:type:Product) found by Key. * When used with an API Client that has the `view_published_products:{projectKey}` scope, * this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyProductProjectionsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestBuilder) Head() *ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead

* * Checks if the current or staged representation of a Product exists for a given `key`. Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise.

type ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ProductProjection, err error)

* * Gets the current or staged representation of a Product(ctp:api:type:Product) found by Key. * When used with an API Client that has the `view_published_products:{projectKey}` scope, * this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) LocaleProjection ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) LocaleProjection(v []string) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) PriceChannel ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) PriceChannel(v string) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCountry ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCountry(v string) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCurrency ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCurrency(v string) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) PriceCustomerGroup(v string) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) Staged ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) Staged(v bool) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) StoreProjection ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) StoreProjection(v string) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyProductProjectionsKeyByKeyRequestMethodGetInput) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGet

type ByProjectKeyProductProjectionsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyProductProjectionsKeyByKeyRequestMethodGetInput struct {
	Staged             *bool
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	StoreProjection    *string
	Expand             []string
}

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductProjectionsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if the current or staged representation of a Product exists for a given `key`. Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductProjectionsKeyByKeyRequestMethodHead

type ByProjectKeyProductProjectionsRequestBuilder ¶ 

type ByProjectKeyProductProjectionsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductProjectionsRequestBuilder) Get() *ByProjectKeyProductProjectionsRequestMethodGet

* * Use the Product Projections query endpoint to get the current or staged representations of Products. * When used with an API Client that has the `view_published_products:{projectKey}` scope, * this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyProductProjectionsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsRequestBuilder) Head() *ByProjectKeyProductProjectionsRequestMethodHead

* * Checks if the current or staged representation of a Product exists for a given Query Predicate. Returns a `200 OK` status if any ProductProjections match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyProductProjectionsRequestBuilder) Search ¶ 

func (rb *ByProjectKeyProductProjectionsRequestBuilder) Search() *ByProjectKeyProductProjectionsSearchRequestBuilder

* * This endpoint provides high performance search queries over ProductProjections. The query result contains the * ProductProjections for which at least one ProductVariant matches the search query. This means that variants can * be included in the result also for which the search query does not match. To determine which ProductVariants match * the search query, the returned ProductProjections include the additional field isMatchingVariant. *

func (*ByProjectKeyProductProjectionsRequestBuilder) Suggest ¶ 

func (rb *ByProjectKeyProductProjectionsRequestBuilder) Suggest() *ByProjectKeyProductProjectionsSuggestRequestBuilder

* * The source of data for suggestions is the searchKeyword field in a product

func (*ByProjectKeyProductProjectionsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyProductProjectionsRequestBuilder) WithId(id string) *ByProjectKeyProductProjectionsByIDRequestBuilder

func (*ByProjectKeyProductProjectionsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyProductProjectionsRequestBuilder) WithKey(key string) *ByProjectKeyProductProjectionsKeyByKeyRequestBuilder

type ByProjectKeyProductProjectionsRequestMethodGet ¶ 

type ByProjectKeyProductProjectionsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductProjectionsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductProjectionsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) Execute(ctx context.Context) (result *ProductProjectionPagedQueryResponse, err error)

* * Use the Product Projections query endpoint to get the current or staged representations of Products. * When used with an API Client that has the `view_published_products:{projectKey}` scope, * this endpoint only returns published (current) Product Projections. *

func (*ByProjectKeyProductProjectionsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) Expand(v []string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) Limit(v int) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) LocaleProjection ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) LocaleProjection(v []string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) Offset(v int) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) PriceChannel ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) PriceChannel(v string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) PriceCountry ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) PriceCountry(v string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) PriceCurrency ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) PriceCurrency(v string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) PriceCustomerGroup(v string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) Sort(v []string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) Staged ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) Staged(v bool) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) StoreProjection ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) StoreProjection(v string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) Where(v []string) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) WithQueryParams(input ByProjectKeyProductProjectionsRequestMethodGetInput) *ByProjectKeyProductProjectionsRequestMethodGet

func (*ByProjectKeyProductProjectionsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductProjectionsRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductProjectionsRequestMethodGet

type ByProjectKeyProductProjectionsRequestMethodGetInput ¶ 

type ByProjectKeyProductProjectionsRequestMethodGetInput struct {
	Staged             *bool
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	StoreProjection    *string
	Expand             []string
	Sort               []string
	Limit              *int
	Offset             *int
	WithTotal          *bool
	Where              []string
	PredicateVar       map[string][]string
}

func (*ByProjectKeyProductProjectionsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductProjectionsRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductProjectionsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyProductProjectionsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyProductProjectionsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductProjectionsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if the current or staged representation of a Product exists for a given Query Predicate. Returns a `200 OK` status if any ProductProjections match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyProductProjectionsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsRequestMethodHead) Where(v []string) *ByProjectKeyProductProjectionsRequestMethodHead

func (*ByProjectKeyProductProjectionsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductProjectionsRequestMethodHead

func (*ByProjectKeyProductProjectionsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyProductProjectionsRequestMethodHead) WithQueryParams(input ByProjectKeyProductProjectionsRequestMethodHeadInput) *ByProjectKeyProductProjectionsRequestMethodHead

type ByProjectKeyProductProjectionsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyProductProjectionsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyProductProjectionsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyProductProjectionsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyProductProjectionsSearchRequestBuilder ¶ 

type ByProjectKeyProductProjectionsSearchRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsSearchRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestBuilder) Get() *ByProjectKeyProductProjectionsSearchRequestMethodGet

* * Product Projection Search

func (*ByProjectKeyProductProjectionsSearchRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestBuilder) Post(body string) *ByProjectKeyProductProjectionsSearchRequestMethodPost

* * Product Projection Search

type ByProjectKeyProductProjectionsSearchRequestMethodGet ¶ 

type ByProjectKeyProductProjectionsSearchRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductProjectionsSearchRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Execute(ctx context.Context) (result *ProductProjectionPagedSearchResponse, err error)

* * Product Projection Search

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Expand(v []string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Facet ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Facet(v []string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Filter ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Filter(v []string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) FilterFacets ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) FilterFacets(v []string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) FilterQuery ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) FilterQuery(v []string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Fuzzy ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Fuzzy(v bool) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) FuzzyLevel ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) FuzzyLevel(v int) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Limit(v int) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) LocaleProjection ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) LocaleProjection(v []string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) MarkMatchingVariants ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) MarkMatchingVariants(v bool) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Offset(v int) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) PriceChannel ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) PriceChannel(v string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) PriceCountry ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) PriceCountry(v string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) PriceCurrency ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) PriceCurrency(v string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) PriceCustomerGroup(v string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Sort(v []string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Staged ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Staged(v bool) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) StoreProjection ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) StoreProjection(v string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) Text ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) Text(v map[string][]string) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) WithQueryParams(input ByProjectKeyProductProjectionsSearchRequestMethodGetInput) *ByProjectKeyProductProjectionsSearchRequestMethodGet

func (*ByProjectKeyProductProjectionsSearchRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductProjectionsSearchRequestMethodGet

type ByProjectKeyProductProjectionsSearchRequestMethodGetInput ¶ 

type ByProjectKeyProductProjectionsSearchRequestMethodGetInput struct {
	Fuzzy                *bool
	FuzzyLevel           *int
	MarkMatchingVariants *bool
	Filter               []string
	FilterFacets         []string
	FilterQuery          []string
	Facet                []string
	Text                 map[string][]string
	Sort                 []string
	Limit                *int
	Offset               *int
	WithTotal            *bool
	Staged               *bool
	PriceCurrency        *string
	PriceCountry         *string
	PriceCustomerGroup   *string
	PriceChannel         *string
	LocaleProjection     []string
	StoreProjection      *string
	Expand               []string
}

func (*ByProjectKeyProductProjectionsSearchRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductProjectionsSearchRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductProjectionsSearchRequestMethodPost ¶ 

type ByProjectKeyProductProjectionsSearchRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsSearchRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductProjectionsSearchRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductProjectionsSearchRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodPost) Execute(ctx context.Context) (result *ProductProjectionPagedSearchResponse, err error)

* * Product Projection Search

func (*ByProjectKeyProductProjectionsSearchRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductProjectionsSearchRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductProjectionsSearchRequestMethodPost

type ByProjectKeyProductProjectionsSuggestRequestBuilder ¶ 

type ByProjectKeyProductProjectionsSuggestRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsSuggestRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestBuilder) Get() *ByProjectKeyProductProjectionsSuggestRequestMethodGet

type ByProjectKeyProductProjectionsSuggestRequestMethodGet ¶ 

type ByProjectKeyProductProjectionsSuggestRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductProjectionsSuggestRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) Execute(ctx context.Context) (result *SuggestionResult, err error)

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) Fuzzy ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) Fuzzy(v bool) *ByProjectKeyProductProjectionsSuggestRequestMethodGet

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) Limit(v int) *ByProjectKeyProductProjectionsSuggestRequestMethodGet

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) Offset(v int) *ByProjectKeyProductProjectionsSuggestRequestMethodGet

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) SearchKeywords ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) SearchKeywords(v map[string][]string) *ByProjectKeyProductProjectionsSuggestRequestMethodGet

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) Sort(v []string) *ByProjectKeyProductProjectionsSuggestRequestMethodGet

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) Staged ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) Staged(v bool) *ByProjectKeyProductProjectionsSuggestRequestMethodGet

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductProjectionsSuggestRequestMethodGet

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) WithQueryParams(input ByProjectKeyProductProjectionsSuggestRequestMethodGetInput) *ByProjectKeyProductProjectionsSuggestRequestMethodGet

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductProjectionsSuggestRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductProjectionsSuggestRequestMethodGet

type ByProjectKeyProductProjectionsSuggestRequestMethodGetInput ¶ 

type ByProjectKeyProductProjectionsSuggestRequestMethodGetInput struct {
	Fuzzy          *bool
	SearchKeywords map[string][]string
	Sort           []string
	Limit          *int
	Offset         *int
	WithTotal      *bool
	Staged         *bool
}

func (*ByProjectKeyProductProjectionsSuggestRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductProjectionsSuggestRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductSelectionsByIDProductsRequestBuilder ¶ 

type ByProjectKeyProductSelectionsByIDProductsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsByIDProductsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductSelectionsByIDProductsRequestBuilder) Get() *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet

type ByProjectKeyProductSelectionsByIDProductsRequestMethodGet ¶ 

type ByProjectKeyProductSelectionsByIDProductsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Execute(ctx context.Context) (result *ProductSelectionProductPagedQueryResponse, err error)

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Expand(v []string) *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Limit(v int) *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Offset(v int) *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Sort ¶ added in v1.3.0 

func (rb *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) Sort(v []string) *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) WithQueryParams(input ByProjectKeyProductSelectionsByIDProductsRequestMethodGetInput) *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductSelectionsByIDProductsRequestMethodGet

type ByProjectKeyProductSelectionsByIDProductsRequestMethodGetInput ¶ 

type ByProjectKeyProductSelectionsByIDProductsRequestMethodGetInput struct {
	Expand    []string
	Limit     *int
	Offset    *int
	WithTotal *bool
	Sort      []string
}

func (*ByProjectKeyProductSelectionsByIDProductsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsByIDProductsRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductSelectionsByIDRequestBuilder ¶ 

type ByProjectKeyProductSelectionsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestBuilder) Delete() *ByProjectKeyProductSelectionsByIDRequestMethodDelete

* * Deletion will only succeed if the Product Selection is not assigned to any Store(ctp:api:type:Store).

func (*ByProjectKeyProductSelectionsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestBuilder) Get() *ByProjectKeyProductSelectionsByIDRequestMethodGet

func (*ByProjectKeyProductSelectionsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsByIDRequestBuilder) Head() *ByProjectKeyProductSelectionsByIDRequestMethodHead

* * Checks if a ProductSelection exists for a given `id`. Returns a `200 OK` status if the ProductSelection exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductSelectionsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestBuilder) Post(body ProductSelectionUpdate) *ByProjectKeyProductSelectionsByIDRequestMethodPost

func (*ByProjectKeyProductSelectionsByIDRequestBuilder) Products ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestBuilder) Products() *ByProjectKeyProductSelectionsByIDProductsRequestBuilder

type ByProjectKeyProductSelectionsByIDRequestMethodDelete ¶ 

type ByProjectKeyProductSelectionsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyProductSelectionsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodDelete) Execute(ctx context.Context) (result *ProductSelection, err error)

* * Deletion will only succeed if the Product Selection is not assigned to any Store(ctp:api:type:Store).

func (*ByProjectKeyProductSelectionsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyProductSelectionsByIDRequestMethodDelete

func (*ByProjectKeyProductSelectionsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodDelete) Version(v int) *ByProjectKeyProductSelectionsByIDRequestMethodDelete

func (*ByProjectKeyProductSelectionsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsByIDRequestMethodDelete

func (*ByProjectKeyProductSelectionsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyProductSelectionsByIDRequestMethodDeleteInput) *ByProjectKeyProductSelectionsByIDRequestMethodDelete

type ByProjectKeyProductSelectionsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyProductSelectionsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyProductSelectionsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductSelectionsByIDRequestMethodGet ¶ 

type ByProjectKeyProductSelectionsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductSelectionsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodGet) Execute(ctx context.Context) (result *ProductSelection, err error)

func (*ByProjectKeyProductSelectionsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyProductSelectionsByIDRequestMethodGet

func (*ByProjectKeyProductSelectionsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsByIDRequestMethodGet

func (*ByProjectKeyProductSelectionsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyProductSelectionsByIDRequestMethodGetInput) *ByProjectKeyProductSelectionsByIDRequestMethodGet

type ByProjectKeyProductSelectionsByIDRequestMethodGetInput ¶ 

type ByProjectKeyProductSelectionsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyProductSelectionsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductSelectionsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyProductSelectionsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyProductSelectionsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ProductSelection exists for a given `id`. Returns a `200 OK` status if the ProductSelection exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductSelectionsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsByIDRequestMethodHead

type ByProjectKeyProductSelectionsByIDRequestMethodPost ¶ 

type ByProjectKeyProductSelectionsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductSelectionsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodPost) Execute(ctx context.Context) (result *ProductSelection, err error)

func (*ByProjectKeyProductSelectionsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyProductSelectionsByIDRequestMethodPost

func (*ByProjectKeyProductSelectionsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsByIDRequestMethodPost

func (*ByProjectKeyProductSelectionsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyProductSelectionsByIDRequestMethodPostInput) *ByProjectKeyProductSelectionsByIDRequestMethodPost

type ByProjectKeyProductSelectionsByIDRequestMethodPostInput ¶ 

type ByProjectKeyProductSelectionsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductSelectionsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductSelectionsKeyByKeyProductsRequestBuilder ¶ 

type ByProjectKeyProductSelectionsKeyByKeyProductsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyProductsRequestBuilder) Get() *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet

type ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet ¶ 

type ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Execute(ctx context.Context) (result *ProductSelectionProductPagedQueryResponse, err error)

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Expand(v []string) *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Limit(v int) *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Offset(v int) *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Sort ¶ added in v1.3.0 

func (rb *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) Sort(v []string) *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) WithQueryParams(input ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGetInput) *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGet

type ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGetInput ¶ 

type ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGetInput struct {
	Expand    []string
	Limit     *int
	Offset    *int
	WithTotal *bool
	Sort      []string
}

func (*ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsKeyByKeyProductsRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductSelectionsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyProductSelectionsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Delete() *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete

* * Deletion will only succeed if the Product Selection is not assigned to any Store(ctp:api:type:Store).

func (*ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Get() *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Head() *ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead

* * Checks if a ProductSelection exists for a given `key`. Returns a `200 OK` status if the ProductSelection exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Post(body ProductSelectionUpdate) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Products ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestBuilder) Products() *ByProjectKeyProductSelectionsKeyByKeyProductsRequestBuilder

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *ProductSelection, err error)

* * Deletion will only succeed if the Product Selection is not assigned to any Store(ctp:api:type:Store).

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyProductSelectionsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDelete

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ProductSelection, err error)

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyProductSelectionsKeyByKeyRequestMethodGetInput) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGet

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ProductSelection exists for a given `key`. Returns a `200 OK` status if the ProductSelection exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodHead

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ProductSelection, err error)

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyProductSelectionsKeyByKeyRequestMethodPostInput) *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPost

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyProductSelectionsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductSelectionsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductSelectionsRequestBuilder ¶ 

type ByProjectKeyProductSelectionsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductSelectionsRequestBuilder) Get() *ByProjectKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductSelectionsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsRequestBuilder) Head() *ByProjectKeyProductSelectionsRequestMethodHead

* * Checks if a ProductSelection exists for a given Query Predicate. Returns a `200 OK` status if any ProductSelections match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyProductSelectionsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductSelectionsRequestBuilder) Post(body ProductSelectionDraft) *ByProjectKeyProductSelectionsRequestMethodPost

func (*ByProjectKeyProductSelectionsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyProductSelectionsRequestBuilder) WithId(id string) *ByProjectKeyProductSelectionsByIDRequestBuilder

func (*ByProjectKeyProductSelectionsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyProductSelectionsRequestBuilder) WithKey(key string) *ByProjectKeyProductSelectionsKeyByKeyRequestBuilder

type ByProjectKeyProductSelectionsRequestMethodGet ¶ 

type ByProjectKeyProductSelectionsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductSelectionsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) Execute(ctx context.Context) (result *ProductSelectionPagedQueryResponse, err error)

func (*ByProjectKeyProductSelectionsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) Expand(v []string) *ByProjectKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductSelectionsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) Limit(v int) *ByProjectKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductSelectionsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) Offset(v int) *ByProjectKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductSelectionsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductSelectionsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) Sort(v []string) *ByProjectKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductSelectionsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) Where(v []string) *ByProjectKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductSelectionsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductSelectionsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) WithQueryParams(input ByProjectKeyProductSelectionsRequestMethodGetInput) *ByProjectKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductSelectionsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductSelectionsRequestMethodGet

type ByProjectKeyProductSelectionsRequestMethodGetInput ¶ 

type ByProjectKeyProductSelectionsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyProductSelectionsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductSelectionsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyProductSelectionsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyProductSelectionsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ProductSelection exists for a given Query Predicate. Returns a `200 OK` status if any ProductSelections match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyProductSelectionsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsRequestMethodHead) Where(v []string) *ByProjectKeyProductSelectionsRequestMethodHead

func (*ByProjectKeyProductSelectionsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsRequestMethodHead

func (*ByProjectKeyProductSelectionsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyProductSelectionsRequestMethodHead) WithQueryParams(input ByProjectKeyProductSelectionsRequestMethodHeadInput) *ByProjectKeyProductSelectionsRequestMethodHead

type ByProjectKeyProductSelectionsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyProductSelectionsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyProductSelectionsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyProductSelectionsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyProductSelectionsRequestMethodPost ¶ 

type ByProjectKeyProductSelectionsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductSelectionsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductSelectionsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductSelectionsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodPost) Execute(ctx context.Context) (result *ProductSelection, err error)

func (*ByProjectKeyProductSelectionsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodPost) Expand(v []string) *ByProjectKeyProductSelectionsRequestMethodPost

func (*ByProjectKeyProductSelectionsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductSelectionsRequestMethodPost

func (*ByProjectKeyProductSelectionsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductSelectionsRequestMethodPost) WithQueryParams(input ByProjectKeyProductSelectionsRequestMethodPostInput) *ByProjectKeyProductSelectionsRequestMethodPost

type ByProjectKeyProductSelectionsRequestMethodPostInput ¶ 

type ByProjectKeyProductSelectionsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductSelectionsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductSelectionsRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductTailoringByIDRequestBuilder ¶ added in v1.5.1 

type ByProjectKeyProductTailoringByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringByIDRequestBuilder) Delete ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestBuilder) Delete() *ByProjectKeyProductTailoringByIDRequestMethodDelete

* * Generates the [ProductTailoringDeleted](ctp:api:type:ProductTailoringDeletedMessage) Message. *

func (*ByProjectKeyProductTailoringByIDRequestBuilder) Get ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestBuilder) Get() *ByProjectKeyProductTailoringByIDRequestMethodGet

func (*ByProjectKeyProductTailoringByIDRequestBuilder) Post ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestBuilder) Post(body ProductTailoringUpdate) *ByProjectKeyProductTailoringByIDRequestMethodPost

type ByProjectKeyProductTailoringByIDRequestMethodDelete ¶ added in v1.5.1 

type ByProjectKeyProductTailoringByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringByIDRequestMethodDelete) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyProductTailoringByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductTailoringByIDRequestMethodDelete) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodDelete) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Generates the [ProductTailoringDeleted](ctp:api:type:ProductTailoringDeletedMessage) Message. *

func (*ByProjectKeyProductTailoringByIDRequestMethodDelete) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyProductTailoringByIDRequestMethodDelete

func (*ByProjectKeyProductTailoringByIDRequestMethodDelete) Version ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodDelete) Version(v int) *ByProjectKeyProductTailoringByIDRequestMethodDelete

func (*ByProjectKeyProductTailoringByIDRequestMethodDelete) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductTailoringByIDRequestMethodDelete

func (*ByProjectKeyProductTailoringByIDRequestMethodDelete) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyProductTailoringByIDRequestMethodDeleteInput) *ByProjectKeyProductTailoringByIDRequestMethodDelete

type ByProjectKeyProductTailoringByIDRequestMethodDeleteInput ¶ added in v1.5.1 

type ByProjectKeyProductTailoringByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyProductTailoringByIDRequestMethodDeleteInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyProductTailoringByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductTailoringByIDRequestMethodGet ¶ added in v1.5.1 

type ByProjectKeyProductTailoringByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringByIDRequestMethodGet) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyProductTailoringByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductTailoringByIDRequestMethodGet) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodGet) Execute(ctx context.Context) (result *ProductTailoring, err error)

func (*ByProjectKeyProductTailoringByIDRequestMethodGet) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodGet) Expand(v []string) *ByProjectKeyProductTailoringByIDRequestMethodGet

func (*ByProjectKeyProductTailoringByIDRequestMethodGet) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductTailoringByIDRequestMethodGet

func (*ByProjectKeyProductTailoringByIDRequestMethodGet) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodGet) WithQueryParams(input ByProjectKeyProductTailoringByIDRequestMethodGetInput) *ByProjectKeyProductTailoringByIDRequestMethodGet

type ByProjectKeyProductTailoringByIDRequestMethodGetInput ¶ added in v1.5.1 

type ByProjectKeyProductTailoringByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyProductTailoringByIDRequestMethodGetInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyProductTailoringByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductTailoringByIDRequestMethodPost ¶ added in v1.5.1 

type ByProjectKeyProductTailoringByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringByIDRequestMethodPost) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyProductTailoringByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductTailoringByIDRequestMethodPost) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodPost) Execute(ctx context.Context) (result *ProductTailoring, err error)

func (*ByProjectKeyProductTailoringByIDRequestMethodPost) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodPost) Expand(v []string) *ByProjectKeyProductTailoringByIDRequestMethodPost

func (*ByProjectKeyProductTailoringByIDRequestMethodPost) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductTailoringByIDRequestMethodPost

func (*ByProjectKeyProductTailoringByIDRequestMethodPost) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringByIDRequestMethodPost) WithQueryParams(input ByProjectKeyProductTailoringByIDRequestMethodPostInput) *ByProjectKeyProductTailoringByIDRequestMethodPost

type ByProjectKeyProductTailoringByIDRequestMethodPostInput ¶ added in v1.5.1 

type ByProjectKeyProductTailoringByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductTailoringByIDRequestMethodPostInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyProductTailoringByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductTailoringKeyByKeyRequestBuilder ¶ added in v1.5.1 

type ByProjectKeyProductTailoringKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringKeyByKeyRequestBuilder) Delete ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestBuilder) Delete() *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete

* * Generates the [ProductTailoringDeleted](ctp:api:type:ProductTailoringDeletedMessage) Message. *

func (*ByProjectKeyProductTailoringKeyByKeyRequestBuilder) Get ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestBuilder) Get() *ByProjectKeyProductTailoringKeyByKeyRequestMethodGet

func (*ByProjectKeyProductTailoringKeyByKeyRequestBuilder) Post ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestBuilder) Post(body ProductTailoringUpdate) *ByProjectKeyProductTailoringKeyByKeyRequestMethodPost

type ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete ¶ added in v1.5.1 

type ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Generates the [ProductTailoringDeleted](ctp:api:type:ProductTailoringDeletedMessage) Message. *

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) Version ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyProductTailoringKeyByKeyRequestMethodDeleteInput) *ByProjectKeyProductTailoringKeyByKeyRequestMethodDelete

type ByProjectKeyProductTailoringKeyByKeyRequestMethodDeleteInput ¶ added in v1.5.1 

type ByProjectKeyProductTailoringKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyProductTailoringKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductTailoringKeyByKeyRequestMethodGet ¶ added in v1.5.1 

type ByProjectKeyProductTailoringKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ProductTailoring, err error)

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyProductTailoringKeyByKeyRequestMethodGet

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductTailoringKeyByKeyRequestMethodGet

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyProductTailoringKeyByKeyRequestMethodGetInput) *ByProjectKeyProductTailoringKeyByKeyRequestMethodGet

type ByProjectKeyProductTailoringKeyByKeyRequestMethodGetInput ¶ added in v1.5.1 

type ByProjectKeyProductTailoringKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodGetInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyProductTailoringKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductTailoringKeyByKeyRequestMethodPost ¶ added in v1.5.1 

type ByProjectKeyProductTailoringKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ProductTailoring, err error)

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyProductTailoringKeyByKeyRequestMethodPost

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductTailoringKeyByKeyRequestMethodPost

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyProductTailoringKeyByKeyRequestMethodPostInput) *ByProjectKeyProductTailoringKeyByKeyRequestMethodPost

type ByProjectKeyProductTailoringKeyByKeyRequestMethodPostInput ¶ added in v1.5.1 

type ByProjectKeyProductTailoringKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductTailoringKeyByKeyRequestMethodPostInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyProductTailoringKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductTailoringRequestBuilder ¶ added in v1.5.1 

type ByProjectKeyProductTailoringRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringRequestBuilder) Get ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestBuilder) Get() *ByProjectKeyProductTailoringRequestMethodGet

func (*ByProjectKeyProductTailoringRequestBuilder) Post ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestBuilder) Post(body ProductTailoringDraft) *ByProjectKeyProductTailoringRequestMethodPost

* * Generates the [ProductTailoringCreated](ctp:api:type:ProductTailoringCreatedMessage) Message. *

func (*ByProjectKeyProductTailoringRequestBuilder) WithId ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestBuilder) WithId(id string) *ByProjectKeyProductTailoringByIDRequestBuilder

func (*ByProjectKeyProductTailoringRequestBuilder) WithKey ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestBuilder) WithKey(key string) *ByProjectKeyProductTailoringKeyByKeyRequestBuilder

type ByProjectKeyProductTailoringRequestMethodGet ¶ added in v1.5.1 

type ByProjectKeyProductTailoringRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringRequestMethodGet) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyProductTailoringRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductTailoringRequestMethodGet) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) Execute(ctx context.Context) (result *ProductTailoringPagedQueryResponse, err error)

func (*ByProjectKeyProductTailoringRequestMethodGet) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) Expand(v []string) *ByProjectKeyProductTailoringRequestMethodGet

func (*ByProjectKeyProductTailoringRequestMethodGet) Limit ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) Limit(v int) *ByProjectKeyProductTailoringRequestMethodGet

func (*ByProjectKeyProductTailoringRequestMethodGet) Offset ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) Offset(v int) *ByProjectKeyProductTailoringRequestMethodGet

func (*ByProjectKeyProductTailoringRequestMethodGet) PredicateVar ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyProductTailoringRequestMethodGet

func (*ByProjectKeyProductTailoringRequestMethodGet) Sort ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) Sort(v []string) *ByProjectKeyProductTailoringRequestMethodGet

func (*ByProjectKeyProductTailoringRequestMethodGet) Where ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) Where(v []string) *ByProjectKeyProductTailoringRequestMethodGet

func (*ByProjectKeyProductTailoringRequestMethodGet) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductTailoringRequestMethodGet

func (*ByProjectKeyProductTailoringRequestMethodGet) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) WithQueryParams(input ByProjectKeyProductTailoringRequestMethodGetInput) *ByProjectKeyProductTailoringRequestMethodGet

func (*ByProjectKeyProductTailoringRequestMethodGet) WithTotal ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductTailoringRequestMethodGet

type ByProjectKeyProductTailoringRequestMethodGetInput ¶ added in v1.5.1 

type ByProjectKeyProductTailoringRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyProductTailoringRequestMethodGetInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyProductTailoringRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductTailoringRequestMethodPost ¶ added in v1.5.1 

type ByProjectKeyProductTailoringRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTailoringRequestMethodPost) Dump ¶ added in v1.5.1 

func (r *ByProjectKeyProductTailoringRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductTailoringRequestMethodPost) Execute ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodPost) Execute(ctx context.Context) (result *ProductTailoring, err error)

* * Generates the [ProductTailoringCreated](ctp:api:type:ProductTailoringCreatedMessage) Message. *

func (*ByProjectKeyProductTailoringRequestMethodPost) Expand ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodPost) Expand(v []string) *ByProjectKeyProductTailoringRequestMethodPost

func (*ByProjectKeyProductTailoringRequestMethodPost) WithHeaders ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductTailoringRequestMethodPost

func (*ByProjectKeyProductTailoringRequestMethodPost) WithQueryParams ¶ added in v1.5.1 

func (rb *ByProjectKeyProductTailoringRequestMethodPost) WithQueryParams(input ByProjectKeyProductTailoringRequestMethodPostInput) *ByProjectKeyProductTailoringRequestMethodPost

type ByProjectKeyProductTailoringRequestMethodPostInput ¶ added in v1.5.1 

type ByProjectKeyProductTailoringRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductTailoringRequestMethodPostInput) Values ¶ added in v1.5.1 

func (input *ByProjectKeyProductTailoringRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductTypesByIDRequestBuilder ¶ 

type ByProjectKeyProductTypesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestBuilder) Delete() *ByProjectKeyProductTypesByIDRequestMethodDelete

func (*ByProjectKeyProductTypesByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestBuilder) Get() *ByProjectKeyProductTypesByIDRequestMethodGet

func (*ByProjectKeyProductTypesByIDRequestBuilder) Head ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesByIDRequestBuilder) Head() *ByProjectKeyProductTypesByIDRequestMethodHead

* * Checks if a ProductType exists for a given `id`. Returns a `200 OK` status if the ProductType exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductTypesByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestBuilder) Post(body ProductTypeUpdate) *ByProjectKeyProductTypesByIDRequestMethodPost

type ByProjectKeyProductTypesByIDRequestMethodDelete ¶ 

type ByProjectKeyProductTypesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyProductTypesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodDelete) Execute(ctx context.Context) (result *ProductType, err error)

func (*ByProjectKeyProductTypesByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyProductTypesByIDRequestMethodDelete

func (*ByProjectKeyProductTypesByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodDelete) Version(v int) *ByProjectKeyProductTypesByIDRequestMethodDelete

func (*ByProjectKeyProductTypesByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductTypesByIDRequestMethodDelete

func (*ByProjectKeyProductTypesByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyProductTypesByIDRequestMethodDeleteInput) *ByProjectKeyProductTypesByIDRequestMethodDelete

type ByProjectKeyProductTypesByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyProductTypesByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyProductTypesByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyProductTypesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductTypesByIDRequestMethodGet ¶ 

type ByProjectKeyProductTypesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductTypesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodGet) Execute(ctx context.Context) (result *ProductType, err error)

func (*ByProjectKeyProductTypesByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyProductTypesByIDRequestMethodGet

func (*ByProjectKeyProductTypesByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductTypesByIDRequestMethodGet

func (*ByProjectKeyProductTypesByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyProductTypesByIDRequestMethodGetInput) *ByProjectKeyProductTypesByIDRequestMethodGet

type ByProjectKeyProductTypesByIDRequestMethodGetInput ¶ 

type ByProjectKeyProductTypesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyProductTypesByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductTypesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductTypesByIDRequestMethodHead ¶ added in v1.2.0 

type ByProjectKeyProductTypesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesByIDRequestMethodHead) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyProductTypesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesByIDRequestMethodHead) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ProductType exists for a given `id`. Returns a `200 OK` status if the ProductType exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductTypesByIDRequestMethodHead) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductTypesByIDRequestMethodHead

type ByProjectKeyProductTypesByIDRequestMethodPost ¶ 

type ByProjectKeyProductTypesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductTypesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodPost) Execute(ctx context.Context) (result *ProductType, err error)

func (*ByProjectKeyProductTypesByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyProductTypesByIDRequestMethodPost

func (*ByProjectKeyProductTypesByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductTypesByIDRequestMethodPost

func (*ByProjectKeyProductTypesByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductTypesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyProductTypesByIDRequestMethodPostInput) *ByProjectKeyProductTypesByIDRequestMethodPost

type ByProjectKeyProductTypesByIDRequestMethodPostInput ¶ 

type ByProjectKeyProductTypesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductTypesByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductTypesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductTypesKeyByKeyRequestBuilder ¶ 

type ByProjectKeyProductTypesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestBuilder) Delete() *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductTypesKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestBuilder) Get() *ByProjectKeyProductTypesKeyByKeyRequestMethodGet

func (*ByProjectKeyProductTypesKeyByKeyRequestBuilder) Head ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestBuilder) Head() *ByProjectKeyProductTypesKeyByKeyRequestMethodHead

* * Checks if a ProductType exists for a given `key`. Returns a `200 OK` status if the ProductType exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductTypesKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestBuilder) Post(body ProductTypeUpdate) *ByProjectKeyProductTypesKeyByKeyRequestMethodPost

type ByProjectKeyProductTypesKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyProductTypesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *ProductType, err error)

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyProductTypesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyProductTypesKeyByKeyRequestMethodDelete

type ByProjectKeyProductTypesKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyProductTypesKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyProductTypesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductTypesKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyProductTypesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductTypesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ProductType, err error)

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyProductTypesKeyByKeyRequestMethodGet

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductTypesKeyByKeyRequestMethodGet

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyProductTypesKeyByKeyRequestMethodGetInput) *ByProjectKeyProductTypesKeyByKeyRequestMethodGet

type ByProjectKeyProductTypesKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyProductTypesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductTypesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductTypesKeyByKeyRequestMethodHead ¶ added in v1.2.0 

type ByProjectKeyProductTypesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodHead) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyProductTypesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodHead) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ProductType exists for a given `key`. Returns a `200 OK` status if the ProductType exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductTypesKeyByKeyRequestMethodHead

type ByProjectKeyProductTypesKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyProductTypesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductTypesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ProductType, err error)

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyProductTypesKeyByKeyRequestMethodPost

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductTypesKeyByKeyRequestMethodPost

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductTypesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyProductTypesKeyByKeyRequestMethodPostInput) *ByProjectKeyProductTypesKeyByKeyRequestMethodPost

type ByProjectKeyProductTypesKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyProductTypesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductTypesKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductTypesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductTypesRequestBuilder ¶ 

type ByProjectKeyProductTypesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductTypesRequestBuilder) Get() *ByProjectKeyProductTypesRequestMethodGet

func (*ByProjectKeyProductTypesRequestBuilder) Head ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesRequestBuilder) Head() *ByProjectKeyProductTypesRequestMethodHead

* * Checks if a ProductType exists for a given Query Predicate. Returns a `200 OK` status if any ProductTypes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyProductTypesRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductTypesRequestBuilder) Post(body ProductTypeDraft) *ByProjectKeyProductTypesRequestMethodPost

func (*ByProjectKeyProductTypesRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyProductTypesRequestBuilder) WithId(id string) *ByProjectKeyProductTypesByIDRequestBuilder

func (*ByProjectKeyProductTypesRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyProductTypesRequestBuilder) WithKey(key string) *ByProjectKeyProductTypesKeyByKeyRequestBuilder

type ByProjectKeyProductTypesRequestMethodGet ¶ 

type ByProjectKeyProductTypesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductTypesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) Execute(ctx context.Context) (result *ProductTypePagedQueryResponse, err error)

func (*ByProjectKeyProductTypesRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) Expand(v []string) *ByProjectKeyProductTypesRequestMethodGet

func (*ByProjectKeyProductTypesRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) Limit(v int) *ByProjectKeyProductTypesRequestMethodGet

func (*ByProjectKeyProductTypesRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) Offset(v int) *ByProjectKeyProductTypesRequestMethodGet

func (*ByProjectKeyProductTypesRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyProductTypesRequestMethodGet

func (*ByProjectKeyProductTypesRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) Sort(v []string) *ByProjectKeyProductTypesRequestMethodGet

func (*ByProjectKeyProductTypesRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) Where(v []string) *ByProjectKeyProductTypesRequestMethodGet

func (*ByProjectKeyProductTypesRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductTypesRequestMethodGet

func (*ByProjectKeyProductTypesRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) WithQueryParams(input ByProjectKeyProductTypesRequestMethodGetInput) *ByProjectKeyProductTypesRequestMethodGet

func (*ByProjectKeyProductTypesRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductTypesRequestMethodGet

type ByProjectKeyProductTypesRequestMethodGetInput ¶ 

type ByProjectKeyProductTypesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyProductTypesRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductTypesRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductTypesRequestMethodHead ¶ added in v1.2.0 

type ByProjectKeyProductTypesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesRequestMethodHead) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyProductTypesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesRequestMethodHead) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ProductType exists for a given Query Predicate. Returns a `200 OK` status if any ProductTypes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyProductTypesRequestMethodHead) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesRequestMethodHead) Where(v string) *ByProjectKeyProductTypesRequestMethodHead

func (*ByProjectKeyProductTypesRequestMethodHead) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductTypesRequestMethodHead

func (*ByProjectKeyProductTypesRequestMethodHead) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyProductTypesRequestMethodHead) WithQueryParams(input ByProjectKeyProductTypesRequestMethodHeadInput) *ByProjectKeyProductTypesRequestMethodHead

type ByProjectKeyProductTypesRequestMethodHeadInput ¶ added in v1.2.0 

type ByProjectKeyProductTypesRequestMethodHeadInput struct {
	Where *string
}

func (*ByProjectKeyProductTypesRequestMethodHeadInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyProductTypesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyProductTypesRequestMethodPost ¶ 

type ByProjectKeyProductTypesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductTypesRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductTypesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductTypesRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodPost) Execute(ctx context.Context) (result *ProductType, err error)

func (*ByProjectKeyProductTypesRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodPost) Expand(v []string) *ByProjectKeyProductTypesRequestMethodPost

func (*ByProjectKeyProductTypesRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductTypesRequestMethodPost

func (*ByProjectKeyProductTypesRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductTypesRequestMethodPost) WithQueryParams(input ByProjectKeyProductTypesRequestMethodPostInput) *ByProjectKeyProductTypesRequestMethodPost

type ByProjectKeyProductTypesRequestMethodPostInput ¶ 

type ByProjectKeyProductTypesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyProductTypesRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductTypesRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductsByIDImagesRequestBuilder ¶ 

type ByProjectKeyProductsByIDImagesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsByIDImagesRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductsByIDImagesRequestBuilder) Post(body io.Reader) *ByProjectKeyProductsByIDImagesRequestMethodPost

* * Upload a JPEG, PNG and GIF file to a ProductVariant(ctp:api:type:ProductVariant). The maximum file size of the image is 10MB. `variant` or `sku` is required to update a specific ProductVariant. The image is uploaded to the Master Variant if `variant` or `sku` are not included. Produces the [ProductImageAdded](/projects/messages#product-image-added) Message when the `Small` version of the image has been uploaded to the CDN. *

type ByProjectKeyProductsByIDImagesRequestMethodPost ¶ 

type ByProjectKeyProductsByIDImagesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsByIDImagesRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductsByIDImagesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductsByIDImagesRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductsByIDImagesRequestMethodPost) Execute(ctx context.Context) (result *Product, err error)

* * Upload a JPEG, PNG and GIF file to a ProductVariant(ctp:api:type:ProductVariant). The maximum file size of the image is 10MB. `variant` or `sku` is required to update a specific ProductVariant. The image is uploaded to the Master Variant if `variant` or `sku` are not included. Produces the [ProductImageAdded](/projects/messages#product-image-added) Message when the `Small` version of the image has been uploaded to the CDN. *

func (*ByProjectKeyProductsByIDImagesRequestMethodPost) Filename ¶ 

func (rb *ByProjectKeyProductsByIDImagesRequestMethodPost) Filename(v string) *ByProjectKeyProductsByIDImagesRequestMethodPost

func (*ByProjectKeyProductsByIDImagesRequestMethodPost) Sku ¶ 

func (rb *ByProjectKeyProductsByIDImagesRequestMethodPost) Sku(v string) *ByProjectKeyProductsByIDImagesRequestMethodPost

func (*ByProjectKeyProductsByIDImagesRequestMethodPost) Staged ¶ 

func (rb *ByProjectKeyProductsByIDImagesRequestMethodPost) Staged(v bool) *ByProjectKeyProductsByIDImagesRequestMethodPost

func (*ByProjectKeyProductsByIDImagesRequestMethodPost) Variant ¶ 

func (rb *ByProjectKeyProductsByIDImagesRequestMethodPost) Variant(v int) *ByProjectKeyProductsByIDImagesRequestMethodPost

func (*ByProjectKeyProductsByIDImagesRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductsByIDImagesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductsByIDImagesRequestMethodPost

func (*ByProjectKeyProductsByIDImagesRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsByIDImagesRequestMethodPost) WithQueryParams(input ByProjectKeyProductsByIDImagesRequestMethodPostInput) *ByProjectKeyProductsByIDImagesRequestMethodPost

type ByProjectKeyProductsByIDImagesRequestMethodPostInput ¶ 

type ByProjectKeyProductsByIDImagesRequestMethodPostInput struct {
	Filename *string
	Variant  *int
	Sku      *string
	Staged   *bool
}

func (*ByProjectKeyProductsByIDImagesRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductsByIDImagesRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductsByIDProductSelectionsRequestBuilder ¶ 

type ByProjectKeyProductsByIDProductSelectionsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsByIDProductSelectionsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestBuilder) Get() *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

type ByProjectKeyProductsByIDProductSelectionsRequestMethodGet ¶ 

type ByProjectKeyProductsByIDProductSelectionsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Execute(ctx context.Context) (result *AssignedProductSelectionPagedQueryResponse, err error)

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Expand(v []string) *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Limit(v int) *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Offset(v int) *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Sort(v []string) *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) Where(v []string) *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) WithQueryParams(input ByProjectKeyProductsByIDProductSelectionsRequestMethodGetInput) *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductsByIDProductSelectionsRequestMethodGet

type ByProjectKeyProductsByIDProductSelectionsRequestMethodGetInput ¶ 

type ByProjectKeyProductsByIDProductSelectionsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyProductsByIDProductSelectionsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductsByIDProductSelectionsRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductsByIDRequestBuilder ¶ 

type ByProjectKeyProductsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyProductsByIDRequestBuilder) Delete() *ByProjectKeyProductsByIDRequestMethodDelete

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. * Produces the [ProductDeleted](/projects/messages#product-deleted) Message.

func (*ByProjectKeyProductsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductsByIDRequestBuilder) Get() *ByProjectKeyProductsByIDRequestMethodGet

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response.

func (*ByProjectKeyProductsByIDRequestBuilder) Head ¶ 

func (rb *ByProjectKeyProductsByIDRequestBuilder) Head() *ByProjectKeyProductsByIDRequestMethodHead

* * Checks if a Product exists for a given `id`. Returns a `200 OK` status if the Product exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductsByIDRequestBuilder) Images ¶ 

func (rb *ByProjectKeyProductsByIDRequestBuilder) Images() *ByProjectKeyProductsByIDImagesRequestBuilder

func (*ByProjectKeyProductsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductsByIDRequestBuilder) Post(body ProductUpdate) *ByProjectKeyProductsByIDRequestMethodPost

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. * * A failed response can return a [DuplicatePriceScope](ctp:api:type:DuplicatePriceScopeError), [DuplicateVariantValues](ctp:api:type:DuplicateVariantValuesError), [DuplicateAttributeValue](ctp:api:type:DuplicateAttributeValueError), or [DuplicateAttributeValues](ctp:api:type:DuplicateAttributeValuesError) error.

func (*ByProjectKeyProductsByIDRequestBuilder) ProductSelections ¶ 

func (rb *ByProjectKeyProductsByIDRequestBuilder) ProductSelections() *ByProjectKeyProductsByIDProductSelectionsRequestBuilder

type ByProjectKeyProductsByIDRequestMethodDelete ¶ 

type ByProjectKeyProductsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyProductsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Product, err error)

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. * Produces the [ProductDeleted](/projects/messages#product-deleted) Message.

func (*ByProjectKeyProductsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyProductsByIDRequestMethodDelete

func (*ByProjectKeyProductsByIDRequestMethodDelete) LocaleProjection ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) LocaleProjection(v []string) *ByProjectKeyProductsByIDRequestMethodDelete

func (*ByProjectKeyProductsByIDRequestMethodDelete) PriceChannel ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) PriceChannel(v string) *ByProjectKeyProductsByIDRequestMethodDelete

func (*ByProjectKeyProductsByIDRequestMethodDelete) PriceCountry ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) PriceCountry(v string) *ByProjectKeyProductsByIDRequestMethodDelete

func (*ByProjectKeyProductsByIDRequestMethodDelete) PriceCurrency ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) PriceCurrency(v string) *ByProjectKeyProductsByIDRequestMethodDelete

func (*ByProjectKeyProductsByIDRequestMethodDelete) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) PriceCustomerGroup(v string) *ByProjectKeyProductsByIDRequestMethodDelete

func (*ByProjectKeyProductsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) Version(v int) *ByProjectKeyProductsByIDRequestMethodDelete

func (*ByProjectKeyProductsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductsByIDRequestMethodDelete

func (*ByProjectKeyProductsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyProductsByIDRequestMethodDeleteInput) *ByProjectKeyProductsByIDRequestMethodDelete

type ByProjectKeyProductsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyProductsByIDRequestMethodDeleteInput struct {
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Version            int
	Expand             []string
}

func (*ByProjectKeyProductsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyProductsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductsByIDRequestMethodGet ¶ 

type ByProjectKeyProductsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodGet) Execute(ctx context.Context) (result *Product, err error)

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response.

func (*ByProjectKeyProductsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyProductsByIDRequestMethodGet

func (*ByProjectKeyProductsByIDRequestMethodGet) LocaleProjection ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodGet) LocaleProjection(v []string) *ByProjectKeyProductsByIDRequestMethodGet

func (*ByProjectKeyProductsByIDRequestMethodGet) PriceChannel ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodGet) PriceChannel(v string) *ByProjectKeyProductsByIDRequestMethodGet

func (*ByProjectKeyProductsByIDRequestMethodGet) PriceCountry ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodGet) PriceCountry(v string) *ByProjectKeyProductsByIDRequestMethodGet

func (*ByProjectKeyProductsByIDRequestMethodGet) PriceCurrency ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodGet) PriceCurrency(v string) *ByProjectKeyProductsByIDRequestMethodGet

func (*ByProjectKeyProductsByIDRequestMethodGet) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodGet) PriceCustomerGroup(v string) *ByProjectKeyProductsByIDRequestMethodGet

func (*ByProjectKeyProductsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductsByIDRequestMethodGet

func (*ByProjectKeyProductsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyProductsByIDRequestMethodGetInput) *ByProjectKeyProductsByIDRequestMethodGet

type ByProjectKeyProductsByIDRequestMethodGetInput ¶ 

type ByProjectKeyProductsByIDRequestMethodGetInput struct {
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Expand             []string
}

func (*ByProjectKeyProductsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductsByIDRequestMethodHead ¶ 

type ByProjectKeyProductsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsByIDRequestMethodHead) Dump ¶ 

func (r *ByProjectKeyProductsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductsByIDRequestMethodHead) Execute ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Product exists for a given `id`. Returns a `200 OK` status if the Product exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductsByIDRequestMethodHead) WithHeaders ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductsByIDRequestMethodHead

type ByProjectKeyProductsByIDRequestMethodPost ¶ 

type ByProjectKeyProductsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodPost) Execute(ctx context.Context) (result *Product, err error)

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. * * A failed response can return a [DuplicatePriceScope](ctp:api:type:DuplicatePriceScopeError), [DuplicateVariantValues](ctp:api:type:DuplicateVariantValuesError), [DuplicateAttributeValue](ctp:api:type:DuplicateAttributeValueError), or [DuplicateAttributeValues](ctp:api:type:DuplicateAttributeValuesError) error.

func (*ByProjectKeyProductsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyProductsByIDRequestMethodPost

func (*ByProjectKeyProductsByIDRequestMethodPost) LocaleProjection ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodPost) LocaleProjection(v []string) *ByProjectKeyProductsByIDRequestMethodPost

func (*ByProjectKeyProductsByIDRequestMethodPost) PriceChannel ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodPost) PriceChannel(v string) *ByProjectKeyProductsByIDRequestMethodPost

func (*ByProjectKeyProductsByIDRequestMethodPost) PriceCountry ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodPost) PriceCountry(v string) *ByProjectKeyProductsByIDRequestMethodPost

func (*ByProjectKeyProductsByIDRequestMethodPost) PriceCurrency ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodPost) PriceCurrency(v string) *ByProjectKeyProductsByIDRequestMethodPost

func (*ByProjectKeyProductsByIDRequestMethodPost) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodPost) PriceCustomerGroup(v string) *ByProjectKeyProductsByIDRequestMethodPost

func (*ByProjectKeyProductsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductsByIDRequestMethodPost

func (*ByProjectKeyProductsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyProductsByIDRequestMethodPostInput) *ByProjectKeyProductsByIDRequestMethodPost

type ByProjectKeyProductsByIDRequestMethodPostInput ¶ 

type ByProjectKeyProductsByIDRequestMethodPostInput struct {
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Expand             []string
}

func (*ByProjectKeyProductsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductsKeyByKeyProductSelectionsRequestBuilder ¶ 

type ByProjectKeyProductsKeyByKeyProductSelectionsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestBuilder) Get() *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

type ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet ¶ 

type ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Execute(ctx context.Context) (result *AssignedProductSelectionPagedQueryResponse, err error)

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Expand(v []string) *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Limit(v int) *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Offset(v int) *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Sort(v []string) *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) Where(v []string) *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) WithQueryParams(input ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGetInput) *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGet

type ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGetInput ¶ 

type ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductsKeyByKeyProductSelectionsRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyProductsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestBuilder) Delete() *ByProjectKeyProductsKeyByKeyRequestMethodDelete

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. * Produces the [ProductDeleted](/projects/messages#product-deleted) Message.

func (*ByProjectKeyProductsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestBuilder) Get() *ByProjectKeyProductsKeyByKeyRequestMethodGet

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response.

func (*ByProjectKeyProductsKeyByKeyRequestBuilder) Head ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestBuilder) Head() *ByProjectKeyProductsKeyByKeyRequestMethodHead

* * Checks if a Product exists for a given `key`. Returns a `200 OK` status if the Product exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestBuilder) Post(body ProductUpdate) *ByProjectKeyProductsKeyByKeyRequestMethodPost

* * A failed response can return a [DuplicatePriceScope](ctp:api:type:DuplicatePriceScopeError), [DuplicateVariantValues](ctp:api:type:DuplicateVariantValuesError), [DuplicateAttributeValue](ctp:api:type:DuplicateAttributeValueError), or [DuplicateAttributeValues](ctp:api:type:DuplicateAttributeValuesError) error.

func (*ByProjectKeyProductsKeyByKeyRequestBuilder) ProductSelections ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestBuilder) ProductSelections() *ByProjectKeyProductsKeyByKeyProductSelectionsRequestBuilder

type ByProjectKeyProductsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyProductsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyProductsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Product, err error)

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. * Produces the [ProductDeleted](/projects/messages#product-deleted) Message.

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyProductsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) LocaleProjection ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) LocaleProjection(v []string) *ByProjectKeyProductsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) PriceChannel ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) PriceChannel(v string) *ByProjectKeyProductsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) PriceCountry ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) PriceCountry(v string) *ByProjectKeyProductsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) PriceCurrency ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) PriceCurrency(v string) *ByProjectKeyProductsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) PriceCustomerGroup(v string) *ByProjectKeyProductsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyProductsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyProductsKeyByKeyRequestMethodDelete

func (*ByProjectKeyProductsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyProductsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyProductsKeyByKeyRequestMethodDelete

type ByProjectKeyProductsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyProductsKeyByKeyRequestMethodDeleteInput struct {
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Version            int
	Expand             []string
}

func (*ByProjectKeyProductsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyProductsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyProductsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyProductsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Product, err error)

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response.

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyProductsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) LocaleProjection ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodGet) LocaleProjection(v []string) *ByProjectKeyProductsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) PriceChannel ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodGet) PriceChannel(v string) *ByProjectKeyProductsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) PriceCountry ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodGet) PriceCountry(v string) *ByProjectKeyProductsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) PriceCurrency ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodGet) PriceCurrency(v string) *ByProjectKeyProductsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodGet) PriceCustomerGroup(v string) *ByProjectKeyProductsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductsKeyByKeyRequestMethodGet

func (*ByProjectKeyProductsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyProductsKeyByKeyRequestMethodGetInput) *ByProjectKeyProductsKeyByKeyRequestMethodGet

type ByProjectKeyProductsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyProductsKeyByKeyRequestMethodGetInput struct {
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Expand             []string
}

func (*ByProjectKeyProductsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductsKeyByKeyRequestMethodHead ¶ 

type ByProjectKeyProductsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsKeyByKeyRequestMethodHead) Dump ¶ 

func (r *ByProjectKeyProductsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductsKeyByKeyRequestMethodHead) Execute ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Product exists for a given `key`. Returns a `200 OK` status if the Product exists or a `404 Not Found` otherwise.

func (*ByProjectKeyProductsKeyByKeyRequestMethodHead) WithHeaders ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductsKeyByKeyRequestMethodHead

type ByProjectKeyProductsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyProductsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Product, err error)

* * A failed response can return a [DuplicatePriceScope](ctp:api:type:DuplicatePriceScopeError), [DuplicateVariantValues](ctp:api:type:DuplicateVariantValuesError), [DuplicateAttributeValue](ctp:api:type:DuplicateAttributeValueError), or [DuplicateAttributeValues](ctp:api:type:DuplicateAttributeValuesError) error.

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyProductsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) LocaleProjection ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodPost) LocaleProjection(v []string) *ByProjectKeyProductsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) PriceChannel ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodPost) PriceChannel(v string) *ByProjectKeyProductsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) PriceCountry ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodPost) PriceCountry(v string) *ByProjectKeyProductsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) PriceCurrency ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodPost) PriceCurrency(v string) *ByProjectKeyProductsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodPost) PriceCustomerGroup(v string) *ByProjectKeyProductsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductsKeyByKeyRequestMethodPost

func (*ByProjectKeyProductsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyProductsKeyByKeyRequestMethodPostInput) *ByProjectKeyProductsKeyByKeyRequestMethodPost

type ByProjectKeyProductsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyProductsKeyByKeyRequestMethodPostInput struct {
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Expand             []string
}

func (*ByProjectKeyProductsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyProductsRequestBuilder ¶ 

type ByProjectKeyProductsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyProductsRequestBuilder) Get() *ByProjectKeyProductsRequestMethodGet

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response.

func (*ByProjectKeyProductsRequestBuilder) Head ¶ 

func (rb *ByProjectKeyProductsRequestBuilder) Head() *ByProjectKeyProductsRequestMethodHead

* * Checks if a Product exists for a given Query Predicate. Returns a `200 OK` status if any Products match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyProductsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyProductsRequestBuilder) Post(body ProductDraft) *ByProjectKeyProductsRequestMethodPost

* * To create a new Product, send a representation that is going to become the initial _staged_ and _current_ representation of the new Product in the catalog. * If [Price Selection](ctp:api:type:ProductPriceSelection) query parameters are provided, selected Prices will be added to the response. * Produces the [ProductCreated](/projects/messages#product-created) Message. *

func (*ByProjectKeyProductsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyProductsRequestBuilder) WithId(id string) *ByProjectKeyProductsByIDRequestBuilder

func (*ByProjectKeyProductsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyProductsRequestBuilder) WithKey(key string) *ByProjectKeyProductsKeyByKeyRequestBuilder

type ByProjectKeyProductsRequestMethodGet ¶ 

type ByProjectKeyProductsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyProductsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyProductsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) Execute(ctx context.Context) (result *ProductPagedQueryResponse, err error)

* * If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response.

func (*ByProjectKeyProductsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) Expand(v []string) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) Limit(v int) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) LocaleProjection ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) LocaleProjection(v []string) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) Offset(v int) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) PriceChannel ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) PriceChannel(v string) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) PriceCountry ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) PriceCountry(v string) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) PriceCurrency ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) PriceCurrency(v string) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) PriceCustomerGroup(v string) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) Sort(v []string) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) Where(v []string) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) WithQueryParams(input ByProjectKeyProductsRequestMethodGetInput) *ByProjectKeyProductsRequestMethodGet

func (*ByProjectKeyProductsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyProductsRequestMethodGet) WithTotal(v bool) *ByProjectKeyProductsRequestMethodGet

type ByProjectKeyProductsRequestMethodGetInput ¶ 

type ByProjectKeyProductsRequestMethodGetInput struct {
	Where              []string
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Expand             []string
	Sort               []string
	Limit              *int
	Offset             *int
	WithTotal          *bool
	PredicateVar       map[string][]string
}

func (*ByProjectKeyProductsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyProductsRequestMethodGetInput) Values() url.Values

type ByProjectKeyProductsRequestMethodHead ¶ 

type ByProjectKeyProductsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsRequestMethodHead) Dump ¶ 

func (r *ByProjectKeyProductsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyProductsRequestMethodHead) Execute ¶ 

func (rb *ByProjectKeyProductsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Product exists for a given Query Predicate. Returns a `200 OK` status if any Products match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyProductsRequestMethodHead) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyProductsRequestMethodHead) Where(v []string) *ByProjectKeyProductsRequestMethodHead

func (*ByProjectKeyProductsRequestMethodHead) WithHeaders ¶ 

func (rb *ByProjectKeyProductsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyProductsRequestMethodHead

func (*ByProjectKeyProductsRequestMethodHead) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyProductsRequestMethodHead) WithQueryParams(input ByProjectKeyProductsRequestMethodHeadInput) *ByProjectKeyProductsRequestMethodHead

type ByProjectKeyProductsRequestMethodHeadInput ¶ added in v1.2.0 

type ByProjectKeyProductsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyProductsRequestMethodHeadInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyProductsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyProductsRequestMethodPost ¶ 

type ByProjectKeyProductsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyProductsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyProductsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyProductsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyProductsRequestMethodPost) Execute(ctx context.Context) (result *Product, err error)

* * To create a new Product, send a representation that is going to become the initial _staged_ and _current_ representation of the new Product in the catalog. * If [Price Selection](ctp:api:type:ProductPriceSelection) query parameters are provided, selected Prices will be added to the response. * Produces the [ProductCreated](/projects/messages#product-created) Message. *

func (*ByProjectKeyProductsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyProductsRequestMethodPost) Expand(v []string) *ByProjectKeyProductsRequestMethodPost

func (*ByProjectKeyProductsRequestMethodPost) LocaleProjection ¶ 

func (rb *ByProjectKeyProductsRequestMethodPost) LocaleProjection(v []string) *ByProjectKeyProductsRequestMethodPost

func (*ByProjectKeyProductsRequestMethodPost) PriceChannel ¶ 

func (rb *ByProjectKeyProductsRequestMethodPost) PriceChannel(v string) *ByProjectKeyProductsRequestMethodPost

func (*ByProjectKeyProductsRequestMethodPost) PriceCountry ¶ 

func (rb *ByProjectKeyProductsRequestMethodPost) PriceCountry(v string) *ByProjectKeyProductsRequestMethodPost

func (*ByProjectKeyProductsRequestMethodPost) PriceCurrency ¶ 

func (rb *ByProjectKeyProductsRequestMethodPost) PriceCurrency(v string) *ByProjectKeyProductsRequestMethodPost

func (*ByProjectKeyProductsRequestMethodPost) PriceCustomerGroup ¶ 

func (rb *ByProjectKeyProductsRequestMethodPost) PriceCustomerGroup(v string) *ByProjectKeyProductsRequestMethodPost

func (*ByProjectKeyProductsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyProductsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyProductsRequestMethodPost

func (*ByProjectKeyProductsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyProductsRequestMethodPost) WithQueryParams(input ByProjectKeyProductsRequestMethodPostInput) *ByProjectKeyProductsRequestMethodPost

type ByProjectKeyProductsRequestMethodPostInput ¶ 

type ByProjectKeyProductsRequestMethodPostInput struct {
	PriceCurrency      *string
	PriceCountry       *string
	PriceCustomerGroup *string
	PriceChannel       *string
	LocaleProjection   []string
	Expand             []string
}

func (*ByProjectKeyProductsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyProductsRequestMethodPostInput) Values() url.Values

type ByProjectKeyQuoteRequestsByIDRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsByIDRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestBuilder) Delete() *ByProjectKeyQuoteRequestsByIDRequestMethodDelete

func (*ByProjectKeyQuoteRequestsByIDRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestBuilder) Get() *ByProjectKeyQuoteRequestsByIDRequestMethodGet

func (*ByProjectKeyQuoteRequestsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestBuilder) Head() *ByProjectKeyQuoteRequestsByIDRequestMethodHead

* * Checks if a QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyQuoteRequestsByIDRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestBuilder) Post(body QuoteRequestUpdate) *ByProjectKeyQuoteRequestsByIDRequestMethodPost

type ByProjectKeyQuoteRequestsByIDRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodDelete) DataErasure ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyQuoteRequestsByIDRequestMethodDelete

func (*ByProjectKeyQuoteRequestsByIDRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuoteRequestsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodDelete) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyQuoteRequestsByIDRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyQuoteRequestsByIDRequestMethodDelete

func (*ByProjectKeyQuoteRequestsByIDRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodDelete) Version(v int) *ByProjectKeyQuoteRequestsByIDRequestMethodDelete

func (*ByProjectKeyQuoteRequestsByIDRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsByIDRequestMethodDelete

func (*ByProjectKeyQuoteRequestsByIDRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyQuoteRequestsByIDRequestMethodDeleteInput) *ByProjectKeyQuoteRequestsByIDRequestMethodDelete

type ByProjectKeyQuoteRequestsByIDRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuoteRequestsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyQuoteRequestsByIDRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuoteRequestsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodGet) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyQuoteRequestsByIDRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyQuoteRequestsByIDRequestMethodGet

func (*ByProjectKeyQuoteRequestsByIDRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsByIDRequestMethodGet

func (*ByProjectKeyQuoteRequestsByIDRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyQuoteRequestsByIDRequestMethodGetInput) *ByProjectKeyQuoteRequestsByIDRequestMethodGet

type ByProjectKeyQuoteRequestsByIDRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuoteRequestsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyQuoteRequestsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyQuoteRequestsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyQuoteRequestsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyQuoteRequestsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsByIDRequestMethodHead

type ByProjectKeyQuoteRequestsByIDRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuoteRequestsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodPost) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyQuoteRequestsByIDRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyQuoteRequestsByIDRequestMethodPost

func (*ByProjectKeyQuoteRequestsByIDRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsByIDRequestMethodPost

func (*ByProjectKeyQuoteRequestsByIDRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyQuoteRequestsByIDRequestMethodPostInput) *ByProjectKeyQuoteRequestsByIDRequestMethodPost

type ByProjectKeyQuoteRequestsByIDRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyQuoteRequestsByIDRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuoteRequestsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder) Delete() *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder) Get() *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder) Head() *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead

* * Checks if a QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder) Post(body QuoteRequestUpdate) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) DataErasure ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDelete

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGetInput) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGet

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodHead

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPostInput) *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPost

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuoteRequestsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyQuoteRequestsRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestBuilder) Get() *ByProjectKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyQuoteRequestsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsRequestBuilder) Head() *ByProjectKeyQuoteRequestsRequestMethodHead

* * Checks if a QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyQuoteRequestsRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestBuilder) Post(body QuoteRequestDraft) *ByProjectKeyQuoteRequestsRequestMethodPost

func (*ByProjectKeyQuoteRequestsRequestBuilder) WithId ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestBuilder) WithId(id string) *ByProjectKeyQuoteRequestsByIDRequestBuilder

func (*ByProjectKeyQuoteRequestsRequestBuilder) WithKey ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestBuilder) WithKey(key string) *ByProjectKeyQuoteRequestsKeyByKeyRequestBuilder

type ByProjectKeyQuoteRequestsRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuoteRequestsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) Execute(ctx context.Context) (result *QuoteRequestPagedQueryResponse, err error)

func (*ByProjectKeyQuoteRequestsRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) Expand(v []string) *ByProjectKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyQuoteRequestsRequestMethodGet) Limit ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) Limit(v int) *ByProjectKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyQuoteRequestsRequestMethodGet) Offset ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) Offset(v int) *ByProjectKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyQuoteRequestsRequestMethodGet) PredicateVar ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyQuoteRequestsRequestMethodGet) Sort ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) Sort(v []string) *ByProjectKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyQuoteRequestsRequestMethodGet) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) Where(v []string) *ByProjectKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyQuoteRequestsRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyQuoteRequestsRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) WithQueryParams(input ByProjectKeyQuoteRequestsRequestMethodGetInput) *ByProjectKeyQuoteRequestsRequestMethodGet

func (*ByProjectKeyQuoteRequestsRequestMethodGet) WithTotal ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodGet) WithTotal(v bool) *ByProjectKeyQuoteRequestsRequestMethodGet

type ByProjectKeyQuoteRequestsRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyQuoteRequestsRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuoteRequestsRequestMethodGetInput) Values() url.Values

type ByProjectKeyQuoteRequestsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyQuoteRequestsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyQuoteRequestsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyQuoteRequestsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodHead) Where(v []string) *ByProjectKeyQuoteRequestsRequestMethodHead

func (*ByProjectKeyQuoteRequestsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsRequestMethodHead

func (*ByProjectKeyQuoteRequestsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodHead) WithQueryParams(input ByProjectKeyQuoteRequestsRequestMethodHeadInput) *ByProjectKeyQuoteRequestsRequestMethodHead

type ByProjectKeyQuoteRequestsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyQuoteRequestsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyQuoteRequestsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyQuoteRequestsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyQuoteRequestsRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuoteRequestsRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuoteRequestsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyQuoteRequestsRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodPost) Execute(ctx context.Context) (result *QuoteRequest, err error)

func (*ByProjectKeyQuoteRequestsRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodPost) Expand(v []string) *ByProjectKeyQuoteRequestsRequestMethodPost

func (*ByProjectKeyQuoteRequestsRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyQuoteRequestsRequestMethodPost

func (*ByProjectKeyQuoteRequestsRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuoteRequestsRequestMethodPost) WithQueryParams(input ByProjectKeyQuoteRequestsRequestMethodPostInput) *ByProjectKeyQuoteRequestsRequestMethodPost

type ByProjectKeyQuoteRequestsRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyQuoteRequestsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyQuoteRequestsRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuoteRequestsRequestMethodPostInput) Values() url.Values

type ByProjectKeyQuotesByIDRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyQuotesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesByIDRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestBuilder) Delete() *ByProjectKeyQuotesByIDRequestMethodDelete

func (*ByProjectKeyQuotesByIDRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestBuilder) Get() *ByProjectKeyQuotesByIDRequestMethodGet

func (*ByProjectKeyQuotesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesByIDRequestBuilder) Head() *ByProjectKeyQuotesByIDRequestMethodHead

* * Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyQuotesByIDRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestBuilder) Post(body QuoteUpdate) *ByProjectKeyQuotesByIDRequestMethodPost

type ByProjectKeyQuotesByIDRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyQuotesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesByIDRequestMethodDelete) DataErasure ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyQuotesByIDRequestMethodDelete

func (*ByProjectKeyQuotesByIDRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuotesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyQuotesByIDRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodDelete) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyQuotesByIDRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyQuotesByIDRequestMethodDelete

func (*ByProjectKeyQuotesByIDRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodDelete) Version(v int) *ByProjectKeyQuotesByIDRequestMethodDelete

func (*ByProjectKeyQuotesByIDRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyQuotesByIDRequestMethodDelete

func (*ByProjectKeyQuotesByIDRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyQuotesByIDRequestMethodDeleteInput) *ByProjectKeyQuotesByIDRequestMethodDelete

type ByProjectKeyQuotesByIDRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyQuotesByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyQuotesByIDRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuotesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyQuotesByIDRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyQuotesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesByIDRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuotesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyQuotesByIDRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodGet) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyQuotesByIDRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyQuotesByIDRequestMethodGet

func (*ByProjectKeyQuotesByIDRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyQuotesByIDRequestMethodGet

func (*ByProjectKeyQuotesByIDRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyQuotesByIDRequestMethodGetInput) *ByProjectKeyQuotesByIDRequestMethodGet

type ByProjectKeyQuotesByIDRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyQuotesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyQuotesByIDRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuotesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyQuotesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyQuotesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyQuotesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyQuotesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyQuotesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyQuotesByIDRequestMethodHead

type ByProjectKeyQuotesByIDRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyQuotesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesByIDRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuotesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyQuotesByIDRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodPost) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyQuotesByIDRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyQuotesByIDRequestMethodPost

func (*ByProjectKeyQuotesByIDRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyQuotesByIDRequestMethodPost

func (*ByProjectKeyQuotesByIDRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyQuotesByIDRequestMethodPostInput) *ByProjectKeyQuotesByIDRequestMethodPost

type ByProjectKeyQuotesByIDRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyQuotesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyQuotesByIDRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuotesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyQuotesKeyByKeyRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyQuotesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesKeyByKeyRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestBuilder) Delete() *ByProjectKeyQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuotesKeyByKeyRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestBuilder) Get() *ByProjectKeyQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyQuotesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestBuilder) Head() *ByProjectKeyQuotesKeyByKeyRequestMethodHead

* * Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyQuotesKeyByKeyRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestBuilder) Post(body QuoteUpdate) *ByProjectKeyQuotesKeyByKeyRequestMethodPost

type ByProjectKeyQuotesKeyByKeyRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyQuotesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodDelete) DataErasure ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuotesKeyByKeyRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuotesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyQuotesKeyByKeyRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuotesKeyByKeyRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuotesKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyQuotesKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyQuotesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyQuotesKeyByKeyRequestMethodDelete

type ByProjectKeyQuotesKeyByKeyRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyQuotesKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuotesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyQuotesKeyByKeyRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyQuotesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuotesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyQuotesKeyByKeyRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyQuotesKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyQuotesKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyQuotesKeyByKeyRequestMethodGetInput) *ByProjectKeyQuotesKeyByKeyRequestMethodGet

type ByProjectKeyQuotesKeyByKeyRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyQuotesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuotesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyQuotesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyQuotesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyQuotesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyQuotesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyQuotesKeyByKeyRequestMethodHead

type ByProjectKeyQuotesKeyByKeyRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyQuotesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuotesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyQuotesKeyByKeyRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyQuotesKeyByKeyRequestMethodPost

func (*ByProjectKeyQuotesKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyQuotesKeyByKeyRequestMethodPost

func (*ByProjectKeyQuotesKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyQuotesKeyByKeyRequestMethodPostInput) *ByProjectKeyQuotesKeyByKeyRequestMethodPost

type ByProjectKeyQuotesKeyByKeyRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyQuotesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyQuotesKeyByKeyRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuotesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyQuotesRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyQuotesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestBuilder) Get() *ByProjectKeyQuotesRequestMethodGet

func (*ByProjectKeyQuotesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesRequestBuilder) Head() *ByProjectKeyQuotesRequestMethodHead

* * Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyQuotesRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestBuilder) Post(body QuoteDraft) *ByProjectKeyQuotesRequestMethodPost

func (*ByProjectKeyQuotesRequestBuilder) WithId ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestBuilder) WithId(id string) *ByProjectKeyQuotesByIDRequestBuilder

func (*ByProjectKeyQuotesRequestBuilder) WithKey ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestBuilder) WithKey(key string) *ByProjectKeyQuotesKeyByKeyRequestBuilder

type ByProjectKeyQuotesRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyQuotesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuotesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyQuotesRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) Execute(ctx context.Context) (result *QuotePagedQueryResponse, err error)

func (*ByProjectKeyQuotesRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) Expand(v []string) *ByProjectKeyQuotesRequestMethodGet

func (*ByProjectKeyQuotesRequestMethodGet) Limit ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) Limit(v int) *ByProjectKeyQuotesRequestMethodGet

func (*ByProjectKeyQuotesRequestMethodGet) Offset ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) Offset(v int) *ByProjectKeyQuotesRequestMethodGet

func (*ByProjectKeyQuotesRequestMethodGet) PredicateVar ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyQuotesRequestMethodGet

func (*ByProjectKeyQuotesRequestMethodGet) Sort ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) Sort(v []string) *ByProjectKeyQuotesRequestMethodGet

func (*ByProjectKeyQuotesRequestMethodGet) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) Where(v []string) *ByProjectKeyQuotesRequestMethodGet

func (*ByProjectKeyQuotesRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyQuotesRequestMethodGet

func (*ByProjectKeyQuotesRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) WithQueryParams(input ByProjectKeyQuotesRequestMethodGetInput) *ByProjectKeyQuotesRequestMethodGet

func (*ByProjectKeyQuotesRequestMethodGet) WithTotal ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodGet) WithTotal(v bool) *ByProjectKeyQuotesRequestMethodGet

type ByProjectKeyQuotesRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyQuotesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyQuotesRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuotesRequestMethodGetInput) Values() url.Values

type ByProjectKeyQuotesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyQuotesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyQuotesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyQuotesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyQuotesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesRequestMethodHead) Where(v []string) *ByProjectKeyQuotesRequestMethodHead

func (*ByProjectKeyQuotesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyQuotesRequestMethodHead

func (*ByProjectKeyQuotesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyQuotesRequestMethodHead) WithQueryParams(input ByProjectKeyQuotesRequestMethodHeadInput) *ByProjectKeyQuotesRequestMethodHead

type ByProjectKeyQuotesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyQuotesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyQuotesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyQuotesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyQuotesRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyQuotesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyQuotesRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyQuotesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyQuotesRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodPost) Execute(ctx context.Context) (result *Quote, err error)

func (*ByProjectKeyQuotesRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodPost) Expand(v []string) *ByProjectKeyQuotesRequestMethodPost

func (*ByProjectKeyQuotesRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyQuotesRequestMethodPost

func (*ByProjectKeyQuotesRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyQuotesRequestMethodPost) WithQueryParams(input ByProjectKeyQuotesRequestMethodPostInput) *ByProjectKeyQuotesRequestMethodPost

type ByProjectKeyQuotesRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyQuotesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyQuotesRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyQuotesRequestMethodPostInput) Values() url.Values

type ByProjectKeyRequestBuilder ¶ 

type ByProjectKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyRequestBuilder) ApiClients ¶ 

func (rb *ByProjectKeyRequestBuilder) ApiClients() *ByProjectKeyApiClientsRequestBuilder

* * Manage your API Clients via an API. Useful for Infrastructure-as-Code tooling, and regularly rotating API secrets. *

func (*ByProjectKeyRequestBuilder) AsAssociate ¶ added in v1.3.0 

func (rb *ByProjectKeyRequestBuilder) AsAssociate() *ByProjectKeyAsAssociateRequestBuilder

func (*ByProjectKeyRequestBuilder) AssociateRoles ¶ added in v1.3.0 

func (rb *ByProjectKeyRequestBuilder) AssociateRoles() *ByProjectKeyAssociateRolesRequestBuilder

* * An Associate Role enables permissions over a Business Unit to an Associate.

func (*ByProjectKeyRequestBuilder) AttributeGroups ¶ added in v1.2.0 

func (rb *ByProjectKeyRequestBuilder) AttributeGroups() *ByProjectKeyAttributeGroupsRequestBuilder

* * Attribute groups ... TODO

func (*ByProjectKeyRequestBuilder) BusinessUnits ¶ added in v1.2.0 

func (rb *ByProjectKeyRequestBuilder) BusinessUnits() *ByProjectKeyBusinessUnitsRequestBuilder

* * A Business Unit can represent a Company or a Division.

func (*ByProjectKeyRequestBuilder) CartDiscounts ¶ 

func (rb *ByProjectKeyRequestBuilder) CartDiscounts() *ByProjectKeyCartDiscountsRequestBuilder

* * Cart discounts are used to change the prices of different elements within a cart.

func (*ByProjectKeyRequestBuilder) Carts ¶ 

func (rb *ByProjectKeyRequestBuilder) Carts() *ByProjectKeyCartsRequestBuilder

* * A shopping cart holds product variants and can be ordered.

func (*ByProjectKeyRequestBuilder) Categories ¶ 

func (rb *ByProjectKeyRequestBuilder) Categories() *ByProjectKeyCategoriesRequestBuilder

* * Categories are used to organize products in a hierarchical structure.

func (*ByProjectKeyRequestBuilder) Channels ¶ 

func (rb *ByProjectKeyRequestBuilder) Channels() *ByProjectKeyChannelsRequestBuilder

* * Channels represent a source or destination of different entities. They can be used to model warehouses or stores. *

func (*ByProjectKeyRequestBuilder) CustomObjects ¶ 

func (rb *ByProjectKeyRequestBuilder) CustomObjects() *ByProjectKeyCustomObjectsRequestBuilder

* * Store custom JSON values.

func (*ByProjectKeyRequestBuilder) CustomerGroups ¶ 

func (rb *ByProjectKeyRequestBuilder) CustomerGroups() *ByProjectKeyCustomerGroupsRequestBuilder

* * customer-groups are used to evaluate products and channels.

func (*ByProjectKeyRequestBuilder) Customers ¶ 

func (rb *ByProjectKeyRequestBuilder) Customers() *ByProjectKeyCustomersRequestBuilder

* * A Customer is a person purchasing products. Carts, Orders, Quotes, Reviews and Payments can be associated to a Customer. *

func (*ByProjectKeyRequestBuilder) DiscountCodes ¶ 

func (rb *ByProjectKeyRequestBuilder) DiscountCodes() *ByProjectKeyDiscountCodesRequestBuilder

* * Discount Codes can be added to a discount-code to enable certain discount-code discounts.

func (*ByProjectKeyRequestBuilder) Extensions ¶ 

func (rb *ByProjectKeyRequestBuilder) Extensions() *ByProjectKeyExtensionsRequestBuilder

* * Extend the behavior of an API with your business logic

func (*ByProjectKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyRequestBuilder) Get() *ByProjectKeyRequestMethodGet

func (*ByProjectKeyRequestBuilder) Graphql ¶ 

func (rb *ByProjectKeyRequestBuilder) Graphql() *ByProjectKeyGraphqlRequestBuilder

* * commercetools Composable Commerce provides a GraphQL API

func (*ByProjectKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyRequestBuilder) Head() *ByProjectKeyRequestMethodHead

* * Checks if a Project exists for a given `projectKey`. Returns a `200 OK` status if the Project exists or a `404 Not Found` otherwise.

func (*ByProjectKeyRequestBuilder) InBusinessUnitKeyWithBusinessUnitKeyValue ¶ added in v1.2.0 

func (rb *ByProjectKeyRequestBuilder) InBusinessUnitKeyWithBusinessUnitKeyValue(businessUnitKey string) *ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyRequestBuilder

func (*ByProjectKeyRequestBuilder) InStoreKeyWithStoreKeyValue ¶ 

func (rb *ByProjectKeyRequestBuilder) InStoreKeyWithStoreKeyValue(storeKey string) *ByProjectKeyInStoreKeyByStoreKeyRequestBuilder

func (*ByProjectKeyRequestBuilder) Inventory ¶ 

func (rb *ByProjectKeyRequestBuilder) Inventory() *ByProjectKeyInventoryRequestBuilder

* * Inventory allows you to track stock quantities.

func (*ByProjectKeyRequestBuilder) Login ¶ 

func (rb *ByProjectKeyRequestBuilder) Login() *ByProjectKeyLoginRequestBuilder

* * Retrieves the authenticated customer.

func (*ByProjectKeyRequestBuilder) Me ¶ 

func (rb *ByProjectKeyRequestBuilder) Me() *ByProjectKeyMeRequestBuilder

func (*ByProjectKeyRequestBuilder) Messages ¶ 

func (rb *ByProjectKeyRequestBuilder) Messages() *ByProjectKeyMessagesRequestBuilder

* * A message represents a change or an action performed on a resource (like an Order or a Product).

func (*ByProjectKeyRequestBuilder) Orders ¶ 

func (rb *ByProjectKeyRequestBuilder) Orders() *ByProjectKeyOrdersRequestBuilder

* * An order can be created from a order, usually after a checkout process has been completed.

func (*ByProjectKeyRequestBuilder) Payments ¶ 

func (rb *ByProjectKeyRequestBuilder) Payments() *ByProjectKeyPaymentsRequestBuilder

* * Payments hold information about the current state of receiving and/or refunding money

func (*ByProjectKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyRequestBuilder) Post(body ProjectUpdate) *ByProjectKeyRequestMethodPost

func (*ByProjectKeyRequestBuilder) ProductDiscounts ¶ 

func (rb *ByProjectKeyRequestBuilder) ProductDiscounts() *ByProjectKeyProductDiscountsRequestBuilder

* * Product discounts are used to change certain product prices.

func (*ByProjectKeyRequestBuilder) ProductProjections ¶ 

func (rb *ByProjectKeyRequestBuilder) ProductProjections() *ByProjectKeyProductProjectionsRequestBuilder

* * A projected representation of a product shows the product with its current or staged data. The current or staged * representation of a product in a catalog is called a product projection. *

func (*ByProjectKeyRequestBuilder) ProductSelections ¶ 

func (rb *ByProjectKeyRequestBuilder) ProductSelections() *ByProjectKeyProductSelectionsRequestBuilder

* * Manage individual Store assortments through Product Selections. * * After you have created Product Selections and populated them with Products, * you can manage Store assortments by assigning Product Selections to Stores. * Product Selections may be used by a single Store or shared across several Stores. * * As a good practice, we recommend first creating Products in the project, and then creating Product Selection. *

func (*ByProjectKeyRequestBuilder) ProductTailoring ¶ added in v1.5.1 

func (rb *ByProjectKeyRequestBuilder) ProductTailoring() *ByProjectKeyProductTailoringRequestBuilder

* * Product tailoring are used to contextualize product data for specific stores.

func (*ByProjectKeyRequestBuilder) ProductTypes ¶ 

func (rb *ByProjectKeyRequestBuilder) ProductTypes() *ByProjectKeyProductTypesRequestBuilder

* * Product Types are used to describe common characteristics, most importantly common custom attributes, * of many concrete products. *

func (*ByProjectKeyRequestBuilder) Products ¶ 

func (rb *ByProjectKeyRequestBuilder) Products() *ByProjectKeyProductsRequestBuilder

* * Products themselves are not sellable. Instead, they act as a parent structure for sellable Product Variants. *

func (*ByProjectKeyRequestBuilder) QuoteRequests ¶ added in v1.2.0 

func (rb *ByProjectKeyRequestBuilder) QuoteRequests() *ByProjectKeyQuoteRequestsRequestBuilder

* * A request for a Quote holds product variants and can be ordered.

func (*ByProjectKeyRequestBuilder) Quotes ¶ added in v1.2.0 

func (rb *ByProjectKeyRequestBuilder) Quotes() *ByProjectKeyQuotesRequestBuilder

* * A quote holds the negotiated offer.

func (*ByProjectKeyRequestBuilder) Reviews ¶ 

func (rb *ByProjectKeyRequestBuilder) Reviews() *ByProjectKeyReviewsRequestBuilder

* * Reviews are used to evaluate products and channels.

func (*ByProjectKeyRequestBuilder) ShippingMethods ¶ 

func (rb *ByProjectKeyRequestBuilder) ShippingMethods() *ByProjectKeyShippingMethodsRequestBuilder

* * ShippingMethods define where orders can be shipped and what the costs are.

func (*ByProjectKeyRequestBuilder) ShoppingLists ¶ 

func (rb *ByProjectKeyRequestBuilder) ShoppingLists() *ByProjectKeyShoppingListsRequestBuilder

* * shopping-lists e.g. for wishlist support

func (*ByProjectKeyRequestBuilder) StagedQuotes ¶ added in v1.2.0 

func (rb *ByProjectKeyRequestBuilder) StagedQuotes() *ByProjectKeyStagedQuotesRequestBuilder

* * A staged quote holds the negotiation between the [Buyer](/../api/quotes-overview#buyer) and the [Seller](/../api/quotes-overview#seller).

func (*ByProjectKeyRequestBuilder) StandalonePrices ¶ 

func (rb *ByProjectKeyRequestBuilder) StandalonePrices() *ByProjectKeyStandalonePricesRequestBuilder

* * A standalone price assigns a price to a product variant for a given scope. The API will use the standalone prices associated with a Product if its field [`priceMode`](/projects/products#pricemode) is set to `Standalone` [ProductPriceMode](ctp:api:type:ProductPriceModeEnum).

func (*ByProjectKeyRequestBuilder) States ¶ 

func (rb *ByProjectKeyRequestBuilder) States() *ByProjectKeyStatesRequestBuilder

* * commercetools Composable Commerce allows you to model states of certain objects, such as orders, line items, products, * reviews, and payments in order to define finite state machines reflecting the business logic you'd like to * implement. *

func (*ByProjectKeyRequestBuilder) Stores ¶ 

func (rb *ByProjectKeyRequestBuilder) Stores() *ByProjectKeyStoresRequestBuilder

* * Stores let you model the context your customers shop in.

func (*ByProjectKeyRequestBuilder) Subscriptions ¶ 

func (rb *ByProjectKeyRequestBuilder) Subscriptions() *ByProjectKeySubscriptionsRequestBuilder

* * Subscriptions allow you to be notified of new messages or changes via a Message Queue of your choice

func (*ByProjectKeyRequestBuilder) TaxCategories ¶ 

func (rb *ByProjectKeyRequestBuilder) TaxCategories() *ByProjectKeyTaxCategoriesRequestBuilder

* * Tax Categories define how products are to be taxed in different countries.

func (*ByProjectKeyRequestBuilder) Types ¶ 

func (rb *ByProjectKeyRequestBuilder) Types() *ByProjectKeyTypesRequestBuilder

* * Types define custom fields that are used to enhance resources as you need.

func (*ByProjectKeyRequestBuilder) Zones ¶ 

func (rb *ByProjectKeyRequestBuilder) Zones() *ByProjectKeyZonesRequestBuilder

* * Zones allow defining ShippingRates for specific Locations.

type ByProjectKeyRequestMethodGet ¶ 

type ByProjectKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyRequestMethodGet) Execute(ctx context.Context) (result *Project, err error)

func (*ByProjectKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyRequestMethodGet

type ByProjectKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Project exists for a given `projectKey`. Returns a `200 OK` status if the Project exists or a `404 Not Found` otherwise.

func (*ByProjectKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyRequestMethodHead

type ByProjectKeyRequestMethodPost ¶ 

type ByProjectKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyRequestMethodPost) Execute(ctx context.Context) (result *Project, err error)

func (*ByProjectKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyRequestMethodPost

type ByProjectKeyReviewsByIDRequestBuilder ¶ 

type ByProjectKeyReviewsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyReviewsByIDRequestBuilder) Delete() *ByProjectKeyReviewsByIDRequestMethodDelete

func (*ByProjectKeyReviewsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyReviewsByIDRequestBuilder) Get() *ByProjectKeyReviewsByIDRequestMethodGet

func (*ByProjectKeyReviewsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsByIDRequestBuilder) Head() *ByProjectKeyReviewsByIDRequestMethodHead

* * Checks if a Review exists for a given `id`. Returns a `200 OK` status if the Review exists or a `404 Not Found` otherwise.

func (*ByProjectKeyReviewsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyReviewsByIDRequestBuilder) Post(body ReviewUpdate) *ByProjectKeyReviewsByIDRequestMethodPost

type ByProjectKeyReviewsByIDRequestMethodDelete ¶ 

type ByProjectKeyReviewsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyReviewsByIDRequestMethodDelete

func (*ByProjectKeyReviewsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyReviewsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyReviewsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Review, err error)

func (*ByProjectKeyReviewsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyReviewsByIDRequestMethodDelete

func (*ByProjectKeyReviewsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodDelete) Version(v int) *ByProjectKeyReviewsByIDRequestMethodDelete

func (*ByProjectKeyReviewsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyReviewsByIDRequestMethodDelete

func (*ByProjectKeyReviewsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyReviewsByIDRequestMethodDeleteInput) *ByProjectKeyReviewsByIDRequestMethodDelete

type ByProjectKeyReviewsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyReviewsByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyReviewsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyReviewsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyReviewsByIDRequestMethodGet ¶ 

type ByProjectKeyReviewsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyReviewsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyReviewsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodGet) Execute(ctx context.Context) (result *Review, err error)

func (*ByProjectKeyReviewsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyReviewsByIDRequestMethodGet

func (*ByProjectKeyReviewsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyReviewsByIDRequestMethodGet

func (*ByProjectKeyReviewsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyReviewsByIDRequestMethodGetInput) *ByProjectKeyReviewsByIDRequestMethodGet

type ByProjectKeyReviewsByIDRequestMethodGetInput ¶ 

type ByProjectKeyReviewsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyReviewsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyReviewsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyReviewsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyReviewsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyReviewsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyReviewsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Review exists for a given `id`. Returns a `200 OK` status if the Review exists or a `404 Not Found` otherwise.

func (*ByProjectKeyReviewsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyReviewsByIDRequestMethodHead

type ByProjectKeyReviewsByIDRequestMethodPost ¶ 

type ByProjectKeyReviewsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyReviewsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyReviewsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodPost) Execute(ctx context.Context) (result *Review, err error)

func (*ByProjectKeyReviewsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyReviewsByIDRequestMethodPost

func (*ByProjectKeyReviewsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyReviewsByIDRequestMethodPost

func (*ByProjectKeyReviewsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyReviewsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyReviewsByIDRequestMethodPostInput) *ByProjectKeyReviewsByIDRequestMethodPost

type ByProjectKeyReviewsByIDRequestMethodPostInput ¶ 

type ByProjectKeyReviewsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyReviewsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyReviewsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyReviewsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyReviewsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestBuilder) Delete() *ByProjectKeyReviewsKeyByKeyRequestMethodDelete

func (*ByProjectKeyReviewsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestBuilder) Get() *ByProjectKeyReviewsKeyByKeyRequestMethodGet

func (*ByProjectKeyReviewsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsKeyByKeyRequestBuilder) Head() *ByProjectKeyReviewsKeyByKeyRequestMethodHead

* * Checks if a Review exists for a given `key`. Returns a `200 OK` status if the Review exists or a `404 Not Found` otherwise.

func (*ByProjectKeyReviewsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestBuilder) Post(body ReviewUpdate) *ByProjectKeyReviewsKeyByKeyRequestMethodPost

type ByProjectKeyReviewsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyReviewsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyReviewsKeyByKeyRequestMethodDelete

func (*ByProjectKeyReviewsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyReviewsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Review, err error)

func (*ByProjectKeyReviewsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyReviewsKeyByKeyRequestMethodDelete

func (*ByProjectKeyReviewsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyReviewsKeyByKeyRequestMethodDelete

func (*ByProjectKeyReviewsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyReviewsKeyByKeyRequestMethodDelete

func (*ByProjectKeyReviewsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyReviewsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyReviewsKeyByKeyRequestMethodDelete

type ByProjectKeyReviewsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyReviewsKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyReviewsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyReviewsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyReviewsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyReviewsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Review, err error)

func (*ByProjectKeyReviewsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyReviewsKeyByKeyRequestMethodGet

func (*ByProjectKeyReviewsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyReviewsKeyByKeyRequestMethodGet

func (*ByProjectKeyReviewsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyReviewsKeyByKeyRequestMethodGetInput) *ByProjectKeyReviewsKeyByKeyRequestMethodGet

type ByProjectKeyReviewsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyReviewsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyReviewsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyReviewsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyReviewsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyReviewsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Review exists for a given `key`. Returns a `200 OK` status if the Review exists or a `404 Not Found` otherwise.

func (*ByProjectKeyReviewsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyReviewsKeyByKeyRequestMethodHead

type ByProjectKeyReviewsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyReviewsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyReviewsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Review, err error)

func (*ByProjectKeyReviewsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyReviewsKeyByKeyRequestMethodPost

func (*ByProjectKeyReviewsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyReviewsKeyByKeyRequestMethodPost

func (*ByProjectKeyReviewsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyReviewsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyReviewsKeyByKeyRequestMethodPostInput) *ByProjectKeyReviewsKeyByKeyRequestMethodPost

type ByProjectKeyReviewsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyReviewsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyReviewsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyReviewsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyReviewsRequestBuilder ¶ 

type ByProjectKeyReviewsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyReviewsRequestBuilder) Get() *ByProjectKeyReviewsRequestMethodGet

func (*ByProjectKeyReviewsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsRequestBuilder) Head() *ByProjectKeyReviewsRequestMethodHead

* * Checks if a Review exists for a given Query Predicate. Returns a `200 OK` status if any Reviews match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyReviewsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyReviewsRequestBuilder) Post(body ReviewDraft) *ByProjectKeyReviewsRequestMethodPost

func (*ByProjectKeyReviewsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyReviewsRequestBuilder) WithId(id string) *ByProjectKeyReviewsByIDRequestBuilder

func (*ByProjectKeyReviewsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyReviewsRequestBuilder) WithKey(key string) *ByProjectKeyReviewsKeyByKeyRequestBuilder

type ByProjectKeyReviewsRequestMethodGet ¶ 

type ByProjectKeyReviewsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyReviewsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyReviewsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) Execute(ctx context.Context) (result *ReviewPagedQueryResponse, err error)

func (*ByProjectKeyReviewsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) Expand(v []string) *ByProjectKeyReviewsRequestMethodGet

func (*ByProjectKeyReviewsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) Limit(v int) *ByProjectKeyReviewsRequestMethodGet

func (*ByProjectKeyReviewsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) Offset(v int) *ByProjectKeyReviewsRequestMethodGet

func (*ByProjectKeyReviewsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyReviewsRequestMethodGet

func (*ByProjectKeyReviewsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) Sort(v []string) *ByProjectKeyReviewsRequestMethodGet

func (*ByProjectKeyReviewsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) Where(v []string) *ByProjectKeyReviewsRequestMethodGet

func (*ByProjectKeyReviewsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyReviewsRequestMethodGet

func (*ByProjectKeyReviewsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) WithQueryParams(input ByProjectKeyReviewsRequestMethodGetInput) *ByProjectKeyReviewsRequestMethodGet

func (*ByProjectKeyReviewsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyReviewsRequestMethodGet) WithTotal(v bool) *ByProjectKeyReviewsRequestMethodGet

type ByProjectKeyReviewsRequestMethodGetInput ¶ 

type ByProjectKeyReviewsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyReviewsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyReviewsRequestMethodGetInput) Values() url.Values

type ByProjectKeyReviewsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyReviewsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyReviewsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyReviewsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Review exists for a given Query Predicate. Returns a `200 OK` status if any Reviews match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyReviewsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsRequestMethodHead) Where(v []string) *ByProjectKeyReviewsRequestMethodHead

func (*ByProjectKeyReviewsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyReviewsRequestMethodHead

func (*ByProjectKeyReviewsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyReviewsRequestMethodHead) WithQueryParams(input ByProjectKeyReviewsRequestMethodHeadInput) *ByProjectKeyReviewsRequestMethodHead

type ByProjectKeyReviewsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyReviewsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyReviewsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyReviewsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyReviewsRequestMethodPost ¶ 

type ByProjectKeyReviewsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyReviewsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyReviewsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyReviewsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyReviewsRequestMethodPost) Execute(ctx context.Context) (result *Review, err error)

func (*ByProjectKeyReviewsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyReviewsRequestMethodPost) Expand(v []string) *ByProjectKeyReviewsRequestMethodPost

func (*ByProjectKeyReviewsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyReviewsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyReviewsRequestMethodPost

func (*ByProjectKeyReviewsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyReviewsRequestMethodPost) WithQueryParams(input ByProjectKeyReviewsRequestMethodPostInput) *ByProjectKeyReviewsRequestMethodPost

type ByProjectKeyReviewsRequestMethodPostInput ¶ 

type ByProjectKeyReviewsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyReviewsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyReviewsRequestMethodPostInput) Values() url.Values

type ByProjectKeyShippingMethodsByIDRequestBuilder ¶ 

type ByProjectKeyShippingMethodsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestBuilder) Delete() *ByProjectKeyShippingMethodsByIDRequestMethodDelete

func (*ByProjectKeyShippingMethodsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestBuilder) Get() *ByProjectKeyShippingMethodsByIDRequestMethodGet

func (*ByProjectKeyShippingMethodsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsByIDRequestBuilder) Head() *ByProjectKeyShippingMethodsByIDRequestMethodHead

* * Checks if a ShippingMethod exists for a given `id`. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestBuilder) Post(body ShippingMethodUpdate) *ByProjectKeyShippingMethodsByIDRequestMethodPost

type ByProjectKeyShippingMethodsByIDRequestMethodDelete ¶ 

type ByProjectKeyShippingMethodsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyShippingMethodsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodDelete) Execute(ctx context.Context) (result *ShippingMethod, err error)

func (*ByProjectKeyShippingMethodsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyShippingMethodsByIDRequestMethodDelete

func (*ByProjectKeyShippingMethodsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodDelete) Version(v int) *ByProjectKeyShippingMethodsByIDRequestMethodDelete

func (*ByProjectKeyShippingMethodsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsByIDRequestMethodDelete

func (*ByProjectKeyShippingMethodsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyShippingMethodsByIDRequestMethodDeleteInput) *ByProjectKeyShippingMethodsByIDRequestMethodDelete

type ByProjectKeyShippingMethodsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyShippingMethodsByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyShippingMethodsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyShippingMethodsByIDRequestMethodGet ¶ 

type ByProjectKeyShippingMethodsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyShippingMethodsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodGet) Execute(ctx context.Context) (result *ShippingMethod, err error)

func (*ByProjectKeyShippingMethodsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyShippingMethodsByIDRequestMethodGet

func (*ByProjectKeyShippingMethodsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsByIDRequestMethodGet

func (*ByProjectKeyShippingMethodsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyShippingMethodsByIDRequestMethodGetInput) *ByProjectKeyShippingMethodsByIDRequestMethodGet

type ByProjectKeyShippingMethodsByIDRequestMethodGetInput ¶ 

type ByProjectKeyShippingMethodsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyShippingMethodsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyShippingMethodsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShippingMethodsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShippingMethod exists for a given `id`. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsByIDRequestMethodHead

type ByProjectKeyShippingMethodsByIDRequestMethodPost ¶ 

type ByProjectKeyShippingMethodsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyShippingMethodsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodPost) Execute(ctx context.Context) (result *ShippingMethod, err error)

func (*ByProjectKeyShippingMethodsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyShippingMethodsByIDRequestMethodPost

func (*ByProjectKeyShippingMethodsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsByIDRequestMethodPost

func (*ByProjectKeyShippingMethodsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyShippingMethodsByIDRequestMethodPostInput) *ByProjectKeyShippingMethodsByIDRequestMethodPost

type ByProjectKeyShippingMethodsByIDRequestMethodPostInput ¶ 

type ByProjectKeyShippingMethodsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyShippingMethodsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyShippingMethodsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyShippingMethodsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestBuilder) Delete() *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete

func (*ByProjectKeyShippingMethodsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestBuilder) Get() *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet

func (*ByProjectKeyShippingMethodsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestBuilder) Head() *ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead

* * Checks if a ShippingMethod exists for a given `key`. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestBuilder) Post(body ShippingMethodUpdate) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *ShippingMethod, err error)

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyShippingMethodsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDelete

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ShippingMethod, err error)

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyShippingMethodsKeyByKeyRequestMethodGetInput) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGet

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShippingMethod exists for a given `key`. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodHead

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ShippingMethod, err error)

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyShippingMethodsKeyByKeyRequestMethodPostInput) *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPost

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyShippingMethodsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyShippingMethodsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder ¶ added in v1.3.0 

type ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder) Get ¶ added in v1.3.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder) Get() *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet

* * Retrieves all the ShippingMethods that can ship to the given Location(ctp:api:type:Location) * with a `predicate` that matches the given Cart. * Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. * This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction). *

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder) Head() *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead

* * Checks if a ShippingMethod that can ship to the given Location(ctp:api:type:Location) exists for the given Cart. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

type ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet ¶ added in v1.3.0 

type ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) CartId ¶ added in v1.3.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) CartId(v string) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) Country ¶ added in v1.3.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) Country(v string) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) Dump ¶ added in v1.3.0 

func (r *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) Execute ¶ added in v1.3.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) Execute(ctx context.Context) (result *ShippingMethodPagedQueryResponse, err error)

* * Retrieves all the ShippingMethods that can ship to the given Location(ctp:api:type:Location) * with a `predicate` that matches the given Cart. * Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. * This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction). *

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) Expand ¶ added in v1.3.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) Expand(v []string) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) State ¶ added in v1.3.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) State(v string) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) WithHeaders ¶ added in v1.3.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) WithQueryParams ¶ added in v1.3.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet) WithQueryParams(input ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGetInput) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGet

type ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGetInput ¶ added in v1.3.0 

type ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGetInput struct {
	Country string
	State   *string
	CartId  string
	Expand  []string
}

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGetInput) Values ¶ added in v1.3.0 

func (input *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodGetInput) Values() url.Values

type ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) CartId ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) CartId(v string) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) Country ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) Country(v string) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShippingMethod that can ship to the given Location(ctp:api:type:Location) exists for the given Cart. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) State ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) State(v string) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead) WithQueryParams(input ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHeadInput) *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHead

type ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHeadInput struct {
	Country string
	State   *string
	CartId  string
}

func (*ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyShippingMethodsMatchingCartLocationRequestMethodHeadInput) Values() url.Values

type ByProjectKeyShippingMethodsMatchingCartRequestBuilder ¶ 

type ByProjectKeyShippingMethodsMatchingCartRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingCartRequestBuilder) Get ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestBuilder) Get() *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet

* * Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart. * Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. * This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction). *

func (*ByProjectKeyShippingMethodsMatchingCartRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestBuilder) Head() *ByProjectKeyShippingMethodsMatchingCartRequestMethodHead

* * Checks if a ShippingMethod exists for the given Cart. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

type ByProjectKeyShippingMethodsMatchingCartRequestMethodGet ¶ 

type ByProjectKeyShippingMethodsMatchingCartRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) CartId ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) CartId(v string) *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) Execute(ctx context.Context) (result *ShippingMethodPagedQueryResponse, err error)

* * Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart. * Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. * This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction). *

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) Expand(v []string) *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet) WithQueryParams(input ByProjectKeyShippingMethodsMatchingCartRequestMethodGetInput) *ByProjectKeyShippingMethodsMatchingCartRequestMethodGet

type ByProjectKeyShippingMethodsMatchingCartRequestMethodGetInput ¶ 

type ByProjectKeyShippingMethodsMatchingCartRequestMethodGetInput struct {
	CartId string
	Expand []string
}

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsMatchingCartRequestMethodGetInput) Values() url.Values

type ByProjectKeyShippingMethodsMatchingCartRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsMatchingCartRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) CartId ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) CartId(v string) *ByProjectKeyShippingMethodsMatchingCartRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShippingMethod exists for the given Cart. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsMatchingCartRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingCartRequestMethodHead) WithQueryParams(input ByProjectKeyShippingMethodsMatchingCartRequestMethodHeadInput) *ByProjectKeyShippingMethodsMatchingCartRequestMethodHead

type ByProjectKeyShippingMethodsMatchingCartRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsMatchingCartRequestMethodHeadInput struct {
	CartId string
}

func (*ByProjectKeyShippingMethodsMatchingCartRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyShippingMethodsMatchingCartRequestMethodHeadInput) Values() url.Values

type ByProjectKeyShippingMethodsMatchingLocationRequestBuilder ¶ 

type ByProjectKeyShippingMethodsMatchingLocationRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingLocationRequestBuilder) Get ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestBuilder) Get() *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet

* * Retrieves all the ShippingMethods that can ship to the given Location(/projects/zones#location). * ShippingMethods that have a `predicate` defined are automatically disqualified. * If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency. * Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`. * If the `currency` parameter is given, exactly one ShippingRate will contain it. *

func (*ByProjectKeyShippingMethodsMatchingLocationRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestBuilder) Head() *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead

* * Checks if a ShippingMethod that can ship to the given Location(ctp:api:type:Location) exists. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

type ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet ¶ 

type ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Country ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Country(v string) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Currency ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Currency(v string) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Execute(ctx context.Context) (result *ShippingMethodPagedQueryResponse, err error)

* * Retrieves all the ShippingMethods that can ship to the given Location(/projects/zones#location). * ShippingMethods that have a `predicate` defined are automatically disqualified. * If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency. * Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`. * If the `currency` parameter is given, exactly one ShippingRate will contain it. *

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Expand(v []string) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) Sort(v []string) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) State ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) State(v string) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet) WithQueryParams(input ByProjectKeyShippingMethodsMatchingLocationRequestMethodGetInput) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGet

type ByProjectKeyShippingMethodsMatchingLocationRequestMethodGetInput ¶ 

type ByProjectKeyShippingMethodsMatchingLocationRequestMethodGetInput struct {
	Country  string
	State    *string
	Currency *string
	Expand   []string
	Sort     []string
}

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsMatchingLocationRequestMethodGetInput) Values() url.Values

type ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) Country ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) Country(v string) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) Currency ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) Currency(v string) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShippingMethod that can ship to the given Location(ctp:api:type:Location) exists. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) State ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) State(v string) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead) WithQueryParams(input ByProjectKeyShippingMethodsMatchingLocationRequestMethodHeadInput) *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHead

type ByProjectKeyShippingMethodsMatchingLocationRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsMatchingLocationRequestMethodHeadInput struct {
	Country  string
	State    *string
	Currency *string
}

func (*ByProjectKeyShippingMethodsMatchingLocationRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyShippingMethodsMatchingLocationRequestMethodHeadInput) Values() url.Values

type ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder ¶ 

type ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder) Get ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder) Get() *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet

* * Retrieves all the ShippingMethods that can ship to the given Location(ctp:api:type:Location) for an OrderEdit(ctp:api:type:OrderEdit). * * If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned. *

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder) Head() *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead

* * Checks if a ShippingMethod that can ship to the given Location(ctp:api:type:Location) exists for the given OrderEdit(ctp:api:type:OrderEdit). Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

type ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet ¶ 

type ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) Country ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) Country(v string) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) Execute(ctx context.Context) (result *ShippingMethodPagedQueryResponse, err error)

* * Retrieves all the ShippingMethods that can ship to the given Location(ctp:api:type:Location) for an OrderEdit(ctp:api:type:OrderEdit). * * If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned. *

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) OrderEditId ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) OrderEditId(v string) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) State ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) State(v string) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet) WithQueryParams(input ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGetInput) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGet

type ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGetInput ¶ 

type ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGetInput struct {
	OrderEditId string
	Country     string
	State       *string
}

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodGetInput) Values() url.Values

type ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) Country ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) Country(v string) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShippingMethod that can ship to the given Location(ctp:api:type:Location) exists for the given OrderEdit(ctp:api:type:OrderEdit). Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) OrderEditId ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) OrderEditId(v string) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) State ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) State(v string) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead) WithQueryParams(input ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHeadInput) *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHead

type ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHeadInput struct {
	OrderEditId string
	Country     string
	State       *string
}

func (*ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyShippingMethodsMatchingOrdereditRequestMethodHeadInput) Values() url.Values

type ByProjectKeyShippingMethodsRequestBuilder ¶ 

type ByProjectKeyShippingMethodsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyShippingMethodsRequestBuilder) Get() *ByProjectKeyShippingMethodsRequestMethodGet

func (*ByProjectKeyShippingMethodsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsRequestBuilder) Head() *ByProjectKeyShippingMethodsRequestMethodHead

* * Checks if a ShippingMethod exists for a given Query Predicate. Returns a `200 OK` status if any ShippingMethods match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsRequestBuilder) MatchingCart ¶ 

func (rb *ByProjectKeyShippingMethodsRequestBuilder) MatchingCart() *ByProjectKeyShippingMethodsMatchingCartRequestBuilder

* * Get ShippingMethods for a cart

func (*ByProjectKeyShippingMethodsRequestBuilder) MatchingCartLocation ¶ added in v1.3.0 

func (rb *ByProjectKeyShippingMethodsRequestBuilder) MatchingCartLocation() *ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder

* * Get ShippingMethods for a cart and location

func (*ByProjectKeyShippingMethodsRequestBuilder) MatchingLocation ¶ 

func (rb *ByProjectKeyShippingMethodsRequestBuilder) MatchingLocation() *ByProjectKeyShippingMethodsMatchingLocationRequestBuilder

* * Get ShippingMethods for a location

func (*ByProjectKeyShippingMethodsRequestBuilder) MatchingOrderedit ¶ 

func (rb *ByProjectKeyShippingMethodsRequestBuilder) MatchingOrderedit() *ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder

* * Get ShippingMethods for an order edit

func (*ByProjectKeyShippingMethodsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyShippingMethodsRequestBuilder) Post(body ShippingMethodDraft) *ByProjectKeyShippingMethodsRequestMethodPost

func (*ByProjectKeyShippingMethodsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyShippingMethodsRequestBuilder) WithId(id string) *ByProjectKeyShippingMethodsByIDRequestBuilder

func (*ByProjectKeyShippingMethodsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyShippingMethodsRequestBuilder) WithKey(key string) *ByProjectKeyShippingMethodsKeyByKeyRequestBuilder

type ByProjectKeyShippingMethodsRequestMethodGet ¶ 

type ByProjectKeyShippingMethodsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyShippingMethodsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) Execute(ctx context.Context) (result *ShippingMethodPagedQueryResponse, err error)

func (*ByProjectKeyShippingMethodsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) Expand(v []string) *ByProjectKeyShippingMethodsRequestMethodGet

func (*ByProjectKeyShippingMethodsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) Limit(v int) *ByProjectKeyShippingMethodsRequestMethodGet

func (*ByProjectKeyShippingMethodsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) Offset(v int) *ByProjectKeyShippingMethodsRequestMethodGet

func (*ByProjectKeyShippingMethodsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyShippingMethodsRequestMethodGet

func (*ByProjectKeyShippingMethodsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) Sort(v []string) *ByProjectKeyShippingMethodsRequestMethodGet

func (*ByProjectKeyShippingMethodsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) Where(v []string) *ByProjectKeyShippingMethodsRequestMethodGet

func (*ByProjectKeyShippingMethodsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsRequestMethodGet

func (*ByProjectKeyShippingMethodsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) WithQueryParams(input ByProjectKeyShippingMethodsRequestMethodGetInput) *ByProjectKeyShippingMethodsRequestMethodGet

func (*ByProjectKeyShippingMethodsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodGet) WithTotal(v bool) *ByProjectKeyShippingMethodsRequestMethodGet

type ByProjectKeyShippingMethodsRequestMethodGetInput ¶ 

type ByProjectKeyShippingMethodsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyShippingMethodsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsRequestMethodGetInput) Values() url.Values

type ByProjectKeyShippingMethodsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShippingMethodsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShippingMethod exists for a given Query Predicate. Returns a `200 OK` status if any ShippingMethods match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyShippingMethodsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsRequestMethodHead) Where(v []string) *ByProjectKeyShippingMethodsRequestMethodHead

func (*ByProjectKeyShippingMethodsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsRequestMethodHead

func (*ByProjectKeyShippingMethodsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyShippingMethodsRequestMethodHead) WithQueryParams(input ByProjectKeyShippingMethodsRequestMethodHeadInput) *ByProjectKeyShippingMethodsRequestMethodHead

type ByProjectKeyShippingMethodsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyShippingMethodsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyShippingMethodsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyShippingMethodsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyShippingMethodsRequestMethodPost ¶ 

type ByProjectKeyShippingMethodsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShippingMethodsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyShippingMethodsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyShippingMethodsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodPost) Execute(ctx context.Context) (result *ShippingMethod, err error)

func (*ByProjectKeyShippingMethodsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodPost) Expand(v []string) *ByProjectKeyShippingMethodsRequestMethodPost

func (*ByProjectKeyShippingMethodsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyShippingMethodsRequestMethodPost

func (*ByProjectKeyShippingMethodsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyShippingMethodsRequestMethodPost) WithQueryParams(input ByProjectKeyShippingMethodsRequestMethodPostInput) *ByProjectKeyShippingMethodsRequestMethodPost

type ByProjectKeyShippingMethodsRequestMethodPostInput ¶ 

type ByProjectKeyShippingMethodsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyShippingMethodsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyShippingMethodsRequestMethodPostInput) Values() url.Values

type ByProjectKeyShoppingListsByIDRequestBuilder ¶ 

type ByProjectKeyShoppingListsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestBuilder) Delete() *ByProjectKeyShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyShoppingListsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestBuilder) Get() *ByProjectKeyShoppingListsByIDRequestMethodGet

func (*ByProjectKeyShoppingListsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsByIDRequestBuilder) Head() *ByProjectKeyShoppingListsByIDRequestMethodHead

* * Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShoppingListsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestBuilder) Post(body ShoppingListUpdate) *ByProjectKeyShoppingListsByIDRequestMethodPost

type ByProjectKeyShoppingListsByIDRequestMethodDelete ¶ 

type ByProjectKeyShoppingListsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsByIDRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyShoppingListsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyShoppingListsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodDelete) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyShoppingListsByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyShoppingListsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodDelete) Version(v int) *ByProjectKeyShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyShoppingListsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsByIDRequestMethodDelete

func (*ByProjectKeyShoppingListsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyShoppingListsByIDRequestMethodDeleteInput) *ByProjectKeyShoppingListsByIDRequestMethodDelete

type ByProjectKeyShoppingListsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyShoppingListsByIDRequestMethodDeleteInput struct {
	Expand      []string
	DataErasure *bool
	Version     int
}

func (*ByProjectKeyShoppingListsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyShoppingListsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyShoppingListsByIDRequestMethodGet ¶ 

type ByProjectKeyShoppingListsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyShoppingListsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodGet) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyShoppingListsByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodGet) Expand(v []string) *ByProjectKeyShoppingListsByIDRequestMethodGet

func (*ByProjectKeyShoppingListsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsByIDRequestMethodGet

func (*ByProjectKeyShoppingListsByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodGet) WithQueryParams(input ByProjectKeyShoppingListsByIDRequestMethodGetInput) *ByProjectKeyShoppingListsByIDRequestMethodGet

type ByProjectKeyShoppingListsByIDRequestMethodGetInput ¶ 

type ByProjectKeyShoppingListsByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyShoppingListsByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyShoppingListsByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyShoppingListsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShoppingListsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShoppingListsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShoppingListsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsByIDRequestMethodHead

type ByProjectKeyShoppingListsByIDRequestMethodPost ¶ 

type ByProjectKeyShoppingListsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyShoppingListsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyShoppingListsByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodPost) Expand(v []string) *ByProjectKeyShoppingListsByIDRequestMethodPost

func (*ByProjectKeyShoppingListsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsByIDRequestMethodPost

func (*ByProjectKeyShoppingListsByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyShoppingListsByIDRequestMethodPost) WithQueryParams(input ByProjectKeyShoppingListsByIDRequestMethodPostInput) *ByProjectKeyShoppingListsByIDRequestMethodPost

type ByProjectKeyShoppingListsByIDRequestMethodPostInput ¶ 

type ByProjectKeyShoppingListsByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyShoppingListsByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyShoppingListsByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyShoppingListsKeyByKeyRequestBuilder ¶ 

type ByProjectKeyShoppingListsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestBuilder) Delete() *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyShoppingListsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestBuilder) Get() *ByProjectKeyShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyShoppingListsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestBuilder) Head() *ByProjectKeyShoppingListsKeyByKeyRequestMethodHead

* * Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShoppingListsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestBuilder) Post(body ShoppingListUpdate) *ByProjectKeyShoppingListsKeyByKeyRequestMethodPost

type ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) DataErasure ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyShoppingListsKeyByKeyRequestMethodDeleteInput) *ByProjectKeyShoppingListsKeyByKeyRequestMethodDelete

type ByProjectKeyShoppingListsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyShoppingListsKeyByKeyRequestMethodDeleteInput struct {
	Expand      []string
	DataErasure *bool
	Version     int
}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyShoppingListsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyShoppingListsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyShoppingListsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsKeyByKeyRequestMethodGet

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyShoppingListsKeyByKeyRequestMethodGetInput) *ByProjectKeyShoppingListsKeyByKeyRequestMethodGet

type ByProjectKeyShoppingListsKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyShoppingListsKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyShoppingListsKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyShoppingListsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShoppingListsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShoppingListsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise.

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsKeyByKeyRequestMethodHead

type ByProjectKeyShoppingListsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyShoppingListsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyShoppingListsKeyByKeyRequestMethodPost

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsKeyByKeyRequestMethodPost

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyShoppingListsKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyShoppingListsKeyByKeyRequestMethodPostInput) *ByProjectKeyShoppingListsKeyByKeyRequestMethodPost

type ByProjectKeyShoppingListsKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyShoppingListsKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyShoppingListsKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyShoppingListsKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyShoppingListsRequestBuilder ¶ 

type ByProjectKeyShoppingListsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsRequestBuilder) Get ¶ 

func (rb *ByProjectKeyShoppingListsRequestBuilder) Get() *ByProjectKeyShoppingListsRequestMethodGet

func (*ByProjectKeyShoppingListsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsRequestBuilder) Head() *ByProjectKeyShoppingListsRequestMethodHead

* * Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyShoppingListsRequestBuilder) Post ¶ 

func (rb *ByProjectKeyShoppingListsRequestBuilder) Post(body ShoppingListDraft) *ByProjectKeyShoppingListsRequestMethodPost

func (*ByProjectKeyShoppingListsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyShoppingListsRequestBuilder) WithId(id string) *ByProjectKeyShoppingListsByIDRequestBuilder

func (*ByProjectKeyShoppingListsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyShoppingListsRequestBuilder) WithKey(key string) *ByProjectKeyShoppingListsKeyByKeyRequestBuilder

type ByProjectKeyShoppingListsRequestMethodGet ¶ 

type ByProjectKeyShoppingListsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyShoppingListsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) Execute(ctx context.Context) (result *ShoppingListPagedQueryResponse, err error)

func (*ByProjectKeyShoppingListsRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) Expand(v []string) *ByProjectKeyShoppingListsRequestMethodGet

func (*ByProjectKeyShoppingListsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) Limit(v int) *ByProjectKeyShoppingListsRequestMethodGet

func (*ByProjectKeyShoppingListsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) Offset(v int) *ByProjectKeyShoppingListsRequestMethodGet

func (*ByProjectKeyShoppingListsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyShoppingListsRequestMethodGet

func (*ByProjectKeyShoppingListsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) Sort(v []string) *ByProjectKeyShoppingListsRequestMethodGet

func (*ByProjectKeyShoppingListsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) Where(v []string) *ByProjectKeyShoppingListsRequestMethodGet

func (*ByProjectKeyShoppingListsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsRequestMethodGet

func (*ByProjectKeyShoppingListsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) WithQueryParams(input ByProjectKeyShoppingListsRequestMethodGetInput) *ByProjectKeyShoppingListsRequestMethodGet

func (*ByProjectKeyShoppingListsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodGet) WithTotal(v bool) *ByProjectKeyShoppingListsRequestMethodGet

type ByProjectKeyShoppingListsRequestMethodGetInput ¶ 

type ByProjectKeyShoppingListsRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyShoppingListsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyShoppingListsRequestMethodGetInput) Values() url.Values

type ByProjectKeyShoppingListsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyShoppingListsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyShoppingListsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyShoppingListsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsRequestMethodHead) Where(v []string) *ByProjectKeyShoppingListsRequestMethodHead

func (*ByProjectKeyShoppingListsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsRequestMethodHead

func (*ByProjectKeyShoppingListsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyShoppingListsRequestMethodHead) WithQueryParams(input ByProjectKeyShoppingListsRequestMethodHeadInput) *ByProjectKeyShoppingListsRequestMethodHead

type ByProjectKeyShoppingListsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyShoppingListsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyShoppingListsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyShoppingListsRequestMethodHeadInput) Values() url.Values

type ByProjectKeyShoppingListsRequestMethodPost ¶ 

type ByProjectKeyShoppingListsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyShoppingListsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyShoppingListsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyShoppingListsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodPost) Execute(ctx context.Context) (result *ShoppingList, err error)

func (*ByProjectKeyShoppingListsRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodPost) Expand(v []string) *ByProjectKeyShoppingListsRequestMethodPost

func (*ByProjectKeyShoppingListsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyShoppingListsRequestMethodPost

func (*ByProjectKeyShoppingListsRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyShoppingListsRequestMethodPost) WithQueryParams(input ByProjectKeyShoppingListsRequestMethodPostInput) *ByProjectKeyShoppingListsRequestMethodPost

type ByProjectKeyShoppingListsRequestMethodPostInput ¶ 

type ByProjectKeyShoppingListsRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyShoppingListsRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyShoppingListsRequestMethodPostInput) Values() url.Values

type ByProjectKeyStagedQuotesByIDRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesByIDRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestBuilder) Delete() *ByProjectKeyStagedQuotesByIDRequestMethodDelete

func (*ByProjectKeyStagedQuotesByIDRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestBuilder) Get() *ByProjectKeyStagedQuotesByIDRequestMethodGet

func (*ByProjectKeyStagedQuotesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestBuilder) Head() *ByProjectKeyStagedQuotesByIDRequestMethodHead

* * Checks if a StagedQuote exists for a given `id`. Returns a `200 OK` status if the StagedQuote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStagedQuotesByIDRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestBuilder) Post(body StagedQuoteUpdate) *ByProjectKeyStagedQuotesByIDRequestMethodPost

type ByProjectKeyStagedQuotesByIDRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesByIDRequestMethodDelete) DataErasure ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodDelete) DataErasure(v bool) *ByProjectKeyStagedQuotesByIDRequestMethodDelete

func (*ByProjectKeyStagedQuotesByIDRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyStagedQuotesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesByIDRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodDelete) Execute(ctx context.Context) (result *StagedQuote, err error)

func (*ByProjectKeyStagedQuotesByIDRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyStagedQuotesByIDRequestMethodDelete

func (*ByProjectKeyStagedQuotesByIDRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodDelete) Version(v int) *ByProjectKeyStagedQuotesByIDRequestMethodDelete

func (*ByProjectKeyStagedQuotesByIDRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesByIDRequestMethodDelete

func (*ByProjectKeyStagedQuotesByIDRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyStagedQuotesByIDRequestMethodDeleteInput) *ByProjectKeyStagedQuotesByIDRequestMethodDelete

type ByProjectKeyStagedQuotesByIDRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesByIDRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyStagedQuotesByIDRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyStagedQuotesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyStagedQuotesByIDRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesByIDRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyStagedQuotesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesByIDRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodGet) Execute(ctx context.Context) (result *StagedQuote, err error)

func (*ByProjectKeyStagedQuotesByIDRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyStagedQuotesByIDRequestMethodGet

func (*ByProjectKeyStagedQuotesByIDRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesByIDRequestMethodGet

func (*ByProjectKeyStagedQuotesByIDRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyStagedQuotesByIDRequestMethodGetInput) *ByProjectKeyStagedQuotesByIDRequestMethodGet

type ByProjectKeyStagedQuotesByIDRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyStagedQuotesByIDRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyStagedQuotesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyStagedQuotesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStagedQuotesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStagedQuotesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a StagedQuote exists for a given `id`. Returns a `200 OK` status if the StagedQuote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStagedQuotesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesByIDRequestMethodHead

type ByProjectKeyStagedQuotesByIDRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesByIDRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyStagedQuotesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesByIDRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodPost) Execute(ctx context.Context) (result *StagedQuote, err error)

func (*ByProjectKeyStagedQuotesByIDRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyStagedQuotesByIDRequestMethodPost

func (*ByProjectKeyStagedQuotesByIDRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesByIDRequestMethodPost

func (*ByProjectKeyStagedQuotesByIDRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyStagedQuotesByIDRequestMethodPostInput) *ByProjectKeyStagedQuotesByIDRequestMethodPost

type ByProjectKeyStagedQuotesByIDRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStagedQuotesByIDRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyStagedQuotesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyStagedQuotesKeyByKeyRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestBuilder) Delete ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestBuilder) Delete() *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStagedQuotesKeyByKeyRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestBuilder) Get() *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyStagedQuotesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestBuilder) Head() *ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead

* * Checks if a StagedQuote exists for a given `key`. Returns a `200 OK` status if the StagedQuote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStagedQuotesKeyByKeyRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestBuilder) Post(body StagedQuoteUpdate) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) DataErasure ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) DataErasure(v bool) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *StagedQuote, err error)

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) Version ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyStagedQuotesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDelete

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodDeleteInput ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodDeleteInput struct {
	DataErasure *bool
	Version     int
	Expand      []string
}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodDeleteInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyStagedQuotesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *StagedQuote, err error)

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyStagedQuotesKeyByKeyRequestMethodGetInput) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGet

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyStagedQuotesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a StagedQuote exists for a given `key`. Returns a `200 OK` status if the StagedQuote exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodHead

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *StagedQuote, err error)

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyStagedQuotesKeyByKeyRequestMethodPostInput) *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPost

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStagedQuotesKeyByKeyRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyStagedQuotesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyStagedQuotesRequestBuilder ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestBuilder) Get() *ByProjectKeyStagedQuotesRequestMethodGet

func (*ByProjectKeyStagedQuotesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesRequestBuilder) Head() *ByProjectKeyStagedQuotesRequestMethodHead

* * Checks if a StagedQuote exists for a given Query Predicate. Returns a `200 OK` status if any StagedQuotes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyStagedQuotesRequestBuilder) Post ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestBuilder) Post(body StagedQuoteDraft) *ByProjectKeyStagedQuotesRequestMethodPost

func (*ByProjectKeyStagedQuotesRequestBuilder) WithId ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestBuilder) WithId(id string) *ByProjectKeyStagedQuotesByIDRequestBuilder

func (*ByProjectKeyStagedQuotesRequestBuilder) WithKey ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestBuilder) WithKey(key string) *ByProjectKeyStagedQuotesKeyByKeyRequestBuilder

type ByProjectKeyStagedQuotesRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyStagedQuotesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) Execute(ctx context.Context) (result *StagedQuotePagedQueryResponse, err error)

func (*ByProjectKeyStagedQuotesRequestMethodGet) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) Expand(v []string) *ByProjectKeyStagedQuotesRequestMethodGet

func (*ByProjectKeyStagedQuotesRequestMethodGet) Limit ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) Limit(v int) *ByProjectKeyStagedQuotesRequestMethodGet

func (*ByProjectKeyStagedQuotesRequestMethodGet) Offset ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) Offset(v int) *ByProjectKeyStagedQuotesRequestMethodGet

func (*ByProjectKeyStagedQuotesRequestMethodGet) PredicateVar ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyStagedQuotesRequestMethodGet

func (*ByProjectKeyStagedQuotesRequestMethodGet) Sort ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) Sort(v []string) *ByProjectKeyStagedQuotesRequestMethodGet

func (*ByProjectKeyStagedQuotesRequestMethodGet) Where ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) Where(v []string) *ByProjectKeyStagedQuotesRequestMethodGet

func (*ByProjectKeyStagedQuotesRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesRequestMethodGet

func (*ByProjectKeyStagedQuotesRequestMethodGet) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) WithQueryParams(input ByProjectKeyStagedQuotesRequestMethodGetInput) *ByProjectKeyStagedQuotesRequestMethodGet

func (*ByProjectKeyStagedQuotesRequestMethodGet) WithTotal ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodGet) WithTotal(v bool) *ByProjectKeyStagedQuotesRequestMethodGet

type ByProjectKeyStagedQuotesRequestMethodGetInput ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyStagedQuotesRequestMethodGetInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyStagedQuotesRequestMethodGetInput) Values() url.Values

type ByProjectKeyStagedQuotesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStagedQuotesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStagedQuotesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a StagedQuote exists for a given Query Predicate. Returns a `200 OK` status if any StagedQuotes match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyStagedQuotesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodHead) Where(v []string) *ByProjectKeyStagedQuotesRequestMethodHead

func (*ByProjectKeyStagedQuotesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesRequestMethodHead

func (*ByProjectKeyStagedQuotesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodHead) WithQueryParams(input ByProjectKeyStagedQuotesRequestMethodHeadInput) *ByProjectKeyStagedQuotesRequestMethodHead

type ByProjectKeyStagedQuotesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyStagedQuotesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyStagedQuotesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyStagedQuotesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyStagedQuotesRequestMethodPost ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStagedQuotesRequestMethodPost) Dump ¶ added in v1.2.0 

func (r *ByProjectKeyStagedQuotesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStagedQuotesRequestMethodPost) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodPost) Execute(ctx context.Context) (result *StagedQuote, err error)

func (*ByProjectKeyStagedQuotesRequestMethodPost) Expand ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodPost) Expand(v []string) *ByProjectKeyStagedQuotesRequestMethodPost

func (*ByProjectKeyStagedQuotesRequestMethodPost) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStagedQuotesRequestMethodPost

func (*ByProjectKeyStagedQuotesRequestMethodPost) WithQueryParams ¶ added in v1.2.0 

func (rb *ByProjectKeyStagedQuotesRequestMethodPost) WithQueryParams(input ByProjectKeyStagedQuotesRequestMethodPostInput) *ByProjectKeyStagedQuotesRequestMethodPost

type ByProjectKeyStagedQuotesRequestMethodPostInput ¶ added in v1.2.0 

type ByProjectKeyStagedQuotesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStagedQuotesRequestMethodPostInput) Values ¶ added in v1.2.0 

func (input *ByProjectKeyStagedQuotesRequestMethodPostInput) Values() url.Values

type ByProjectKeyStandalonePricesByIDRequestBuilder ¶ 

type ByProjectKeyStandalonePricesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestBuilder) Delete() *ByProjectKeyStandalonePricesByIDRequestMethodDelete

* * Produces the [StandalonePriceDeleted](ctp:api:type:StandalonePriceDeletedMessage) Message. *

func (*ByProjectKeyStandalonePricesByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestBuilder) Get() *ByProjectKeyStandalonePricesByIDRequestMethodGet

func (*ByProjectKeyStandalonePricesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesByIDRequestBuilder) Head() *ByProjectKeyStandalonePricesByIDRequestMethodHead

* * Checks if a StandalonePrice exists for a given `id`. Returns a `200 OK` status if the StandalonePrice exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStandalonePricesByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestBuilder) Post(body StandalonePriceUpdate) *ByProjectKeyStandalonePricesByIDRequestMethodPost

type ByProjectKeyStandalonePricesByIDRequestMethodDelete ¶ 

type ByProjectKeyStandalonePricesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyStandalonePricesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodDelete) Execute(ctx context.Context) (result *StandalonePrice, err error)

* * Produces the [StandalonePriceDeleted](ctp:api:type:StandalonePriceDeletedMessage) Message. *

func (*ByProjectKeyStandalonePricesByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyStandalonePricesByIDRequestMethodDelete

func (*ByProjectKeyStandalonePricesByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodDelete) Version(v int) *ByProjectKeyStandalonePricesByIDRequestMethodDelete

func (*ByProjectKeyStandalonePricesByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesByIDRequestMethodDelete

func (*ByProjectKeyStandalonePricesByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyStandalonePricesByIDRequestMethodDeleteInput) *ByProjectKeyStandalonePricesByIDRequestMethodDelete

type ByProjectKeyStandalonePricesByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyStandalonePricesByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyStandalonePricesByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyStandalonePricesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyStandalonePricesByIDRequestMethodGet ¶ 

type ByProjectKeyStandalonePricesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyStandalonePricesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodGet) Execute(ctx context.Context) (result *StandalonePrice, err error)

func (*ByProjectKeyStandalonePricesByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyStandalonePricesByIDRequestMethodGet

func (*ByProjectKeyStandalonePricesByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesByIDRequestMethodGet

func (*ByProjectKeyStandalonePricesByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyStandalonePricesByIDRequestMethodGetInput) *ByProjectKeyStandalonePricesByIDRequestMethodGet

type ByProjectKeyStandalonePricesByIDRequestMethodGetInput ¶ 

type ByProjectKeyStandalonePricesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyStandalonePricesByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyStandalonePricesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyStandalonePricesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStandalonePricesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStandalonePricesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a StandalonePrice exists for a given `id`. Returns a `200 OK` status if the StandalonePrice exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStandalonePricesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesByIDRequestMethodHead

type ByProjectKeyStandalonePricesByIDRequestMethodPost ¶ 

type ByProjectKeyStandalonePricesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyStandalonePricesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodPost) Execute(ctx context.Context) (result *StandalonePrice, err error)

func (*ByProjectKeyStandalonePricesByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyStandalonePricesByIDRequestMethodPost

func (*ByProjectKeyStandalonePricesByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesByIDRequestMethodPost

func (*ByProjectKeyStandalonePricesByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyStandalonePricesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyStandalonePricesByIDRequestMethodPostInput) *ByProjectKeyStandalonePricesByIDRequestMethodPost

type ByProjectKeyStandalonePricesByIDRequestMethodPostInput ¶ 

type ByProjectKeyStandalonePricesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStandalonePricesByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyStandalonePricesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyStandalonePricesKeyByKeyRequestBuilder ¶ 

type ByProjectKeyStandalonePricesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestBuilder) Delete() *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete

* * Produces the [StandalonePriceDeleted](ctp:api:type:StandalonePriceDeletedMessage) Message. *

func (*ByProjectKeyStandalonePricesKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestBuilder) Get() *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet

func (*ByProjectKeyStandalonePricesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestBuilder) Head() *ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead

* * Checks if a StandalonePrice exists for a given `key`. Returns a `200 OK` status if the StandalonePrice exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStandalonePricesKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestBuilder) Post(body StandalonePriceUpdate) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *StandalonePrice, err error)

* * Produces the [StandalonePriceDeleted](ctp:api:type:StandalonePriceDeletedMessage) Message. *

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyStandalonePricesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDelete

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyStandalonePricesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *StandalonePrice, err error)

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyStandalonePricesKeyByKeyRequestMethodGetInput) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGet

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyStandalonePricesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a StandalonePrice exists for a given `key`. Returns a `200 OK` status if the StandalonePrice exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodHead

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *StandalonePrice, err error)

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyStandalonePricesKeyByKeyRequestMethodPostInput) *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPost

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyStandalonePricesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStandalonePricesKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyStandalonePricesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyStandalonePricesRequestBuilder ¶ 

type ByProjectKeyStandalonePricesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesRequestBuilder) Get ¶ 

func (rb *ByProjectKeyStandalonePricesRequestBuilder) Get() *ByProjectKeyStandalonePricesRequestMethodGet

func (*ByProjectKeyStandalonePricesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesRequestBuilder) Head() *ByProjectKeyStandalonePricesRequestMethodHead

* * Checks if a StandalonePrice exists for a given Query Predicate. Returns a `200 OK` status if any StandalonePrices match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyStandalonePricesRequestBuilder) Post ¶ 

func (rb *ByProjectKeyStandalonePricesRequestBuilder) Post(body StandalonePriceDraft) *ByProjectKeyStandalonePricesRequestMethodPost

* * Produces the [StandalonePriceCreated](ctp:api:type:StandalonePriceCreatedMessage) Message. *

func (*ByProjectKeyStandalonePricesRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyStandalonePricesRequestBuilder) WithId(id string) *ByProjectKeyStandalonePricesByIDRequestBuilder

func (*ByProjectKeyStandalonePricesRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyStandalonePricesRequestBuilder) WithKey(key string) *ByProjectKeyStandalonePricesKeyByKeyRequestBuilder

type ByProjectKeyStandalonePricesRequestMethodGet ¶ 

type ByProjectKeyStandalonePricesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyStandalonePricesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) Execute(ctx context.Context) (result *StandalonePricePagedQueryResponse, err error)

func (*ByProjectKeyStandalonePricesRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) Expand(v []string) *ByProjectKeyStandalonePricesRequestMethodGet

func (*ByProjectKeyStandalonePricesRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) Limit(v int) *ByProjectKeyStandalonePricesRequestMethodGet

func (*ByProjectKeyStandalonePricesRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) Offset(v int) *ByProjectKeyStandalonePricesRequestMethodGet

func (*ByProjectKeyStandalonePricesRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyStandalonePricesRequestMethodGet

func (*ByProjectKeyStandalonePricesRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) Sort(v []string) *ByProjectKeyStandalonePricesRequestMethodGet

func (*ByProjectKeyStandalonePricesRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) Where(v []string) *ByProjectKeyStandalonePricesRequestMethodGet

func (*ByProjectKeyStandalonePricesRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesRequestMethodGet

func (*ByProjectKeyStandalonePricesRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) WithQueryParams(input ByProjectKeyStandalonePricesRequestMethodGetInput) *ByProjectKeyStandalonePricesRequestMethodGet

func (*ByProjectKeyStandalonePricesRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodGet) WithTotal(v bool) *ByProjectKeyStandalonePricesRequestMethodGet

type ByProjectKeyStandalonePricesRequestMethodGetInput ¶ 

type ByProjectKeyStandalonePricesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyStandalonePricesRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyStandalonePricesRequestMethodGetInput) Values() url.Values

type ByProjectKeyStandalonePricesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStandalonePricesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStandalonePricesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a StandalonePrice exists for a given Query Predicate. Returns a `200 OK` status if any StandalonePrices match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyStandalonePricesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesRequestMethodHead) Where(v []string) *ByProjectKeyStandalonePricesRequestMethodHead

func (*ByProjectKeyStandalonePricesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesRequestMethodHead

func (*ByProjectKeyStandalonePricesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyStandalonePricesRequestMethodHead) WithQueryParams(input ByProjectKeyStandalonePricesRequestMethodHeadInput) *ByProjectKeyStandalonePricesRequestMethodHead

type ByProjectKeyStandalonePricesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyStandalonePricesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyStandalonePricesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyStandalonePricesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyStandalonePricesRequestMethodPost ¶ 

type ByProjectKeyStandalonePricesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStandalonePricesRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyStandalonePricesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStandalonePricesRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodPost) Execute(ctx context.Context) (result *StandalonePrice, err error)

* * Produces the [StandalonePriceCreated](ctp:api:type:StandalonePriceCreatedMessage) Message. *

func (*ByProjectKeyStandalonePricesRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodPost) Expand(v []string) *ByProjectKeyStandalonePricesRequestMethodPost

func (*ByProjectKeyStandalonePricesRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStandalonePricesRequestMethodPost

func (*ByProjectKeyStandalonePricesRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyStandalonePricesRequestMethodPost) WithQueryParams(input ByProjectKeyStandalonePricesRequestMethodPostInput) *ByProjectKeyStandalonePricesRequestMethodPost

type ByProjectKeyStandalonePricesRequestMethodPostInput ¶ 

type ByProjectKeyStandalonePricesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStandalonePricesRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyStandalonePricesRequestMethodPostInput) Values() url.Values

type ByProjectKeyStatesByIDRequestBuilder ¶ 

type ByProjectKeyStatesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyStatesByIDRequestBuilder) Delete() *ByProjectKeyStatesByIDRequestMethodDelete

func (*ByProjectKeyStatesByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyStatesByIDRequestBuilder) Get() *ByProjectKeyStatesByIDRequestMethodGet

func (*ByProjectKeyStatesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesByIDRequestBuilder) Head() *ByProjectKeyStatesByIDRequestMethodHead

* * Checks if a State exists for a given `id`. Returns a `200 OK` status if the State exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStatesByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyStatesByIDRequestBuilder) Post(body StateUpdate) *ByProjectKeyStatesByIDRequestMethodPost

type ByProjectKeyStatesByIDRequestMethodDelete ¶ 

type ByProjectKeyStatesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyStatesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyStatesByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodDelete) Execute(ctx context.Context) (result *State, err error)

func (*ByProjectKeyStatesByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyStatesByIDRequestMethodDelete

func (*ByProjectKeyStatesByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodDelete) Version(v int) *ByProjectKeyStatesByIDRequestMethodDelete

func (*ByProjectKeyStatesByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyStatesByIDRequestMethodDelete

func (*ByProjectKeyStatesByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyStatesByIDRequestMethodDeleteInput) *ByProjectKeyStatesByIDRequestMethodDelete

type ByProjectKeyStatesByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyStatesByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyStatesByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyStatesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyStatesByIDRequestMethodGet ¶ 

type ByProjectKeyStatesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyStatesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStatesByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodGet) Execute(ctx context.Context) (result *State, err error)

func (*ByProjectKeyStatesByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyStatesByIDRequestMethodGet

func (*ByProjectKeyStatesByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStatesByIDRequestMethodGet

func (*ByProjectKeyStatesByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyStatesByIDRequestMethodGetInput) *ByProjectKeyStatesByIDRequestMethodGet

type ByProjectKeyStatesByIDRequestMethodGetInput ¶ 

type ByProjectKeyStatesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyStatesByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyStatesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyStatesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStatesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStatesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStatesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a State exists for a given `id`. Returns a `200 OK` status if the State exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStatesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStatesByIDRequestMethodHead

type ByProjectKeyStatesByIDRequestMethodPost ¶ 

type ByProjectKeyStatesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyStatesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStatesByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodPost) Execute(ctx context.Context) (result *State, err error)

func (*ByProjectKeyStatesByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyStatesByIDRequestMethodPost

func (*ByProjectKeyStatesByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStatesByIDRequestMethodPost

func (*ByProjectKeyStatesByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyStatesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyStatesByIDRequestMethodPostInput) *ByProjectKeyStatesByIDRequestMethodPost

type ByProjectKeyStatesByIDRequestMethodPostInput ¶ 

type ByProjectKeyStatesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStatesByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyStatesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyStatesKeyByKeyRequestBuilder ¶ 

type ByProjectKeyStatesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestBuilder) Delete() *ByProjectKeyStatesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStatesKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestBuilder) Get() *ByProjectKeyStatesKeyByKeyRequestMethodGet

func (*ByProjectKeyStatesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesKeyByKeyRequestBuilder) Head() *ByProjectKeyStatesKeyByKeyRequestMethodHead

* * Checks if a State exists for a given `key`. Returns a `200 OK` status if the State exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStatesKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestBuilder) Post(body StateUpdate) *ByProjectKeyStatesKeyByKeyRequestMethodPost

type ByProjectKeyStatesKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyStatesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyStatesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyStatesKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *State, err error)

func (*ByProjectKeyStatesKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyStatesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStatesKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyStatesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStatesKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyStatesKeyByKeyRequestMethodDelete

func (*ByProjectKeyStatesKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyStatesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyStatesKeyByKeyRequestMethodDelete

type ByProjectKeyStatesKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyStatesKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyStatesKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyStatesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyStatesKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyStatesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyStatesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStatesKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *State, err error)

func (*ByProjectKeyStatesKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyStatesKeyByKeyRequestMethodGet

func (*ByProjectKeyStatesKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStatesKeyByKeyRequestMethodGet

func (*ByProjectKeyStatesKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyStatesKeyByKeyRequestMethodGetInput) *ByProjectKeyStatesKeyByKeyRequestMethodGet

type ByProjectKeyStatesKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyStatesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyStatesKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyStatesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyStatesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStatesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStatesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStatesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a State exists for a given `key`. Returns a `200 OK` status if the State exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStatesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStatesKeyByKeyRequestMethodHead

type ByProjectKeyStatesKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyStatesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyStatesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStatesKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *State, err error)

func (*ByProjectKeyStatesKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyStatesKeyByKeyRequestMethodPost

func (*ByProjectKeyStatesKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStatesKeyByKeyRequestMethodPost

func (*ByProjectKeyStatesKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyStatesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyStatesKeyByKeyRequestMethodPostInput) *ByProjectKeyStatesKeyByKeyRequestMethodPost

type ByProjectKeyStatesKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyStatesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStatesKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyStatesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyStatesRequestBuilder ¶ 

type ByProjectKeyStatesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesRequestBuilder) Get ¶ 

func (rb *ByProjectKeyStatesRequestBuilder) Get() *ByProjectKeyStatesRequestMethodGet

func (*ByProjectKeyStatesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesRequestBuilder) Head() *ByProjectKeyStatesRequestMethodHead

* * Checks if a State exists for a given Query Predicate. Returns a `200 OK` status if any States match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyStatesRequestBuilder) Post ¶ 

func (rb *ByProjectKeyStatesRequestBuilder) Post(body StateDraft) *ByProjectKeyStatesRequestMethodPost

func (*ByProjectKeyStatesRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyStatesRequestBuilder) WithId(id string) *ByProjectKeyStatesByIDRequestBuilder

func (*ByProjectKeyStatesRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyStatesRequestBuilder) WithKey(key string) *ByProjectKeyStatesKeyByKeyRequestBuilder

type ByProjectKeyStatesRequestMethodGet ¶ 

type ByProjectKeyStatesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyStatesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStatesRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) Execute(ctx context.Context) (result *StatePagedQueryResponse, err error)

func (*ByProjectKeyStatesRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) Expand(v []string) *ByProjectKeyStatesRequestMethodGet

func (*ByProjectKeyStatesRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) Limit(v int) *ByProjectKeyStatesRequestMethodGet

func (*ByProjectKeyStatesRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) Offset(v int) *ByProjectKeyStatesRequestMethodGet

func (*ByProjectKeyStatesRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyStatesRequestMethodGet

func (*ByProjectKeyStatesRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) Sort(v []string) *ByProjectKeyStatesRequestMethodGet

func (*ByProjectKeyStatesRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) Where(v []string) *ByProjectKeyStatesRequestMethodGet

func (*ByProjectKeyStatesRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStatesRequestMethodGet

func (*ByProjectKeyStatesRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) WithQueryParams(input ByProjectKeyStatesRequestMethodGetInput) *ByProjectKeyStatesRequestMethodGet

func (*ByProjectKeyStatesRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyStatesRequestMethodGet) WithTotal(v bool) *ByProjectKeyStatesRequestMethodGet

type ByProjectKeyStatesRequestMethodGetInput ¶ 

type ByProjectKeyStatesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyStatesRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyStatesRequestMethodGetInput) Values() url.Values

type ByProjectKeyStatesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStatesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStatesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStatesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a State exists for a given Query Predicate. Returns a `200 OK` status if any States match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyStatesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesRequestMethodHead) Where(v []string) *ByProjectKeyStatesRequestMethodHead

func (*ByProjectKeyStatesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStatesRequestMethodHead

func (*ByProjectKeyStatesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyStatesRequestMethodHead) WithQueryParams(input ByProjectKeyStatesRequestMethodHeadInput) *ByProjectKeyStatesRequestMethodHead

type ByProjectKeyStatesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyStatesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyStatesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyStatesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyStatesRequestMethodPost ¶ 

type ByProjectKeyStatesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStatesRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyStatesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStatesRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyStatesRequestMethodPost) Execute(ctx context.Context) (result *State, err error)

func (*ByProjectKeyStatesRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyStatesRequestMethodPost) Expand(v []string) *ByProjectKeyStatesRequestMethodPost

func (*ByProjectKeyStatesRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyStatesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStatesRequestMethodPost

func (*ByProjectKeyStatesRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyStatesRequestMethodPost) WithQueryParams(input ByProjectKeyStatesRequestMethodPostInput) *ByProjectKeyStatesRequestMethodPost

type ByProjectKeyStatesRequestMethodPostInput ¶ 

type ByProjectKeyStatesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStatesRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyStatesRequestMethodPostInput) Values() url.Values

type ByProjectKeyStoresByIDRequestBuilder ¶ 

type ByProjectKeyStoresByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyStoresByIDRequestBuilder) Delete() *ByProjectKeyStoresByIDRequestMethodDelete

func (*ByProjectKeyStoresByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyStoresByIDRequestBuilder) Get() *ByProjectKeyStoresByIDRequestMethodGet

func (*ByProjectKeyStoresByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresByIDRequestBuilder) Head() *ByProjectKeyStoresByIDRequestMethodHead

* * Checks if a Store exists for a given `id`. Returns a `200 OK` status if the Store exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStoresByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyStoresByIDRequestBuilder) Post(body StoreUpdate) *ByProjectKeyStoresByIDRequestMethodPost

type ByProjectKeyStoresByIDRequestMethodDelete ¶ 

type ByProjectKeyStoresByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyStoresByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyStoresByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodDelete) Execute(ctx context.Context) (result *Store, err error)

func (*ByProjectKeyStoresByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyStoresByIDRequestMethodDelete

func (*ByProjectKeyStoresByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodDelete) Version(v int) *ByProjectKeyStoresByIDRequestMethodDelete

func (*ByProjectKeyStoresByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyStoresByIDRequestMethodDelete

func (*ByProjectKeyStoresByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyStoresByIDRequestMethodDeleteInput) *ByProjectKeyStoresByIDRequestMethodDelete

type ByProjectKeyStoresByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyStoresByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyStoresByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyStoresByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyStoresByIDRequestMethodGet ¶ 

type ByProjectKeyStoresByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyStoresByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStoresByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodGet) Execute(ctx context.Context) (result *Store, err error)

func (*ByProjectKeyStoresByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodGet) Expand(v []string) *ByProjectKeyStoresByIDRequestMethodGet

func (*ByProjectKeyStoresByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStoresByIDRequestMethodGet

func (*ByProjectKeyStoresByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodGet) WithQueryParams(input ByProjectKeyStoresByIDRequestMethodGetInput) *ByProjectKeyStoresByIDRequestMethodGet

type ByProjectKeyStoresByIDRequestMethodGetInput ¶ 

type ByProjectKeyStoresByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyStoresByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyStoresByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyStoresByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStoresByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStoresByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStoresByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Store exists for a given `id`. Returns a `200 OK` status if the Store exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStoresByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStoresByIDRequestMethodHead

type ByProjectKeyStoresByIDRequestMethodPost ¶ 

type ByProjectKeyStoresByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyStoresByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStoresByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodPost) Execute(ctx context.Context) (result *Store, err error)

func (*ByProjectKeyStoresByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodPost) Expand(v []string) *ByProjectKeyStoresByIDRequestMethodPost

func (*ByProjectKeyStoresByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStoresByIDRequestMethodPost

func (*ByProjectKeyStoresByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyStoresByIDRequestMethodPost) WithQueryParams(input ByProjectKeyStoresByIDRequestMethodPostInput) *ByProjectKeyStoresByIDRequestMethodPost

type ByProjectKeyStoresByIDRequestMethodPostInput ¶ 

type ByProjectKeyStoresByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStoresByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyStoresByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyStoresKeyByKeyRequestBuilder ¶ 

type ByProjectKeyStoresKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestBuilder) Delete() *ByProjectKeyStoresKeyByKeyRequestMethodDelete

func (*ByProjectKeyStoresKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestBuilder) Get() *ByProjectKeyStoresKeyByKeyRequestMethodGet

func (*ByProjectKeyStoresKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresKeyByKeyRequestBuilder) Head() *ByProjectKeyStoresKeyByKeyRequestMethodHead

* * Checks if a Store exists for a given `key`. Returns a `200 OK` status if the Store exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStoresKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestBuilder) Post(body StoreUpdate) *ByProjectKeyStoresKeyByKeyRequestMethodPost

type ByProjectKeyStoresKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyStoresKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyStoresKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyStoresKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Store, err error)

func (*ByProjectKeyStoresKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyStoresKeyByKeyRequestMethodDelete

func (*ByProjectKeyStoresKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyStoresKeyByKeyRequestMethodDelete

func (*ByProjectKeyStoresKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyStoresKeyByKeyRequestMethodDelete

func (*ByProjectKeyStoresKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyStoresKeyByKeyRequestMethodDeleteInput) *ByProjectKeyStoresKeyByKeyRequestMethodDelete

type ByProjectKeyStoresKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyStoresKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyStoresKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyStoresKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyStoresKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyStoresKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyStoresKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStoresKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Store, err error)

func (*ByProjectKeyStoresKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyStoresKeyByKeyRequestMethodGet

func (*ByProjectKeyStoresKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStoresKeyByKeyRequestMethodGet

func (*ByProjectKeyStoresKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyStoresKeyByKeyRequestMethodGetInput) *ByProjectKeyStoresKeyByKeyRequestMethodGet

type ByProjectKeyStoresKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyStoresKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyStoresKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyStoresKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyStoresKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStoresKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStoresKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStoresKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Store exists for a given `key`. Returns a `200 OK` status if the Store exists or a `404 Not Found` otherwise.

func (*ByProjectKeyStoresKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStoresKeyByKeyRequestMethodHead

type ByProjectKeyStoresKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyStoresKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyStoresKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStoresKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Store, err error)

func (*ByProjectKeyStoresKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyStoresKeyByKeyRequestMethodPost

func (*ByProjectKeyStoresKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStoresKeyByKeyRequestMethodPost

func (*ByProjectKeyStoresKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyStoresKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyStoresKeyByKeyRequestMethodPostInput) *ByProjectKeyStoresKeyByKeyRequestMethodPost

type ByProjectKeyStoresKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyStoresKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStoresKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyStoresKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyStoresRequestBuilder ¶ 

type ByProjectKeyStoresRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresRequestBuilder) Get ¶ 

func (rb *ByProjectKeyStoresRequestBuilder) Get() *ByProjectKeyStoresRequestMethodGet

func (*ByProjectKeyStoresRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresRequestBuilder) Head() *ByProjectKeyStoresRequestMethodHead

* * Checks if a Store exists for a given Query Predicate. Returns a `200 OK` status if any Stores match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyStoresRequestBuilder) Post ¶ 

func (rb *ByProjectKeyStoresRequestBuilder) Post(body StoreDraft) *ByProjectKeyStoresRequestMethodPost

func (*ByProjectKeyStoresRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyStoresRequestBuilder) WithId(id string) *ByProjectKeyStoresByIDRequestBuilder

func (*ByProjectKeyStoresRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyStoresRequestBuilder) WithKey(key string) *ByProjectKeyStoresKeyByKeyRequestBuilder

type ByProjectKeyStoresRequestMethodGet ¶ 

type ByProjectKeyStoresRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyStoresRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyStoresRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) Execute(ctx context.Context) (result *StorePagedQueryResponse, err error)

func (*ByProjectKeyStoresRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) Expand(v []string) *ByProjectKeyStoresRequestMethodGet

func (*ByProjectKeyStoresRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) Limit(v int) *ByProjectKeyStoresRequestMethodGet

func (*ByProjectKeyStoresRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) Offset(v int) *ByProjectKeyStoresRequestMethodGet

func (*ByProjectKeyStoresRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyStoresRequestMethodGet

func (*ByProjectKeyStoresRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) Sort(v []string) *ByProjectKeyStoresRequestMethodGet

func (*ByProjectKeyStoresRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) Where(v []string) *ByProjectKeyStoresRequestMethodGet

func (*ByProjectKeyStoresRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyStoresRequestMethodGet

func (*ByProjectKeyStoresRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) WithQueryParams(input ByProjectKeyStoresRequestMethodGetInput) *ByProjectKeyStoresRequestMethodGet

func (*ByProjectKeyStoresRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyStoresRequestMethodGet) WithTotal(v bool) *ByProjectKeyStoresRequestMethodGet

type ByProjectKeyStoresRequestMethodGetInput ¶ 

type ByProjectKeyStoresRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyStoresRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyStoresRequestMethodGetInput) Values() url.Values

type ByProjectKeyStoresRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyStoresRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyStoresRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyStoresRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Store exists for a given Query Predicate. Returns a `200 OK` status if any Stores match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyStoresRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresRequestMethodHead) Where(v []string) *ByProjectKeyStoresRequestMethodHead

func (*ByProjectKeyStoresRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyStoresRequestMethodHead

func (*ByProjectKeyStoresRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyStoresRequestMethodHead) WithQueryParams(input ByProjectKeyStoresRequestMethodHeadInput) *ByProjectKeyStoresRequestMethodHead

type ByProjectKeyStoresRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyStoresRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyStoresRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyStoresRequestMethodHeadInput) Values() url.Values

type ByProjectKeyStoresRequestMethodPost ¶ 

type ByProjectKeyStoresRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyStoresRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyStoresRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyStoresRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyStoresRequestMethodPost) Execute(ctx context.Context) (result *Store, err error)

func (*ByProjectKeyStoresRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyStoresRequestMethodPost) Expand(v []string) *ByProjectKeyStoresRequestMethodPost

func (*ByProjectKeyStoresRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyStoresRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyStoresRequestMethodPost

func (*ByProjectKeyStoresRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyStoresRequestMethodPost) WithQueryParams(input ByProjectKeyStoresRequestMethodPostInput) *ByProjectKeyStoresRequestMethodPost

type ByProjectKeyStoresRequestMethodPostInput ¶ 

type ByProjectKeyStoresRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyStoresRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyStoresRequestMethodPostInput) Values() url.Values

type ByProjectKeySubscriptionsByIDHealthRequestBuilder ¶ added in v1.2.0 

type ByProjectKeySubscriptionsByIDHealthRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsByIDHealthRequestBuilder) Get ¶ added in v1.2.0 

func (rb *ByProjectKeySubscriptionsByIDHealthRequestBuilder) Get() *ByProjectKeySubscriptionsByIDHealthRequestMethodGet

* * This endpoint can be polled by a monitoring or alerting system that checks the health of your Subscriptions. To ease integration with such systems this endpoint does not require [Authorization](/../api/authorization). *

type ByProjectKeySubscriptionsByIDHealthRequestMethodGet ¶ added in v1.2.0 

type ByProjectKeySubscriptionsByIDHealthRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsByIDHealthRequestMethodGet) Dump ¶ added in v1.2.0 

func (r *ByProjectKeySubscriptionsByIDHealthRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsByIDHealthRequestMethodGet) Execute ¶ added in v1.2.0 

func (rb *ByProjectKeySubscriptionsByIDHealthRequestMethodGet) Execute(ctx context.Context) error

* * This endpoint can be polled by a monitoring or alerting system that checks the health of your Subscriptions. To ease integration with such systems this endpoint does not require [Authorization](/../api/authorization). *

func (*ByProjectKeySubscriptionsByIDHealthRequestMethodGet) WithHeaders ¶ added in v1.2.0 

func (rb *ByProjectKeySubscriptionsByIDHealthRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsByIDHealthRequestMethodGet

type ByProjectKeySubscriptionsByIDRequestBuilder ¶ 

type ByProjectKeySubscriptionsByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestBuilder) Delete() *ByProjectKeySubscriptionsByIDRequestMethodDelete

func (*ByProjectKeySubscriptionsByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestBuilder) Get() *ByProjectKeySubscriptionsByIDRequestMethodGet

func (*ByProjectKeySubscriptionsByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsByIDRequestBuilder) Head() *ByProjectKeySubscriptionsByIDRequestMethodHead

* * Checks if a Subscription exists for a given `id`. Returns a `200 OK` status if the Subscription exists or a `404 Not Found` otherwise.

func (*ByProjectKeySubscriptionsByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestBuilder) Post(body SubscriptionUpdate) *ByProjectKeySubscriptionsByIDRequestMethodPost

func (*ByProjectKeySubscriptionsByIDRequestBuilder) WithIdHealth ¶ added in v1.2.0 

func (rb *ByProjectKeySubscriptionsByIDRequestBuilder) WithIdHealth() *ByProjectKeySubscriptionsByIDHealthRequestBuilder

type ByProjectKeySubscriptionsByIDRequestMethodDelete ¶ 

type ByProjectKeySubscriptionsByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeySubscriptionsByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodDelete) Execute(ctx context.Context) (result *Subscription, err error)

func (*ByProjectKeySubscriptionsByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodDelete) Version(v int) *ByProjectKeySubscriptionsByIDRequestMethodDelete

func (*ByProjectKeySubscriptionsByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsByIDRequestMethodDelete

func (*ByProjectKeySubscriptionsByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodDelete) WithQueryParams(input ByProjectKeySubscriptionsByIDRequestMethodDeleteInput) *ByProjectKeySubscriptionsByIDRequestMethodDelete

type ByProjectKeySubscriptionsByIDRequestMethodDeleteInput ¶ 

type ByProjectKeySubscriptionsByIDRequestMethodDeleteInput struct {
	Version int
}

func (*ByProjectKeySubscriptionsByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeySubscriptionsByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeySubscriptionsByIDRequestMethodGet ¶ 

type ByProjectKeySubscriptionsByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeySubscriptionsByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodGet) Execute(ctx context.Context) (result *Subscription, err error)

func (*ByProjectKeySubscriptionsByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsByIDRequestMethodGet

type ByProjectKeySubscriptionsByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeySubscriptionsByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeySubscriptionsByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Subscription exists for a given `id`. Returns a `200 OK` status if the Subscription exists or a `404 Not Found` otherwise.

func (*ByProjectKeySubscriptionsByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsByIDRequestMethodHead

type ByProjectKeySubscriptionsByIDRequestMethodPost ¶ 

type ByProjectKeySubscriptionsByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeySubscriptionsByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodPost) Execute(ctx context.Context) (result *Subscription, err error)

func (*ByProjectKeySubscriptionsByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeySubscriptionsByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsByIDRequestMethodPost

type ByProjectKeySubscriptionsKeyByKeyRequestBuilder ¶ 

type ByProjectKeySubscriptionsKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestBuilder) Delete() *ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete

func (*ByProjectKeySubscriptionsKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestBuilder) Get() *ByProjectKeySubscriptionsKeyByKeyRequestMethodGet

func (*ByProjectKeySubscriptionsKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestBuilder) Head() *ByProjectKeySubscriptionsKeyByKeyRequestMethodHead

* * Checks if a Subscription exists for a given `key`. Returns a `200 OK` status if the Subscription exists or a `404 Not Found` otherwise.

func (*ByProjectKeySubscriptionsKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestBuilder) Post(body SubscriptionUpdate) *ByProjectKeySubscriptionsKeyByKeyRequestMethodPost

type ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Subscription, err error)

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeySubscriptionsKeyByKeyRequestMethodDeleteInput) *ByProjectKeySubscriptionsKeyByKeyRequestMethodDelete

type ByProjectKeySubscriptionsKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeySubscriptionsKeyByKeyRequestMethodDeleteInput struct {
	Version int
}

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeySubscriptionsKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeySubscriptionsKeyByKeyRequestMethodGet ¶ 

type ByProjectKeySubscriptionsKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeySubscriptionsKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Subscription, err error)

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsKeyByKeyRequestMethodGet

type ByProjectKeySubscriptionsKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeySubscriptionsKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeySubscriptionsKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Subscription exists for a given `key`. Returns a `200 OK` status if the Subscription exists or a `404 Not Found` otherwise.

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsKeyByKeyRequestMethodHead

type ByProjectKeySubscriptionsKeyByKeyRequestMethodPost ¶ 

type ByProjectKeySubscriptionsKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeySubscriptionsKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Subscription, err error)

func (*ByProjectKeySubscriptionsKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeySubscriptionsKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsKeyByKeyRequestMethodPost

type ByProjectKeySubscriptionsRequestBuilder ¶ 

type ByProjectKeySubscriptionsRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsRequestBuilder) Get ¶ 

func (rb *ByProjectKeySubscriptionsRequestBuilder) Get() *ByProjectKeySubscriptionsRequestMethodGet

func (*ByProjectKeySubscriptionsRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsRequestBuilder) Head() *ByProjectKeySubscriptionsRequestMethodHead

* * Checks if a Subscription exists for a given Query Predicate. Returns a `200 OK` status if any Subscriptions match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeySubscriptionsRequestBuilder) Post ¶ 

func (rb *ByProjectKeySubscriptionsRequestBuilder) Post(body SubscriptionDraft) *ByProjectKeySubscriptionsRequestMethodPost

* * A test message is sent to ensure the correct configuration of the Destination. If the message cannot be delivered, the Subscription will not be created. The payload of the test message is a notification of type [ResourceCreated](/../api/projects/subscriptions#resourcecreateddeliverypayload) for the `resourceTypeId` `subscription`. *

func (*ByProjectKeySubscriptionsRequestBuilder) WithId ¶ 

func (rb *ByProjectKeySubscriptionsRequestBuilder) WithId(id string) *ByProjectKeySubscriptionsByIDRequestBuilder

func (*ByProjectKeySubscriptionsRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeySubscriptionsRequestBuilder) WithKey(key string) *ByProjectKeySubscriptionsKeyByKeyRequestBuilder

type ByProjectKeySubscriptionsRequestMethodGet ¶ 

type ByProjectKeySubscriptionsRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsRequestMethodGet) Dump ¶ 

func (r *ByProjectKeySubscriptionsRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodGet) Execute(ctx context.Context) (result *SubscriptionPagedQueryResponse, err error)

func (*ByProjectKeySubscriptionsRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodGet) Limit(v int) *ByProjectKeySubscriptionsRequestMethodGet

func (*ByProjectKeySubscriptionsRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodGet) Offset(v int) *ByProjectKeySubscriptionsRequestMethodGet

func (*ByProjectKeySubscriptionsRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeySubscriptionsRequestMethodGet

func (*ByProjectKeySubscriptionsRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodGet) Sort(v []string) *ByProjectKeySubscriptionsRequestMethodGet

func (*ByProjectKeySubscriptionsRequestMethodGet) Where ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodGet) Where(v []string) *ByProjectKeySubscriptionsRequestMethodGet

func (*ByProjectKeySubscriptionsRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsRequestMethodGet

func (*ByProjectKeySubscriptionsRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodGet) WithQueryParams(input ByProjectKeySubscriptionsRequestMethodGetInput) *ByProjectKeySubscriptionsRequestMethodGet

func (*ByProjectKeySubscriptionsRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodGet) WithTotal(v bool) *ByProjectKeySubscriptionsRequestMethodGet

type ByProjectKeySubscriptionsRequestMethodGetInput ¶ 

type ByProjectKeySubscriptionsRequestMethodGetInput struct {
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeySubscriptionsRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeySubscriptionsRequestMethodGetInput) Values() url.Values

type ByProjectKeySubscriptionsRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeySubscriptionsRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeySubscriptionsRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Subscription exists for a given Query Predicate. Returns a `200 OK` status if any Subscriptions match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeySubscriptionsRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsRequestMethodHead) Where(v []string) *ByProjectKeySubscriptionsRequestMethodHead

func (*ByProjectKeySubscriptionsRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsRequestMethodHead

func (*ByProjectKeySubscriptionsRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeySubscriptionsRequestMethodHead) WithQueryParams(input ByProjectKeySubscriptionsRequestMethodHeadInput) *ByProjectKeySubscriptionsRequestMethodHead

type ByProjectKeySubscriptionsRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeySubscriptionsRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeySubscriptionsRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeySubscriptionsRequestMethodHeadInput) Values() url.Values

type ByProjectKeySubscriptionsRequestMethodPost ¶ 

type ByProjectKeySubscriptionsRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeySubscriptionsRequestMethodPost) Dump ¶ 

func (r *ByProjectKeySubscriptionsRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeySubscriptionsRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodPost) Execute(ctx context.Context) (result *Subscription, err error)

* * A test message is sent to ensure the correct configuration of the Destination. If the message cannot be delivered, the Subscription will not be created. The payload of the test message is a notification of type [ResourceCreated](/../api/projects/subscriptions#resourcecreateddeliverypayload) for the `resourceTypeId` `subscription`. *

func (*ByProjectKeySubscriptionsRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeySubscriptionsRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeySubscriptionsRequestMethodPost

type ByProjectKeyTaxCategoriesByIDRequestBuilder ¶ 

type ByProjectKeyTaxCategoriesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestBuilder) Delete() *ByProjectKeyTaxCategoriesByIDRequestMethodDelete

func (*ByProjectKeyTaxCategoriesByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestBuilder) Get() *ByProjectKeyTaxCategoriesByIDRequestMethodGet

func (*ByProjectKeyTaxCategoriesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesByIDRequestBuilder) Head() *ByProjectKeyTaxCategoriesByIDRequestMethodHead

* * Checks if a TaxCategory exists for a given `id`. Returns a `200 OK` status if the TaxCategory exists or a `404 Not Found` otherwise.

func (*ByProjectKeyTaxCategoriesByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestBuilder) Post(body TaxCategoryUpdate) *ByProjectKeyTaxCategoriesByIDRequestMethodPost

type ByProjectKeyTaxCategoriesByIDRequestMethodDelete ¶ 

type ByProjectKeyTaxCategoriesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyTaxCategoriesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodDelete) Execute(ctx context.Context) (result *TaxCategory, err error)

func (*ByProjectKeyTaxCategoriesByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyTaxCategoriesByIDRequestMethodDelete

func (*ByProjectKeyTaxCategoriesByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodDelete) Version(v int) *ByProjectKeyTaxCategoriesByIDRequestMethodDelete

func (*ByProjectKeyTaxCategoriesByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesByIDRequestMethodDelete

func (*ByProjectKeyTaxCategoriesByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyTaxCategoriesByIDRequestMethodDeleteInput) *ByProjectKeyTaxCategoriesByIDRequestMethodDelete

type ByProjectKeyTaxCategoriesByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyTaxCategoriesByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyTaxCategoriesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyTaxCategoriesByIDRequestMethodGet ¶ 

type ByProjectKeyTaxCategoriesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyTaxCategoriesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodGet) Execute(ctx context.Context) (result *TaxCategory, err error)

func (*ByProjectKeyTaxCategoriesByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyTaxCategoriesByIDRequestMethodGet

func (*ByProjectKeyTaxCategoriesByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesByIDRequestMethodGet

func (*ByProjectKeyTaxCategoriesByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyTaxCategoriesByIDRequestMethodGetInput) *ByProjectKeyTaxCategoriesByIDRequestMethodGet

type ByProjectKeyTaxCategoriesByIDRequestMethodGetInput ¶ 

type ByProjectKeyTaxCategoriesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyTaxCategoriesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyTaxCategoriesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyTaxCategoriesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyTaxCategoriesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a TaxCategory exists for a given `id`. Returns a `200 OK` status if the TaxCategory exists or a `404 Not Found` otherwise.

func (*ByProjectKeyTaxCategoriesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesByIDRequestMethodHead

type ByProjectKeyTaxCategoriesByIDRequestMethodPost ¶ 

type ByProjectKeyTaxCategoriesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyTaxCategoriesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodPost) Execute(ctx context.Context) (result *TaxCategory, err error)

func (*ByProjectKeyTaxCategoriesByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyTaxCategoriesByIDRequestMethodPost

func (*ByProjectKeyTaxCategoriesByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesByIDRequestMethodPost

func (*ByProjectKeyTaxCategoriesByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyTaxCategoriesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyTaxCategoriesByIDRequestMethodPostInput) *ByProjectKeyTaxCategoriesByIDRequestMethodPost

type ByProjectKeyTaxCategoriesByIDRequestMethodPostInput ¶ 

type ByProjectKeyTaxCategoriesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyTaxCategoriesByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyTaxCategoriesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder ¶ 

type ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder) Delete() *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder) Get() *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder) Head() *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead

* * Checks if a TaxCategory exists for a given `key`. Returns a `200 OK` status if the Tax Category exists or a `404 Not Found` otherwise.

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder) Post(body TaxCategoryUpdate) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *TaxCategory, err error)

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDelete

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *TaxCategory, err error)

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGetInput) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGet

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a TaxCategory exists for a given `key`. Returns a `200 OK` status if the Tax Category exists or a `404 Not Found` otherwise.

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodHead

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *TaxCategory, err error)

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPostInput) *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPost

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyTaxCategoriesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyTaxCategoriesRequestBuilder ¶ 

type ByProjectKeyTaxCategoriesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesRequestBuilder) Get ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestBuilder) Get() *ByProjectKeyTaxCategoriesRequestMethodGet

func (*ByProjectKeyTaxCategoriesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesRequestBuilder) Head() *ByProjectKeyTaxCategoriesRequestMethodHead

* * Checks if a TaxCategory exists for a given Query Predicate. Returns a `200 OK` status if any TaxCategories match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyTaxCategoriesRequestBuilder) Post ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestBuilder) Post(body TaxCategoryDraft) *ByProjectKeyTaxCategoriesRequestMethodPost

func (*ByProjectKeyTaxCategoriesRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestBuilder) WithId(id string) *ByProjectKeyTaxCategoriesByIDRequestBuilder

func (*ByProjectKeyTaxCategoriesRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestBuilder) WithKey(key string) *ByProjectKeyTaxCategoriesKeyByKeyRequestBuilder

type ByProjectKeyTaxCategoriesRequestMethodGet ¶ 

type ByProjectKeyTaxCategoriesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyTaxCategoriesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) Execute(ctx context.Context) (result *TaxCategoryPagedQueryResponse, err error)

func (*ByProjectKeyTaxCategoriesRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) Expand(v []string) *ByProjectKeyTaxCategoriesRequestMethodGet

func (*ByProjectKeyTaxCategoriesRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) Limit(v int) *ByProjectKeyTaxCategoriesRequestMethodGet

func (*ByProjectKeyTaxCategoriesRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) Offset(v int) *ByProjectKeyTaxCategoriesRequestMethodGet

func (*ByProjectKeyTaxCategoriesRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyTaxCategoriesRequestMethodGet

func (*ByProjectKeyTaxCategoriesRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) Sort(v []string) *ByProjectKeyTaxCategoriesRequestMethodGet

func (*ByProjectKeyTaxCategoriesRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) Where(v []string) *ByProjectKeyTaxCategoriesRequestMethodGet

func (*ByProjectKeyTaxCategoriesRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesRequestMethodGet

func (*ByProjectKeyTaxCategoriesRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) WithQueryParams(input ByProjectKeyTaxCategoriesRequestMethodGetInput) *ByProjectKeyTaxCategoriesRequestMethodGet

func (*ByProjectKeyTaxCategoriesRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodGet) WithTotal(v bool) *ByProjectKeyTaxCategoriesRequestMethodGet

type ByProjectKeyTaxCategoriesRequestMethodGetInput ¶ 

type ByProjectKeyTaxCategoriesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyTaxCategoriesRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyTaxCategoriesRequestMethodGetInput) Values() url.Values

type ByProjectKeyTaxCategoriesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyTaxCategoriesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyTaxCategoriesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a TaxCategory exists for a given Query Predicate. Returns a `200 OK` status if any TaxCategories match the Query Predicate, or a `404 Not Found` otherwise.

func (*ByProjectKeyTaxCategoriesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesRequestMethodHead) Where(v []string) *ByProjectKeyTaxCategoriesRequestMethodHead

func (*ByProjectKeyTaxCategoriesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesRequestMethodHead

func (*ByProjectKeyTaxCategoriesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyTaxCategoriesRequestMethodHead) WithQueryParams(input ByProjectKeyTaxCategoriesRequestMethodHeadInput) *ByProjectKeyTaxCategoriesRequestMethodHead

type ByProjectKeyTaxCategoriesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyTaxCategoriesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyTaxCategoriesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyTaxCategoriesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyTaxCategoriesRequestMethodPost ¶ 

type ByProjectKeyTaxCategoriesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTaxCategoriesRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyTaxCategoriesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyTaxCategoriesRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodPost) Execute(ctx context.Context) (result *TaxCategory, err error)

func (*ByProjectKeyTaxCategoriesRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodPost) Expand(v []string) *ByProjectKeyTaxCategoriesRequestMethodPost

func (*ByProjectKeyTaxCategoriesRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyTaxCategoriesRequestMethodPost

func (*ByProjectKeyTaxCategoriesRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyTaxCategoriesRequestMethodPost) WithQueryParams(input ByProjectKeyTaxCategoriesRequestMethodPostInput) *ByProjectKeyTaxCategoriesRequestMethodPost

type ByProjectKeyTaxCategoriesRequestMethodPostInput ¶ 

type ByProjectKeyTaxCategoriesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyTaxCategoriesRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyTaxCategoriesRequestMethodPostInput) Values() url.Values

type ByProjectKeyTypesByIDRequestBuilder ¶ 

type ByProjectKeyTypesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyTypesByIDRequestBuilder) Delete() *ByProjectKeyTypesByIDRequestMethodDelete

func (*ByProjectKeyTypesByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyTypesByIDRequestBuilder) Get() *ByProjectKeyTypesByIDRequestMethodGet

func (*ByProjectKeyTypesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesByIDRequestBuilder) Head() *ByProjectKeyTypesByIDRequestMethodHead

* * Checks if a Type exists for a given `id`. Returns a `200 OK` status if the Type exists or a `404 Not Found` otherwise.

func (*ByProjectKeyTypesByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyTypesByIDRequestBuilder) Post(body TypeUpdate) *ByProjectKeyTypesByIDRequestMethodPost

type ByProjectKeyTypesByIDRequestMethodDelete ¶ 

type ByProjectKeyTypesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyTypesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyTypesByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodDelete) Execute(ctx context.Context) (result *Type, err error)

func (*ByProjectKeyTypesByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyTypesByIDRequestMethodDelete

func (*ByProjectKeyTypesByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodDelete) Version(v int) *ByProjectKeyTypesByIDRequestMethodDelete

func (*ByProjectKeyTypesByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyTypesByIDRequestMethodDelete

func (*ByProjectKeyTypesByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyTypesByIDRequestMethodDeleteInput) *ByProjectKeyTypesByIDRequestMethodDelete

type ByProjectKeyTypesByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyTypesByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyTypesByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyTypesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyTypesByIDRequestMethodGet ¶ 

type ByProjectKeyTypesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyTypesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyTypesByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodGet) Execute(ctx context.Context) (result *Type, err error)

func (*ByProjectKeyTypesByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyTypesByIDRequestMethodGet

func (*ByProjectKeyTypesByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyTypesByIDRequestMethodGet

func (*ByProjectKeyTypesByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyTypesByIDRequestMethodGetInput) *ByProjectKeyTypesByIDRequestMethodGet

type ByProjectKeyTypesByIDRequestMethodGetInput ¶ 

type ByProjectKeyTypesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyTypesByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyTypesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyTypesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyTypesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyTypesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyTypesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Type exists for a given `id`. Returns a `200 OK` status if the Type exists or a `404 Not Found` otherwise.

func (*ByProjectKeyTypesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyTypesByIDRequestMethodHead

type ByProjectKeyTypesByIDRequestMethodPost ¶ 

type ByProjectKeyTypesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyTypesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyTypesByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodPost) Execute(ctx context.Context) (result *Type, err error)

func (*ByProjectKeyTypesByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyTypesByIDRequestMethodPost

func (*ByProjectKeyTypesByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyTypesByIDRequestMethodPost

func (*ByProjectKeyTypesByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyTypesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyTypesByIDRequestMethodPostInput) *ByProjectKeyTypesByIDRequestMethodPost

type ByProjectKeyTypesByIDRequestMethodPostInput ¶ 

type ByProjectKeyTypesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyTypesByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyTypesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyTypesKeyByKeyRequestBuilder ¶ 

type ByProjectKeyTypesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestBuilder) Delete() *ByProjectKeyTypesKeyByKeyRequestMethodDelete

func (*ByProjectKeyTypesKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestBuilder) Get() *ByProjectKeyTypesKeyByKeyRequestMethodGet

func (*ByProjectKeyTypesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesKeyByKeyRequestBuilder) Head() *ByProjectKeyTypesKeyByKeyRequestMethodHead

* * Checks if a Type exists for a given `key`. Returns a `200 OK` status if the Type exists or a `404 Not Found` otherwise.

func (*ByProjectKeyTypesKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestBuilder) Post(body TypeUpdate) *ByProjectKeyTypesKeyByKeyRequestMethodPost

type ByProjectKeyTypesKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyTypesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyTypesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyTypesKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Type, err error)

func (*ByProjectKeyTypesKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyTypesKeyByKeyRequestMethodDelete

func (*ByProjectKeyTypesKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyTypesKeyByKeyRequestMethodDelete

func (*ByProjectKeyTypesKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyTypesKeyByKeyRequestMethodDelete

func (*ByProjectKeyTypesKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyTypesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyTypesKeyByKeyRequestMethodDelete

type ByProjectKeyTypesKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyTypesKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyTypesKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyTypesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyTypesKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyTypesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyTypesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyTypesKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Type, err error)

func (*ByProjectKeyTypesKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyTypesKeyByKeyRequestMethodGet

func (*ByProjectKeyTypesKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyTypesKeyByKeyRequestMethodGet

func (*ByProjectKeyTypesKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyTypesKeyByKeyRequestMethodGetInput) *ByProjectKeyTypesKeyByKeyRequestMethodGet

type ByProjectKeyTypesKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyTypesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyTypesKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyTypesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyTypesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyTypesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyTypesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyTypesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Type exists for a given `key`. Returns a `200 OK` status if the Type exists or a `404 Not Found` otherwise.

func (*ByProjectKeyTypesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyTypesKeyByKeyRequestMethodHead

type ByProjectKeyTypesKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyTypesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyTypesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyTypesKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Type, err error)

func (*ByProjectKeyTypesKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyTypesKeyByKeyRequestMethodPost

func (*ByProjectKeyTypesKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyTypesKeyByKeyRequestMethodPost

func (*ByProjectKeyTypesKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyTypesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyTypesKeyByKeyRequestMethodPostInput) *ByProjectKeyTypesKeyByKeyRequestMethodPost

type ByProjectKeyTypesKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyTypesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyTypesKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyTypesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyTypesRequestBuilder ¶ 

type ByProjectKeyTypesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesRequestBuilder) Get ¶ 

func (rb *ByProjectKeyTypesRequestBuilder) Get() *ByProjectKeyTypesRequestMethodGet

func (*ByProjectKeyTypesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesRequestBuilder) Head() *ByProjectKeyTypesRequestMethodHead

* * Checks if a Type exists for a given Query Predicate. Returns a `200 OK` status if any Types match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyTypesRequestBuilder) Post ¶ 

func (rb *ByProjectKeyTypesRequestBuilder) Post(body TypeDraft) *ByProjectKeyTypesRequestMethodPost

func (*ByProjectKeyTypesRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyTypesRequestBuilder) WithId(id string) *ByProjectKeyTypesByIDRequestBuilder

func (*ByProjectKeyTypesRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyTypesRequestBuilder) WithKey(key string) *ByProjectKeyTypesKeyByKeyRequestBuilder

type ByProjectKeyTypesRequestMethodGet ¶ 

type ByProjectKeyTypesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyTypesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyTypesRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) Execute(ctx context.Context) (result *TypePagedQueryResponse, err error)

func (*ByProjectKeyTypesRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) Expand(v []string) *ByProjectKeyTypesRequestMethodGet

func (*ByProjectKeyTypesRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) Limit(v int) *ByProjectKeyTypesRequestMethodGet

func (*ByProjectKeyTypesRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) Offset(v int) *ByProjectKeyTypesRequestMethodGet

func (*ByProjectKeyTypesRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyTypesRequestMethodGet

func (*ByProjectKeyTypesRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) Sort(v []string) *ByProjectKeyTypesRequestMethodGet

func (*ByProjectKeyTypesRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) Where(v []string) *ByProjectKeyTypesRequestMethodGet

func (*ByProjectKeyTypesRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyTypesRequestMethodGet

func (*ByProjectKeyTypesRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) WithQueryParams(input ByProjectKeyTypesRequestMethodGetInput) *ByProjectKeyTypesRequestMethodGet

func (*ByProjectKeyTypesRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyTypesRequestMethodGet) WithTotal(v bool) *ByProjectKeyTypesRequestMethodGet

type ByProjectKeyTypesRequestMethodGetInput ¶ 

type ByProjectKeyTypesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyTypesRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyTypesRequestMethodGetInput) Values() url.Values

type ByProjectKeyTypesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyTypesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyTypesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyTypesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Type exists for a given Query Predicate. Returns a `200 OK` status if any Types match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyTypesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesRequestMethodHead) Where(v []string) *ByProjectKeyTypesRequestMethodHead

func (*ByProjectKeyTypesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyTypesRequestMethodHead

func (*ByProjectKeyTypesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyTypesRequestMethodHead) WithQueryParams(input ByProjectKeyTypesRequestMethodHeadInput) *ByProjectKeyTypesRequestMethodHead

type ByProjectKeyTypesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyTypesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyTypesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyTypesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyTypesRequestMethodPost ¶ 

type ByProjectKeyTypesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyTypesRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyTypesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyTypesRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyTypesRequestMethodPost) Execute(ctx context.Context) (result *Type, err error)

func (*ByProjectKeyTypesRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyTypesRequestMethodPost) Expand(v []string) *ByProjectKeyTypesRequestMethodPost

func (*ByProjectKeyTypesRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyTypesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyTypesRequestMethodPost

func (*ByProjectKeyTypesRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyTypesRequestMethodPost) WithQueryParams(input ByProjectKeyTypesRequestMethodPostInput) *ByProjectKeyTypesRequestMethodPost

type ByProjectKeyTypesRequestMethodPostInput ¶ 

type ByProjectKeyTypesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyTypesRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyTypesRequestMethodPostInput) Values() url.Values

type ByProjectKeyZonesByIDRequestBuilder ¶ 

type ByProjectKeyZonesByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesByIDRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyZonesByIDRequestBuilder) Delete() *ByProjectKeyZonesByIDRequestMethodDelete

func (*ByProjectKeyZonesByIDRequestBuilder) Get ¶ 

func (rb *ByProjectKeyZonesByIDRequestBuilder) Get() *ByProjectKeyZonesByIDRequestMethodGet

func (*ByProjectKeyZonesByIDRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesByIDRequestBuilder) Head() *ByProjectKeyZonesByIDRequestMethodHead

* * Checks if a Zone exists for a given `id`. Returns a `200 OK` status if the Zone exists or a `404 Not Found` otherwise.

func (*ByProjectKeyZonesByIDRequestBuilder) Post ¶ 

func (rb *ByProjectKeyZonesByIDRequestBuilder) Post(body ZoneUpdate) *ByProjectKeyZonesByIDRequestMethodPost

type ByProjectKeyZonesByIDRequestMethodDelete ¶ 

type ByProjectKeyZonesByIDRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesByIDRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyZonesByIDRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyZonesByIDRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodDelete) Execute(ctx context.Context) (result *Zone, err error)

func (*ByProjectKeyZonesByIDRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodDelete) Expand(v []string) *ByProjectKeyZonesByIDRequestMethodDelete

func (*ByProjectKeyZonesByIDRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodDelete) Version(v int) *ByProjectKeyZonesByIDRequestMethodDelete

func (*ByProjectKeyZonesByIDRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyZonesByIDRequestMethodDelete

func (*ByProjectKeyZonesByIDRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodDelete) WithQueryParams(input ByProjectKeyZonesByIDRequestMethodDeleteInput) *ByProjectKeyZonesByIDRequestMethodDelete

type ByProjectKeyZonesByIDRequestMethodDeleteInput ¶ 

type ByProjectKeyZonesByIDRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyZonesByIDRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyZonesByIDRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyZonesByIDRequestMethodGet ¶ 

type ByProjectKeyZonesByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesByIDRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyZonesByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyZonesByIDRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodGet) Execute(ctx context.Context) (result *Zone, err error)

func (*ByProjectKeyZonesByIDRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodGet) Expand(v []string) *ByProjectKeyZonesByIDRequestMethodGet

func (*ByProjectKeyZonesByIDRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyZonesByIDRequestMethodGet

func (*ByProjectKeyZonesByIDRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodGet) WithQueryParams(input ByProjectKeyZonesByIDRequestMethodGetInput) *ByProjectKeyZonesByIDRequestMethodGet

type ByProjectKeyZonesByIDRequestMethodGetInput ¶ 

type ByProjectKeyZonesByIDRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyZonesByIDRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyZonesByIDRequestMethodGetInput) Values() url.Values

type ByProjectKeyZonesByIDRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyZonesByIDRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesByIDRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyZonesByIDRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyZonesByIDRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesByIDRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Zone exists for a given `id`. Returns a `200 OK` status if the Zone exists or a `404 Not Found` otherwise.

func (*ByProjectKeyZonesByIDRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesByIDRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyZonesByIDRequestMethodHead

type ByProjectKeyZonesByIDRequestMethodPost ¶ 

type ByProjectKeyZonesByIDRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesByIDRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyZonesByIDRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyZonesByIDRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodPost) Execute(ctx context.Context) (result *Zone, err error)

func (*ByProjectKeyZonesByIDRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodPost) Expand(v []string) *ByProjectKeyZonesByIDRequestMethodPost

func (*ByProjectKeyZonesByIDRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyZonesByIDRequestMethodPost

func (*ByProjectKeyZonesByIDRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyZonesByIDRequestMethodPost) WithQueryParams(input ByProjectKeyZonesByIDRequestMethodPostInput) *ByProjectKeyZonesByIDRequestMethodPost

type ByProjectKeyZonesByIDRequestMethodPostInput ¶ 

type ByProjectKeyZonesByIDRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyZonesByIDRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyZonesByIDRequestMethodPostInput) Values() url.Values

type ByProjectKeyZonesKeyByKeyRequestBuilder ¶ 

type ByProjectKeyZonesKeyByKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesKeyByKeyRequestBuilder) Delete ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestBuilder) Delete() *ByProjectKeyZonesKeyByKeyRequestMethodDelete

func (*ByProjectKeyZonesKeyByKeyRequestBuilder) Get ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestBuilder) Get() *ByProjectKeyZonesKeyByKeyRequestMethodGet

func (*ByProjectKeyZonesKeyByKeyRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesKeyByKeyRequestBuilder) Head() *ByProjectKeyZonesKeyByKeyRequestMethodHead

* * Checks if a Zone exists for a given `key`. Returns a `200 OK` status if the Zone exists or a `404 Not Found` otherwise.

func (*ByProjectKeyZonesKeyByKeyRequestBuilder) Post ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestBuilder) Post(body ZoneUpdate) *ByProjectKeyZonesKeyByKeyRequestMethodPost

type ByProjectKeyZonesKeyByKeyRequestMethodDelete ¶ 

type ByProjectKeyZonesKeyByKeyRequestMethodDelete struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesKeyByKeyRequestMethodDelete) Dump ¶ 

func (r *ByProjectKeyZonesKeyByKeyRequestMethodDelete) Dump() map[string]interface{}

func (*ByProjectKeyZonesKeyByKeyRequestMethodDelete) Execute ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodDelete) Execute(ctx context.Context) (result *Zone, err error)

func (*ByProjectKeyZonesKeyByKeyRequestMethodDelete) Expand ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodDelete) Expand(v []string) *ByProjectKeyZonesKeyByKeyRequestMethodDelete

func (*ByProjectKeyZonesKeyByKeyRequestMethodDelete) Version ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodDelete) Version(v int) *ByProjectKeyZonesKeyByKeyRequestMethodDelete

func (*ByProjectKeyZonesKeyByKeyRequestMethodDelete) WithHeaders ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodDelete) WithHeaders(headers http.Header) *ByProjectKeyZonesKeyByKeyRequestMethodDelete

func (*ByProjectKeyZonesKeyByKeyRequestMethodDelete) WithQueryParams ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodDelete) WithQueryParams(input ByProjectKeyZonesKeyByKeyRequestMethodDeleteInput) *ByProjectKeyZonesKeyByKeyRequestMethodDelete

type ByProjectKeyZonesKeyByKeyRequestMethodDeleteInput ¶ 

type ByProjectKeyZonesKeyByKeyRequestMethodDeleteInput struct {
	Version int
	Expand  []string
}

func (*ByProjectKeyZonesKeyByKeyRequestMethodDeleteInput) Values ¶ 

func (input *ByProjectKeyZonesKeyByKeyRequestMethodDeleteInput) Values() url.Values

type ByProjectKeyZonesKeyByKeyRequestMethodGet ¶ 

type ByProjectKeyZonesKeyByKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesKeyByKeyRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyZonesKeyByKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyZonesKeyByKeyRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodGet) Execute(ctx context.Context) (result *Zone, err error)

func (*ByProjectKeyZonesKeyByKeyRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodGet) Expand(v []string) *ByProjectKeyZonesKeyByKeyRequestMethodGet

func (*ByProjectKeyZonesKeyByKeyRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyZonesKeyByKeyRequestMethodGet

func (*ByProjectKeyZonesKeyByKeyRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodGet) WithQueryParams(input ByProjectKeyZonesKeyByKeyRequestMethodGetInput) *ByProjectKeyZonesKeyByKeyRequestMethodGet

type ByProjectKeyZonesKeyByKeyRequestMethodGetInput ¶ 

type ByProjectKeyZonesKeyByKeyRequestMethodGetInput struct {
	Expand []string
}

func (*ByProjectKeyZonesKeyByKeyRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyZonesKeyByKeyRequestMethodGetInput) Values() url.Values

type ByProjectKeyZonesKeyByKeyRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyZonesKeyByKeyRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesKeyByKeyRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyZonesKeyByKeyRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyZonesKeyByKeyRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Zone exists for a given `key`. Returns a `200 OK` status if the Zone exists or a `404 Not Found` otherwise.

func (*ByProjectKeyZonesKeyByKeyRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyZonesKeyByKeyRequestMethodHead

type ByProjectKeyZonesKeyByKeyRequestMethodPost ¶ 

type ByProjectKeyZonesKeyByKeyRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesKeyByKeyRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyZonesKeyByKeyRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyZonesKeyByKeyRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodPost) Execute(ctx context.Context) (result *Zone, err error)

func (*ByProjectKeyZonesKeyByKeyRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodPost) Expand(v []string) *ByProjectKeyZonesKeyByKeyRequestMethodPost

func (*ByProjectKeyZonesKeyByKeyRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyZonesKeyByKeyRequestMethodPost

func (*ByProjectKeyZonesKeyByKeyRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyZonesKeyByKeyRequestMethodPost) WithQueryParams(input ByProjectKeyZonesKeyByKeyRequestMethodPostInput) *ByProjectKeyZonesKeyByKeyRequestMethodPost

type ByProjectKeyZonesKeyByKeyRequestMethodPostInput ¶ 

type ByProjectKeyZonesKeyByKeyRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyZonesKeyByKeyRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyZonesKeyByKeyRequestMethodPostInput) Values() url.Values

type ByProjectKeyZonesRequestBuilder ¶ 

type ByProjectKeyZonesRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesRequestBuilder) Get ¶ 

func (rb *ByProjectKeyZonesRequestBuilder) Get() *ByProjectKeyZonesRequestMethodGet

func (*ByProjectKeyZonesRequestBuilder) Head ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesRequestBuilder) Head() *ByProjectKeyZonesRequestMethodHead

* * Checks if a Zone exists for a given Query Predicate. Returns a `200 OK` status if any Zones match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyZonesRequestBuilder) Post ¶ 

func (rb *ByProjectKeyZonesRequestBuilder) Post(body ZoneDraft) *ByProjectKeyZonesRequestMethodPost

func (*ByProjectKeyZonesRequestBuilder) WithId ¶ 

func (rb *ByProjectKeyZonesRequestBuilder) WithId(id string) *ByProjectKeyZonesByIDRequestBuilder

func (*ByProjectKeyZonesRequestBuilder) WithKey ¶ 

func (rb *ByProjectKeyZonesRequestBuilder) WithKey(key string) *ByProjectKeyZonesKeyByKeyRequestBuilder

type ByProjectKeyZonesRequestMethodGet ¶ 

type ByProjectKeyZonesRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesRequestMethodGet) Dump ¶ 

func (r *ByProjectKeyZonesRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyZonesRequestMethodGet) Execute ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) Execute(ctx context.Context) (result *ZonePagedQueryResponse, err error)

func (*ByProjectKeyZonesRequestMethodGet) Expand ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) Expand(v []string) *ByProjectKeyZonesRequestMethodGet

func (*ByProjectKeyZonesRequestMethodGet) Limit ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) Limit(v int) *ByProjectKeyZonesRequestMethodGet

func (*ByProjectKeyZonesRequestMethodGet) Offset ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) Offset(v int) *ByProjectKeyZonesRequestMethodGet

func (*ByProjectKeyZonesRequestMethodGet) PredicateVar ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) PredicateVar(v map[string][]string) *ByProjectKeyZonesRequestMethodGet

func (*ByProjectKeyZonesRequestMethodGet) Sort ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) Sort(v []string) *ByProjectKeyZonesRequestMethodGet

func (*ByProjectKeyZonesRequestMethodGet) Where ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) Where(v []string) *ByProjectKeyZonesRequestMethodGet

func (*ByProjectKeyZonesRequestMethodGet) WithHeaders ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) WithHeaders(headers http.Header) *ByProjectKeyZonesRequestMethodGet

func (*ByProjectKeyZonesRequestMethodGet) WithQueryParams ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) WithQueryParams(input ByProjectKeyZonesRequestMethodGetInput) *ByProjectKeyZonesRequestMethodGet

func (*ByProjectKeyZonesRequestMethodGet) WithTotal ¶ 

func (rb *ByProjectKeyZonesRequestMethodGet) WithTotal(v bool) *ByProjectKeyZonesRequestMethodGet

type ByProjectKeyZonesRequestMethodGetInput ¶ 

type ByProjectKeyZonesRequestMethodGetInput struct {
	Expand       []string
	Sort         []string
	Limit        *int
	Offset       *int
	WithTotal    *bool
	Where        []string
	PredicateVar map[string][]string
}

func (*ByProjectKeyZonesRequestMethodGetInput) Values ¶ 

func (input *ByProjectKeyZonesRequestMethodGetInput) Values() url.Values

type ByProjectKeyZonesRequestMethodHead ¶ added in v1.4.0 

type ByProjectKeyZonesRequestMethodHead struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesRequestMethodHead) Dump ¶ added in v1.4.0 

func (r *ByProjectKeyZonesRequestMethodHead) Dump() map[string]interface{}

func (*ByProjectKeyZonesRequestMethodHead) Execute ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesRequestMethodHead) Execute(ctx context.Context) error

* * Checks if a Zone exists for a given Query Predicate. Returns a `200 OK` status if any Zones match the Query Predicate or a `404 Not Found` otherwise.

func (*ByProjectKeyZonesRequestMethodHead) Where ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesRequestMethodHead) Where(v []string) *ByProjectKeyZonesRequestMethodHead

func (*ByProjectKeyZonesRequestMethodHead) WithHeaders ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesRequestMethodHead) WithHeaders(headers http.Header) *ByProjectKeyZonesRequestMethodHead

func (*ByProjectKeyZonesRequestMethodHead) WithQueryParams ¶ added in v1.4.0 

func (rb *ByProjectKeyZonesRequestMethodHead) WithQueryParams(input ByProjectKeyZonesRequestMethodHeadInput) *ByProjectKeyZonesRequestMethodHead

type ByProjectKeyZonesRequestMethodHeadInput ¶ added in v1.4.0 

type ByProjectKeyZonesRequestMethodHeadInput struct {
	Where []string
}

func (*ByProjectKeyZonesRequestMethodHeadInput) Values ¶ added in v1.4.0 

func (input *ByProjectKeyZonesRequestMethodHeadInput) Values() url.Values

type ByProjectKeyZonesRequestMethodPost ¶ 

type ByProjectKeyZonesRequestMethodPost struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyZonesRequestMethodPost) Dump ¶ 

func (r *ByProjectKeyZonesRequestMethodPost) Dump() map[string]interface{}

func (*ByProjectKeyZonesRequestMethodPost) Execute ¶ 

func (rb *ByProjectKeyZonesRequestMethodPost) Execute(ctx context.Context) (result *Zone, err error)

func (*ByProjectKeyZonesRequestMethodPost) Expand ¶ 

func (rb *ByProjectKeyZonesRequestMethodPost) Expand(v []string) *ByProjectKeyZonesRequestMethodPost

func (*ByProjectKeyZonesRequestMethodPost) WithHeaders ¶ 

func (rb *ByProjectKeyZonesRequestMethodPost) WithHeaders(headers http.Header) *ByProjectKeyZonesRequestMethodPost

func (*ByProjectKeyZonesRequestMethodPost) WithQueryParams ¶ 

func (rb *ByProjectKeyZonesRequestMethodPost) WithQueryParams(input ByProjectKeyZonesRequestMethodPostInput) *ByProjectKeyZonesRequestMethodPost

type ByProjectKeyZonesRequestMethodPostInput ¶ 

type ByProjectKeyZonesRequestMethodPostInput struct {
	Expand []string
}

func (*ByProjectKeyZonesRequestMethodPostInput) Values ¶ 

func (input *ByProjectKeyZonesRequestMethodPostInput) Values() url.Values

type Cart ¶ 

type Cart struct {
	// Unique identifier of the Cart.
	ID string `json:"id"`
	// Current version of the Cart.
	Version int `json:"version"`
	// Date and time (UTC) the Cart was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Cart was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-defined unique identifier of the Cart.
	Key *string `json:"key,omitempty"`
	// `id` of the [Customer](ctp:api:type:Customer) that the Cart belongs to.
	CustomerId *string `json:"customerId,omitempty"`
	// Email address of the Customer that the Cart belongs to.
	CustomerEmail *string `json:"customerEmail,omitempty"`
	// [Reference](ctp:api:type:Reference) to the Customer Group of the Customer that the Cart belongs to. Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// [Anonymous session](ctp:api:type:AnonymousSession) associated with the Cart.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// [Reference](ctp:api:type:Reference) to a Business Unit the Cart belongs to.
	BusinessUnit *BusinessUnitKeyReference `json:"businessUnit,omitempty"`
	// [Reference](ctp:api:type:Reference) to a Store the Cart belongs to.
	Store *StoreKeyReference `json:"store,omitempty"`
	// [Line Items](ctp:api:type:LineItems) added to the Cart.
	LineItems []LineItem `json:"lineItems"`
	// [Custom Line Items](ctp:api:type:CustomLineItems) added to the Cart.
	CustomLineItems []CustomLineItem `json:"customLineItems"`
	// Sum of all [LineItem](ctp:api:type:LineItem) quantities, excluding [CustomLineItems](ctp:api:type:CustomLineItem). Only present when the Cart has at least one LineItem.
	TotalLineItemQuantity *int `json:"totalLineItemQuantity,omitempty"`
	// Sum of the `totalPrice` field of all [LineItems](ctp:api:type:LineItem) and [CustomLineItems](ctp:api:type:CustomLineItem), and if available, the `price` field of [ShippingInfo](ctp:api:type:ShippingInfo).
	// If a discount applies on `totalPrice`, this field holds the discounted value.
	//
	// Taxes are included if [TaxRate](ctp:api:type:TaxRate) `includedInPrice` is `true` for each price.
	TotalPrice CentPrecisionMoney `json:"totalPrice"`
	// - For a Cart with `Platform` [TaxMode](ctp:api:type:TaxMode), it is automatically set when a [shipping address is set](ctp:api:type:CartSetShippingAddressAction).
	// - For a Cart with `External` [TaxMode](ctp:api:type:TaxMode), it is automatically set when `shippingAddress` and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
	//
	// If a discount applies on `totalPrice`, this field holds the discounted values.
	TaxedPrice *TaxedPrice `json:"taxedPrice,omitempty"`
	// Sum of the `taxedPrice` field of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods.
	TaxedShippingPrice *TaxedPrice `json:"taxedShippingPrice,omitempty"`
	// Discounts that apply on the Cart `totalPrice`.
	DiscountOnTotalPrice *DiscountOnTotalPrice `json:"discountOnTotalPrice,omitempty"`
	// Indicates how Tax Rates are set.
	TaxMode TaxMode `json:"taxMode"`
	// Indicates how monetary values are rounded when calculating taxes for `taxedPrice`.
	TaxRoundingMode RoundingMode `json:"taxRoundingMode"`
	// Indicates how taxes are calculated when calculating taxes for `taxedPrice`.
	TaxCalculationMode TaxCalculationMode `json:"taxCalculationMode"`
	// Indicates how stock quantities are tracked for Line Items in the Cart.
	InventoryMode InventoryMode `json:"inventoryMode"`
	// Current status of the Cart.
	CartState CartState `json:"cartState"`
	// Billing address associated with the Cart.
	BillingAddress *Address `json:"billingAddress,omitempty"`
	// Shipping address for a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode). Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
	ShippingAddress *Address `json:"shippingAddress,omitempty"`
	// Indicates whether the Cart has one or multiple Shipping Methods.
	ShippingMode ShippingMode `json:"shippingMode"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Shipping-related information of a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode). Automatically set when a [Shipping Method is set](ctp:api:type:CartSetShippingMethodAction).
	ShippingInfo *ShippingInfo `json:"shippingInfo,omitempty"`
	// Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it is [ClassificationShippingRateInput](ctp:api:type:ClassificationShippingRateInput).
	// - If `CartScore`, it is [ScoreShippingRateInput](ctp:api:type:ScoreShippingRateInput).
	// - If `CartValue`, it cannot be used.
	ShippingRateInput ShippingRateInput `json:"shippingRateInput,omitempty"`
	// Custom Fields of the Shipping Method in a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingCustomFields *CustomFields `json:"shippingCustomFields,omitempty"`
	// Shipping-related information of a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode). Updated automatically each time a new [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).
	Shipping []Shipping `json:"shipping"`
	// Additional shipping addresses of the Cart as specified by [LineItems](ctp:api:type:LineItem) using the `shippingDetails` field.
	//
	// For Carts with `Single` [ShippingMode](ctp:api:type:ShippingMode): eligible Shipping Methods or applicable Tax Rates are determined by the address in `shippingAddress`, and not `itemShippingAddresses`.
	ItemShippingAddresses []Address `json:"itemShippingAddresses"`
	// Discount Codes applied to the Cart. A Cart that has `directDiscounts` cannot have `discountCodes`.
	DiscountCodes []DiscountCodeInfo `json:"discountCodes"`
	// Direct Discounts added to the Cart. A Cart that has `discountCodes` cannot have `directDiscounts`.
	DirectDiscounts []DirectDiscount `json:"directDiscounts"`
	// Automatically set when a Line Item with `GiftLineItem` [LineItemMode](ctp:api:type:LineItemMode) is [removed](ctp:api:type:CartRemoveLineItemAction) from the Cart.
	RefusedGifts []CartDiscountReference `json:"refusedGifts"`
	// Payment information related to the Cart.
	PaymentInfo *PaymentInfo `json:"paymentInfo,omitempty"`
	// Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	Country *string `json:"country,omitempty"`
	// Languages of the Cart. Can only contain languages supported by the [Project](ctp:api:type:Project).
	Locale *string `json:"locale,omitempty"`
	// Indicates how the Cart was created.
	Origin CartOrigin `json:"origin"`
	// Custom Fields of the Cart.
	Custom *CustomFields `json:"custom,omitempty"`
	// Number of days after which an active Cart is deleted since its last modification. Configured in [Project settings](ctp:api:type:CartsConfiguration).
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
	// Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
}

func (*Cart) UnmarshalJSON ¶ 

func (obj *Cart) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartAddCustomLineItemAction ¶ 

type CartAddCustomLineItemAction struct {
	// Money value of the Custom Line Item.
	// The value can be negative.
	Money Money `json:"money"`
	// Name of the Custom Line Item.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier of the Custom Line Item.
	Key *string `json:"key,omitempty"`
	// Number of Custom Line Items to add to the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// User-defined identifier used in a deep-link URL for the Custom Line Item.
	// It must match the pattern `[a-zA-Z0-9_-]{2,256}`.
	Slug string `json:"slug"`
	// Used to select a Tax Rate when a Cart has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	//
	// If [TaxMode](ctp:api:type:TaxMode) is `Platform`, this field must not be empty.
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// An external Tax Rate can be set if the Cart has `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Container for Custom Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// Custom Fields for the Custom Line Item.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// - If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget)
	// are applied to the Custom Line Item.
	// - If `External`, Cart Discounts are not considered on the Custom Line Item.
	PriceMode *CustomLineItemPriceMode `json:"priceMode,omitempty"`
}

* * If the Cart already contains a CustomLineItem(ctp:api:type:CustomLineItem) with the same `slug`, `name`, `money`, `taxCategory`, `state`, * and Custom Fields, then only the quantity of the existing Custom Line Item is increased. * If CustomLineItem(ctp:api:type:CustomLineItem) `shippingDetails` are set, they are merged with the `targets` that already exist on the * ItemShippingDetails(ctp:api:type:ItemShippingDetails) of the Custom Line Item. * In case of overlapping address keys the ItemShippingTarget(ctp:api:type:ItemShippingTarget) `quantity` is summed up. * * If the Cart already contains a Custom Line Item with the same slug that is otherwise not identical, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned. * * If the Tax Rate is not set, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. *

func (CartAddCustomLineItemAction) MarshalJSON ¶ 

func (obj CartAddCustomLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartAddCustomShippingMethodAction ¶ added in v1.2.0 

type CartAddCustomShippingMethodAction struct {
	// User-defined identifier for the custom Shipping Method that must be unique across the Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey string `json:"shippingKey"`
	// Name of the custom Shipping Method.
	ShippingMethodName string `json:"shippingMethodName"`
	// Determines the shipping rate and Tax Rate of the associated Line Items.
	ShippingAddress BaseAddress `json:"shippingAddress"`
	// Determines the shipping price.
	ShippingRate ShippingRateDraft `json:"shippingRate"`
	// Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it must be [ClassificationShippingRateInputDraft](ctp:api:type:ClassificationShippingRateInputDraft).
	// - If `CartScore`, it must be [ScoreShippingRateInputDraft](ctp:api:type:ScoreShippingRateInputDraft).
	// - If `CartValue`, it cannot be set.
	ShippingRateInput ShippingRateInputDraft `json:"shippingRateInput,omitempty"`
	// Tax Category used to determine a shipping Tax Rate if the Cart has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// Tax Rate used to tax a shipping expense if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Deliveries to be shipped with the custom Shipping Method.
	Deliveries []DeliveryDraft `json:"deliveries"`
	// Custom Fields for the custom Shipping Method.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * To add a custom Shipping Method (independent of the [ShippingMethods](ctp:api:type:ShippingMethod) managed through * the [Shipping Methods API](/projects/shippingMethods)) to the Cart, it **must have** the `Multiple` ShippingMode(ctp:api:type:ShippingMode). *

func (CartAddCustomShippingMethodAction) MarshalJSON ¶ added in v1.2.0 

func (obj CartAddCustomShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartAddCustomShippingMethodAction) UnmarshalJSON ¶ added in v1.2.0 

func (obj *CartAddCustomShippingMethodAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartAddDiscountCodeAction ¶ 

type CartAddDiscountCodeAction struct {
	// `code` of a [DiscountCode](ctp:api:type:DiscountCode).
	Code string `json:"code"`
}

* * Adds a DiscountCode(ctp:api:type:DiscountCode) to the Cart to activate the related [Cart Discounts](/../api/projects/cartDiscounts). * Adding a Discount Code is only possible if no DirectDiscount(ctp:api:type:DirectDiscount) has been applied to the Cart. * Discount Codes can be added to [frozen Carts](ctp:api:type:FrozenCarts), but their DiscountCodeState(ctp:api:type:DiscountCodeState) is then `DoesNotMatchCart`. * * The maximum number of Discount Codes in a Cart is restricted by a [limit](/../api/limits#carts). * * Specific Error Code: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) *

func (CartAddDiscountCodeAction) MarshalJSON ¶ 

func (obj CartAddDiscountCodeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartAddItemShippingAddressAction ¶ 

type CartAddItemShippingAddressAction struct {
	// Address to append to `itemShippingAddresses`.
	//
	// The new Address must have a `key` that is unique across this Cart.
	Address BaseAddress `json:"address"`
}

* * Adds an address to a Cart when shipping to multiple addresses is desired. *

func (CartAddItemShippingAddressAction) MarshalJSON ¶ 

func (obj CartAddItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartAddLineItemAction ¶ 

type CartAddLineItemAction struct {
	// User-defined unique identifier of the LineItem.
	Key *string `json:"key,omitempty"`
	// `id` of the published [Product](ctp:api:type:Product).
	//
	// Either the `productId` and `variantId`, or `sku` must be provided.
	ProductId *string `json:"productId,omitempty"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant) in the Product.
	// If not provided, the Master Variant is used.
	//
	// Either the `productId` and `variantId`, or `sku` must be provided.
	VariantId *int `json:"variantId,omitempty"`
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant).
	//
	// Either the `productId` and `variantId`, or `sku` must be provided.
	Sku *string `json:"sku,omitempty"`
	// Quantity of the Product Variant to add to the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// Date and time (UTC) the Product Variant is added to the Cart.
	// If not set, it defaults to the current date and time.
	//
	// Optional for backwards compatibility reasons.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price.
	// The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	// If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set, the Channel must match one of the Store's distribution channels.
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
	// Used to identify [Inventory entries](/../api/projects/inventory) that must be reserved.
	// The Channel must have the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` value, and the `priceMode` to `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalPrice *Money `json:"externalPrice,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` and `totalPrice` values, and the `priceMode` to `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
	// External Tax Rate for the Line Item, if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Sets the external Tax Rates for individual Shipping Methods, if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode) and `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	PerMethodExternalTaxRate []MethodExternalTaxRateDraft `json:"perMethodExternalTaxRate"`
	// Inventory mode specific to the Line Item only, and valid for the entire `quantity` of the Line Item.
	// Set only if the inventory mode should be different from the `inventoryMode` specified on the [Cart](ctp:api:type:Cart).
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Container for Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// Custom Fields for the Line Item.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * If the Cart contains a LineItem(ctp:api:type:LineItem) for a Product Variant with the same LineItemMode(ctp:api:type:LineItemMode), [Custom Fields](/../api/projects/custom-fields), supply and distribution channel, then only the quantity of the existing Line Item is increased. * If LineItem(ctp:api:type:LineItem) `shippingDetails` is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. * A new Line Item is added when the `externalPrice` or `externalTotalPrice` is set in this update action. * The LineItem(ctp:api:type:LineItem) price is set as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). * * If the Tax Rate is not set, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. * * If the Line Items do not have a Price according to the Product(ctp:api:type:Product) `priceMode` value for a selected currency and/or country, Customer Group, or Channel, a [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) error is returned. *

func (CartAddLineItemAction) MarshalJSON ¶ 

func (obj CartAddLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartAddPaymentAction ¶ 

type CartAddPaymentAction struct {
	// Payment to add to the Cart.
	// Must not be assigned to another Order or active Cart already.
	Payment PaymentResourceIdentifier `json:"payment"`
}

func (CartAddPaymentAction) MarshalJSON ¶ 

func (obj CartAddPaymentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartAddShippingMethodAction ¶ added in v1.2.0 

type CartAddShippingMethodAction struct {
	// User-defined identifier for the [Shipping](ctp:api:type:Shipping) that must be unique across the Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey string `json:"shippingKey"`
	// RecourceIdentifier to a [ShippingMethod](ctp:api:type:ShippingMethod) to add to the Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	// If the referenced Shipping Method has a predicate that does not match the Cart, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
	ShippingMethod ShippingMethodResourceIdentifier `json:"shippingMethod"`
	// Determines the shipping rate and Tax Rate of the Line Items.
	ShippingAddress BaseAddress `json:"shippingAddress"`
	// Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it must be [ClassificationShippingRateInputDraft](ctp:api:type:ClassificationShippingRateInputDraft).
	// - If `CartScore`, it must be [ScoreShippingRateInputDraft](ctp:api:type:ScoreShippingRateInputDraft).
	// - If `CartValue`, it cannot be set.
	ShippingRateInput ShippingRateInputDraft `json:"shippingRateInput,omitempty"`
	// Tax Rate used to tax a shipping expense if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Deliveries to be shipped with the referenced Shipping Method.
	Deliveries []DeliveryDraft `json:"deliveries"`
	// Custom Fields for the Shipping Method.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * Adds a Shipping Method for a specified shipping address to a Cart with `Multiple` ShippingMode(ctp:api:type:ShippingMode). *

func (CartAddShippingMethodAction) MarshalJSON ¶ added in v1.2.0 

func (obj CartAddShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartAddShippingMethodAction) UnmarshalJSON ¶ added in v1.2.0 

func (obj *CartAddShippingMethodAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartAddShoppingListAction ¶ 

type CartAddShoppingListAction struct {
	// Shopping List that contains the Line Items to be added.
	ShoppingList ShoppingListResourceIdentifier `json:"shoppingList"`
	// `distributionChannel` to set for all [LineItems](ctp:api:type:LineItem) that are added to the Cart.
	// The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
	// `supplyChannel` to set for all [LineItems](ctp:api:type:LineItem) that are added to the Cart.
	// The Channel must have the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
}

* * Adds all [LineItems](ctp:api:type:LineItem) of a ShoppingList(ctp:api:type:ShoppingList) to the Cart. *

func (CartAddShoppingListAction) MarshalJSON ¶ 

func (obj CartAddShoppingListAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction ¶ 

type CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Using positive or negative quantities increases or decreases the number of items shipped to an address.
	TargetsDelta []ItemShippingTarget `json:"targetsDelta"`
}

func (CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction) MarshalJSON ¶ 

func (obj CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartApplyDeltaToLineItemShippingDetailsTargetsAction ¶ 

type CartApplyDeltaToLineItemShippingDetailsTargetsAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Using positive or negative quantities increases or decreases the number of items shipped to an address.
	TargetsDelta []ItemShippingTarget `json:"targetsDelta"`
}

* * To override the shipping details, see [Set LineItem ShippingDetails](ctp:api:type:CartSetLineItemShippingDetailsAction). *

func (CartApplyDeltaToLineItemShippingDetailsTargetsAction) MarshalJSON ¶ 

func (obj CartApplyDeltaToLineItemShippingDetailsTargetsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartChangeCustomLineItemMoneyAction ¶ 

type CartChangeCustomLineItemMoneyAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Value to set. Must not be empty. Can be a negative amount.
	Money Money `json:"money"`
}

func (CartChangeCustomLineItemMoneyAction) MarshalJSON ¶ 

func (obj CartChangeCustomLineItemMoneyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartChangeCustomLineItemPriceModeAction ¶ added in v1.2.0 

type CartChangeCustomLineItemPriceModeAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// New value to set. Must not be empty.
	Mode CustomLineItemPriceMode `json:"mode"`
}

func (CartChangeCustomLineItemPriceModeAction) MarshalJSON ¶ added in v1.2.0 

func (obj CartChangeCustomLineItemPriceModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartChangeCustomLineItemQuantityAction ¶ 

type CartChangeCustomLineItemQuantityAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// New value to set.
	//
	// If `0`, the Custom Line Item is removed from the Cart.
	Quantity int `json:"quantity"`
}

* * When multiple shipping addresses are set for a Custom Line Item, * use the [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction) update action to change the shipping details. * Since it is not possible for the API to infer how the overall change in the Custom Line Item quantity should be distributed over the sub-quantities, * the `shippingDetails` field is kept in its current state to avoid data loss. * * To change the Custom Line Item quantity and shipping details together, * use this update action in combination with the [Set CustomLineItem ShippingDetails](ctp:api:type:CartSetCustomLineItemShippingDetailsAction) update action * in a single Cart update command. *

func (CartChangeCustomLineItemQuantityAction) MarshalJSON ¶ 

func (obj CartChangeCustomLineItemQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartChangeLineItemQuantityAction ¶ 

type CartChangeLineItemQuantityAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// New value to set.
	//
	// If `0`, the Line Item is removed from the Cart.
	Quantity int `json:"quantity"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` to the given value when changing the quantity of a Line Item with the `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	//
	// The LineItem price is updated as described in LineItem Price selection.
	ExternalPrice *Money `json:"externalPrice,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` and `totalPrice` to the given value when changing the quantity of a Line Item with the `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
}

* * When multiple shipping addresses are set for a Line Item, * use the [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) and [Add LineItem](ctp:api:type:CartAddLineItemAction) update action * to change the shipping details. * Since it is not possible for the API to infer how the overall change in the Line Item quantity should be distributed over the sub-quantities, * the `shippingDetails` field is kept in its current state to avoid data loss. * * To change the Line Item quantity and shipping details together, * use this update action in combination with the [Set LineItem ShippingDetails](ctp:api:type:CartSetLineItemShippingDetailsAction) update action * in a single Cart update command. * * The LineItem(ctp:api:type:LineItem) price is set as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). *

func (CartChangeLineItemQuantityAction) MarshalJSON ¶ 

func (obj CartChangeLineItemQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartChangeTaxCalculationModeAction ¶ 

type CartChangeTaxCalculationModeAction struct {
	// New value to set.
	TaxCalculationMode TaxCalculationMode `json:"taxCalculationMode"`
}

* * Changing the tax calculation mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation). *

func (CartChangeTaxCalculationModeAction) MarshalJSON ¶ 

func (obj CartChangeTaxCalculationModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartChangeTaxModeAction ¶ 

type CartChangeTaxModeAction struct {
	// The new TaxMode.
	TaxMode TaxMode `json:"taxMode"`
}

* * - When `External` TaxMode(ctp:api:type:TaxMode) is changed to `Platform` or `Disabled`, all previously set external Tax Rates are removed. * - When set to `Platform`, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's `shippingAddress`. *

func (CartChangeTaxModeAction) MarshalJSON ¶ 

func (obj CartChangeTaxModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartChangeTaxRoundingModeAction ¶ 

type CartChangeTaxRoundingModeAction struct {
	// New value to set.
	TaxRoundingMode RoundingMode `json:"taxRoundingMode"`
}

* * Changing the tax rounding mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation). *

func (CartChangeTaxRoundingModeAction) MarshalJSON ¶ 

func (obj CartChangeTaxRoundingModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartClassificationTier ¶ 

type CartClassificationTier struct {
	// `key` selected from the `values` of the [CartClassificationType](/projects/project#cartclassificationtype) configured in the Project.
	Value string `json:"value"`
	// Fixed shipping rate for the selected classification.
	Price Money `json:"price"`
	// Appears in response to [Get ShippingMethods for a Cart](ctp:api:endpoint:/{projectKey}/shipping-methods/matching-cart:GET) if the shipping rate matches the search query.
	IsMatching *bool `json:"isMatching,omitempty"`
}

* * Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example, `Light`, `Medium`, or `Heavy`). *

func (CartClassificationTier) MarshalJSON ¶ 

func (obj CartClassificationTier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartClassificationType ¶ 

type CartClassificationType struct {
	// The classification items that can be used for specifying any [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	Values []CustomFieldLocalizedEnumValue `json:"values"`
}

* * Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example, `Light`, `Medium`, or `Heavy`). * Only keys defined in the `values` array can be used to create a tier or to set a value of the `shippingRateInput` on the Cart(ctp:api:type:Cart). * Keys must be unique. *

func (CartClassificationType) MarshalJSON ¶ 

func (obj CartClassificationType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscount ¶ 

type CartDiscount struct {
	// Unique identifier of the CartDiscount.
	ID string `json:"id"`
	// Current version of the CartDiscount.
	Version int `json:"version"`
	// Date and time (UTC) for the CartDiscount was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) for the CartDiscount was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Name of the CartDiscount.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier of the CartDiscount.
	Key *string `json:"key,omitempty"`
	// Description of the CartDiscount.
	Description *LocalizedString `json:"description,omitempty"`
	// Effect of the CartDiscount on the `target`.
	Value CartDiscountValue `json:"value"`
	// Valid [Cart Predicate](/../api/projects/predicates#cart-predicates).
	CartPredicate string `json:"cartPredicate"`
	// Segment of the Cart that is discounted.
	//
	// Empty, if the `value` is `giftLineItem`.
	Target CartDiscountTarget `json:"target,omitempty"`
	// Value between `0` and `1`.
	// All matching CartDiscounts are applied to a Cart in the order defined by this field.
	// A Discount with a higher sortOrder is prioritized.
	// The sort order is unambiguous among all CartDiscounts.
	SortOrder string `json:"sortOrder"`
	// - If a value exists, the Cart Discount applies on [Carts](ctp:api:type:Cart) having a [Store](ctp:api:type:Store) matching any Store defined for this field.
	// - If empty, the Cart Discount applies on all [Carts](ctp:api:type:Cart), irrespective of a Store.
	Stores []StoreKeyReference `json:"stores"`
	// Indicates if the CartDiscount is active and can be applied to the Cart.
	IsActive bool `json:"isActive"`
	// Date and time (UTC) from which the Discount is effective.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Discount is effective.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Indicates if the Discount is used in connection with a [DiscountCode](ctp:api:type:DiscountCode).
	RequiresDiscountCode bool `json:"requiresDiscountCode"`
	// References of all resources that are addressed in the predicate.
	// The API generates this array from the predicate.
	References []Reference `json:"references"`
	// Indicates whether the application of the CartDiscount causes other discounts to be ignored.
	StackingMode StackingMode `json:"stackingMode"`
	// Custom Fields of the CartDiscount.
	Custom *CustomFields `json:"custom,omitempty"`
}

func (*CartDiscount) UnmarshalJSON ¶ 

func (obj *CartDiscount) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountAddStoreAction ¶ added in v1.4.0 

type CartDiscountAddStoreAction struct {
	// [Store](ctp:api:type:Store) to add.
	//
	// A failed update can return the following errors:
	//
	// - If the referenced Stores exceed the [limit](/../api/limits#cart-discounts-stores), a [MaxStoreReferencesReached](ctp:api:type:MaxStoreReferencesReachedError) error is returned.
	// - If the referenced Stores exceed the [limit](/../api/limits#cart-discounts) for Cart Discounts that do not require a Discount Code, a [StoreCartDiscountsLimitReached](ctp:api:type:StoreCartDiscountsLimitReachedError) error is returned.
	Store StoreResourceIdentifier `json:"store"`
}

* * If a referenced Store does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned. * * This action generates a [CartDiscountStoreAdded](ctp:api:type:CartDiscountStoreAddedMessage) Message. *

func (CartDiscountAddStoreAction) MarshalJSON ¶ added in v1.4.0 

func (obj CartDiscountAddStoreAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountChangeCartPredicateAction ¶ 

type CartDiscountChangeCartPredicateAction struct {
	// New value to set.
	CartPredicate string `json:"cartPredicate"`
}

func (CartDiscountChangeCartPredicateAction) MarshalJSON ¶ 

func (obj CartDiscountChangeCartPredicateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountChangeIsActiveAction ¶ 

type CartDiscountChangeIsActiveAction struct {
	// New value to set.
	// If set to `true`, the Discount will be applied to the Cart.
	//
	// If the limit for active Cart Discounts is reached, a [MaxCartDiscountsReached](ctp:api:type:MaxCartDiscountsReachedError) error is returned.
	IsActive bool `json:"isActive"`
}

func (CartDiscountChangeIsActiveAction) MarshalJSON ¶ 

func (obj CartDiscountChangeIsActiveAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountChangeNameAction ¶ 

type CartDiscountChangeNameAction struct {
	// New value to set.
	Name LocalizedString `json:"name"`
}

func (CartDiscountChangeNameAction) MarshalJSON ¶ 

func (obj CartDiscountChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountChangeRequiresDiscountCodeAction ¶ 

type CartDiscountChangeRequiresDiscountCodeAction struct {
	// New value to set.
	// If set to `true`, the Discount can only be used in connection with a [DiscountCode](ctp:api:type:DiscountCode).
	RequiresDiscountCode bool `json:"requiresDiscountCode"`
}

func (CartDiscountChangeRequiresDiscountCodeAction) MarshalJSON ¶ 

func (obj CartDiscountChangeRequiresDiscountCodeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountChangeSortOrderAction ¶ 

type CartDiscountChangeSortOrderAction struct {
	// New value to set (between `0` and `1`).
	// A Discount with a higher sortOrder is prioritized.
	SortOrder string `json:"sortOrder"`
}

func (CartDiscountChangeSortOrderAction) MarshalJSON ¶ 

func (obj CartDiscountChangeSortOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountChangeStackingModeAction ¶ 

type CartDiscountChangeStackingModeAction struct {
	// New value to set.
	StackingMode StackingMode `json:"stackingMode"`
}

func (CartDiscountChangeStackingModeAction) MarshalJSON ¶ 

func (obj CartDiscountChangeStackingModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountChangeTargetAction ¶ 

type CartDiscountChangeTargetAction struct {
	// New value to set.
	Target CartDiscountTarget `json:"target"`
}

func (CartDiscountChangeTargetAction) MarshalJSON ¶ 

func (obj CartDiscountChangeTargetAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountChangeTargetAction) UnmarshalJSON ¶ 

func (obj *CartDiscountChangeTargetAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountChangeValueAction ¶ 

type CartDiscountChangeValueAction struct {
	// New value to set.
	// When trying to set a [CartDiscountValueGiftLineItemDraft](ctp:api:type:CartDiscountValueGiftLineItemDraft) an [InvalidInput](ctp:api:type:InvalidInputError) error is returned.
	Value CartDiscountValueDraft `json:"value"`
}

* * Changes the CartDiscountValue(ctp:api:type:CartDiscountValue) for [relative](ctp:api:type:CartDiscountValueRelative), [absolute](ctp:api:type:CartDiscountValueAbsolute) and [fixed price](ctp:api:type:CartDiscountValueFixed) CartDiscounts. * Changing to [Gift Line Item](ctp:api:type:CartDiscountValueGiftLineItem) is not supported. *

func (CartDiscountChangeValueAction) MarshalJSON ¶ 

func (obj CartDiscountChangeValueAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountChangeValueAction) UnmarshalJSON ¶ 

func (obj *CartDiscountChangeValueAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountCreatedMessage ¶ added in v1.5.0 

type CartDiscountCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Cart Discount](ctp:api:type:CartDiscount) that was created.
	CartDiscount CartDiscount `json:"cartDiscount"`
}

* * Generated after a successful [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) request. *

func (CartDiscountCreatedMessage) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountCreatedMessage) UnmarshalJSON ¶ added in v1.5.0 

func (obj *CartDiscountCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountCreatedMessagePayload ¶ added in v1.5.0 

type CartDiscountCreatedMessagePayload struct {
	// The [Cart Discount](ctp:api:type:CartDiscount) that was created.
	CartDiscount CartDiscount `json:"cartDiscount"`
}

* * Generated after a successful [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) request. *

func (CartDiscountCreatedMessagePayload) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountCustomLineItemsTarget ¶ 

type CartDiscountCustomLineItemsTarget struct {
	// Valid [CustomLineItem target predicate](/../api/projects/predicates#customlineitem-field-identifiers).
	Predicate string `json:"predicate"`
}

* * Discount is applied to [CustomLineItems](ctp:api:type:CustomLineItem) matching the `predicate`. *

func (CartDiscountCustomLineItemsTarget) MarshalJSON ¶ 

func (obj CartDiscountCustomLineItemsTarget) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountDeletedMessage ¶ added in v1.5.0 

type CartDiscountDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts/{id}:DELETE) request. *

func (CartDiscountDeletedMessage) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountDeletedMessage) UnmarshalJSON ¶ added in v1.5.0 

func (obj *CartDiscountDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountDeletedMessagePayload ¶ added in v1.5.0 

type CartDiscountDeletedMessagePayload struct {
}

* * Generated after a successful [Delete CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts/{id}:DELETE) request. *

func (CartDiscountDeletedMessagePayload) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountDraft ¶ 

type CartDiscountDraft struct {
	// Name of the CartDiscount.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier for the CartDiscount.
	Key *string `json:"key,omitempty"`
	// Description of the CartDiscount.
	Description *LocalizedString `json:"description,omitempty"`
	// Effect of the CartDiscount on the `target`.
	Value CartDiscountValueDraft `json:"value"`
	// Valid [Cart Predicate](/../api/projects/predicates#cart-predicates).
	CartPredicate string `json:"cartPredicate"`
	// Segment of the Cart that will be discounted.
	//
	// Must not be set if the `value` is `giftLineItem`.
	Target CartDiscountTarget `json:"target,omitempty"`
	// Value between `0` and `1`.
	// A Discount with a higher sortOrder is prioritized.
	// The sort order must be unambiguous among all CartDiscounts.
	SortOrder string `json:"sortOrder"`
	// - If defined, the Cart Discount applies on [Carts](ctp:api:type:Cart) having a [Store](ctp:api:type:Store) matching any Store defined for this field.
	// - If not defined, the Cart Discount applies on all Carts, irrespective of a Store.
	//
	// If the referenced Stores exceed the [limit](/../api/limits#cart-discounts-stores), a [MaxStoreReferencesReached](ctp:api:type:MaxStoreReferencesReachedError) error is returned.
	//
	// If the referenced Stores exceed the [limit](/../api/limits#cart-discounts) for Cart Discounts that do not require a Discount Code, a [StoreCartDiscountsLimitReached](ctp:api:type:StoreCartDiscountsLimitReachedError) error is returned.
	Stores []StoreResourceIdentifier `json:"stores"`
	// Only active Discounts can be applied to the Cart.
	// If the [limit](/../api/limits#cart-discounts) for active Cart Discounts is reached, a [MaxCartDiscountsReached](ctp:api:type:MaxCartDiscountsReachedError) error is returned.
	IsActive *bool `json:"isActive,omitempty"`
	// Date and time (UTC) from which the Discount is effective.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Discount is effective.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// States whether the Discount can only be used in a connection with a [DiscountCode](ctp:api:type:DiscountCode).
	RequiresDiscountCode *bool `json:"requiresDiscountCode,omitempty"`
	// Specifies whether the application of this discount causes the following discounts to be ignored.
	StackingMode *StackingMode `json:"stackingMode,omitempty"`
	// Custom Fields of the CartDiscount.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (CartDiscountDraft) MarshalJSON ¶ added in v1.4.0 

func (obj CartDiscountDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountDraft) UnmarshalJSON ¶ 

func (obj *CartDiscountDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountLineItemsTarget ¶ 

type CartDiscountLineItemsTarget struct {
	// Valid [LineItem target predicate](/../api/projects/predicates#lineitem-field-identifiers).
	Predicate string `json:"predicate"`
}

* * Discount is applied to [LineItems](ctp:api:type:LineItem) matching the `predicate`. *

func (CartDiscountLineItemsTarget) MarshalJSON ¶ 

func (obj CartDiscountLineItemsTarget) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountPagedQueryResponse ¶ 

type CartDiscountPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [CartDiscounts](ctp:api:type:CartDiscount) matching the query.
	Results []CartDiscount `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of CartDiscount(ctp:api:type:CartDiscount). *

type CartDiscountReference ¶ 

type CartDiscountReference struct {
	// Unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount).
	ID string `json:"id"`
	// Contains the representation of the expanded CartDiscount. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for CartDiscounts.
	Obj *CartDiscount `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a CartDiscount(ctp:api:type:CartDiscount). *

func (CartDiscountReference) MarshalJSON ¶ 

func (obj CartDiscountReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountRemoveStoreAction ¶ added in v1.4.0 

type CartDiscountRemoveStoreAction struct {
	// [Store](ctp:api:type:Store) to remove.
	Store StoreResourceIdentifier `json:"store"`
}

* * If a referenced Store does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned. * * This action generates a [CartDiscountStoreRemoved](ctp:api:type:CartDiscountStoreRemovedMessage) Message. *

func (CartDiscountRemoveStoreAction) MarshalJSON ¶ added in v1.4.0 

func (obj CartDiscountRemoveStoreAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountResourceIdentifier ¶ 

type CartDiscountResourceIdentifier struct {
	// Unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a CartDiscount(ctp:api:type:CartDiscount). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (CartDiscountResourceIdentifier) MarshalJSON ¶ 

func (obj CartDiscountResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountSetCustomFieldAction ¶ 

type CartDiscountSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CartDiscountSetCustomFieldAction) MarshalJSON ¶ 

func (obj CartDiscountSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountSetCustomTypeAction ¶ 

type CartDiscountSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the CartDiscount with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the CartDiscount.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the CartDiscount.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (CartDiscountSetCustomTypeAction) MarshalJSON ¶ 

func (obj CartDiscountSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountSetDescriptionAction ¶ 

type CartDiscountSetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (CartDiscountSetDescriptionAction) MarshalJSON ¶ 

func (obj CartDiscountSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountSetKeyAction ¶ 

type CartDiscountSetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (CartDiscountSetKeyAction) MarshalJSON ¶ 

func (obj CartDiscountSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountSetStoresAction ¶ added in v1.4.0 

type CartDiscountSetStoresAction struct {
	// [Stores](ctp:api:type:Store) to set.
	// Overrides the current list of Stores.
	// If empty, any existing values will be removed.
	//
	// A failed update can return the following errors:
	//
	// - If the referenced Stores exceed the [limit](/../api/limits#cart-discounts-stores), a [MaxStoreReferencesReached](ctp:api:type:MaxStoreReferencesReachedError) error is returned.
	// - If the referenced Stores exceed the [limit](/../api/limits#cart-discounts) for Cart Discounts that do not require a Discount Code, a [StoreCartDiscountsLimitReached](ctp:api:type:StoreCartDiscountsLimitReachedError) error is returned.
	Stores []StoreResourceIdentifier `json:"stores"`
}

* * If a referenced Store does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned. * * This action generates a [CartDiscountStoresSet](ctp:api:type:CartDiscountStoresSetMessage) Message. *

func (CartDiscountSetStoresAction) MarshalJSON ¶ added in v1.4.0 

func (obj CartDiscountSetStoresAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountSetValidFromAction ¶ 

type CartDiscountSetValidFromAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
}

func (CartDiscountSetValidFromAction) MarshalJSON ¶ 

func (obj CartDiscountSetValidFromAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountSetValidFromAndUntilAction ¶ 

type CartDiscountSetValidFromAndUntilAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Value to set.
	// If empty, any existing value will be removed.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

func (CartDiscountSetValidFromAndUntilAction) MarshalJSON ¶ 

func (obj CartDiscountSetValidFromAndUntilAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountSetValidUntilAction ¶ 

type CartDiscountSetValidUntilAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

func (CartDiscountSetValidUntilAction) MarshalJSON ¶ 

func (obj CartDiscountSetValidUntilAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountShippingCostTarget ¶ 

type CartDiscountShippingCostTarget struct {
}

* * Discount is applied to the shipping costs of the Cart(ctp:api:type:Cart). *

func (CartDiscountShippingCostTarget) MarshalJSON ¶ 

func (obj CartDiscountShippingCostTarget) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountStoreAddedMessage ¶ added in v1.5.0 

type CartDiscountStoreAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Store](ctp:api:type:Store) that was added to the [Cart Discount](ctp:api:type:CartDiscount).
	Store StoreKeyReference `json:"store"`
}

* * Generated after a successful [Add Store](ctp:api:type:CartDiscountAddStoreAction) update action. *

func (CartDiscountStoreAddedMessage) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountStoreAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountStoreAddedMessage) UnmarshalJSON ¶ added in v1.5.0 

func (obj *CartDiscountStoreAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountStoreAddedMessagePayload ¶ added in v1.5.0 

type CartDiscountStoreAddedMessagePayload struct {
	// The [Store](ctp:api:type:Store) that was added to the [Cart Discount](ctp:api:type:CartDiscount).
	Store StoreKeyReference `json:"store"`
}

* * Generated after a successful [Add Store](ctp:api:type:CartDiscountAddStoreAction) update action. *

func (CartDiscountStoreAddedMessagePayload) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountStoreAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountStoreRemovedMessage ¶ added in v1.5.0 

type CartDiscountStoreRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Store](ctp:api:type:Store) that was removed from the [Cart Discount](ctp:api:type:CartDiscount).
	Store StoreKeyReference `json:"store"`
}

* * Generated after a successful [Remove Store](ctp:api:type:CartDiscountRemoveStoreAction) update action. *

func (CartDiscountStoreRemovedMessage) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountStoreRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountStoreRemovedMessage) UnmarshalJSON ¶ added in v1.5.0 

func (obj *CartDiscountStoreRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountStoreRemovedMessagePayload ¶ added in v1.5.0 

type CartDiscountStoreRemovedMessagePayload struct {
	// The [Store](ctp:api:type:Store) that was removed from the [Cart Discount](ctp:api:type:CartDiscount).
	Store StoreKeyReference `json:"store"`
}

* * Generated after a successful [Remove Store](ctp:api:type:CartDiscountRemoveStoreAction) update action. *

func (CartDiscountStoreRemovedMessagePayload) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountStoreRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountStoresSetMessage ¶ added in v1.5.0 

type CartDiscountStoresSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Stores](ctp:api:type:Store) of the [Cart Discount](ctp:api:type:CartDiscount) after the [Set Stores](ctp:api:type:CartDiscountSetStoresAction) update action.
	Stores []StoreKeyReference `json:"stores"`
}

* * Generated after a successful [Set Stores](ctp:api:type:CartDiscountSetStoresAction) update action. *

func (CartDiscountStoresSetMessage) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountStoresSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountStoresSetMessage) UnmarshalJSON ¶ added in v1.5.0 

func (obj *CartDiscountStoresSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountStoresSetMessagePayload ¶ added in v1.5.0 

type CartDiscountStoresSetMessagePayload struct {
	// [Stores](ctp:api:type:Store) of the [Cart Discount](ctp:api:type:CartDiscount) after the [Set Stores](ctp:api:type:CartDiscountSetStoresAction) update action.
	Stores []StoreKeyReference `json:"stores"`
}

* * Generated after a successful [Set Stores](ctp:api:type:CartDiscountSetStoresAction) update action. *

func (CartDiscountStoresSetMessagePayload) MarshalJSON ¶ added in v1.5.0 

func (obj CartDiscountStoresSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountTarget ¶ 

type CartDiscountTarget interface{}

type CartDiscountTotalPriceTarget ¶ added in v1.4.0 

type CartDiscountTotalPriceTarget struct {
}

* * Discount is applied to the total price of the Cart(ctp:api:type:Cart). *

func (CartDiscountTotalPriceTarget) MarshalJSON ¶ added in v1.4.0 

func (obj CartDiscountTotalPriceTarget) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountUpdate ¶ 

type CartDiscountUpdate struct {
	// Expected version of the CartDiscount on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the CartDiscount.
	Actions []CartDiscountUpdateAction `json:"actions"`
}

func (*CartDiscountUpdate) UnmarshalJSON ¶ 

func (obj *CartDiscountUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountUpdateAction ¶ 

type CartDiscountUpdateAction interface{}

type CartDiscountValue ¶ 

type CartDiscountValue interface{}

type CartDiscountValueAbsolute ¶ 

type CartDiscountValueAbsolute struct {
	// Cent precision money values in different currencies.
	Money []CentPrecisionMoney `json:"money"`
}

* * Discounts the CartDiscountTarget(ctp:api:type:CartDiscountTarget) by an absolute amount (not allowed for MultiBuyLineItemsTarget(ctp:api:type:MultiBuyLineItemsTarget) and MultiBuyCustomLineItemsTarget(ctp:api:type:MultiBuyCustomLineItemsTarget)). *

func (CartDiscountValueAbsolute) MarshalJSON ¶ 

func (obj CartDiscountValueAbsolute) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountValueAbsoluteDraft ¶ 

type CartDiscountValueAbsoluteDraft struct {
	// Money values in different currencies.
	// An absolute Cart Discount will match a price only if the array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be decreased by 10€ and the matching $ price will be decreased by 15$. If the array has multiple values of the same currency, the API returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	//
	// If the array is empty, the discount does not apply.
	Money []Money `json:"money"`
}

func (CartDiscountValueAbsoluteDraft) MarshalJSON ¶ 

func (obj CartDiscountValueAbsoluteDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountValueDraft ¶ 

type CartDiscountValueDraft interface{}

type CartDiscountValueFixed ¶ 

type CartDiscountValueFixed struct {
	// Money values in [cent precision](ctp:api:type:CentPrecisionMoney) or [high precision](ctp:api:type:HighPrecisionMoney) of different currencies.
	Money []TypedMoney `json:"money"`
}

* * Sets the DiscountedLineItemPrice(ctp:api:type:DiscountedLineItemPrice) of the CartDiscountLineItemsTarget(ctp:api:type:CartDiscountLineItemsTarget) or CartDiscountCustomLineItemsTarget(ctp:api:type:CartDiscountCustomLineItemsTarget) to the value specified in the `money` field, if it is lower than the current Line Item price for the same currency. If the Line Item price is already discounted to a price equal to or lower than the respective price in the `money` field, this Discount is not applied. If the `quantity` of the Line Item eligible for the Discount is greater than `1`, the fixed price discount is only applied to the Line Item portion for which the `money` value is lesser than their current price. *

func (CartDiscountValueFixed) MarshalJSON ¶ 

func (obj CartDiscountValueFixed) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountValueFixed) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CartDiscountValueFixed) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountValueFixedDraft ¶ 

type CartDiscountValueFixedDraft struct {
	// Money values provided either in [cent precision](ctp:api:type:Money) or [high precision](ctp:api:type:HighPrecisionMoneyDraft) for different currencies.
	// A fixed Cart Discount will match a price only if the array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be discounted by 10€ and the matching $ price will be discounted to 15$. If the array has multiple values of the same currency, the API returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	//
	// If the array is empty, the discount does not apply.
	Money []TypedMoneyDraft `json:"money"`
}

* * Sets the DiscountedLineItemPrice(ctp:api:type:DiscountedLineItemPrice) of the CartDiscountLineItemsTarget(ctp:api:type:CartDiscountLineItemsTarget) or CartDiscountCustomLineItemsTarget(ctp:api:type:CartDiscountCustomLineItemsTarget) to the value specified in the `money` field, if it is lower than the current Line Item price for the same currency. If the Line Item price is already discounted to a price equal to or lower than the respective price in the `money` field, this Discount is not applied. *

func (CartDiscountValueFixedDraft) MarshalJSON ¶ 

func (obj CartDiscountValueFixedDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDiscountValueFixedDraft) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CartDiscountValueFixedDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartDiscountValueGiftLineItem ¶ 

type CartDiscountValueGiftLineItem struct {
	// Reference to a Product.
	//
	// A Gift Line Item can be present on a Cart even if the referenced Product is unpublished.
	Product ProductReference `json:"product"`
	// [ProductVariant](ctp:api:type:ProductVariant) of the Product.
	VariantId int `json:"variantId"`
	// Channel must have the [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum) `InventorySupply`.
	SupplyChannel *ChannelReference `json:"supplyChannel,omitempty"`
	// Channel must have the [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum) `ProductDistribution`.
	DistributionChannel *ChannelReference `json:"distributionChannel,omitempty"`
}

func (CartDiscountValueGiftLineItem) MarshalJSON ¶ 

func (obj CartDiscountValueGiftLineItem) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountValueGiftLineItemDraft ¶ 

type CartDiscountValueGiftLineItemDraft struct {
	// ResourceIdentifier of a Product.
	//
	// A Gift Line Item is added to a Cart even if the referenced Product is unpublished.
	Product ProductResourceIdentifier `json:"product"`
	// [ProductVariant](ctp:api:type:ProductVariant) of the Product.
	VariantId int `json:"variantId"`
	// Channel must have the role `InventorySupply`.
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
	// Channel must have the role `ProductDistribution`.
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
}

* * Can only be used in a CartDiscountDraft(ctp:api:type:CartDiscountDraft) with no `target` specified. * Hence, this type can not be used in the [Change Value](ctp:api:type:CartDiscountChangeValueAction) update action. *

func (CartDiscountValueGiftLineItemDraft) MarshalJSON ¶ 

func (obj CartDiscountValueGiftLineItemDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountValueRelative ¶ 

type CartDiscountValueRelative struct {
	// Fraction (per ten thousand) the price is reduced by. For example, `1000` will result in a 10% price reduction.
	Permyriad int `json:"permyriad"`
}

* * Discounts the CartDiscountTarget(ctp:api:type:CartDiscountTarget) relative to its price. *

func (CartDiscountValueRelative) MarshalJSON ¶ 

func (obj CartDiscountValueRelative) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDiscountValueRelativeDraft ¶ 

type CartDiscountValueRelativeDraft struct {
	// Fraction (per ten thousand) the price is reduced by. For example, `1000` will result in a 10% price reduction.
	Permyriad int `json:"permyriad"`
}

func (CartDiscountValueRelativeDraft) MarshalJSON ¶ 

func (obj CartDiscountValueRelativeDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartDraft ¶ 

type CartDraft struct {
	// Currency the Cart uses.
	Currency string `json:"currency"`
	// User-defined unique identifier for the Cart.
	Key *string `json:"key,omitempty"`
	// `id` of the [Customer](ctp:api:type:Customer) that the Cart belongs to.
	CustomerId *string `json:"customerId,omitempty"`
	// Email address of the Customer that the Cart belongs to.
	CustomerEmail *string `json:"customerEmail,omitempty"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Customer Group of the Customer that the Cart belongs to. Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	//
	// It is automatically set if the Customer referenced in `customerId` belongs to a Customer Group.
	// It can also be set explicitly when no `customerId` is present.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
	// [Anonymous session](ctp:api:type:AnonymousSession) associated with the Cart.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. When the `customerId` of the Cart is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
	BusinessUnit *BusinessUnitResourceIdentifier `json:"businessUnit,omitempty"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Store the Cart should belong to. Once set, it cannot be updated.
	Store *StoreResourceIdentifier `json:"store,omitempty"`
	// [Line Items](ctp:api:type:LineItems) to add to the Cart.
	LineItems []LineItemDraft `json:"lineItems"`
	// [Custom Line Items](ctp:api:type:CustomLineItems) to add to the Cart.
	CustomLineItems []CustomLineItemDraft `json:"customLineItems"`
	// Determines how Tax Rates are set.
	TaxMode *TaxMode `json:"taxMode,omitempty"`
	// External Tax Rate for the `shippingMethod` if the Cart has `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRateForShippingMethod *ExternalTaxRateDraft `json:"externalTaxRateForShippingMethod,omitempty"`
	// Determines how monetary values are rounded when calculating taxes for `taxedPrice`.
	TaxRoundingMode *RoundingMode `json:"taxRoundingMode,omitempty"`
	// Determines how taxes are calculated for `taxedPrice`.
	TaxCalculationMode *TaxCalculationMode `json:"taxCalculationMode,omitempty"`
	// Determines how stock quantities are tracked for Line Items in the Cart.
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Billing address associated with the Cart.
	BillingAddress *BaseAddress `json:"billingAddress,omitempty"`
	// Shipping address for a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode). Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
	// Must be one of the `itemShippingAddresses` when that field is also provided.
	ShippingAddress *BaseAddress `json:"shippingAddress,omitempty"`
	// Shipping Method for a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode). If the referenced [ShippingMethod](ctp:api:type:ShippingMethod) has a `predicate` that does not match the Cart, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned when [creating a Cart](ctp:api:endpoint:/{projectKey}/carts:POST).
	ShippingMethod *ShippingMethodResourceIdentifier `json:"shippingMethod,omitempty"`
	// Used as an input to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it must be [ClassificationShippingRateInputDraft](ctp:api:type:ClassificationShippingRateInputDraft).
	// - If `CartScore`, it must be [ScoreShippingRateInputDraft](ctp:api:type:ScoreShippingRateInputDraft).
	// - If `CartValue`, it cannot be set.
	ShippingRateInput ShippingRateInputDraft `json:"shippingRateInput,omitempty"`
	// - If set to `Single`, only a single Shipping Method can be added to the Cart.
	// - If set to `Multiple`, multiple Shipping Methods can be added to the Cart.
	ShippingMode *ShippingMode `json:"shippingMode,omitempty"`
	// Custom Shipping Methods for a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	CustomShipping []CustomShippingDraft `json:"customShipping"`
	// Shipping Methods for a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	Shipping []ShippingDraft `json:"shipping"`
	// Multiple shipping addresses of the Cart. Each address must contain a `key` that is unique in this Cart.
	// The keys are used by [LineItems](ctp:api:type:LineItem) to reference these addresses under their `shippingDetails`.
	//
	// For Carts with `Single` [ShippingMode](ctp:api:type:ShippingMode): eligible Shipping Methods or applicable Tax Rates are determined by the address `shippingAddress`, and not `itemShippingAddresses`.
	ItemShippingAddresses []BaseAddress `json:"itemShippingAddresses"`
	// `code` of the existing [DiscountCodes](ctp:api:type:DiscountCode) to add to the Cart.
	DiscountCodes []string `json:"discountCodes"`
	// Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	// If used for [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/carts:POST), the provided country must be one of the [Store's](ctp:api:type:Store) `countries`.
	Country *string `json:"country,omitempty"`
	// Languages of the Cart. Can only contain languages supported by the [Project](ctp:api:type:Project).
	Locale *string `json:"locale,omitempty"`
	// Indicates how the Cart was created.
	Origin *CartOrigin `json:"origin,omitempty"`
	// Number of days after which an active Cart is deleted since its last modification.
	// If not provided, the default value for this field configured in [Project settings](ctp:api:type:CartsConfiguration) is assigned.
	//
	// Create a [ChangeSubscription](ctp:api:type:ChangeSubscription) for Carts to receive a [ResourceDeletedDeliveryPayload](ctp:api:type:ResourceDeletedDeliveryPayload) upon deletion of the Cart.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
	// Custom Fields for the Cart.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (CartDraft) MarshalJSON ¶ 

func (obj CartDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartDraft) UnmarshalJSON ¶ 

func (obj *CartDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartFreezeCartAction ¶ added in v1.3.0 

type CartFreezeCartAction struct {
}

* * Changes the CartState(ctp:api:type:CartState) from `Active` to `Frozen`. Results in a [Frozen Cart](ctp:api:type:FrozenCarts). * Fails with [InvalidOperation](ctp:api:type:InvalidOperation) error when the Cart is empty. *

func (CartFreezeCartAction) MarshalJSON ¶ added in v1.3.0 

func (obj CartFreezeCartAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartOrigin ¶ 

type CartOrigin string

* * Indicates who created the Cart. * 

const (
	CartOriginCustomer CartOrigin = "Customer"
	CartOriginMerchant CartOrigin = "Merchant"
	CartOriginQuote    CartOrigin = "Quote"
)

type CartPagedQueryResponse ¶ 

type CartPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Carts](ctp:api:type:Cart) matching the query.
	Results []Cart `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of Cart(ctp:api:type:Cart). *

type CartRecalculateAction ¶ 

type CartRecalculateAction struct {
	// - Leave empty or set to `false` to only update the Prices and TaxRates of the Line Items.
	// - Set to `true` to update the Line Items' product data (like `name`, `variant` and `productType`) also.
	UpdateProductData *bool `json:"updateProductData,omitempty"`
}

* * This update action does not set any Cart field in particular, but it triggers several [Cart updates](/../api/carts-orders-overview#cart-updates) * to bring prices and discounts to the latest state. Those can become stale over time when no Cart updates have been performed for a while and * prices on related Products have changed in the meanwhile. * * If the `priceMode` of the Product(ctp:api:type:Product) related to a Line Item is of `Embedded` [ProductPriceMode](ctp:api:type:ProductPriceModeEnum), * the updated `price` of that LineItem(ctp:api:type:LineItem) may not correspond to a Price in the `variant.prices` anymore. *

func (CartRecalculateAction) MarshalJSON ¶ 

func (obj CartRecalculateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartReference ¶ 

type CartReference struct {
	// Unique identifier of the referenced [Cart](ctp:api:type:Cart).
	ID string `json:"id"`
	// Contains the representation of the expanded Cart. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Carts.
	Obj *Cart `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Cart(ctp:api:type:Cart). *

func (CartReference) MarshalJSON ¶ 

func (obj CartReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartRemoveCustomLineItemAction ¶ 

type CartRemoveCustomLineItemAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
}

* * This update action does not support specifying quantities, unlike the [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) update action. * * If `shippingDetails` must be partially removed, use the [Change CustomLineItem Quantity](ctp:api:type:CartChangeCustomLineItemQuantityAction) update action. *

func (CartRemoveCustomLineItemAction) MarshalJSON ¶ 

func (obj CartRemoveCustomLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartRemoveDiscountCodeAction ¶ 

type CartRemoveDiscountCodeAction struct {
	// Discount Code to remove from the Cart.
	DiscountCode DiscountCodeReference `json:"discountCode"`
}

func (CartRemoveDiscountCodeAction) MarshalJSON ¶ 

func (obj CartRemoveDiscountCodeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartRemoveItemShippingAddressAction ¶ 

type CartRemoveItemShippingAddressAction struct {
	// `key` of the Address to remove from `itemShippingAddresses`.
	AddressKey string `json:"addressKey"`
}

* * An address can only be removed if it is not referenced in any ItemShippingTarget(ctp:api:type:ItemShippingTarget) of the Cart. *

func (CartRemoveItemShippingAddressAction) MarshalJSON ¶ 

func (obj CartRemoveItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartRemoveLineItemAction ¶ 

type CartRemoveLineItemAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Amount to subtract from the LineItem's `quantity`.
	// If absent, the LineItem is removed from the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` to the given value when decreasing the quantity of a Line Item with the `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalPrice *Money `json:"externalPrice,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` and `totalPrice` to the given value when decreasing the quantity of a Line Item with the `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
	// Container for Line Item-specific addresses to remove.
	ShippingDetailsToRemove *ItemShippingDetailsDraft `json:"shippingDetailsToRemove,omitempty"`
}

* * The LineItem(ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). *

func (CartRemoveLineItemAction) MarshalJSON ¶ 

func (obj CartRemoveLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartRemovePaymentAction ¶ 

type CartRemovePaymentAction struct {
	// Payment to remove from the Cart.
	Payment PaymentResourceIdentifier `json:"payment"`
}

func (CartRemovePaymentAction) MarshalJSON ¶ 

func (obj CartRemovePaymentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartRemoveShippingMethodAction ¶ added in v1.2.0 

type CartRemoveShippingMethodAction struct {
	// User-defined unique identifier of the Shipping Method to remove from the Cart.
	ShippingKey string `json:"shippingKey"`
}

* * Removes a Shipping Method from a Cart that has the `Multiple` ShippingMode(ctp:api:type:ShippingMode). *

func (CartRemoveShippingMethodAction) MarshalJSON ¶ added in v1.2.0 

func (obj CartRemoveShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartResourceIdentifier ¶ 

type CartResourceIdentifier struct {
	// Unique identifier of the referenced [Cart](ctp:api:type:Cart). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [Cart](ctp:api:type:Cart). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a Cart(ctp:api:type:Cart). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (CartResourceIdentifier) MarshalJSON ¶ 

func (obj CartResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartScoreTier ¶ 

type CartScoreTier struct {
	// Abstract value for categorizing a Cart. The range starts at `0`. The default price covers `0`, tiers start at `1`. See [Tiered shipping rates](/../api/shipping-delivery-overview#tiered-shipping-rates) for details and examples.
	Score int `json:"score"`
	// Defines a fixed price for the `score`.
	Price *Money `json:"price,omitempty"`
	// Dynamically calculates a Price for a range of scores.
	PriceFunction *PriceFunction `json:"priceFunction,omitempty"`
	// Appears in response to [Get ShippingMethods for a Cart](ctp:api:endpoint:/{projectKey}/shipping-methods/matching-cart:GET) if the shipping rate matches the search query.
	IsMatching *bool `json:"isMatching,omitempty"`
}

* * Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges). * Either `price` or `priceFunction` is required. *

func (CartScoreTier) MarshalJSON ¶ 

func (obj CartScoreTier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartScoreType ¶ 

type CartScoreType struct {
}

* * Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges). *

func (CartScoreType) MarshalJSON ¶ 

func (obj CartScoreType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetAnonymousIdAction ¶ 

type CartSetAnonymousIdAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	AnonymousId *string `json:"anonymousId,omitempty"`
}

func (CartSetAnonymousIdAction) MarshalJSON ¶ 

func (obj CartSetAnonymousIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetBillingAddressAction ¶ 

type CartSetBillingAddressAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Address *BaseAddress `json:"address,omitempty"`
}

func (CartSetBillingAddressAction) MarshalJSON ¶ 

func (obj CartSetBillingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetBillingAddressCustomFieldAction ¶ 

type CartSetBillingAddressCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CartSetBillingAddressCustomFieldAction) MarshalJSON ¶ 

func (obj CartSetBillingAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetBillingAddressCustomTypeAction ¶ 

type CartSetBillingAddressCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the `billingAddress` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `billingAddress`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `billingAddress`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (CartSetBillingAddressCustomTypeAction) MarshalJSON ¶ 

func (obj CartSetBillingAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetBusinessUnitAction ¶ added in v1.3.0 

type CartSetBusinessUnitAction struct {
	// New Business Unit to assign to the Cart, which must have access to the [Store](/../api/projects/stores) that is set on the Cart.
	BusinessUnit BusinessUnitResourceIdentifier `json:"businessUnit"`
}

* * Updates the Business Unit on the Cart. The Cart must have an existing Business Unit assigned already. *

func (CartSetBusinessUnitAction) MarshalJSON ¶ added in v1.3.0 

func (obj CartSetBusinessUnitAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCartTotalTaxAction ¶ 

type CartSetCartTotalTaxAction struct {
	// The Cart's total gross price becoming the `totalGross` field (`totalNet` + taxes) on the Cart's `taxedPrice`.
	ExternalTotalGross Money `json:"externalTotalGross"`
	// Set if the `externalTotalGross` price is a sum of portions with different tax rates.
	ExternalTaxPortions []TaxPortionDraft `json:"externalTaxPortions"`
}

* * This update action results in the `taxedPrice` field being added to the Cart when the `ExternalAmount` TaxMode(ctp:api:type:TaxMode) is used. *

func (CartSetCartTotalTaxAction) MarshalJSON ¶ 

func (obj CartSetCartTotalTaxAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCountryAction ¶ 

type CartSetCountryAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	//
	// If the Cart is bound to a `store`, the provided value must be included in the [Store's](ctp:api:type:Store) `countries`.
	// Otherwise a [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) error is returned.
	Country *string `json:"country,omitempty"`
}

* * Setting the country can lead to changes in the LineItem(ctp:api:type:LineItem) prices. *

func (CartSetCountryAction) MarshalJSON ¶ 

func (obj CartSetCountryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomFieldAction ¶ 

type CartSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CartSetCustomFieldAction) MarshalJSON ¶ 

func (obj CartSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomLineItemCustomFieldAction ¶ 

type CartSetCustomLineItemCustomFieldAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CartSetCustomLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj CartSetCustomLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomLineItemCustomTypeAction ¶ 

type CartSetCustomLineItemCustomTypeAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the CustomLineItem with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the CustomLineItem.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the CustomLineItem.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (CartSetCustomLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj CartSetCustomLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomLineItemShippingDetailsAction ¶ 

type CartSetCustomLineItemShippingDetailsAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
}

func (CartSetCustomLineItemShippingDetailsAction) MarshalJSON ¶ 

func (obj CartSetCustomLineItemShippingDetailsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomLineItemTaxAmountAction ¶ 

type CartSetCustomLineItemTaxAmountAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ExternalTaxAmount *ExternalTaxAmountDraft `json:"externalTaxAmount,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Custom Line Item.
	// This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Can be used if the Cart has the `ExternalAmount` TaxMode(ctp:api:type:TaxMode). *

func (CartSetCustomLineItemTaxAmountAction) MarshalJSON ¶ 

func (obj CartSetCustomLineItemTaxAmountAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomLineItemTaxRateAction ¶ 

type CartSetCustomLineItemTaxRateAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Value to set.
	// If empty, an existing value is removed.
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Custom Line Item.
	// This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Can be used if the Cart has the `External` TaxMode(ctp:api:type:TaxMode). *

func (CartSetCustomLineItemTaxRateAction) MarshalJSON ¶ 

func (obj CartSetCustomLineItemTaxRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomShippingMethodAction ¶ 

type CartSetCustomShippingMethodAction struct {
	// Name of the custom Shipping Method.
	ShippingMethodName string `json:"shippingMethodName"`
	// Determines the shipping price.
	ShippingRate ShippingRateDraft `json:"shippingRate"`
	// Tax Category used to determine the Tax Rate when the Cart has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// External Tax Rate for the `shippingRate` to be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
}

* * To set the Cart's custom Shipping Method (independent of the [ShippingMethods](ctp:api:type:ShippingMethod) managed through * the [Shipping Methods API](/projects/shippingMethods)) the Cart must have * the `Single` ShippingMode(ctp:api:type:ShippingMode) and a `shippingAddress`. * * To unset a custom Shipping Method on a Cart, use the [Set ShippingMethod](ctp:api:type:CartSetShippingMethodAction) update action * without the `shippingMethod` field instead. *

func (CartSetCustomShippingMethodAction) MarshalJSON ¶ 

func (obj CartSetCustomShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomTypeAction ¶ 

type CartSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Cart with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Cart.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Cart.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (CartSetCustomTypeAction) MarshalJSON ¶ 

func (obj CartSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomerEmailAction ¶ 

type CartSetCustomerEmailAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Email *string `json:"email,omitempty"`
}

func (CartSetCustomerEmailAction) MarshalJSON ¶ 

func (obj CartSetCustomerEmailAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomerGroupAction ¶ 

type CartSetCustomerGroupAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
}

* * This update action can only be used if a Customer is not assigned to a Cart. * If a Customer is already assigned, the Cart has the same Customer Group as the assigned Customer. * * Setting the Customer Group also updates the LineItem(ctp:api:type:LineItem) `prices` according to the Customer Group. *

func (CartSetCustomerGroupAction) MarshalJSON ¶ 

func (obj CartSetCustomerGroupAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetCustomerIdAction ¶ 

type CartSetCustomerIdAction struct {
	// `id` of an existing [Customer](ctp:api:type:Customer). If empty, any value is removed.
	CustomerId *string `json:"customerId,omitempty"`
}

* * Setting the Cart's `customerId` can lead to updates on all its LineItem(ctp:api:type:LineItem) `prices`. * * If the Customer with the specified `id` cannot be found, this update action returns a * [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error. *

func (CartSetCustomerIdAction) MarshalJSON ¶ 

func (obj CartSetCustomerIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetDeleteDaysAfterLastModificationAction ¶ 

type CartSetDeleteDaysAfterLastModificationAction struct {
	// Value to set.
	// If not provided, the default value for this field configured in [Project settings](ctp:api:type:CartsConfiguration) is assigned.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
}

* * Number of days after which a Cart with `Active` CartState(ctp:api:type:CartState) is deleted since its last modification. * * If a ChangeSubscription(ctp:api:type:ChangeSubscription) exists for Carts, a ResourceDeletedDeliveryPayload(ctp:api:type:ResourceDeletedDeliveryPayload) is sent. *

func (CartSetDeleteDaysAfterLastModificationAction) MarshalJSON ¶ 

func (obj CartSetDeleteDaysAfterLastModificationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetDirectDiscountsAction ¶ added in v1.2.0 

type CartSetDirectDiscountsAction struct {
	// - If set, all existing Direct Discounts are replaced.
	//   The discounts apply in the order they are added to the list.
	// - If empty, all existing Direct Discounts are removed and all affected prices on the Cart or Order are recalculated.
	Discounts []DirectDiscountDraft `json:"discounts"`
}

* * Adds a DirectDiscount(ctp:api:type:DirectDiscount), but only if no DiscountCode(ctp:api:type:DiscountCode) has been added to the Cart. * Either a Discount Code or a Direct Discount can exist on a Cart at the same time. *

func (CartSetDirectDiscountsAction) MarshalJSON ¶ added in v1.2.0 

func (obj CartSetDirectDiscountsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetItemShippingAddressCustomFieldAction ¶ 

type CartSetItemShippingAddressCustomFieldAction struct {
	// `key` of the [Address](ctp:api:type:Address) in `itemShippingAddress`.
	AddressKey string `json:"addressKey"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CartSetItemShippingAddressCustomFieldAction) MarshalJSON ¶ 

func (obj CartSetItemShippingAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetItemShippingAddressCustomTypeAction ¶ 

type CartSetItemShippingAddressCustomTypeAction struct {
	// `key` of the [Address](ctp:api:type:Address) in `itemShippingAddress`.
	AddressKey string `json:"addressKey"`
	// Defines the [Type](ctp:api:type:Type) that extends the `itemShippingAddress` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `itemShippingAddress`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `itemShippingAddress`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (CartSetItemShippingAddressCustomTypeAction) MarshalJSON ¶ 

func (obj CartSetItemShippingAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetKeyAction ¶ 

type CartSetKeyAction struct {
	// Value to set.
	// If empty, any existing key will be removed.
	Key *string `json:"key,omitempty"`
}

func (CartSetKeyAction) MarshalJSON ¶ 

func (obj CartSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemCustomFieldAction ¶ 

type CartSetLineItemCustomFieldAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CartSetLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj CartSetLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemCustomTypeAction ¶ 

type CartSetLineItemCustomTypeAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Line Item with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Line Item.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Line Item.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (CartSetLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj CartSetLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemDistributionChannelAction ¶ 

type CartSetLineItemDistributionChannelAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// - If present, a [Reference](ctp:api:type:Reference) to the Channel is set for the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	// - If not present, the current [Reference](ctp:api:type:Reference) to a distribution channel is removed from the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	//   The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
}

* * Setting a distribution channel for a LineItem(ctp:api:type:LineItem) can lead to an updated `price` as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). *

func (CartSetLineItemDistributionChannelAction) MarshalJSON ¶ 

func (obj CartSetLineItemDistributionChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemInventoryModeAction ¶ added in v1.3.0 

type CartSetLineItemInventoryModeAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Inventory mode specific to the Line Item only, and valid for the entire `quantity` of the Line Item.
	// Set only if the inventory mode should be different from the `inventoryMode` specified on the [Cart](ctp:api:type:Cart).
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
}

func (CartSetLineItemInventoryModeAction) MarshalJSON ¶ added in v1.3.0 

func (obj CartSetLineItemInventoryModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemPriceAction ¶ 

type CartSetLineItemPriceAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If `externalPrice` is not given and the `priceMode` is `ExternalPrice`, the external price is unset and the `priceMode` is set to `Platform`.
	ExternalPrice *Money `json:"externalPrice,omitempty"`
}

* * Sets the LineItem(ctp:api:type:LineItem) `price` and changes the `priceMode` to `ExternalPrice` LineItemPriceMode(ctp:api:type:LineItemPriceMode). *

func (CartSetLineItemPriceAction) MarshalJSON ¶ 

func (obj CartSetLineItemPriceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemShippingDetailsAction ¶ 

type CartSetLineItemShippingDetailsAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If empty, the existing value is removed.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
}

func (CartSetLineItemShippingDetailsAction) MarshalJSON ¶ 

func (obj CartSetLineItemShippingDetailsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemSupplyChannelAction ¶ 

type CartSetLineItemSupplyChannelAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// - If present, a [Reference](ctp:api:type:Reference) to the Channel is set for the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	// - If not present, the current [Reference](ctp:api:type:Reference) to a supply channel will be removed from the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	//   The Channel must have the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
}

* * Performing this action has no impact on inventory that should be reserved. *

func (CartSetLineItemSupplyChannelAction) MarshalJSON ¶ 

func (obj CartSetLineItemSupplyChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemTaxAmountAction ¶ 

type CartSetLineItemTaxAmountAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ExternalTaxAmount *ExternalTaxAmountDraft `json:"externalTaxAmount,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Line Item.
	// This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Can be used if the Cart has the `ExternalAmount` TaxMode(ctp:api:type:TaxMode). *

func (CartSetLineItemTaxAmountAction) MarshalJSON ¶ 

func (obj CartSetLineItemTaxAmountAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemTaxRateAction ¶ 

type CartSetLineItemTaxRateAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Line Item.
	// This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Can be used if the Cart has the `External` TaxMode(ctp:api:type:TaxMode). *

func (CartSetLineItemTaxRateAction) MarshalJSON ¶ 

func (obj CartSetLineItemTaxRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLineItemTotalPriceAction ¶ 

type CartSetLineItemTotalPriceAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If `externalTotalPrice` is not given and the `priceMode` is `ExternalTotal`, the external price is unset and the `priceMode` is set to `Platform`.
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
}

* * Sets the LineItem(ctp:api:type:LineItem) `totalPrice` and `price`, and changes the `priceMode` to `ExternalTotal` LineItemPriceMode(ctp:api:type:LineItemPriceMode). *

func (CartSetLineItemTotalPriceAction) MarshalJSON ¶ 

func (obj CartSetLineItemTotalPriceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetLocaleAction ¶ 

type CartSetLocaleAction struct {
	// Value to set.
	// Must be one of the [Project](ctp:api:type:Project)'s `languages`.
	// If empty, any existing value will be removed.
	Locale *string `json:"locale,omitempty"`
}

func (CartSetLocaleAction) MarshalJSON ¶ 

func (obj CartSetLocaleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetShippingAddressAction ¶ 

type CartSetShippingAddressAction struct {
	// Value to set.
	// If not set, the shipping address is unset, and the `taxedPrice` and `taxRate` are unset in all Line Items of the Cart.
	Address *BaseAddress `json:"address,omitempty"`
}

* * Setting the shipping address also sets the TaxRate(ctp:api:type:TaxRate) of Line Items and calculates the TaxedPrice(ctp:api:type:TaxedPrice). * * If a matching price cannot be found for the given shipping address during [Line Item Price selection](ctp:api:type:LineItemPriceSelection), * a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. * * If you want to allow shipping to states inside a country that are not explicitly covered by a TaxRate, * set the `countryTaxRateFallbackEnabled` field to `true` in the CartsConfiguration(ctp:api:type:CartsConfiguration) by using * the [Change CountryTaxRateFallbackEnabled](ctp:api:type:ProjectChangeCountryTaxRateFallbackEnabledAction) update action. *

func (CartSetShippingAddressAction) MarshalJSON ¶ 

func (obj CartSetShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetShippingAddressCustomFieldAction ¶ 

type CartSetShippingAddressCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CartSetShippingAddressCustomFieldAction) MarshalJSON ¶ 

func (obj CartSetShippingAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetShippingAddressCustomTypeAction ¶ 

type CartSetShippingAddressCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the `shippingAddress` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `shippingAddress`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `shippingAddress`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (CartSetShippingAddressCustomTypeAction) MarshalJSON ¶ 

func (obj CartSetShippingAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetShippingCustomFieldAction ¶ added in v1.2.0 

type CartSetShippingCustomFieldAction struct {
	// The `shippingKey` of the [Shipping](ctp:api:type:Shipping) to customize. Used to specify which Shipping Method to customize
	// on a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	// Leave this empty to customize the one and only ShippingMethod on a `Single` ShippingMode Cart.
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CartSetShippingCustomFieldAction) MarshalJSON ¶ added in v1.2.0 

func (obj CartSetShippingCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetShippingCustomTypeAction ¶ added in v1.2.0 

type CartSetShippingCustomTypeAction struct {
	// The `shippingKey` of the [Shipping](ctp:api:type:Shipping) to customize. Used to specify which Shipping Method to customize
	// on a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	// Leave this empty to customize the one and only ShippingMethod on a `Single` ShippingMode Cart.
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the specified ShippingMethod with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the ShippingMethod.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `shippingMethod`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Cart's `shippingMethod` or `shipping`. *

func (CartSetShippingCustomTypeAction) MarshalJSON ¶ added in v1.2.0 

func (obj CartSetShippingCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetShippingMethodAction ¶ 

type CartSetShippingMethodAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	//
	// If the referenced Shipping Method has a predicate that does not match the Cart, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
	ShippingMethod *ShippingMethodResourceIdentifier `json:"shippingMethod,omitempty"`
	// An external Tax Rate can be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
}

* * To set the Cart's Shipping Method the Cart must have the `Single` ShippingMode(ctp:api:type:ShippingMode) and a `shippingAddress`. *

func (CartSetShippingMethodAction) MarshalJSON ¶ 

func (obj CartSetShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetShippingMethodTaxAmountAction ¶ 

type CartSetShippingMethodTaxAmountAction struct {
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) to update. This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ExternalTaxAmount *ExternalTaxAmountDraft `json:"externalTaxAmount,omitempty"`
}

* * A Shipping Method tax amount can be set if the Cart has the `ExternalAmount` TaxMode(ctp:api:type:TaxMode). *

func (CartSetShippingMethodTaxAmountAction) MarshalJSON ¶ 

func (obj CartSetShippingMethodTaxAmountAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetShippingMethodTaxRateAction ¶ 

type CartSetShippingMethodTaxRateAction struct {
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) to update. This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
}

* * A Shipping Method Tax Rate can be set if the Cart has the `External` TaxMode(ctp:api:type:TaxMode). *

func (CartSetShippingMethodTaxRateAction) MarshalJSON ¶ 

func (obj CartSetShippingMethodTaxRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartSetShippingRateInputAction ¶ 

type CartSetShippingRateInputAction struct {
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it must be [ClassificationShippingRateInputDraft](ctp:api:type:ClassificationShippingRateInputDraft).
	// - If `CartScore`, it must be [ScoreShippingRateInputDraft](ctp:api:type:ScoreShippingRateInputDraft).
	// - If `CartValue`, it cannot be set.
	ShippingRateInput ShippingRateInputDraft `json:"shippingRateInput,omitempty"`
}

* * Input used to select a ShippingRatePriceTier(ctp:api:type:ShippingRatePriceTier). * If no matching tier can be found, or the input is not set, the default price for the shipping rate is used. *

func (CartSetShippingRateInputAction) MarshalJSON ¶ 

func (obj CartSetShippingRateInputAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CartSetShippingRateInputAction) UnmarshalJSON ¶ 

func (obj *CartSetShippingRateInputAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartState ¶ 

type CartState string

* * Indicates the current status of a Cart. * 

const (
	CartStateActive  CartState = "Active"
	CartStateMerged  CartState = "Merged"
	CartStateOrdered CartState = "Ordered"
	CartStateFrozen  CartState = "Frozen"
)

type CartUnfreezeCartAction ¶ added in v1.3.0 

type CartUnfreezeCartAction struct {
}

* * Changes the CartState(ctp:api:type:CartState) from `Frozen` to `Active`. Reactivates a [Frozen Cart](ctp:api:type:FrozenCarts). * This action updates all prices in the Cart according to latest Prices on related Product Variants and Shipping Methods and by applying all discounts currently being active and applicable for the Cart. *

func (CartUnfreezeCartAction) MarshalJSON ¶ added in v1.3.0 

func (obj CartUnfreezeCartAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartUpdate ¶ 

type CartUpdate struct {
	// Expected version of the Cart on which the changes apply.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Cart.
	Actions []CartUpdateAction `json:"actions"`
}

func (*CartUpdate) UnmarshalJSON ¶ 

func (obj *CartUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CartUpdateAction ¶ 

type CartUpdateAction interface{}

type CartUpdateItemShippingAddressAction ¶ 

type CartUpdateItemShippingAddressAction struct {
	// The new Address with the same `key` as the Address it will replace.
	Address BaseAddress `json:"address"`
}

* * Updates an address in `itemShippingAddresses` by keeping the Address `key`. *

func (CartUpdateItemShippingAddressAction) MarshalJSON ¶ 

func (obj CartUpdateItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartValueTier ¶ 

type CartValueTier struct {
	// Minimum total price of a Cart for which a shipping rate applies.
	MinimumCentAmount int `json:"minimumCentAmount"`
	// Fixed shipping rate Price for a CartValue.
	Price Money `json:"price"`
	// Appears in response to [Get ShippingMethods for a Cart](ctp:api:endpoint:/{projectKey}/shipping-methods/matching-cart:GET) if the shipping rate matches the search query.
	IsMatching *bool `json:"isMatching,omitempty"`
}

* * Used when the ShippingRate maps to the sum of LineItem(ctp:api:type:LineItem) Prices. * The value of the Cart is used to select a tier. * If chosen, it is not possible to set a value for the `shippingRateInput` on the Cart(ctp:api:type:Cart). * Tiers contain the `centAmount` (a value of `100` in the currency `USD` corresponds to `$ 1.00`), and start at `1`.' *

func (CartValueTier) MarshalJSON ¶ 

func (obj CartValueTier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartValueType ¶ 

type CartValueType struct {
}

* * Used when the ShippingRate maps to the sum of LineItem(ctp:api:type:LineItem) Prices. * The value of the Cart is used to select a tier. * If chosen, it is not possible to set a value for the `shippingRateInput` on the Cart(ctp:api:type:Cart). *

func (CartValueType) MarshalJSON ¶ 

func (obj CartValueType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CartsConfiguration ¶ 

type CartsConfiguration struct {
	// Default value for the `deleteDaysAfterLastModification` parameter of the [CartDraft](ctp:api:type:CartDraft) and [MyCartDraft](ctp:api:type:MyCartDraft).
	// If a [ChangeSubscription](ctp:api:type:ChangeSubscription) for Carts exists, a [ResourceDeletedDeliveryPayload](ctp:api:type:ResourceDeletedDeliveryPayload) is sent upon deletion of a Cart.
	//
	// This field may not be present on Projects created before January 2020.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
	// Indicates if country _- no state_ Tax Rate fallback should be used when a shipping address state is not explicitly covered in the rates lists of all Tax Categories of a Cart Line Items. This field may not be present on Projects created before June 2020.
	CountryTaxRateFallbackEnabled *bool `json:"countryTaxRateFallbackEnabled,omitempty"`
}

type Category ¶ 

type Category struct {
	// Unique identifier of the Category.
	ID string `json:"id"`
	// Current version of the Category.
	Version int `json:"version"`
	// Date and time (UTC) the Category was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Category was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Name of the Category.
	Name LocalizedString `json:"name"`
	// User-defined identifier used as a deep-link URL to the related Category per [Locale](ctp:api:type:Locale).
	// A Category can have the same slug for different Locales, but they are unique across the [Project](ctp:api:type:Project).
	// Valid slugs match the pattern `^[A-Za-z0-9_-]{2,256}+$`.
	// For [good performance](/../api/predicates/query#performance-considerations), indexes are provided for the first 15 `languages` set in a Project.
	Slug LocalizedString `json:"slug"`
	// Description of the Category.
	Description *LocalizedString `json:"description,omitempty"`
	// Contains the parent path towards the root Category.
	Ancestors []CategoryReference `json:"ancestors"`
	// Parent Category of this Category.
	Parent *CategoryReference `json:"parent,omitempty"`
	// Decimal value between 0 and 1. Frontend applications can use this value for ordering Categories within the same level in the category tree.
	OrderHint string `json:"orderHint"`
	// Additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).
	ExternalId *string `json:"externalId,omitempty"`
	// Name of the Category used by external search engines for improved search engine performance.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// Description of the Category used by external search engines for improved search engine performance.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// Keywords related to the Category for improved search engine performance.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// Custom Fields for the Category.
	Custom *CustomFields `json:"custom,omitempty"`
	// Media related to the Category.
	Assets []Asset `json:"assets"`
	// User-defined unique identifier of the Category.
	Key *string `json:"key,omitempty"`
}

func (Category) MarshalJSON ¶ 

func (obj Category) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryAddAssetAction ¶ 

type CategoryAddAssetAction struct {
	// Value to append.
	Asset AssetDraft `json:"asset"`
	// Position in the array at which the Asset should be put. When specified, the value must be between `0` and the total number of Assets minus `1`.
	Position *int `json:"position,omitempty"`
}

func (CategoryAddAssetAction) MarshalJSON ¶ 

func (obj CategoryAddAssetAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryChangeAssetNameAction ¶ 

type CategoryChangeAssetNameAction struct {
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetId *string `json:"assetId,omitempty"`
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetKey *string `json:"assetKey,omitempty"`
	// New value to set. Must not be empty.
	Name LocalizedString `json:"name"`
}

func (CategoryChangeAssetNameAction) MarshalJSON ¶ 

func (obj CategoryChangeAssetNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryChangeAssetOrderAction ¶ 

type CategoryChangeAssetOrderAction struct {
	// New value to set. Must contain all Asset `id`s.
	AssetOrder []string `json:"assetOrder"`
}

* * This update action changes the order of the `assets` array. The new order is defined by listing the `id`s of the Assets. *

func (CategoryChangeAssetOrderAction) MarshalJSON ¶ 

func (obj CategoryChangeAssetOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryChangeNameAction ¶ 

type CategoryChangeNameAction struct {
	// New value to set. Must not be empty.
	Name LocalizedString `json:"name"`
}

func (CategoryChangeNameAction) MarshalJSON ¶ 

func (obj CategoryChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryChangeOrderHintAction ¶ 

type CategoryChangeOrderHintAction struct {
	// New value to set. Must be a decimal value between 0 and 1.
	OrderHint string `json:"orderHint"`
}

func (CategoryChangeOrderHintAction) MarshalJSON ¶ 

func (obj CategoryChangeOrderHintAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryChangeParentAction ¶ 

type CategoryChangeParentAction struct {
	// New value to set as parent.
	Parent CategoryResourceIdentifier `json:"parent"`
}

func (CategoryChangeParentAction) MarshalJSON ¶ 

func (obj CategoryChangeParentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryChangeSlugAction ¶ 

type CategoryChangeSlugAction struct {
	// New value to set. Must not be empty.
	// A Category can have the same slug for different [Locales](ctp:api:type:Locale), but it must be unique across the [Project](ctp:api:type:Project).
	// Valid slugs must match the pattern `^[A-Za-z0-9_-]{2,256}+$`.
	Slug LocalizedString `json:"slug"`
}

* * Changing the slug produces the [CategorySlugChanged](ctp:api:type:CategorySlugChangedMessage) Message. *

func (CategoryChangeSlugAction) MarshalJSON ¶ 

func (obj CategoryChangeSlugAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryCreatedMessage ¶ 

type CategoryCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Category](ctp:api:type:Category) that was created.
	Category Category `json:"category"`
}

* * Generated after a successful [Create Category](ctp:api:endpoint:/{projectKey}/categories:POST) request. *

func (CategoryCreatedMessage) MarshalJSON ¶ 

func (obj CategoryCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CategoryCreatedMessage) UnmarshalJSON ¶ 

func (obj *CategoryCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CategoryCreatedMessagePayload ¶ 

type CategoryCreatedMessagePayload struct {
	// [Category](ctp:api:type:Category) that was created.
	Category Category `json:"category"`
}

* * Generated after a successful [Create Category](ctp:api:endpoint:/{projectKey}/categories:POST) request. *

func (CategoryCreatedMessagePayload) MarshalJSON ¶ 

func (obj CategoryCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryDraft ¶ 

type CategoryDraft struct {
	// Name of the Category.
	Name LocalizedString `json:"name"`
	// User-defined identifier used as a deep-link URL to the related Category.
	// A Category can have the same slug for different [Locales](ctp:api:type:Locale), but it must be unique across the [Project](ctp:api:type:Project).
	// Valid slugs must match the pattern `^[A-Za-z0-9_-]{2,256}+$`.
	Slug LocalizedString `json:"slug"`
	// Description of the Category.
	Description *LocalizedString `json:"description,omitempty"`
	// Parent Category of the Category.
	// The parent can be set by its `id` or `key`.
	Parent *CategoryResourceIdentifier `json:"parent,omitempty"`
	// Decimal value between 0 and 1. Frontend applications can use this value for ordering Categories within the same level in the category tree.
	// If not set, a random value will be assigned.
	OrderHint *string `json:"orderHint,omitempty"`
	// Additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).
	ExternalId *string `json:"externalId,omitempty"`
	// Name of the Category used by external search engines for improved search engine performance.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// Description of the Category used by external search engines for improved search engine performance.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// Keywords related to the Category for improved search engine performance.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// Custom Fields for the Category.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Media related to the Category.
	Assets []AssetDraft `json:"assets"`
	// User-defined unique identifier for the Category.
	Key *string `json:"key,omitempty"`
}

func (CategoryDraft) MarshalJSON ¶ 

func (obj CategoryDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryOrderHints ¶ 

type CategoryOrderHints map[string]string

* * JSON object where the key is a Category(ctp:api:type:Category) `id` and the value is an order hint. * Allows controlling the order of Products and how they appear in Categories. Products with no order hint have an order score below `0`. Order hints are non-unique. * If a subset of Products have the same value for order hint in a specific category, the behavior is undetermined.

type CategoryPagedQueryResponse ¶ 

type CategoryPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Category](ctp:api:type:Category) matching the query.
	Results []Category `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of Category(ctp:api:type:Category). *

type CategoryReference ¶ 

type CategoryReference struct {
	// Unique identifier of the referenced [Category](ctp:api:type:Category).
	ID string `json:"id"`
	// Contains the representation of the expanded Category. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Categories.
	Obj *Category `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Category(ctp:api:type:Category). *

func (CategoryReference) MarshalJSON ¶ 

func (obj CategoryReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryRemoveAssetAction ¶ 

type CategoryRemoveAssetAction struct {
	// Value to remove. Either `assetId` or `assetKey` is required.
	AssetId *string `json:"assetId,omitempty"`
	// Value to remove. Either `assetId` or `assetKey` is required.
	AssetKey *string `json:"assetKey,omitempty"`
}

func (CategoryRemoveAssetAction) MarshalJSON ¶ 

func (obj CategoryRemoveAssetAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryResourceIdentifier ¶ 

type CategoryResourceIdentifier struct {
	// Unique identifier of the referenced [Category](ctp:api:type:Channel). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [Category](ctp:api:type:Category). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a Category(ctp:api:type:Category). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (CategoryResourceIdentifier) MarshalJSON ¶ 

func (obj CategoryResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetAssetCustomFieldAction ¶ 

type CategorySetAssetCustomFieldAction struct {
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetId *string `json:"assetId,omitempty"`
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetKey *string `json:"assetKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CategorySetAssetCustomFieldAction) MarshalJSON ¶ 

func (obj CategorySetAssetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetAssetCustomTypeAction ¶ 

type CategorySetAssetCustomTypeAction struct {
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetId *string `json:"assetId,omitempty"`
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetKey *string `json:"assetKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Asset with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Asset.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Asset.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (CategorySetAssetCustomTypeAction) MarshalJSON ¶ 

func (obj CategorySetAssetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetAssetDescriptionAction ¶ 

type CategorySetAssetDescriptionAction struct {
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetId *string `json:"assetId,omitempty"`
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetKey *string `json:"assetKey,omitempty"`
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (CategorySetAssetDescriptionAction) MarshalJSON ¶ 

func (obj CategorySetAssetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetAssetKeyAction ¶ 

type CategorySetAssetKeyAction struct {
	// Value to set.
	AssetId string `json:"assetId"`
	// Value to set. If empty, any existing value will be removed.
	AssetKey *string `json:"assetKey,omitempty"`
}

* * Set or remove the `key` of an Asset(ctp:api:type:Asset). *

func (CategorySetAssetKeyAction) MarshalJSON ¶ 

func (obj CategorySetAssetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetAssetSourcesAction ¶ 

type CategorySetAssetSourcesAction struct {
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetId *string `json:"assetId,omitempty"`
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetKey *string `json:"assetKey,omitempty"`
	// Must not be empty. At least one entry is required.
	Sources []AssetSource `json:"sources"`
}

func (CategorySetAssetSourcesAction) MarshalJSON ¶ 

func (obj CategorySetAssetSourcesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetAssetTagsAction ¶ 

type CategorySetAssetTagsAction struct {
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetId *string `json:"assetId,omitempty"`
	// New value to set. Either `assetId` or `assetKey` is required.
	AssetKey *string `json:"assetKey,omitempty"`
	// Keywords for categorizing and organizing Assets.
	Tags []string `json:"tags"`
}

func (CategorySetAssetTagsAction) MarshalJSON ¶ 

func (obj CategorySetAssetTagsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetCustomFieldAction ¶ 

type CategorySetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CategorySetCustomFieldAction) MarshalJSON ¶ 

func (obj CategorySetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetCustomTypeAction ¶ 

type CategorySetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Category with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Category.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Category.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (CategorySetCustomTypeAction) MarshalJSON ¶ 

func (obj CategorySetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetDescriptionAction ¶ 

type CategorySetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (CategorySetDescriptionAction) MarshalJSON ¶ 

func (obj CategorySetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetExternalIdAction ¶ 

type CategorySetExternalIdAction struct {
	// Value to set. If empty, any existing value will be removed.
	ExternalId *string `json:"externalId,omitempty"`
}

* * This update action sets a new ID that can be used as an additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP). *

func (CategorySetExternalIdAction) MarshalJSON ¶ 

func (obj CategorySetExternalIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetKeyAction ¶ 

type CategorySetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (CategorySetKeyAction) MarshalJSON ¶ 

func (obj CategorySetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetMetaDescriptionAction ¶ 

type CategorySetMetaDescriptionAction struct {
	// Value to set.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
}

func (CategorySetMetaDescriptionAction) MarshalJSON ¶ 

func (obj CategorySetMetaDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetMetaKeywordsAction ¶ 

type CategorySetMetaKeywordsAction struct {
	// Value to set.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
}

func (CategorySetMetaKeywordsAction) MarshalJSON ¶ 

func (obj CategorySetMetaKeywordsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySetMetaTitleAction ¶ 

type CategorySetMetaTitleAction struct {
	// Value to set.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
}

func (CategorySetMetaTitleAction) MarshalJSON ¶ 

func (obj CategorySetMetaTitleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategorySlugChangedMessage ¶ 

type CategorySlugChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The slug of the [Category](ctp:api:type:Category) after the [Change Slug](ctp:api:type:CategoryChangeSlugAction) update action.
	Slug LocalizedString `json:"slug"`
	// The slug of the [Category](ctp:api:type:Category) before the [Change Slug](ctp:api:type:CategoryChangeSlugAction) update action.
	OldSlug *LocalizedString `json:"oldSlug,omitempty"`
}

* * Generated after a successful [Change Slug](ctp:api:type:CategoryChangeSlugAction) update action. *

func (CategorySlugChangedMessage) MarshalJSON ¶ 

func (obj CategorySlugChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CategorySlugChangedMessage) UnmarshalJSON ¶ 

func (obj *CategorySlugChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CategorySlugChangedMessagePayload ¶ 

type CategorySlugChangedMessagePayload struct {
	// The slug of the [Category](ctp:api:type:Category) after the [Change Slug](ctp:api:type:CategoryChangeSlugAction) update action.
	Slug LocalizedString `json:"slug"`
	// The slug of the [Category](ctp:api:type:Category) before the [Change Slug](ctp:api:type:CategoryChangeSlugAction) update action.
	OldSlug *LocalizedString `json:"oldSlug,omitempty"`
}

* * Generated after a successful [Change Slug](ctp:api:type:CategoryChangeSlugAction) update action. *

func (CategorySlugChangedMessagePayload) MarshalJSON ¶ 

func (obj CategorySlugChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CategoryUpdate ¶ 

type CategoryUpdate struct {
	// Expected version of the Category on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Category.
	Actions []CategoryUpdateAction `json:"actions"`
}

func (*CategoryUpdate) UnmarshalJSON ¶ 

func (obj *CategoryUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CategoryUpdateAction ¶ 

type CategoryUpdateAction interface{}

type CentPrecisionMoney ¶ 

type CentPrecisionMoney struct {
	// Amount in the smallest indivisible unit of a currency, such as:
	//
	// * Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as `500`).
	// * The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as `5`).
	CentAmount int `json:"centAmount"`
	// Currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
	CurrencyCode string `json:"currencyCode"`
	// The number of default fraction digits for the given currency, like `2` for EUR or `0` for JPY.
	FractionDigits int `json:"fractionDigits"`
}

* * Object that stores cent amounts in a specific currency. *

func (CentPrecisionMoney) MarshalJSON ¶ 

func (obj CentPrecisionMoney) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CentPrecisionMoneyDraft ¶ 

type CentPrecisionMoneyDraft struct {
	// Amount in the smallest indivisible unit of a currency.
	CentAmount *int `json:"centAmount,omitempty"`
	// Currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
	CurrencyCode string `json:"currencyCode"`
	// This field is optional for cent precision. If provided, it must be equal to the default number of fraction digits for the specified currency.
	FractionDigits *int `json:"fractionDigits,omitempty"`
}

* * This draft type is the alternative to Money(ctp:api:type:Money). *

func (CentPrecisionMoneyDraft) MarshalJSON ¶ 

func (obj CentPrecisionMoneyDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeSubscription ¶ 

type ChangeSubscription struct {
	// Unique identifier for the type of resource, for example, `cart`.
	ResourceTypeId ChangeSubscriptionResourceTypeId `json:"resourceTypeId"`
}

* * Notification about changes to a resource. The payload format differs for resource [creation](ctp:api:type:ResourceCreatedDeliveryPayload), * [update](ctp:api:type:ResourceUpdatedDeliveryPayload), * and [deletion](ctp:api:type:ResourceDeletedDeliveryPayload). *

type ChangeSubscriptionResourceTypeId ¶ added in v1.2.0 

type ChangeSubscriptionResourceTypeId string

* * Resource types supported by [ChangeSubscriptions](ctp:api:type:ChangeSubscription): * 

const (
	ChangeSubscriptionResourceTypeIdApprovalFlow          ChangeSubscriptionResourceTypeId = "approval-flow"
	ChangeSubscriptionResourceTypeIdApprovalRule          ChangeSubscriptionResourceTypeId = "approval-rule"
	ChangeSubscriptionResourceTypeIdAssociateRole         ChangeSubscriptionResourceTypeId = "associate-role"
	ChangeSubscriptionResourceTypeIdBusinessUnit          ChangeSubscriptionResourceTypeId = "business-unit"
	ChangeSubscriptionResourceTypeIdCart                  ChangeSubscriptionResourceTypeId = "cart"
	ChangeSubscriptionResourceTypeIdCartDiscount          ChangeSubscriptionResourceTypeId = "cart-discount"
	ChangeSubscriptionResourceTypeIdCategory              ChangeSubscriptionResourceTypeId = "category"
	ChangeSubscriptionResourceTypeIdChannel               ChangeSubscriptionResourceTypeId = "channel"
	ChangeSubscriptionResourceTypeIdCustomer              ChangeSubscriptionResourceTypeId = "customer"
	ChangeSubscriptionResourceTypeIdCustomerEmailToken    ChangeSubscriptionResourceTypeId = "customer-email-token"
	ChangeSubscriptionResourceTypeIdCustomerGroup         ChangeSubscriptionResourceTypeId = "customer-group"
	ChangeSubscriptionResourceTypeIdCustomerPasswordToken ChangeSubscriptionResourceTypeId = "customer-password-token"
	ChangeSubscriptionResourceTypeIdDiscountCode          ChangeSubscriptionResourceTypeId = "discount-code"
	ChangeSubscriptionResourceTypeIdExtension             ChangeSubscriptionResourceTypeId = "extension"
	ChangeSubscriptionResourceTypeIdInventoryEntry        ChangeSubscriptionResourceTypeId = "inventory-entry"
	ChangeSubscriptionResourceTypeIdKeyValueDocument      ChangeSubscriptionResourceTypeId = "key-value-document"
	ChangeSubscriptionResourceTypeIdOrder                 ChangeSubscriptionResourceTypeId = "order"
	ChangeSubscriptionResourceTypeIdOrderEdit             ChangeSubscriptionResourceTypeId = "order-edit"
	ChangeSubscriptionResourceTypeIdPayment               ChangeSubscriptionResourceTypeId = "payment"
	ChangeSubscriptionResourceTypeIdProduct               ChangeSubscriptionResourceTypeId = "product"
	ChangeSubscriptionResourceTypeIdProductDiscount       ChangeSubscriptionResourceTypeId = "product-discount"
	ChangeSubscriptionResourceTypeIdProductPrice          ChangeSubscriptionResourceTypeId = "product-price"
	ChangeSubscriptionResourceTypeIdProductSelection      ChangeSubscriptionResourceTypeId = "product-selection"
	ChangeSubscriptionResourceTypeIdProductType           ChangeSubscriptionResourceTypeId = "product-type"
	ChangeSubscriptionResourceTypeIdQuote                 ChangeSubscriptionResourceTypeId = "quote"
	ChangeSubscriptionResourceTypeIdQuoteRequest          ChangeSubscriptionResourceTypeId = "quote-request"
	ChangeSubscriptionResourceTypeIdReview                ChangeSubscriptionResourceTypeId = "review"
	ChangeSubscriptionResourceTypeIdShippingMethod        ChangeSubscriptionResourceTypeId = "shipping-method"
	ChangeSubscriptionResourceTypeIdShoppingList          ChangeSubscriptionResourceTypeId = "shopping-list"
	ChangeSubscriptionResourceTypeIdStagedQuote           ChangeSubscriptionResourceTypeId = "staged-quote"
	ChangeSubscriptionResourceTypeIdStandalonePrice       ChangeSubscriptionResourceTypeId = "standalone-price"
	ChangeSubscriptionResourceTypeIdState                 ChangeSubscriptionResourceTypeId = "state"
	ChangeSubscriptionResourceTypeIdStore                 ChangeSubscriptionResourceTypeId = "store"
	ChangeSubscriptionResourceTypeIdSubscription          ChangeSubscriptionResourceTypeId = "subscription"
	ChangeSubscriptionResourceTypeIdTaxCategory           ChangeSubscriptionResourceTypeId = "tax-category"
	ChangeSubscriptionResourceTypeIdType                  ChangeSubscriptionResourceTypeId = "type"
	ChangeSubscriptionResourceTypeIdZone                  ChangeSubscriptionResourceTypeId = "zone"
)

type Channel ¶ 

type Channel struct {
	// Unique identifier of the Channel.
	ID string `json:"id"`
	// Current version of the Channel.
	Version int `json:"version"`
	// Date and time (UTC) the Channel was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Channel was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the Channel.
	Key string `json:"key"`
	// Roles of the Channel.
	Roles []ChannelRoleEnum `json:"roles"`
	// Name of the Channel.
	Name *LocalizedString `json:"name,omitempty"`
	// Description of the Channel.
	Description *LocalizedString `json:"description,omitempty"`
	// Address where the Channel is located (for example, if the Channel is a physical store).
	Address *Address `json:"address,omitempty"`
	// Statistics about the review ratings taken into account for the Channel.
	ReviewRatingStatistics *ReviewRatingStatistics `json:"reviewRatingStatistics,omitempty"`
	// Custom Fields defined for the Channel.
	Custom *CustomFields `json:"custom,omitempty"`
	// GeoJSON geometry object encoding the geo location of the Channel.
	GeoLocation GeoJson `json:"geoLocation,omitempty"`
}

func (*Channel) UnmarshalJSON ¶ 

func (obj *Channel) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ChannelAddRolesAction ¶ 

type ChannelAddRolesAction struct {
	// Value to append to the array.
	Roles []ChannelRoleEnum `json:"roles"`
}

func (ChannelAddRolesAction) MarshalJSON ¶ 

func (obj ChannelAddRolesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelChangeDescriptionAction ¶ 

type ChannelChangeDescriptionAction struct {
	// New value to set. Must not be empty.
	Description LocalizedString `json:"description"`
}

func (ChannelChangeDescriptionAction) MarshalJSON ¶ 

func (obj ChannelChangeDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelChangeKeyAction ¶ 

type ChannelChangeKeyAction struct {
	// New value to set. Must not be empty.
	Key string `json:"key"`
}

func (ChannelChangeKeyAction) MarshalJSON ¶ 

func (obj ChannelChangeKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelChangeNameAction ¶ 

type ChannelChangeNameAction struct {
	// New value to set. Must not be empty.
	Name LocalizedString `json:"name"`
}

func (ChannelChangeNameAction) MarshalJSON ¶ 

func (obj ChannelChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelDraft ¶ 

type ChannelDraft struct {
	// User-defined unique identifier for the Channel.
	Key string `json:"key"`
	// Roles of the Channel.
	// Each channel must have at least one role.
	// If not specified, then `InventorySupply` is assigned by default.
	Roles []ChannelRoleEnum `json:"roles"`
	// Name of the Channel.
	Name *LocalizedString `json:"name,omitempty"`
	// Description of the Channel.
	Description *LocalizedString `json:"description,omitempty"`
	// Address where the Channel is located.
	Address *BaseAddress `json:"address,omitempty"`
	// Custom fields defined for the Channel.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// GeoJSON geometry object encoding the geo location of the Channel.
	// Currently, only the [Point](ctp:api:type:GeoJsonPoint) type is supported.
	GeoLocation GeoJson `json:"geoLocation,omitempty"`
}

func (ChannelDraft) MarshalJSON ¶ 

func (obj ChannelDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ChannelDraft) UnmarshalJSON ¶ 

func (obj *ChannelDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ChannelPagedQueryResponse ¶ 

type ChannelPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Channels](ctp:api:type:Channel) matching the query.
	Results []Channel `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of Channel(ctp:api:type:Channel). *

type ChannelReference ¶ 

type ChannelReference struct {
	// Unique identifier of the referenced [Channel](ctp:api:type:Channel).
	ID string `json:"id"`
	// Contains the representation of the expanded Channel.
	// Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Channels.
	Obj *Channel `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Channel(ctp:api:type:Channel). *

func (ChannelReference) MarshalJSON ¶ 

func (obj ChannelReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelRemoveRolesAction ¶ 

type ChannelRemoveRolesAction struct {
	// Value to remove from the array.
	Roles []ChannelRoleEnum `json:"roles"`
}

func (ChannelRemoveRolesAction) MarshalJSON ¶ 

func (obj ChannelRemoveRolesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelResourceIdentifier ¶ 

type ChannelResourceIdentifier struct {
	// Unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a Channel(ctp:api:type:Channel). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (ChannelResourceIdentifier) MarshalJSON ¶ 

func (obj ChannelResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelRoleEnum ¶ 

type ChannelRoleEnum string

* * Describes the purpose and type of the Channel. A Channel can have one or more roles. * 

const (
	ChannelRoleEnumInventorySupply     ChannelRoleEnum = "InventorySupply"
	ChannelRoleEnumProductDistribution ChannelRoleEnum = "ProductDistribution"
	ChannelRoleEnumOrderExport         ChannelRoleEnum = "OrderExport"
	ChannelRoleEnumOrderImport         ChannelRoleEnum = "OrderImport"
	ChannelRoleEnumPrimary             ChannelRoleEnum = "Primary"
)

type ChannelSetAddressAction ¶ 

type ChannelSetAddressAction struct {
	// Value to set. If empty, any existing value will be removed.
	Address *BaseAddress `json:"address,omitempty"`
}

func (ChannelSetAddressAction) MarshalJSON ¶ 

func (obj ChannelSetAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelSetAddressCustomFieldAction ¶ 

type ChannelSetAddressCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// Specifies the format of the value of the Custom Field defined by `name`.
	// If `value` is absent or `null`, this field will be removed, if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	Value interface{} `json:"value,omitempty"`
}

func (ChannelSetAddressCustomFieldAction) MarshalJSON ¶ 

func (obj ChannelSetAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelSetAddressCustomTypeAction ¶ 

type ChannelSetAddressCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the `address` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `address`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `address`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ChannelSetAddressCustomTypeAction) MarshalJSON ¶ 

func (obj ChannelSetAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelSetCustomFieldAction ¶ 

type ChannelSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (ChannelSetCustomFieldAction) MarshalJSON ¶ 

func (obj ChannelSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelSetCustomTypeAction ¶ 

type ChannelSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Channel with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Channel.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Channel.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ChannelSetCustomTypeAction) MarshalJSON ¶ 

func (obj ChannelSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelSetGeoLocationAction ¶ 

type ChannelSetGeoLocationAction struct {
	// Value to set.
	GeoLocation GeoJson `json:"geoLocation,omitempty"`
}

func (ChannelSetGeoLocationAction) MarshalJSON ¶ 

func (obj ChannelSetGeoLocationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ChannelSetGeoLocationAction) UnmarshalJSON ¶ 

func (obj *ChannelSetGeoLocationAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ChannelSetRolesAction ¶ 

type ChannelSetRolesAction struct {
	// Value to set. If not specified, then `InventorySupply` is assigned by default.
	Roles []ChannelRoleEnum `json:"roles"`
}

func (ChannelSetRolesAction) MarshalJSON ¶ 

func (obj ChannelSetRolesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelUpdate ¶ 

type ChannelUpdate struct {
	// Expected version of the Channel on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Channel.
	Actions []ChannelUpdateAction `json:"actions"`
}

func (*ChannelUpdate) UnmarshalJSON ¶ 

func (obj *ChannelUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ChannelUpdateAction ¶ 

type ChannelUpdateAction interface{}

type ClassificationShippingRateInput ¶ 

type ClassificationShippingRateInput struct {
	// Key of the value used as a programmatic identifier.
	Key string `json:"key"`
	// Descriptive localized label of the value.
	Label LocalizedString `json:"label"`
}

func (ClassificationShippingRateInput) MarshalJSON ¶ 

func (obj ClassificationShippingRateInput) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ClassificationShippingRateInputDraft ¶ 

type ClassificationShippingRateInputDraft struct {
	// Key of the value used as a programmatic identifier.
	Key string `json:"key"`
}

func (ClassificationShippingRateInputDraft) MarshalJSON ¶ 

func (obj ClassificationShippingRateInputDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

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) WithProjectKey ¶ 

func (c *Client) WithProjectKey(projectKey string) *ByProjectKeyRequestBuilder

* * The Project endpoint is used to retrieve certain information from a project.

type ClientConfig ¶ 

type ClientConfig struct {
	URL         string
	Credentials *clientcredentials.Config
	LogLevel    int
	HTTPClient  *http.Client
	UserAgent   string
}

type ClientLogging ¶ 

type ClientLogging struct {
	// `id` of the [API Client](ctp:api:type:ApiClient) which created the resource.
	ClientId *string `json:"clientId,omitempty"`
	// [External user ID](/../api/general-concepts#external-user-ids) provided by `X-External-User-ID` HTTP Header.
	ExternalUserId *string `json:"externalUserId,omitempty"`
	// Indicates the [Customer](ctp:api:type:Customer) who modified the resource using a token from the [password flow](/authorization#password-flow).
	Customer *CustomerReference `json:"customer,omitempty"`
	// Indicates that the resource was modified during an [anonymous session](ctp:api:type:AnonymousSession) with the logged ID.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// Indicates the [Customer](ctp:api:type:Customer) who created or modified the resource in the context of a [Business Unit](ctp:api:type:BusinessUnit). Only present when an Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).
	Associate *CustomerReference `json:"associate,omitempty"`
}

* * These objects represent information about which [API Client](/../api/projects/api-clients) created or modified a resource. For more information, see [Client Logging](/../api/general-concepts#client-logging). *

type CloudEventsFormat ¶ 

type CloudEventsFormat struct {
	CloudEventsVersion string `json:"cloudEventsVersion"`
}

* * The CloudEventsFormat can be used with any Destination(#destination), and the payload is delivered in the `JSON Event Format`. AzureEventGridDestination(ctp:api:type:AzureEventGridDestination) offers native support to filter and route CloudEvents. *

func (CloudEventsFormat) MarshalJSON ¶ 

func (obj CloudEventsFormat) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CloudEventsPayload ¶ added in v1.2.0 

type CloudEventsPayload struct {
	// The version of the [CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md) specification which the event uses.
	Specversion string `json:"specversion"`
	// Unique identifier of the event.
	ID string `json:"id"`
	// The `type` is namespaced with `com.commercetools`, followed by the [ReferenceTypeId](ctp:api:type:ReferenceTypeId), the type of Subscription (either `message` or `change`), and the message or change type.
	// For example, `com.commercetools.product.message.ProductPublished` or `com.commercetools.order.change.ResourceCreated`.
	Type string `json:"type"`
	// The default REST URI of the [ReferenceTypeId](ctp:api:type:ReferenceTypeId) that triggered this event, including the project key.
	Source string `json:"source"`
	// Unique identifier of the resource that triggered the event.
	Subject string `json:"subject"`
	// Corresponds to the `lastModifiedAt` of the resource at the time the event was triggered.
	Time time.Time `json:"time"`
	// Corresponds to the `sequenceNumber` of a [MessageSubscription](ctp:api:type:MessageSubscription). Can be used to process messages in the correct order.
	Sequence *string `json:"sequence,omitempty"`
	// `"Integer"`
	Sequencetype *string `json:"sequencetype,omitempty"`
	// The URI from which the message can be retrieved if messages are [enabled](/../api/projects/messages#enable-querying-messages-via-the-api). Only set for [MessageSubscriptions](ctp:api:type:MessageSubscription).
	Dataref *string `json:"dataref,omitempty"`
	// [MessageDeliveryPayload](ctp:api:type:MessageDeliveryPayload), [ResourceCreatedDeliveryPayload](ctp:api:type:ResourceCreatedDeliveryPayload), [ResourceUpdatedDeliveryPayload](ctp:api:type:ResourceUpdatedDeliveryPayload), or [ResourceDeletedDeliveryPayload](ctp:api:type:ResourceDeletedDeliveryPayload).
	Data DeliveryPayload `json:"data"`
}

* * The CloudEventsFormat(ctp:api:type:CloudEventsFormat) represents event data in a way that conforms to a common specification. The message payload can be found inside the `data` field. *

func (CloudEventsPayload) MarshalJSON ¶ added in v1.2.0 

func (obj CloudEventsPayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CloudEventsPayload) UnmarshalJSON ¶ added in v1.2.0 

func (obj *CloudEventsPayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type Company ¶ added in v1.2.0 

type Company struct {
	// Unique identifier of the Business Unit.
	ID string `json:"id"`
	// Current version of the Business Unit.
	Version int `json:"version"`
	// Date and time (UTC) the Business Unit was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Business Unit was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the Business Unit.
	Key string `json:"key"`
	// Indicates whether the Business Unit can be edited and used in [Orders](/../api/projects/orders).
	Status BusinessUnitStatus `json:"status"`
	// References to [Stores](ctp:api:type:Store) the Business Unit is associated with. Only present when `storeMode` is `Explicit`.
	//
	// If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores.
	//
	// If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store.
	Stores []StoreKeyReference `json:"stores"`
	// Is always `Explicit` since a Company cannot have a parent Business Unit that Stores can be inherited from.
	StoreMode BusinessUnitStoreMode `json:"storeMode"`
	// Name of the Business Unit.
	Name string `json:"name"`
	// Email address of the Business Unit.
	ContactEmail *string `json:"contactEmail,omitempty"`
	// Custom Fields for the Business Unit.
	Custom *CustomFields `json:"custom,omitempty"`
	// Addresses used by the Business Unit.
	Addresses []Address `json:"addresses"`
	// Unique identifiers of addresses used as shipping addresses.
	ShippingAddressIds []string `json:"shippingAddressIds"`
	// Unique identifier of the address used as the default shipping address.
	DefaultShippingAddressId *string `json:"defaultShippingAddressId,omitempty"`
	// Unique identifiers of addresses used as billing addresses.
	BillingAddressIds []string `json:"billingAddressIds"`
	// Unique identifier of the address used as the default billing address.
	DefaultBillingAddressId *string `json:"defaultBillingAddressId,omitempty"`
	// Is always `Explicit` since a Company cannot have a parent Business Unit that Associates can be inherited from.
	AssociateMode BusinessUnitAssociateMode `json:"associateMode"`
	// Associates that are part of the Business Unit in specific [roles](ctp:api:type:AssociateRole).
	Associates []Associate `json:"associates"`
	// Associates that are inherited from a parent Business Unit. The value of this field is [eventually consistent](/../api/general-concepts#eventual-consistency) and is only present when the `associateMode` is set to `ExplicitAndFromParent`.
	InheritedAssociates []InheritedAssociate `json:"inheritedAssociates"`
	// Parent unit of the Business Unit. Only present when the `unitType` is `Division`.
	ParentUnit *BusinessUnitKeyReference `json:"parentUnit,omitempty"`
	// Top-level unit of the Business Unit. The top-level unit is of `unitType` `Company`.
	TopLevelUnit BusinessUnitKeyReference `json:"topLevelUnit"`
}

* * Business Unit type to represent the top level of a business. * Contains specific fields and values that differentiate a Company from the generic BusinessUnit(ctp:api:type:BusinessUnit). *

func (Company) MarshalJSON ¶ added in v1.2.0 

func (obj Company) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CompanyDraft ¶ added in v1.2.0 

type CompanyDraft struct {
	// User-defined unique identifier for the Business Unit.
	Key string `json:"key"`
	// Indicates whether the Business Unit can be edited and used in [Orders](/../api/projects/orders).
	Status *BusinessUnitStatus `json:"status,omitempty"`
	// Sets the [Stores](ctp:api:type:Store) the Business Unit is associated with. Can only be set when `storeMode` is `Explicit`.
	// Defaults to empty for [Companies](ctp:api:type:BusinessUnitType) and not set for [Divisions](ctp:api:type:BusinessUnitType).
	//
	// If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores.
	//
	// If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store.
	Stores []StoreResourceIdentifier `json:"stores"`
	// Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent.
	// `storeMode` is always `Explicit` for [Companies](ctp:api:type:BusinessUnitType) and defaults to `FromParent` for [Divisions](ctp:api:type:BusinessUnitType).
	StoreMode *BusinessUnitStoreMode `json:"storeMode,omitempty"`
	// Name of the Business Unit.
	Name string `json:"name"`
	// Email address of the Business Unit.
	ContactEmail *string `json:"contactEmail,omitempty"`
	// Determines whether the Business Unit can inherit Associates from a parent.
	// Always `Explicit` for [Companies](ctp:api:type:BusinessUnitType) and defaults to `ExplicitAndFromParent` for [Divisions](ctp:api:type:BusinessUnitType).
	AssociateMode *BusinessUnitAssociateMode `json:"associateMode,omitempty"`
	// List of members that are part of the Business Unit in specific [roles](ctp:api:type:AssociateRole).
	Associates []AssociateDraft `json:"associates"`
	// Addresses used by the Business Unit.
	Addresses []BaseAddress `json:"addresses"`
	// Indexes of entries in `addresses` to set as shipping addresses.
	// The `shippingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
	ShippingAddresses []int `json:"shippingAddresses"`
	// Index of the entry in `addresses` to set as the default shipping address.
	DefaultShippingAddress *int `json:"defaultShippingAddress,omitempty"`
	// Indexes of entries in `addresses` to set as billing addresses.
	// The `billingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
	BillingAddresses []int `json:"billingAddresses"`
	// Index of the entry in `addresses` to set as the default billing address.
	DefaultBillingAddress *int `json:"defaultBillingAddress,omitempty"`
	// Custom Fields for the Business Unit.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * Draft type to represent the top level of a business. Contains the fields and values of the generic BusinessUnitDraft(ctp:api:type:BusinessUnitDraft) that are used specifically for creating a Company(ctp:api:type:Company). *

func (CompanyDraft) MarshalJSON ¶ added in v1.2.0 

func (obj CompanyDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ConcurrentModificationError ¶ 

type ConcurrentModificationError struct {
	// `"Object $resourceId has a different version than expected. Expected: $expectedVersion - Actual: $currentVersion."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// 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 ¶ added in v1.1.0 

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 ¶ added in v1.1.0 

func (obj *ConcurrentModificationError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ConfluentCloudDestination ¶ added in v1.3.0 

type ConfluentCloudDestination struct {
	// URL to the bootstrap server including the port number in the format `<xxxxx>.<region>.<provider>.confluent.cloud:9092`.
	BootstrapServer string `json:"bootstrapServer"`
	// Partially hidden on retrieval for security reasons.
	ApiKey string `json:"apiKey"`
	// Partially hidden on retrieval for security reasons.
	ApiSecret string `json:"apiSecret"`
	// The Kafka `acks` value.
	Acks string `json:"acks"`
	// The name of the topic.
	Topic string `json:"topic"`
	// The Kafka record key.
	Key *string `json:"key,omitempty"`
}

* * This destination can be used to push events and messages to [Confluent Cloud](https://www.confluent.io/confluent-cloud/). * To set up a Subscription of this type, first, create a topic in Confluent Cloud. * Then, to allow Composable Commerce to push events and messages to your topic, generate [API keys](https://docs.confluent.io/cloud/current/access-management/authenticate/api-keys/api-keys.html) for your topic, and create the Subscription destination using the generated credentials. * * The Composable Commerce producer uses the following values: `SASL_SSL` for`security.protocol`, `PLAIN` for`sasl.mechanism`, and the default value (1048576) for `max.request.size`. *

func (ConfluentCloudDestination) MarshalJSON ¶ added in v1.3.0 

func (obj ConfluentCloudDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ContainerAndKey ¶ 

type ContainerAndKey struct {
	// User-defined identifier that is unique within the given container.
	Key string `json:"key"`
	// Namespace to group [Custom Objects](ctp:api:type:CustomObject).
	Container string `json:"container"`
}

* * `ContainerAndKey` is specific to [Custom Objects](ctp:api:type:CustomObject). Custom Objects are grouped into containers, which can be used like namespaces. Within a given container, a user-defined key can be used to uniquely identify resources. *

type ContentTooLargeError ¶ added in v1.4.0 

type ContentTooLargeError struct {
	// `"Content too large."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the request results in too much data being returned from the API. Adjust the request query to reduce the size of the data returned. *

func (*ContentTooLargeError) DecodeStruct ¶ added in v1.4.0 

func (obj *ContentTooLargeError) DecodeStruct(src map[string]interface{}) error

func (ContentTooLargeError) Error ¶ added in v1.4.0 

func (obj ContentTooLargeError) Error() string

func (ContentTooLargeError) MarshalJSON ¶ added in v1.4.0 

func (obj ContentTooLargeError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ContentTooLargeError) UnmarshalJSON ¶ added in v1.4.0 

func (obj *ContentTooLargeError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CountryNotConfiguredInStoreError ¶ added in v1.3.0 

type CountryNotConfiguredInStoreError struct {
	// `"The country $country is not configured for the store $store."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Countries configured for the Store.
	StoreCountries []string `json:"storeCountries"`
	// The country that is not configured for the Store but referenced on the Cart or Order.
	Country string `json:"country"`
}

* * Returned when a Cart(ctp:api:type:Cart) or an Order(ctp:api:type:Order) in a Store(ctp:api:type:Store) references a country that is not included in the countries configured for the Store. * * The error is returned as a failed response to: * * - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/carts:POST) request and [Set Country](ctp:api:type:CartSetCountryAction) update action on Carts. * - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/me/carts:POST) request and [Set Country](ctp:api:type:MyCartSetCountryAction) update action on My Carts. * - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. * - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. * - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders. * - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. * - [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) request on Order Import. * - [Set Country](ctp:api:type:StagedOrderSetCountryAction) on Order Edits. *

func (*CountryNotConfiguredInStoreError) DecodeStruct ¶ added in v1.3.0 

func (obj *CountryNotConfiguredInStoreError) DecodeStruct(src map[string]interface{}) error

func (CountryNotConfiguredInStoreError) Error ¶ added in v1.3.0 

func (obj CountryNotConfiguredInStoreError) Error() string

func (CountryNotConfiguredInStoreError) MarshalJSON ¶ added in v1.3.0 

func (obj CountryNotConfiguredInStoreError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CountryNotConfiguredInStoreError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *CountryNotConfiguredInStoreError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CreatedBy ¶ 

type CreatedBy struct {
	// `id` of the [API Client](ctp:api:type:ApiClient) which created the resource.
	ClientId *string `json:"clientId,omitempty"`
	// [External user ID](/../api/general-concepts#external-user-ids) provided by `X-External-User-ID` HTTP Header or [`external_user_id:{externalUserId}`](/../api/scopes#external_user_idexternaluserid) scope.
	ExternalUserId *string `json:"externalUserId,omitempty"`
	// Indicates the [Customer](ctp:api:type:Customer) who created the resource using a token from the [password flow](/authorization#password-flow).
	Customer *CustomerReference `json:"customer,omitempty"`
	// Indicates the [anonymous session](ctp:api:type:AnonymousSession) during which the resource was created.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// Indicates the [Customer](ctp:api:type:Customer) who created the resource in the context of a [Business Unit](ctp:api:type:BusinessUnit). Only present when an Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).
	Associate *CustomerReference `json:"associate,omitempty"`
}

* * Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).

type CustomFieldBooleanType ¶ 

type CustomFieldBooleanType struct {
}

* * Field type for Boolean values. *

func (CustomFieldBooleanType) MarshalJSON ¶ 

func (obj CustomFieldBooleanType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldDateTimeType ¶ 

type CustomFieldDateTimeType struct {
}

* * Field type for [DateTime](ctp:api:type:DateTime) values. *

func (CustomFieldDateTimeType) MarshalJSON ¶ 

func (obj CustomFieldDateTimeType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldDateType ¶ 

type CustomFieldDateType struct {
}

* * Field type for Date(ctp:api:type:Date) values. *

func (CustomFieldDateType) MarshalJSON ¶ 

func (obj CustomFieldDateType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldEnumType ¶ 

type CustomFieldEnumType struct {
	// Allowed values.
	Values []CustomFieldEnumValue `json:"values"`
}

* * Field type for enum values. *

func (CustomFieldEnumType) MarshalJSON ¶ 

func (obj CustomFieldEnumType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldEnumValue ¶ 

type CustomFieldEnumValue struct {
	// Key of the value used as a programmatic identifier.
	Key string `json:"key"`
	// Descriptive label of the value.
	Label string `json:"label"`
}

* * Defines an allowed value of a CustomFieldEnumType(ctp:api:type:CustomFieldEnumType) field. *

type CustomFieldLocalizedEnumType ¶ 

type CustomFieldLocalizedEnumType struct {
	// Allowed values.
	Values []CustomFieldLocalizedEnumValue `json:"values"`
}

* * Field type for localized enum values. *

func (CustomFieldLocalizedEnumType) MarshalJSON ¶ 

func (obj CustomFieldLocalizedEnumType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldLocalizedEnumValue ¶ 

type CustomFieldLocalizedEnumValue struct {
	// Key of the value used as a programmatic identifier.
	Key string `json:"key"`
	// Descriptive localized label of the value.
	Label LocalizedString `json:"label"`
}

* * Defines an allowed value of a CustomFieldLocalizedEnumType(ctp:api:type:CustomFieldLocalizedEnumType) field. *

type CustomFieldLocalizedStringType ¶ 

type CustomFieldLocalizedStringType struct {
}

* * Field type for LocalizedString(ctp:api:type:LocalizedString) values. *

func (CustomFieldLocalizedStringType) MarshalJSON ¶ 

func (obj CustomFieldLocalizedStringType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldMoneyType ¶ 

type CustomFieldMoneyType struct {
}

* * Field type for CentPrecisionMoney(ctp:api:type:CentPrecisionMoney) values. *

func (CustomFieldMoneyType) MarshalJSON ¶ 

func (obj CustomFieldMoneyType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldNumberType ¶ 

type CustomFieldNumberType struct {
}

* * Field type for number values. *

func (CustomFieldNumberType) MarshalJSON ¶ 

func (obj CustomFieldNumberType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldReferenceType ¶ 

type CustomFieldReferenceType struct {
	// Resource type the Custom Field can reference.
	ReferenceTypeId CustomFieldReferenceValue `json:"referenceTypeId"`
}

* * Field type for Reference(ctp:api:type:Reference) values. *

func (CustomFieldReferenceType) MarshalJSON ¶ 

func (obj CustomFieldReferenceType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldReferenceValue ¶ 

type CustomFieldReferenceValue string

* * Defines which resource type a CustomFieldReferenceType(ctp:api:type:CustomFieldReferenceType) can reference. * 

const (
	CustomFieldReferenceValueApprovalFlow     CustomFieldReferenceValue = "approval-flow"
	CustomFieldReferenceValueAssociateRole    CustomFieldReferenceValue = "associate-role"
	CustomFieldReferenceValueBusinessUnit     CustomFieldReferenceValue = "business-unit"
	CustomFieldReferenceValueCart             CustomFieldReferenceValue = "cart"
	CustomFieldReferenceValueCategory         CustomFieldReferenceValue = "category"
	CustomFieldReferenceValueChannel          CustomFieldReferenceValue = "channel"
	CustomFieldReferenceValueCustomer         CustomFieldReferenceValue = "customer"
	CustomFieldReferenceValueKeyValueDocument CustomFieldReferenceValue = "key-value-document"
	CustomFieldReferenceValueOrder            CustomFieldReferenceValue = "order"
	CustomFieldReferenceValueProduct          CustomFieldReferenceValue = "product"
	CustomFieldReferenceValueProductType      CustomFieldReferenceValue = "product-type"
	CustomFieldReferenceValueReview           CustomFieldReferenceValue = "review"
	CustomFieldReferenceValueState            CustomFieldReferenceValue = "state"
	CustomFieldReferenceValueShippingMethod   CustomFieldReferenceValue = "shipping-method"
	CustomFieldReferenceValueZone             CustomFieldReferenceValue = "zone"
)

type CustomFieldSetType ¶ 

type CustomFieldSetType struct {
	// Field type of the elements in the set.
	ElementType FieldType `json:"elementType"`
}

* * Values of a SetType Custom Field are sets of values of the specified `elementType` (without duplicate elements). *

func (CustomFieldSetType) MarshalJSON ¶ 

func (obj CustomFieldSetType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomFieldSetType) UnmarshalJSON ¶ 

func (obj *CustomFieldSetType) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomFieldStringType ¶ 

type CustomFieldStringType struct {
}

* * Field type for string values. *

func (CustomFieldStringType) MarshalJSON ¶ 

func (obj CustomFieldStringType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFieldTimeType ¶ 

type CustomFieldTimeType struct {
}

* * Field type for [Time](ctp:api:type:Time) values. *

func (CustomFieldTimeType) MarshalJSON ¶ 

func (obj CustomFieldTimeType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomFields ¶ 

type CustomFields struct {
	// Reference to the [Type](ctp:api:type:Type) that holds the [FieldDefinitions](ctp:api:type:FieldDefinition) for the Custom Fields.
	Type TypeReference `json:"type"`
	// Object containing the Custom Fields for the [customized resource or data type](/../api/projects/types#list-of-customizable-data-types).
	Fields FieldContainer `json:"fields"`
}

* * Serves as value of the `custom` field on a resource or data type customized with a Type(ctp:api:type:Type). *

type CustomFieldsDraft ¶ 

type CustomFieldsDraft struct {
	// `id` or `key` of the [Type](ctp:api:type:Type).
	Type TypeResourceIdentifier `json:"type"`
	// Object containing the Custom Fields for the [customized resource or data type](/../api/projects/types#list-of-customizable-data-types).
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * The representation used when creating or updating a [customizable data type](/../api/projects/types#list-of-customizable-data-types) with Custom Fields. *

type CustomLineItem ¶ 

type CustomLineItem struct {
	// Unique identifier of the Custom Line Item.
	ID string `json:"id"`
	// User-defined unique identifier of the Custom Line Item.
	Key *string `json:"key,omitempty"`
	// Name of the Custom Line Item.
	Name LocalizedString `json:"name"`
	// Money value of the Custom Line Item.
	Money TypedMoney `json:"money"`
	// Automatically set after the `taxRate` is set.
	TaxedPrice *TaxedItemPrice `json:"taxedPrice,omitempty"`
	// Total taxed prices based on the quantity of the Custom Line Item assigned to each [Shipping Method](ctp:api:type:ShippingMethod). Only applicable for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	// Automatically set after `perMethodTaxRate` is set.
	TaxedPricePortions []MethodTaxedPrice `json:"taxedPricePortions"`
	// Total price of the Custom Line Item (`money` multiplied by `quantity`).
	// If the Custom Line Item is discounted, the total price is `discountedPricePerQuantity` multiplied by `quantity`.
	//
	// Includes taxes if the [TaxRate](ctp:api:type:TaxRate) `includedInPrice` is `true`.
	TotalPrice CentPrecisionMoney `json:"totalPrice"`
	// User-defined identifier used in a deep-link URL for the Custom Line Item.
	// It matches the pattern `[a-zA-Z0-9_-]{2,256}`.
	Slug string `json:"slug"`
	// Number of Custom Line Items in the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order).
	Quantity int `json:"quantity"`
	// State of the Custom Line Item in the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order).
	State []ItemState `json:"state"`
	// Used to select a Tax Rate when a Cart has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	TaxCategory *TaxCategoryReference `json:"taxCategory,omitempty"`
	// - For a Cart with `Platform` [TaxMode](ctp:api:type:TaxMode), the `taxRate` of Custom Line Items is set automatically once a shipping address is set. The rate is based on the [TaxCategory](ctp:api:type:TaxCategory) that applies for the shipping address.
	// - For a Cart with `External` TaxMode, the `taxRate` of Custom Line Items can be set using [ExternalTaxRateDraft](ctp:api:type:ExternalTaxRateDraft).
	TaxRate *TaxRate `json:"taxRate,omitempty"`
	// Tax Rate per Shipping Method for a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode). For a Cart with `Platform` [TaxMode](ctp:api:type:TaxMode) it is automatically set after the [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).
	// For a Cart with `External` [TaxMode](ctp:api:type:TaxMode), the Tax Rate must be set with [ExternalTaxRateDraft](ctp:api:type:ExternalTaxRateDraft).
	PerMethodTaxRate []MethodTaxRate `json:"perMethodTaxRate"`
	// Discounted price of a single quantity of the Custom Line Item.
	DiscountedPricePerQuantity []DiscountedLineItemPriceForQuantity `json:"discountedPricePerQuantity"`
	// Custom Fields of the Custom Line Item.
	Custom *CustomFields `json:"custom,omitempty"`
	// Container for Custom Line Item-specific addresses.
	ShippingDetails *ItemShippingDetails `json:"shippingDetails,omitempty"`
	// Indicates whether Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget) are applied to the Custom Line Item.
	PriceMode CustomLineItemPriceMode `json:"priceMode"`
}

* * A generic item that can be added to the Cart but is not bound to a Product that can be used for discounts (negative money), vouchers, complex cart rules, additional services, or fees. * You control the lifecycle of this item. *

func (*CustomLineItem) UnmarshalJSON ¶ 

func (obj *CustomLineItem) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomLineItemDraft ¶ 

type CustomLineItemDraft struct {
	// Name of the Custom Line Item.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier of the Custom Line Item.
	Key *string `json:"key,omitempty"`
	// Number of Custom Line Items to add to the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// Money value of the Custom Line Item.
	// The value can be negative.
	Money Money `json:"money"`
	// User-defined identifier used in a deep-link URL for the Custom Line Item.
	// It must match the pattern `[a-zA-Z0-9_-]{2,256}`.
	Slug string `json:"slug"`
	// Used to select a Tax Rate when a Cart has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	// This field is required for `Platform` [TaxMode](ctp:api:type:TaxMode).
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// External Tax Rate for the Custom Line Item if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Custom Fields for the Custom Line Item.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Container for Custom Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// - If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget)
	// are applied to the Custom Line Item.
	// - If `External`, Cart Discounts are not considered on the Custom Line Item.
	PriceMode *CustomLineItemPriceMode `json:"priceMode,omitempty"`
}

type CustomLineItemImportDraft ¶ 

type CustomLineItemImportDraft struct {
	// Name of the Custom Line Item.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier of the Custom Line Item.
	Key *string `json:"key,omitempty"`
	// User-defined identifier used in a deep-link URL for the Custom Line Item. This value should match the pattern `[a-zA-Z0-9_-]{2,256}`.
	Slug string `json:"slug"`
	// The number of items in the Custom Line Item. Can be a negative value.
	Quantity int `json:"quantity"`
	// The cost of individual items in the Custom Line Item. The amount can be negative.
	Money Money `json:"money"`
	// The tax rate used to calculate the `taxedPrice` of the Order.
	TaxRate *TaxRate `json:"taxRate,omitempty"`
	// Include a value to associate a Tax Category with the Custom Line Item.
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// - If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget)
	// are applied to the Custom Line Item.
	// - If `External`, Cart Discounts are not considered on the Custom Line Item.
	PriceMode *CustomLineItemPriceMode `json:"priceMode,omitempty"`
	// Container for Custom Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// State of the Custom Line Items.
	State []ItemState `json:"state"`
	// Custom Fields of the CustomLineItem.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * Custom Line Items contain generic user-defined items that are not linked to Products. *

func (CustomLineItemImportDraft) MarshalJSON ¶ 

func (obj CustomLineItemImportDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomLineItemPriceMode ¶ added in v1.2.0 

type CustomLineItemPriceMode string

* * Determines if Cart Discounts can be applied to a Custom Line Item in the Cart. * 

const (
	CustomLineItemPriceModeStandard CustomLineItemPriceMode = "Standard"
	CustomLineItemPriceModeExternal CustomLineItemPriceMode = "External"
)

type CustomLineItemReturnItem ¶ 

type CustomLineItemReturnItem struct {
	// Unique identifier of the Return Item.
	ID string `json:"id"`
	// User-defined unique identifier of the CustomLineItemReturnItem.
	Key *string `json:"key,omitempty"`
	// Number of Custom Line Items returned.
	Quantity int `json:"quantity"`
	// User-defined description for the return.
	Comment *string `json:"comment,omitempty"`
	// Shipment status of the Return Item.
	ShipmentState ReturnShipmentState `json:"shipmentState"`
	// Payment status of the Return Item:
	//
	// - `NonRefundable`, for items in the `Advised` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
	// - `Initial`, for items in the `Returned` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
	PaymentState ReturnPaymentState `json:"paymentState"`
	// Custom Fields of the Return Item.
	Custom *CustomFields `json:"custom,omitempty"`
	// Date and time (UTC) the Return Item was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Date and time (UTC) the Return Item was intitially created.
	CreatedAt time.Time `json:"createdAt"`
	// `id` of the returned [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
}

func (CustomLineItemReturnItem) MarshalJSON ¶ 

func (obj CustomLineItemReturnItem) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomLineItemStateTransitionMessage ¶ 

type CustomLineItemStateTransitionMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// User-defined unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Date and time (UTC) when the transition of the [Custom Line Item](ctp:api:type:CustomLineItem) [State](ctp:api:type:State) was performed.
	TransitionDate time.Time `json:"transitionDate"`
	// Number of [Custom Line Items](ctp:api:type:CustomLineItem) for which the [State](ctp:api:type:State) was transitioned.
	Quantity int `json:"quantity"`
	// [State](ctp:api:type:State) the [Custom Line Item](ctp:api:type:CustomLineItem) was transitioned from.
	FromState StateReference `json:"fromState"`
	// [State](ctp:api:type:State) the [Custom Line Item](ctp:api:type:CustomLineItem) was transitioned to.
	ToState StateReference `json:"toState"`
}

* * Generated after a successful [Transition CustomLineItem State](ctp:api:type:OrderTransitionCustomLineItemStateAction) update action. *

func (CustomLineItemStateTransitionMessage) MarshalJSON ¶ 

func (obj CustomLineItemStateTransitionMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomLineItemStateTransitionMessage) UnmarshalJSON ¶ 

func (obj *CustomLineItemStateTransitionMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomLineItemStateTransitionMessagePayload ¶ 

type CustomLineItemStateTransitionMessagePayload struct {
	// Unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// User-defined unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Date and time (UTC) when the transition of the [Custom Line Item](ctp:api:type:CustomLineItem) [State](ctp:api:type:State) was performed.
	TransitionDate time.Time `json:"transitionDate"`
	// Number of [Custom Line Items](ctp:api:type:CustomLineItem) for which the [State](ctp:api:type:State) was transitioned.
	Quantity int `json:"quantity"`
	// [State](ctp:api:type:State) the [Custom Line Item](ctp:api:type:CustomLineItem) was transitioned from.
	FromState StateReference `json:"fromState"`
	// [State](ctp:api:type:State) the [Custom Line Item](ctp:api:type:CustomLineItem) was transitioned to.
	ToState StateReference `json:"toState"`
}

* * Generated after a successful [Transition CustomLineItem State](ctp:api:type:OrderTransitionCustomLineItemStateAction) update action. *

func (CustomLineItemStateTransitionMessagePayload) MarshalJSON ¶ 

func (obj CustomLineItemStateTransitionMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomObject ¶ 

type CustomObject struct {
	// Unique identifier of the CustomObject.
	ID string `json:"id"`
	// Current version of the CustomObject.
	Version int `json:"version"`
	// Date and time (UTC) the CustomObject was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the CustomObject was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Namespace to group CustomObjects.
	Container string `json:"container"`
	// User-defined unique identifier of the CustomObject within the defined `container`.
	Key string `json:"key"`
	// JSON standard types Number, String, Boolean, Array, Object, and [common API data types](/../api/types).
	// For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed.
	// If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.
	Value interface{} `json:"value"`
}

type CustomObjectDraft ¶ 

type CustomObjectDraft struct {
	// Namespace to group CustomObjects.
	Container string `json:"container"`
	// User-defined unique identifier of the CustomObject within the defined `container`.
	Key string `json:"key"`
	// JSON standard types Number, String, Boolean, Array, Object, and [common API data types](/../api/types).
	// For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed.
	// If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.
	Value interface{} `json:"value"`
	// Current version of the CustomObject.
	Version *int `json:"version,omitempty"`
}

type CustomObjectPagedQueryResponse ¶ 

type CustomObjectPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// The total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [CustomObjects](ctp:api:type:CustomObject) matching the query.
	Results []CustomObject `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of CustomObject(ctp:api:type:CustomObject). *

type CustomObjectReference ¶ 

type CustomObjectReference struct {
	// Unique identifier of the referenced [CustomObject](ctp:api:type:CustomObject).
	ID string `json:"id"`
	// Contains the representation of the expanded CustomObject. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for CustomObjects.
	Obj *CustomObject `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a CustomObject(ctp:api:type:CustomObject). *

func (CustomObjectReference) MarshalJSON ¶ 

func (obj CustomObjectReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomShippingDraft ¶ added in v1.2.0 

type CustomShippingDraft struct {
	// User-defined unique identifier of the custom Shipping Method in the Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	Key string `json:"key"`
	// Name of the custom Shipping Method.
	ShippingMethodName string `json:"shippingMethodName"`
	// Determines the shipping rate and Tax Rate of the associated Line Items.
	ShippingAddress *BaseAddress `json:"shippingAddress,omitempty"`
	// Determines the shipping price.
	ShippingRate ShippingRateDraft `json:"shippingRate"`
	// Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it must be [ClassificationShippingRateInputDraft](ctp:api:type:ClassificationShippingRateInputDraft).
	// - If `CartScore`, it must be [ScoreShippingRateInputDraft](ctp:api:type:ScoreShippingRateInputDraft).
	// - If `CartValue`, it cannot be set.
	ShippingRateInput ShippingRateInputDraft `json:"shippingRateInput,omitempty"`
	// Tax Category used to determine a shipping Tax Rate if the Cart has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// Tax Rate used to tax a shipping expense if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Deliveries to be shipped with the custom Shipping Method.
	Deliveries []DeliveryDraft `json:"deliveries"`
	// Custom Fields for the custom Shipping Method.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (CustomShippingDraft) MarshalJSON ¶ added in v1.3.0 

func (obj CustomShippingDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomShippingDraft) UnmarshalJSON ¶ added in v1.2.0 

func (obj *CustomShippingDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomTokenizer ¶ 

type CustomTokenizer struct {
	// Contains custom tokens.
	Inputs []string `json:"inputs"`
}

* * Define arbitrary tokens that are used to match the input. *

func (CustomTokenizer) MarshalJSON ¶ 

func (obj CustomTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Customer ¶ 

type Customer struct {
	// Unique identifier of the Customer.
	ID string `json:"id"`
	// Current version of the Customer.
	Version int `json:"version"`
	// Date and time (UTC) the Customer was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Customer was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-defined unique identifier of the Customer.
	Key *string `json:"key,omitempty"`
	// User-defined unique identifier of the Customer.
	//
	// Can be used to refer to a Customer in a human-readable way (in emails, invoices, and other correspondence).
	CustomerNumber *string `json:"customerNumber,omitempty"`
	// Optional identifier for use in external systems like customer relationship management (CRM) or enterprise resource planning (ERP).
	ExternalId *string `json:"externalId,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Email address of the Customer that is [unique](/../api/customers-overview#customer-uniqueness) for an entire Project or to a Store the Customer is assigned to.
	// It is the mandatory unique identifier of a Customer.
	Email string `json:"email"`
	// Present only when `authenticationMode` is set to `Password`.
	Password *string `json:"password,omitempty"`
	// Given name (first name) of the Customer.
	FirstName *string `json:"firstName,omitempty"`
	// Family name (last name) of the Customer.
	LastName *string `json:"lastName,omitempty"`
	// Middle name of the Customer.
	MiddleName *string `json:"middleName,omitempty"`
	// Title of the Customer, for example, 'Dr.'.
	Title *string `json:"title,omitempty"`
	// Date of birth of the Customer.
	DateOfBirth *Date `json:"dateOfBirth,omitempty"`
	// Company name of the Customer.
	CompanyName *string `json:"companyName,omitempty"`
	// Individual VAT ID of the Customer.
	VatId *string `json:"vatId,omitempty"`
	// Addresses used by the Customer.
	Addresses []Address `json:"addresses"`
	// ID of the address in `addresses` used as the default shipping address.
	DefaultShippingAddressId *string `json:"defaultShippingAddressId,omitempty"`
	// IDs of addresses in `addresses` used as shipping addresses.
	ShippingAddressIds []string `json:"shippingAddressIds"`
	// ID of the address in `addresses` used as the default billing address.
	DefaultBillingAddressId *string `json:"defaultBillingAddressId,omitempty"`
	// IDs of addresses in `addresses` used as billing addresses.
	BillingAddressIds []string `json:"billingAddressIds"`
	// Indicates whether the email address of the Customer is [verified](#email-verification-of-customer).
	IsEmailVerified bool `json:"isEmailVerified"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) to which the Customer belongs.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// Custom Fields for the Customer.
	Custom *CustomFields `json:"custom,omitempty"`
	// Preferred language of the Customer.
	Locale *string `json:"locale,omitempty"`
	// Salutation of the Customer, for example, 'Mr.' or 'Mrs.'.
	Salutation *string `json:"salutation,omitempty"`
	// [Stores](ctp:api:type:Store) to which the Customer is assigned to.
	//
	// - If no Stores are specified, the Customer is a global customer, and can log in using the [Password Flow for global Customers](/../api/authorization#password-flow-for-global-customers).
	// - If any Stores are specified, the Customer can only log in using the [Password Flow for Customers in a Store](/../api/authorization#password-flow-for-customers-in-a-store) for those specific Stores.
	Stores []StoreKeyReference `json:"stores"`
	// Indicates whether the `password` is required for the Customer.
	AuthenticationMode AuthenticationMode `json:"authenticationMode"`
}

* * If `stores` is not empty, the Customer is specific to those Stores. *

func (Customer) MarshalJSON ¶ 

func (obj Customer) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddAddressAction ¶ 

type CustomerAddAddressAction struct {
	// Value to append to the `addresses` array.
	Address BaseAddress `json:"address"`
}

* * Adding an address to the Customer produces the [CustomerAddressAdded](ctp:api:type:CustomerAddressAddedMessage) Message. *

func (CustomerAddAddressAction) MarshalJSON ¶ 

func (obj CustomerAddAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddBillingAddressIdAction ¶ 

type CustomerAddBillingAddressIdAction struct {
	// `id` of the [Address](ctp:api:type:Address) to become a billing address.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to become a billing address.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Adds an Address from the `addresses` array to `billingAddressIds`. Either `addressId` or `addressKey` is required. *

func (CustomerAddBillingAddressIdAction) MarshalJSON ¶ 

func (obj CustomerAddBillingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddShippingAddressIdAction ¶ 

type CustomerAddShippingAddressIdAction struct {
	// `id` of the [Address](ctp:api:type:Address) to become a shipping address.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to become a shipping address.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Adds an Address from the `addresses` array to `shippingAddressIds`. Either `addressId` or `addressKey` is required. *

func (CustomerAddShippingAddressIdAction) MarshalJSON ¶ 

func (obj CustomerAddShippingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddStoreAction ¶ 

type CustomerAddStoreAction struct {
	// ResourceIdentifier of the Store to add.
	Store StoreResourceIdentifier `json:"store"`
}

* * Associates the Customer with a Store. *

func (CustomerAddStoreAction) MarshalJSON ¶ 

func (obj CustomerAddStoreAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddressAddedMessage ¶ 

type CustomerAddressAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Address](ctp:api:type:Address) that was added during the [Add Address](ctp:api:type:CustomerAddAddressAction) update action.
	Address Address `json:"address"`
}

* * Generated after a successful [Add Address](ctp:api:type:CustomerAddAddressAction) update action. *

func (CustomerAddressAddedMessage) MarshalJSON ¶ 

func (obj CustomerAddressAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerAddressAddedMessage) UnmarshalJSON ¶ 

func (obj *CustomerAddressAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerAddressAddedMessagePayload ¶ 

type CustomerAddressAddedMessagePayload struct {
	// [Address](ctp:api:type:Address) that was added during the [Add Address](ctp:api:type:CustomerAddAddressAction) update action.
	Address Address `json:"address"`
}

* * Generated after a successful [Add Address](ctp:api:type:CustomerAddAddressAction) update action. *

func (CustomerAddressAddedMessagePayload) MarshalJSON ¶ 

func (obj CustomerAddressAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddressChangedMessage ¶ 

type CustomerAddressChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Address](ctp:api:type:Address) that was set during the [Change Address](ctp:api:type:CustomerChangeAddressAction) update action.
	Address Address `json:"address"`
}

* * Generated after a successful [Change Address](ctp:api:type:CustomerChangeAddressAction) update action. *

func (CustomerAddressChangedMessage) MarshalJSON ¶ 

func (obj CustomerAddressChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerAddressChangedMessage) UnmarshalJSON ¶ 

func (obj *CustomerAddressChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerAddressChangedMessagePayload ¶ 

type CustomerAddressChangedMessagePayload struct {
	// [Address](ctp:api:type:Address) that was set during the [Change Address](ctp:api:type:CustomerChangeAddressAction) update action.
	Address Address `json:"address"`
}

* * Generated after a successful [Change Address](ctp:api:type:CustomerChangeAddressAction) update action. *

func (CustomerAddressChangedMessagePayload) MarshalJSON ¶ 

func (obj CustomerAddressChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddressCustomFieldAddedMessage ¶ added in v1.4.0 

type CustomerAddressCustomFieldAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. * If a Custom Field already exists with the same name, a [CustomerAddressCustomFieldChanged](ctp:api:type:CustomerAddressCustomFieldChangedMessage) Message is generated instead. *

func (CustomerAddressCustomFieldAddedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomFieldAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerAddressCustomFieldAddedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerAddressCustomFieldAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerAddressCustomFieldAddedMessagePayload ¶ added in v1.4.0 

type CustomerAddressCustomFieldAddedMessagePayload struct {
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. * If a Custom Field already exists with the same name, a [CustomerAddressCustomFieldChanged](ctp:api:type:CustomerAddressCustomFieldChangedMessage) Message is generated instead. *

func (CustomerAddressCustomFieldAddedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomFieldAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddressCustomFieldChangedMessage ¶ added in v1.4.0 

type CustomerAddressCustomFieldChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
	// When there has not been a Custom Field with the `name` on the Customer Address before, a [Customer Address Custom Field Added](ctp:api:type:CustomerAddressCustomFieldAddedMessage) Message is generated instead.
	PreviousValue interface{} `json:"previousValue,omitempty"`
}

* * Generated after changing an existing Custom Field on an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. *

func (CustomerAddressCustomFieldChangedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomFieldChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerAddressCustomFieldChangedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerAddressCustomFieldChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerAddressCustomFieldChangedMessagePayload ¶ added in v1.4.0 

type CustomerAddressCustomFieldChangedMessagePayload struct {
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
	// When there has not been a Custom Field with the `name` on the Customer Address before, a [Customer Address Custom Field Added](ctp:api:type:CustomerAddressCustomFieldAddedMessage) Message is generated instead.
	PreviousValue interface{} `json:"previousValue,omitempty"`
}

* * Generated after changing an existing Custom Field on an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. *

func (CustomerAddressCustomFieldChangedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomFieldChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddressCustomFieldRemovedMessage ¶ added in v1.4.0 

type CustomerAddressCustomFieldRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. *

func (CustomerAddressCustomFieldRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomFieldRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerAddressCustomFieldRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerAddressCustomFieldRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerAddressCustomFieldRemovedMessagePayload ¶ added in v1.4.0 

type CustomerAddressCustomFieldRemovedMessagePayload struct {
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. *

func (CustomerAddressCustomFieldRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomFieldRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddressCustomTypeRemovedMessage ¶ added in v1.4.0 

type CustomerAddressCustomTypeRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after removing a Custom Type from an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action. *

func (CustomerAddressCustomTypeRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomTypeRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerAddressCustomTypeRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerAddressCustomTypeRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerAddressCustomTypeRemovedMessagePayload ¶ added in v1.4.0 

type CustomerAddressCustomTypeRemovedMessagePayload struct {
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after removing a Custom Type from an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action. *

func (CustomerAddressCustomTypeRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomTypeRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddressCustomTypeSetMessage ¶ added in v1.4.0 

type CustomerAddressCustomTypeSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Custom Fields that have been set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after adding a Custom Type to an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action. *

func (CustomerAddressCustomTypeSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomTypeSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerAddressCustomTypeSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerAddressCustomTypeSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerAddressCustomTypeSetMessagePayload ¶ added in v1.4.0 

type CustomerAddressCustomTypeSetMessagePayload struct {
	// The Custom Fields that have been set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after adding a Custom Type to an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action. *

func (CustomerAddressCustomTypeSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerAddressCustomTypeSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerAddressRemovedMessage ¶ 

type CustomerAddressRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Address](ctp:api:type:Address) that was removed during the [Remove Address](ctp:api:type:CustomerRemoveAddressAction) update action.
	Address Address `json:"address"`
}

* * Generated after a successful [Remove Address](ctp:api:type:CustomerRemoveAddressAction) update action. *

func (CustomerAddressRemovedMessage) MarshalJSON ¶ 

func (obj CustomerAddressRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerAddressRemovedMessage) UnmarshalJSON ¶ 

func (obj *CustomerAddressRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerAddressRemovedMessagePayload ¶ 

type CustomerAddressRemovedMessagePayload struct {
	// [Address](ctp:api:type:Address) that was removed during the [Remove Address](ctp:api:type:CustomerRemoveAddressAction) update action.
	Address Address `json:"address"`
}

* * Generated after a successful [Remove Address](ctp:api:type:CustomerRemoveAddressAction) update action. *

func (CustomerAddressRemovedMessagePayload) MarshalJSON ¶ 

func (obj CustomerAddressRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerChangeAddressAction ¶ 

type CustomerChangeAddressAction struct {
	// `id` of the [Address](ctp:api:type:Address) to change.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to change.
	AddressKey *string `json:"addressKey,omitempty"`
	// Value to set.
	Address BaseAddress `json:"address"`
}

* * Changing an address of the Customer produces the [CustomerAddressChanged](ctp:api:type:CustomerAddressChangedMessage) Message. * * Either `addressId` or `addressKey` is required. *

func (CustomerChangeAddressAction) MarshalJSON ¶ 

func (obj CustomerChangeAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerChangeEmailAction ¶ 

type CustomerChangeEmailAction struct {
	// Value to set.
	Email string `json:"email"`
}

* * Changes the `email` of the Customer and sets the `isEmailVerified` property to `false`. This update action generates a [CustomerEmailChanged](ctp:api:type:CustomerEmailChangedMessage) Message. *

func (CustomerChangeEmailAction) MarshalJSON ¶ 

func (obj CustomerChangeEmailAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerChangePassword ¶ 

type CustomerChangePassword struct {
	// Unique identifier of the Customer.
	ID string `json:"id"`
	// Expected version of the Customer on which the changes should be applied.
	Version int `json:"version"`
	// Current password of the Customer.
	//
	// If the current password does not match, an [InvalidCurrentPassword](ctp:api:type:InvalidCurrentPasswordError) error is returned.
	CurrentPassword string `json:"currentPassword"`
	// New password to be set.
	NewPassword string `json:"newPassword"`
}

type CustomerCompanyNameSetMessage ¶ 

type CustomerCompanyNameSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `companyName` that was set during the [Set Company Name](ctp:api:type:CustomerSetCompanyNameAction) update action.
	CompanyName *string `json:"companyName,omitempty"`
}

* * Generated after a successful [Set Company Name](ctp:api:type:CustomerSetCompanyNameAction) update action. *

func (CustomerCompanyNameSetMessage) MarshalJSON ¶ 

func (obj CustomerCompanyNameSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerCompanyNameSetMessage) UnmarshalJSON ¶ 

func (obj *CustomerCompanyNameSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerCompanyNameSetMessagePayload ¶ 

type CustomerCompanyNameSetMessagePayload struct {
	// The `companyName` that was set during the [Set Company Name](ctp:api:type:CustomerSetCompanyNameAction) update action.
	CompanyName *string `json:"companyName,omitempty"`
}

* * Generated after a successful [Set Company Name](ctp:api:type:CustomerSetCompanyNameAction) update action. *

func (CustomerCompanyNameSetMessagePayload) MarshalJSON ¶ 

func (obj CustomerCompanyNameSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerCreateEmailToken ¶ 

type CustomerCreateEmailToken struct {
	// Unique identifier of the Customer.
	ID string `json:"id"`
	// Expected version of the Customer.
	Version *int `json:"version,omitempty"`
	// Validity period of the generated token in minutes.
	TtlMinutes int `json:"ttlMinutes"`
}

type CustomerCreatePasswordResetToken ¶ 

type CustomerCreatePasswordResetToken struct {
	// Email address of the Customer treated as [case-insensitive](/../api/customers-overview#email-case-insensitivity).
	Email string `json:"email"`
	// Validity period of the generated token in minutes.
	TtlMinutes *int `json:"ttlMinutes,omitempty"`
}

type CustomerCreatedMessage ¶ 

type CustomerCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Customer](ctp:api:type:Customer) that was created.
	Customer Customer `json:"customer"`
}

* * Generated after a successful [Create Customer](ctp:api:endpoint:/{projectKey}/customers:POST) request. *

func (CustomerCreatedMessage) MarshalJSON ¶ 

func (obj CustomerCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerCreatedMessage) UnmarshalJSON ¶ 

func (obj *CustomerCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerCreatedMessagePayload ¶ 

type CustomerCreatedMessagePayload struct {
	// [Customer](ctp:api:type:Customer) that was created.
	Customer Customer `json:"customer"`
}

* * Generated after a successful [Create Customer](ctp:api:endpoint:/{projectKey}/customers:POST) request. *

func (CustomerCreatedMessagePayload) MarshalJSON ¶ 

func (obj CustomerCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerCustomFieldAddedMessage ¶ added in v1.4.0 

type CustomerCustomFieldAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. * If a Custom Field already exists with the same name, a [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message is generated instead. *

func (CustomerCustomFieldAddedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomFieldAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerCustomFieldAddedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerCustomFieldAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerCustomFieldAddedMessagePayload ¶ added in v1.4.0 

type CustomerCustomFieldAddedMessagePayload struct {
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. * If a Custom Field already exists with the same name, a [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message is generated instead. *

func (CustomerCustomFieldAddedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomFieldAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerCustomFieldChangedMessage ¶ added in v1.4.0 

type CustomerCustomFieldChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
	// When there has not been a Custom Field with the `name` on the Customer before, a [Customer Custom Field Added](ctp:api:type:CustomerCustomFieldAddedMessage) Message is generated instead.
	PreviousValue interface{} `json:"previousValue,omitempty"`
}

* * Generated after changing an existing Custom Field on a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. *

func (CustomerCustomFieldChangedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomFieldChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerCustomFieldChangedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerCustomFieldChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerCustomFieldChangedMessagePayload ¶ added in v1.4.0 

type CustomerCustomFieldChangedMessagePayload struct {
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
	// When there has not been a Custom Field with the `name` on the Customer before, a [Customer Custom Field Added](ctp:api:type:CustomerCustomFieldAddedMessage) Message is generated instead.
	PreviousValue interface{} `json:"previousValue,omitempty"`
}

* * Generated after changing an existing Custom Field on a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. *

func (CustomerCustomFieldChangedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomFieldChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerCustomFieldRemovedMessage ¶ added in v1.4.0 

type CustomerCustomFieldRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. *

func (CustomerCustomFieldRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomFieldRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerCustomFieldRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerCustomFieldRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerCustomFieldRemovedMessagePayload ¶ added in v1.4.0 

type CustomerCustomFieldRemovedMessagePayload struct {
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. *

func (CustomerCustomFieldRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomFieldRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerCustomTypeRemovedMessage ¶ added in v1.4.0 

type CustomerCustomTypeRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters. *

func (CustomerCustomTypeRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomTypeRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerCustomTypeRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerCustomTypeRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerCustomTypeRemovedMessagePayload ¶ added in v1.4.0 

type CustomerCustomTypeRemovedMessagePayload struct {
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters. *

func (CustomerCustomTypeRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomTypeRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerCustomTypeSetMessage ¶ added in v1.4.0 

type CustomerCustomTypeSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Custom Fields that have been set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action. *

func (CustomerCustomTypeSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomTypeSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerCustomTypeSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerCustomTypeSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerCustomTypeSetMessagePayload ¶ added in v1.4.0 

type CustomerCustomTypeSetMessagePayload struct {
	// The Custom Fields that have been set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action. *

func (CustomerCustomTypeSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerCustomTypeSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerDateOfBirthSetMessage ¶ 

type CustomerDateOfBirthSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `dateOfBirth` that was set during the [Set Date of Birth](ctp:api:type:CustomerSetDateOfBirthAction) update action.
	DateOfBirth *Date `json:"dateOfBirth,omitempty"`
}

* * Generated after a successful [Set Date of Birth](ctp:api:type:CustomerSetDateOfBirthAction) update action. *

func (CustomerDateOfBirthSetMessage) MarshalJSON ¶ 

func (obj CustomerDateOfBirthSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerDateOfBirthSetMessage) UnmarshalJSON ¶ 

func (obj *CustomerDateOfBirthSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerDateOfBirthSetMessagePayload ¶ 

type CustomerDateOfBirthSetMessagePayload struct {
	// The `dateOfBirth` that was set during the [Set Date of Birth](ctp:api:type:CustomerSetDateOfBirthAction) update action.
	DateOfBirth *Date `json:"dateOfBirth,omitempty"`
}

* * Generated after a successful [Set Date of Birth](ctp:api:type:CustomerSetDateOfBirthAction) update action. *

func (CustomerDateOfBirthSetMessagePayload) MarshalJSON ¶ 

func (obj CustomerDateOfBirthSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerDeletedMessage ¶ 

type CustomerDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete Customer](/../api/projects/customers#delete-customer) request. *

func (CustomerDeletedMessage) MarshalJSON ¶ 

func (obj CustomerDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerDeletedMessage) UnmarshalJSON ¶ 

func (obj *CustomerDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerDeletedMessagePayload ¶ 

type CustomerDeletedMessagePayload struct {
}

* * Generated after a successful [Delete Customer](/../api/projects/customers#delete-customer) request. *

func (CustomerDeletedMessagePayload) MarshalJSON ¶ 

func (obj CustomerDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerDraft ¶ 

type CustomerDraft struct {
	// User-defined unique identifier for the Customer.
	// The `key` field is preferred over `customerNumber` as it is mutable and provides more flexibility.
	Key *string `json:"key,omitempty"`
	// User-defined unique identifier for a Customer.
	// Once set, it cannot be changed.
	//
	// Can be used to refer to a Customer in a human-readable way (in emails, invoices, and other correspondence).
	CustomerNumber *string `json:"customerNumber,omitempty"`
	// Optional identifier for use in external systems like customer relationship management (CRM) or enterprise resource planning (ERP).
	ExternalId *string `json:"externalId,omitempty"`
	// Email address of the Customer that must be [unique](/../api/customers-overview#customer-uniqueness) for an entire Project or to a Store the Customer is assigned to.
	// It is the mandatory unique identifier of a Customer.
	Email string `json:"email"`
	// Required when `authenticationMode` is set to `Password`.
	// Provide the Customer's password in plain text. The API stores passwords in an encrypted format.
	Password *string `json:"password,omitempty"`
	// Given name (first name) of the Customer.
	FirstName *string `json:"firstName,omitempty"`
	// Family name (last name) of the Customer.
	LastName *string `json:"lastName,omitempty"`
	// Middle name of the Customer.
	MiddleName *string `json:"middleName,omitempty"`
	// Title of the Customer, for example, 'Dr.'.
	Title *string `json:"title,omitempty"`
	// Deprecated since an anonymous [Cart](ctp:api:type:Cart) can be identified by its `id` or external `key`.
	AnonymousCartId *string `json:"anonymousCartId,omitempty"`
	// Identifies a [Cart](ctp:api:type:Cart) that will be assigned to the new Customer.
	AnonymousCart *CartResourceIdentifier `json:"anonymousCart,omitempty"`
	// Identifies Carts and Orders belonging to an anonymous session that will be assigned to the new Customer.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// Date of birth of the Customer.
	DateOfBirth *Date `json:"dateOfBirth,omitempty"`
	// Company name of the Customer. When representing a company as a Customer, [Business Units](ctp:api:type:BusinessUnit) provide extended funtionality.
	CompanyName *string `json:"companyName,omitempty"`
	// Individual VAT ID of the Customer.
	VatId *string `json:"vatId,omitempty"`
	// Addresses of the Customer.
	Addresses []BaseAddress `json:"addresses"`
	// Index of the address in the `addresses` array to use as the default shipping address.
	// The `defaultShippingAddressId` of the Customer will be set to the `id` of that address.
	DefaultShippingAddress *int `json:"defaultShippingAddress,omitempty"`
	// Indices of the shipping addresses in the `addresses` array.
	// The `shippingAddressIds` of the Customer will be set to the IDs of these addresses.
	ShippingAddresses []int `json:"shippingAddresses"`
	// Index of the address in the `addresses` array to use as the default billing address.
	// The `defaultBillingAddressId` of the Customer will be set to the `id` of that address.
	DefaultBillingAddress *int `json:"defaultBillingAddress,omitempty"`
	// Indices of the billing addresses in the `addresses` array.
	// The `billingAddressIds` of the Customer will be set to the IDs of these addresses.
	BillingAddresses []int `json:"billingAddresses"`
	// Set to `true` if the email address of the Customer has been verified already.
	// The intended use is to leave this field unset upon sign-up of the Customer and initiate the [email verification](#email-verification-of-customer) afterwards.
	IsEmailVerified *bool `json:"isEmailVerified,omitempty"`
	// Sets the [CustomerGroup](ctp:api:type:CustomerGroup) for the Customer.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
	// Custom Fields for the Customer.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Preferred language of the Customer.
	// Must be one of the languages supported by the [Project](ctp:api:type:Project).
	Locale *string `json:"locale,omitempty"`
	// Salutation of the Customer, for example, 'Mr.' or 'Mrs.'.
	Salutation *string `json:"salutation,omitempty"`
	// Sets the [Stores](ctp:api:type:Store) for the Customer.
	//
	// - If no Stores are specified, the Customer is a global customer, and can log in using the [Password Flow for global Customers](/../api/authorization#password-flow-for-global-customers).
	// - If any Stores are specified, the Customer can only log in using the [Password Flow for Customers in a Store](/../api/authorization#password-flow-for-customers-in-a-store) for those specific Stores.
	Stores []StoreResourceIdentifier `json:"stores"`
	// - Set to `Password` to make the `password` field required for the Customer.
	// - Set to `ExternalAuth` when the password is not required for the Customer.
	AuthenticationMode *AuthenticationMode `json:"authenticationMode,omitempty"`
}

func (CustomerDraft) MarshalJSON ¶ 

func (obj CustomerDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerEmailChangedMessage ¶ 

type CustomerEmailChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `email` that was set during the [Change Email](ctp:api:type:CustomerChangeEmailAction) update action.
	Email string `json:"email"`
}

* * Generated after a successful [Change Email](ctp:api:type:CustomerChangeEmailAction) update action. *

func (CustomerEmailChangedMessage) MarshalJSON ¶ 

func (obj CustomerEmailChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerEmailChangedMessage) UnmarshalJSON ¶ 

func (obj *CustomerEmailChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerEmailChangedMessagePayload ¶ 

type CustomerEmailChangedMessagePayload struct {
	// The `email` that was set during the [Change Email](ctp:api:type:CustomerChangeEmailAction) update action.
	Email string `json:"email"`
}

* * Generated after a successful [Change Email](ctp:api:type:CustomerChangeEmailAction) update action. *

func (CustomerEmailChangedMessagePayload) MarshalJSON ¶ 

func (obj CustomerEmailChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerEmailTokenCreatedMessage ¶ added in v1.4.0 

type CustomerEmailTokenCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the Customer.
	CustomerId string `json:"customerId"`
	// Date and time (UTC) the email token expires.
	ExpiresAt time.Time `json:"expiresAt"`
}

* * Generated after a successful [Create email token for Customer](ctp:api:endpoint:/{projectKey}/customers/email-token:POST) request. The `resource` property of the Message is a CustomerEmailTokenReference(ctp:api:type:CustomerEmailTokenReference). *

func (CustomerEmailTokenCreatedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerEmailTokenCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerEmailTokenCreatedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerEmailTokenCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerEmailTokenCreatedMessagePayload ¶ added in v1.4.0 

type CustomerEmailTokenCreatedMessagePayload struct {
	// Unique identifier of the Customer.
	CustomerId string `json:"customerId"`
	// Date and time (UTC) the email token expires.
	ExpiresAt time.Time `json:"expiresAt"`
}

* * Generated after a successful [Create email token for Customer](ctp:api:endpoint:/{projectKey}/customers/email-token:POST) request. The `resource` property of the Message is a CustomerEmailTokenReference(ctp:api:type:CustomerEmailTokenReference). *

func (CustomerEmailTokenCreatedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerEmailTokenCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerEmailTokenReference ¶ added in v1.4.0 

type CustomerEmailTokenReference struct {
	// Unique identifier of the referenced [CustomerToken](ctp:api:type:CustomerToken).
	ID string `json:"id"`
}

* * Reference(ctp:api:type:Reference) to a CustomerToken(ctp:api:type:CustomerToken) for email verification. *

func (CustomerEmailTokenReference) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerEmailTokenReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerEmailVerifiedMessage ¶ 

type CustomerEmailVerifiedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Verify Customer's Email](ctp:api:endpoint:/{projectKey}/customers/email/confirm:POST) request. *

func (CustomerEmailVerifiedMessage) MarshalJSON ¶ 

func (obj CustomerEmailVerifiedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerEmailVerifiedMessage) UnmarshalJSON ¶ 

func (obj *CustomerEmailVerifiedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerEmailVerifiedMessagePayload ¶ 

type CustomerEmailVerifiedMessagePayload struct {
}

* * Generated after a successful [Verify Customer's Email](ctp:api:endpoint:/{projectKey}/customers/email/confirm:POST) request. *

func (CustomerEmailVerifiedMessagePayload) MarshalJSON ¶ 

func (obj CustomerEmailVerifiedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerEmailVerify ¶ 

type CustomerEmailVerify struct {
	// Expected version of the Customer.
	Version *int `json:"version,omitempty"`
	// Value of the token to verify Customer email.
	TokenValue string `json:"tokenValue"`
}

type CustomerFirstNameSetMessage ¶ 

type CustomerFirstNameSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `firstName` that was set during the [Set First Name](ctp:api:type:CustomerSetFirstNameAction) update action.
	FirstName *string `json:"firstName,omitempty"`
}

* * Generated after a successful [Set First Name](ctp:api:type:CustomerSetFirstNameAction) update action. *

func (CustomerFirstNameSetMessage) MarshalJSON ¶ 

func (obj CustomerFirstNameSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerFirstNameSetMessage) UnmarshalJSON ¶ 

func (obj *CustomerFirstNameSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerFirstNameSetMessagePayload ¶ 

type CustomerFirstNameSetMessagePayload struct {
	// The `firstName` that was set during the [Set First Name](ctp:api:type:CustomerSetFirstNameAction) update action.
	FirstName *string `json:"firstName,omitempty"`
}

* * Generated after a successful [Set First Name](ctp:api:type:CustomerSetFirstNameAction) update action. *

func (CustomerFirstNameSetMessagePayload) MarshalJSON ¶ 

func (obj CustomerFirstNameSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroup ¶ 

type CustomerGroup struct {
	// Unique identifier of the CustomerGroup.
	ID string `json:"id"`
	// Current version of the CustomerGroup.
	Version int `json:"version"`
	// Date and time (UTC) the CustomerGroup was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the CustomerGroup was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier for the CustomerGroup.
	Key *string `json:"key,omitempty"`
	// Unique name of the CustomerGroup.
	Name string `json:"name"`
	// Custom Fields for the CustomerGroup.
	Custom *CustomFields `json:"custom,omitempty"`
}

type CustomerGroupChangeNameAction ¶ 

type CustomerGroupChangeNameAction struct {
	// New name of the CustomerGroup.
	Name string `json:"name"`
}

func (CustomerGroupChangeNameAction) MarshalJSON ¶ 

func (obj CustomerGroupChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupCustomFieldAddedMessage ¶ added in v1.4.0 

type CustomerGroupCustomFieldAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. * If a Custom Field already exists with the same name, a [CustomerGroupCustomFieldChanged](ctp:api:type:CustomerGroupCustomFieldChangedMessage) Message is generated instead. *

func (CustomerGroupCustomFieldAddedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomFieldAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerGroupCustomFieldAddedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerGroupCustomFieldAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerGroupCustomFieldAddedMessagePayload ¶ added in v1.4.0 

type CustomerGroupCustomFieldAddedMessagePayload struct {
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field to a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. * If a Custom Field already exists with the same name, a [CustomerGroupCustomFieldChanged](ctp:api:type:CustomerGroupCustomFieldChangedMessage) Message is generated instead. *

func (CustomerGroupCustomFieldAddedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomFieldAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupCustomFieldChangedMessage ¶ added in v1.4.0 

type CustomerGroupCustomFieldChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
	OldValue interface{} `json:"oldValue,omitempty"`
}

* * Generated after changing an existing Custom Field on a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. *

func (CustomerGroupCustomFieldChangedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomFieldChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerGroupCustomFieldChangedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerGroupCustomFieldChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerGroupCustomFieldChangedMessagePayload ¶ added in v1.4.0 

type CustomerGroupCustomFieldChangedMessagePayload struct {
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
	OldValue interface{} `json:"oldValue,omitempty"`
}

* * Generated after changing an existing Custom Field on a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. *

func (CustomerGroupCustomFieldChangedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomFieldChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupCustomFieldRemovedMessage ¶ added in v1.4.0 

type CustomerGroupCustomFieldRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. *

func (CustomerGroupCustomFieldRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomFieldRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerGroupCustomFieldRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerGroupCustomFieldRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerGroupCustomFieldRemovedMessagePayload ¶ added in v1.4.0 

type CustomerGroupCustomFieldRemovedMessagePayload struct {
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated after removing a Custom Field from a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. *

func (CustomerGroupCustomFieldRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomFieldRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupCustomTypeRemovedMessage ¶ added in v1.4.0 

type CustomerGroupCustomTypeRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after removing a Custom Type from a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action with empty parameters. *

func (CustomerGroupCustomTypeRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomTypeRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerGroupCustomTypeRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerGroupCustomTypeRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerGroupCustomTypeRemovedMessagePayload ¶ added in v1.4.0 

type CustomerGroupCustomTypeRemovedMessagePayload struct {
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after removing a Custom Type from a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action with empty parameters. *

func (CustomerGroupCustomTypeRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomTypeRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupCustomTypeSetMessage ¶ added in v1.4.0 

type CustomerGroupCustomTypeSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Custom Fields that have been set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after adding a Custom Type to a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action. *

func (CustomerGroupCustomTypeSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomTypeSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerGroupCustomTypeSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerGroupCustomTypeSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerGroupCustomTypeSetMessagePayload ¶ added in v1.4.0 

type CustomerGroupCustomTypeSetMessagePayload struct {
	// The Custom Fields that have been set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	OldTypeId *string `json:"oldTypeId,omitempty"`
}

* * Generated after adding a Custom Type to a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action. *

func (CustomerGroupCustomTypeSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerGroupCustomTypeSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupDraft ¶ 

type CustomerGroupDraft struct {
	// User-defined unique identifier for the CustomerGroup.
	Key *string `json:"key,omitempty"`
	// Unique value which must be different from any value used for `name` in [CustomerGroup](ctp:api:type:CustomerGroup) in the Project.
	// If not, a [DuplicateField](ctp:api:type:DuplicateFieldError) error is returned.
	GroupName string `json:"groupName"`
	// Custom Fields for the CustomerGroup.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

type CustomerGroupPagedQueryResponse ¶ 

type CustomerGroupPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [CustomerGroups](ctp:api:type:CustomerGroup) matching the query.
	Results []CustomerGroup `json:"results"`
}

* * [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of CustomerGroup(ctp:api:type:CustomerGroup). *

type CustomerGroupReference ¶ 

type CustomerGroupReference struct {
	// Unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup).
	ID string `json:"id"`
	// Contains the representation of the expanded CustomerGroup. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for CustomerGroups.
	Obj *CustomerGroup `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a CustomerGroup(ctp:api:type:CustomerGroup). *

func (CustomerGroupReference) MarshalJSON ¶ 

func (obj CustomerGroupReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupResourceIdentifier ¶ 

type CustomerGroupResourceIdentifier struct {
	// Unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a CustomerGroup(ctp:api:type:CustomerGroup). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (CustomerGroupResourceIdentifier) MarshalJSON ¶ 

func (obj CustomerGroupResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupSetCustomFieldAction ¶ 

type CustomerGroupSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (CustomerGroupSetCustomFieldAction) MarshalJSON ¶ 

func (obj CustomerGroupSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupSetCustomTypeAction ¶ 

type CustomerGroupSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the CustomerGroup with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the CustomerGroup.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the CustomerGroup.
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * This action sets or removes the custom type for an existing CustomerGroup. * If present, this action overwrites any existing [custom](/../api/projects/custom-fields) type and fields. *

func (CustomerGroupSetCustomTypeAction) MarshalJSON ¶ 

func (obj CustomerGroupSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupSetKeyAction ¶ 

type CustomerGroupSetKeyAction struct {
	// If `key` is absent or `null`, the existing key, if any, will be removed.
	Key *string `json:"key,omitempty"`
}

func (CustomerGroupSetKeyAction) MarshalJSON ¶ 

func (obj CustomerGroupSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupSetMessage ¶ 

type CustomerGroupSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Customer Group](ctp:api:type:CustomerGroup) that was set during the [Set Customer Group](ctp:api:type:CustomerSetCustomerGroupAction) update action.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
}

* * Generated after a successful [Set Customer Group](ctp:api:type:CustomerSetCustomerGroupAction) update action. *

func (CustomerGroupSetMessage) MarshalJSON ¶ 

func (obj CustomerGroupSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerGroupSetMessage) UnmarshalJSON ¶ 

func (obj *CustomerGroupSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerGroupSetMessagePayload ¶ 

type CustomerGroupSetMessagePayload struct {
	// [Customer Group](ctp:api:type:CustomerGroup) that was set during the [Set Customer Group](ctp:api:type:CustomerSetCustomerGroupAction) update action.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
}

* * Generated after a successful [Set Customer Group](ctp:api:type:CustomerSetCustomerGroupAction) update action. *

func (CustomerGroupSetMessagePayload) MarshalJSON ¶ 

func (obj CustomerGroupSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerGroupUpdate ¶ 

type CustomerGroupUpdate struct {
	// Expected version of the CustomerGroup on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the CustomerGroup.
	Actions []CustomerGroupUpdateAction `json:"actions"`
}

func (*CustomerGroupUpdate) UnmarshalJSON ¶ 

func (obj *CustomerGroupUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerGroupUpdateAction ¶ 

type CustomerGroupUpdateAction interface{}

type CustomerLastNameSetMessage ¶ 

type CustomerLastNameSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `lastName` that was set during the [Set Last Name](ctp:api:type:CustomerSetLastNameAction) update action.
	LastName *string `json:"lastName,omitempty"`
}

* * Generated after a successful [Set Last Name](ctp:api:type:CustomerSetLastNameAction) update action. *

func (CustomerLastNameSetMessage) MarshalJSON ¶ 

func (obj CustomerLastNameSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerLastNameSetMessage) UnmarshalJSON ¶ 

func (obj *CustomerLastNameSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerLastNameSetMessagePayload ¶ 

type CustomerLastNameSetMessagePayload struct {
	// The `lastName` that was set during the [Set Last Name](ctp:api:type:CustomerSetLastNameAction) update action.
	LastName *string `json:"lastName,omitempty"`
}

* * Generated after a successful [Set Last Name](ctp:api:type:CustomerSetLastNameAction) update action. *

func (CustomerLastNameSetMessagePayload) MarshalJSON ¶ 

func (obj CustomerLastNameSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerPagedQueryResponse ¶ 

type CustomerPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Customers](ctp:api:type:Customer) matching the query.
	Results []Customer `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of Customer(ctp:api:type:Customer). *

type CustomerPasswordTokenCreatedMessage ¶ added in v1.4.0 

type CustomerPasswordTokenCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the Customer.
	CustomerId string `json:"customerId"`
	// Date and time (UTC) the password token expires.
	ExpiresAt time.Time `json:"expiresAt"`
}

* * Generated after a successful [Create password reset token for Customer](ctp:api:endpoint:/{projectKey}/customers/password-token:POST) request. The `resource` property of the Message is a CustomerPasswordTokenReference(ctp:api:type:CustomerPasswordTokenReference). *

func (CustomerPasswordTokenCreatedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerPasswordTokenCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerPasswordTokenCreatedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *CustomerPasswordTokenCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerPasswordTokenCreatedMessagePayload ¶ added in v1.4.0 

type CustomerPasswordTokenCreatedMessagePayload struct {
	// Unique identifier of the Customer.
	CustomerId string `json:"customerId"`
	// Date and time (UTC) the password token expires.
	ExpiresAt time.Time `json:"expiresAt"`
}

* * Generated after a successful [Create password reset token for Customer](ctp:api:endpoint:/{projectKey}/customers/password-token:POST) request. The `resource` property of the Message is a CustomerPasswordTokenReference(ctp:api:type:CustomerPasswordTokenReference). *

func (CustomerPasswordTokenCreatedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerPasswordTokenCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerPasswordTokenReference ¶ added in v1.4.0 

type CustomerPasswordTokenReference struct {
	// Unique identifier of the referenced [CustomerToken](ctp:api:type:CustomerToken).
	ID string `json:"id"`
}

* * Reference(ctp:api:type:Reference) to a CustomerToken(ctp:api:type:CustomerToken) for password reset. *

func (CustomerPasswordTokenReference) MarshalJSON ¶ added in v1.4.0 

func (obj CustomerPasswordTokenReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerPasswordUpdatedMessage ¶ 

type CustomerPasswordUpdatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Whether the Customer's password was updated during the [Reset password](ctp:api:endpoint:/{projectKey}/customers/password/reset:POST) or [Change password](ctp:api:endpoint:/{projectKey}/customers/password:POST) flow.
	Reset bool `json:"reset"`
}

* * Generated after a successful [Reset Customer's Password](ctp:api:endpoint:/{projectKey}/customers/password/reset:POST), [Reset Customer's Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password/reset:POST), [Change Customer's Password](ctp:api:endpoint:/{projectKey}/customers/password:POST), or [Change Customer's Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password:POST) request. This Message is also produced during equivalent requests to the [My Customer Profile](/../api/projects/me-profile) endpoint. *

func (CustomerPasswordUpdatedMessage) MarshalJSON ¶ 

func (obj CustomerPasswordUpdatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerPasswordUpdatedMessage) UnmarshalJSON ¶ 

func (obj *CustomerPasswordUpdatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerPasswordUpdatedMessagePayload ¶ 

type CustomerPasswordUpdatedMessagePayload struct {
	// Whether the Customer's password was updated during the [Reset password](ctp:api:endpoint:/{projectKey}/customers/password/reset:POST) or [Change password](ctp:api:endpoint:/{projectKey}/customers/password:POST) flow.
	Reset bool `json:"reset"`
}

* * Generated after a successful [Reset Customer's Password](ctp:api:endpoint:/{projectKey}/customers/password/reset:POST), [Reset Customer's Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password/reset:POST), [Change Customer's Password](ctp:api:endpoint:/{projectKey}/customers/password:POST), or [Change Customer's Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password:POST) request. This Message is also produced during equivalent requests to the [My Customer Profile](/../api/projects/me-profile) endpoint. *

func (CustomerPasswordUpdatedMessagePayload) MarshalJSON ¶ 

func (obj CustomerPasswordUpdatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerReference ¶ 

type CustomerReference struct {
	// Unique identifier of the referenced [Customer](ctp:api:type:Customer).
	ID string `json:"id"`
	// Contains the representation of the expanded Customer. Only present in responses to requests with [Reference Expansion](ctp:api:type:Expansion) for Customers.
	Obj *Customer `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Customer(ctp:api:type:Customer). *

func (CustomerReference) MarshalJSON ¶ 

func (obj CustomerReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerRemoveAddressAction ¶ 

type CustomerRemoveAddressAction struct {
	// `id` of the [Address](ctp:api:type:Address) to remove.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to remove.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removing an address from the Customer produces the [CustomerAddressRemoved](ctp:api:type:CustomerAddressRemovedMessage) Message. * * Either `addressId` or `addressKey` is required. *

func (CustomerRemoveAddressAction) MarshalJSON ¶ 

func (obj CustomerRemoveAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerRemoveBillingAddressIdAction ¶ 

type CustomerRemoveBillingAddressIdAction struct {
	// `id` of the [Address](ctp:api:type:Address) to remove from `billingAddressesIds`.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to remove from `billingAddressesIds`.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removes a billing address from `billingAddressesIds`. * If the billing address is the default billing address, the `defaultBillingAddressId` is unset. Either `addressId` or `addressKey` is required. *

func (CustomerRemoveBillingAddressIdAction) MarshalJSON ¶ 

func (obj CustomerRemoveBillingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerRemoveShippingAddressIdAction ¶ 

type CustomerRemoveShippingAddressIdAction struct {
	// `id` of the [Address](ctp:api:type:Address) to remove from `shippingAddressesIds`.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to remove from `shippingAddressesIds`.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removes a shipping address from `shippingAddressesIds`. * If the shipping address is the default shipping address, the `defaultShippingAddressId` is unset. Either `addressId` or `addressKey` is required. *

func (CustomerRemoveShippingAddressIdAction) MarshalJSON ¶ 

func (obj CustomerRemoveShippingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerRemoveStoreAction ¶ 

type CustomerRemoveStoreAction struct {
	// ResourceIdentifier of the Store to remove.
	Store StoreResourceIdentifier `json:"store"`
}

* * Removes the association to a Store from the Customer. * If no more Stores are assigned, the Customer becomes a [global Customer](/../api/customers-overview#global-versus-store-specific-customers). *

func (CustomerRemoveStoreAction) MarshalJSON ¶ 

func (obj CustomerRemoveStoreAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerResetPassword ¶ 

type CustomerResetPassword struct {
	// Value of the token to reset the Customer password.
	TokenValue string `json:"tokenValue"`
	// New password to be set.
	NewPassword string `json:"newPassword"`
	// Expected version of the Customer.
	Version *int `json:"version,omitempty"`
}

type CustomerResourceIdentifier ¶ 

type CustomerResourceIdentifier struct {
	// Unique identifier of the referenced [Customer](ctp:api:type:Customer). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [Customer](ctp:api:type:Customer). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a Customer(ctp:api:type:Customer). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (CustomerResourceIdentifier) MarshalJSON ¶ 

func (obj CustomerResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetAddressCustomFieldAction ¶ 

type CustomerSetAddressCustomFieldAction struct {
	// User-defined unique identifier of the [Address](ctp:api:type:Address) to be updated.
	AddressId string `json:"addressId"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// If `value` is provided, it is set for the field defined by `name`.
	// Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	Value interface{} `json:"value,omitempty"`
}

* * Adding a Custom Field to an Address of a Customer generates the [CustomerAddressCustomFieldAdded](ctp:api:type:CustomerAddressCustomFieldAddedMessage) Message, removing one generates the [CustomerAddressCustomFieldRemoved](ctp:api:type:CustomerAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerAddressCustomFieldChanged](ctp:api:type:CustomerAddressCustomFieldChangedMessage) Message. *

func (CustomerSetAddressCustomFieldAction) MarshalJSON ¶ 

func (obj CustomerSetAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetAddressCustomTypeAction ¶ 

type CustomerSetAddressCustomTypeAction struct {
	// User-defined unique identifier of the [Address](ctp:api:type:Address) to be updated.
	AddressId string `json:"addressId"`
	// Defines the [Type](ctp:api:type:Type) that extends the `address` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `address`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `address`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * Adding or updating a Custom Type on an Address of a Customer generates the [CustomerAddressCustomTypeSet](ctp:api:type:CustomerAddressCustomTypeSetMessage) Message, and removing one generates the [CustomerAddressCustomTypeRemoved](ctp:api:type:CustomerAddressCustomTypeRemovedMessage) Message. *

func (CustomerSetAddressCustomTypeAction) MarshalJSON ¶ 

func (obj CustomerSetAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetAuthenticationModeAction ¶ 

type CustomerSetAuthenticationModeAction struct {
	// Value to set.
	// Changing a Customer's `authMode` from `Password` to `ExternalAuth` deletes the Customer's password.
	AuthMode AuthenticationMode `json:"authMode"`
	// Required when `authMode` is `Password`.
	Password *string `json:"password,omitempty"`
}

func (CustomerSetAuthenticationModeAction) MarshalJSON ¶ 

func (obj CustomerSetAuthenticationModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetCompanyNameAction ¶ 

type CustomerSetCompanyNameAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	CompanyName *string `json:"companyName,omitempty"`
}

* * Setting a company name produces the [CustomerCompanyNameSet](ctp:api:type:CustomerCompanyNameSetMessage) Message. *

func (CustomerSetCompanyNameAction) MarshalJSON ¶ 

func (obj CustomerSetCompanyNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetCustomFieldAction ¶ 

type CustomerSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// If `value` is provided, it is set for the field defined by `name`.
	// Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	Value interface{} `json:"value,omitempty"`
}

* * Adding a Custom Field to a Customer generates the [CustomerCustomFieldAdded](ctp:api:type:CustomerCustomFieldAddedMessage) Message, removing one generates the [CustomerCustomFieldRemoved](ctp:api:type:CustomerCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message. *

func (CustomerSetCustomFieldAction) MarshalJSON ¶ 

func (obj CustomerSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetCustomTypeAction ¶ 

type CustomerSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Customer with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Customer.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Customer.
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * Adding or updating a Custom Type on a Customer generates the [CustomerCustomTypeSet](ctp:api:type:CustomerCustomTypeSetMessage) Message, removing one generates the [CustomerCustomTypeRemoved](ctp:api:type:CustomerCustomTypeRemovedMessage) Message. *

func (CustomerSetCustomTypeAction) MarshalJSON ¶ 

func (obj CustomerSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetCustomerGroupAction ¶ 

type CustomerSetCustomerGroupAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
}

* * Setting the Customer Group of the Customer produces the [CustomerGroupSet](ctp:api:type:CustomerGroupSetMessage) Message. *

func (CustomerSetCustomerGroupAction) MarshalJSON ¶ 

func (obj CustomerSetCustomerGroupAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetCustomerNumberAction ¶ 

type CustomerSetCustomerNumberAction struct {
	// Value to set.
	// Once set, it cannot be changed.
	CustomerNumber *string `json:"customerNumber,omitempty"`
}

* * Sets a new ID that can be used to refer to a Customer in a human-reabable way (for use in emails, invoices, etc). *

func (CustomerSetCustomerNumberAction) MarshalJSON ¶ 

func (obj CustomerSetCustomerNumberAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetDateOfBirthAction ¶ 

type CustomerSetDateOfBirthAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	DateOfBirth *Date `json:"dateOfBirth,omitempty"`
}

* * Setting the date of birth of the Customer produces the [CustomerDateOfBirthSet](ctp:api:type:CustomerDateOfBirthSetMessage) Message. *

func (CustomerSetDateOfBirthAction) MarshalJSON ¶ 

func (obj CustomerSetDateOfBirthAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetDefaultBillingAddressAction ¶ 

type CustomerSetDefaultBillingAddressAction struct {
	// `id` of the [Address](ctp:api:type:Address) to become the default billing address.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to become the default billing address.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Sets the default billing address from `addresses`. * The action adds the `id` of the specified Address to the `billingAddressIds` if not contained already. Either `addressId` or `addressKey` is required. *

func (CustomerSetDefaultBillingAddressAction) MarshalJSON ¶ 

func (obj CustomerSetDefaultBillingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetDefaultShippingAddressAction ¶ 

type CustomerSetDefaultShippingAddressAction struct {
	// `id` of the [Address](ctp:api:type:Address) to become the default shipping address.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to become the default shipping address.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Sets the default shipping address from `addresses`. * The action adds the `id` of the specified address to the `shippingAddressIds` if not contained already. Either `addressId` or `addressKey` is required. * * If the Tax Category of the Cart ShippingInfo(ctp:api:type:ShippingInfo) is missing the TaxRate matching country and state given in the `shippingAddress` of that Cart, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. *

func (CustomerSetDefaultShippingAddressAction) MarshalJSON ¶ 

func (obj CustomerSetDefaultShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetExternalIdAction ¶ 

type CustomerSetExternalIdAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	ExternalId *string `json:"externalId,omitempty"`
}

func (CustomerSetExternalIdAction) MarshalJSON ¶ 

func (obj CustomerSetExternalIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetFirstNameAction ¶ 

type CustomerSetFirstNameAction struct {
	// Value to set. If empty, any existing value is removed.
	FirstName *string `json:"firstName,omitempty"`
}

* * Setting the first name of the Customer produces the [CustomeFirstNameSet](ctp:api:type:CustomerFirstNameSetMessage) Message. *

func (CustomerSetFirstNameAction) MarshalJSON ¶ 

func (obj CustomerSetFirstNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetKeyAction ¶ 

type CustomerSetKeyAction struct {
	// If `key` is absent or `null`, the existing key, if any, will be removed.
	Key *string `json:"key,omitempty"`
}

func (CustomerSetKeyAction) MarshalJSON ¶ 

func (obj CustomerSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetLastNameAction ¶ 

type CustomerSetLastNameAction struct {
	// Value to set. If empty, any existing value is removed.
	LastName *string `json:"lastName,omitempty"`
}

* * Setting the last name of the Customer produces the [CustomerLastNameSet](ctp:api:type:CustomerLastNameSetMessage) Message. *

func (CustomerSetLastNameAction) MarshalJSON ¶ 

func (obj CustomerSetLastNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetLocaleAction ¶ 

type CustomerSetLocaleAction struct {
	// Value to set.
	// Must be one of the languages supported by the [Project](ctp:api:type:Project).
	Locale *string `json:"locale,omitempty"`
}

func (CustomerSetLocaleAction) MarshalJSON ¶ 

func (obj CustomerSetLocaleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetMiddleNameAction ¶ 

type CustomerSetMiddleNameAction struct {
	// Value to set. If empty, any existing value is removed.
	MiddleName *string `json:"middleName,omitempty"`
}

func (CustomerSetMiddleNameAction) MarshalJSON ¶ 

func (obj CustomerSetMiddleNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetSalutationAction ¶ 

type CustomerSetSalutationAction struct {
	// Value to set. If empty, any existing value is removed.
	Salutation *string `json:"salutation,omitempty"`
}

func (CustomerSetSalutationAction) MarshalJSON ¶ 

func (obj CustomerSetSalutationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetStoresAction ¶ 

type CustomerSetStoresAction struct {
	// ResourceIdentifier of the Stores to set.
	Stores []StoreResourceIdentifier `json:"stores"`
}

* * Sets the Stores the Customer account is associated with. * If no Stores are specified, the Customer becomes a [global Customer](/../api/customers-overview#global-versus-store-specific-customers). *

func (CustomerSetStoresAction) MarshalJSON ¶ 

func (obj CustomerSetStoresAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetTitleAction ¶ 

type CustomerSetTitleAction struct {
	// Value to set. If empty, any existing value is removed.
	Title *string `json:"title,omitempty"`
}

* * Setting the title of the Customer produces the [CustomerTitleSet](ctp:api:type:CustomerTitleSetMessage) Message. *

func (CustomerSetTitleAction) MarshalJSON ¶ 

func (obj CustomerSetTitleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSetVatIdAction ¶ 

type CustomerSetVatIdAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	VatId *string `json:"vatId,omitempty"`
}

func (CustomerSetVatIdAction) MarshalJSON ¶ 

func (obj CustomerSetVatIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerSignInResult ¶ 

type CustomerSignInResult struct {
	// Customer [signed up](ctp:api:endpoint:/{projectKey}/customers:POST) or [signed in](ctp:api:endpoint:/{projectKey}/login:POST) after authentication.
	Customer Customer `json:"customer"`
	// Cart associated with the Customer.
	// If empty, the Customer does not have a Cart assigned.
	Cart *Cart `json:"cart,omitempty"`
}

type CustomerSignin ¶ 

type CustomerSignin struct {
	// Email address of the Customer treated as [case-insensitive](/../api/customers-overview#email-case-insensitivity).
	Email string `json:"email"`
	// Password of the Customer.
	Password string `json:"password"`
	// Deprecated since it is now possible to identify an anonymous cart by using its `id` or external `key`.
	AnonymousCartId *string `json:"anonymousCartId,omitempty"`
	// Identifies a [Cart](ctp:api:type:Cart) that will be assigned to the Customer.
	AnonymousCart *CartResourceIdentifier `json:"anonymousCart,omitempty"`
	// - Set to `MergeWithExistingCustomerCart` if [LineItems](ctp:api:type:LineItem) of the anonymous Cart should be merged with the active Customer Cart that has been modified most recently.
	// - Set to `UseAsNewActiveCustomerCart` if the anonymous Cart should be used as the new active Customer Cart and no [LineItems](ctp:api:type:LineItem) are to be merged.
	AnonymousCartSignInMode *AnonymousCartSignInMode `json:"anonymousCartSignInMode,omitempty"`
	// If both `anonymousCart` and `anonymousId` are provided, the `anonymousId` on the CustomerSignin must match that of the anonymous [Cart](ctp:api:type:Cart).
	// Otherwise a [400 Bad Request](ctp:api:type:InvalidOperationError) `Invalid Operation` error is returned with the message:
	// "Cart with the ID cart-id does not have the expected anonymousId.".
	AnonymousId *string `json:"anonymousId,omitempty"`
	// - If `true`, the [LineItem](ctp:api:type:LineItem) Product data (`name`, `variant`, and `productType`) of the returned Cart will be updated.
	// - If `false`, only the prices, discounts, and tax rates will be updated.
	UpdateProductData *bool `json:"updateProductData,omitempty"`
}

type CustomerTitleSetMessage ¶ 

type CustomerTitleSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `title` that was set during the [Set Title](ctp:api:type:CustomerSetTitleAction) update action.
	Title *string `json:"title,omitempty"`
}

* * Generated after a successful [Set Title](ctp:api:type:CustomerSetTitleAction) update action. *

func (CustomerTitleSetMessage) MarshalJSON ¶ 

func (obj CustomerTitleSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*CustomerTitleSetMessage) UnmarshalJSON ¶ 

func (obj *CustomerTitleSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerTitleSetMessagePayload ¶ 

type CustomerTitleSetMessagePayload struct {
	// The `title` that was set during the [Set Title](ctp:api:type:CustomerSetTitleAction) update action.
	Title *string `json:"title,omitempty"`
}

* * Generated after a successful [Set Title](ctp:api:type:CustomerSetTitleAction) update action. *

func (CustomerTitleSetMessagePayload) MarshalJSON ¶ 

func (obj CustomerTitleSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomerToken ¶ 

type CustomerToken struct {
	// Unique identifier of the token.
	ID string `json:"id"`
	// The `id` of the Customer.
	CustomerId string `json:"customerId"`
	// Value of the token.
	Value string `json:"value"`
	// Date and time (UTC) the token expires.
	ExpiresAt time.Time `json:"expiresAt"`
	// Date and time (UTC) the token was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// When the token is created, `lastModifiedAt` is set to `createdAt`.
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`
}

type CustomerUpdate ¶ 

type CustomerUpdate struct {
	// Expected version of the Customer on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Customer.
	Actions []CustomerUpdateAction `json:"actions"`
}

func (*CustomerUpdate) UnmarshalJSON ¶ 

func (obj *CustomerUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type CustomerUpdateAction ¶ 

type CustomerUpdateAction interface{}

type Date ¶ 

type Date struct {
	Year  int
	Month time.Month
	Day   int
}

Date holds date information for Commercetools API format

func NewDate ¶ 

func NewDate(year int, month time.Month, day int) Date

NewDate initializes a Date struct

func (*Date) MarshalJSON ¶ 

func (d *Date) MarshalJSON() ([]byte, error)

MarshalJSON marshals into the commercetools date format

func (*Date) UnmarshalJSON ¶ 

func (d *Date) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes JSON data into a Date struct

type DecodeStruct ¶ added in v1.1.0 

type DecodeStruct interface {
	DecodeStruct(map[string]interface{}) error
}

type Delivery ¶ 

type Delivery struct {
	// Unique identifier of the Delivery.
	ID string `json:"id"`
	// User-defined unique identifier of the Delivery.
	Key *string `json:"key,omitempty"`
	// Date and time (UTC) the Delivery was created.
	CreatedAt time.Time `json:"createdAt"`
	// Line Items or Custom Line Items that are delivered.
	Items []DeliveryItem `json:"items"`
	// Information regarding the appearance, content, and shipment of a Parcel.
	Parcels []Parcel `json:"parcels"`
	// Address to which Parcels are delivered.
	Address *Address `json:"address,omitempty"`
	// Custom Fields of the Delivery.
	Custom *CustomFields `json:"custom,omitempty"`
}

* * Contains information on how items are shipped to Customers, for example, a delivery note. *

type DeliveryAddedMessage ¶ 

type DeliveryAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Delivery](ctp:api:type:Delivery) that was added to the [Order](ctp:api:type:Order). The [Delivery](ctp:api:type:Delivery) in the Message body does not contain [Parcels](ctp:api:type:Parcel) if those were part of the initial [Add Delivery](ctp:api:type:OrderAddDeliveryAction) update action. In that case, the update action produces an additional [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message containing information about the [Parcels](ctp:api:type:Parcel).
	Delivery Delivery `json:"delivery"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Add Delivery](ctp:api:type:OrderAddDeliveryAction) update action. *

func (DeliveryAddedMessage) MarshalJSON ¶ 

func (obj DeliveryAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DeliveryAddedMessage) UnmarshalJSON ¶ 

func (obj *DeliveryAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DeliveryAddedMessagePayload ¶ 

type DeliveryAddedMessagePayload struct {
	// [Delivery](ctp:api:type:Delivery) that was added to the [Order](ctp:api:type:Order). The [Delivery](ctp:api:type:Delivery) in the Message body does not contain [Parcels](ctp:api:type:Parcel) if those were part of the initial [Add Delivery](ctp:api:type:OrderAddDeliveryAction) update action. In that case, the update action produces an additional [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message containing information about the [Parcels](ctp:api:type:Parcel).
	Delivery Delivery `json:"delivery"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Add Delivery](ctp:api:type:OrderAddDeliveryAction) update action. *

func (DeliveryAddedMessagePayload) MarshalJSON ¶ 

func (obj DeliveryAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DeliveryAddressSetMessage ¶ 

type DeliveryAddressSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Parcel](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// [Address](ctp:api:type:Address) after the [Set Delivery Address](ctp:api:type:OrderSetDeliveryAddressAction) update action.
	Address *Address `json:"address,omitempty"`
	// [Address](ctp:api:type:Address) before the [Set Delivery Address](ctp:api:type:OrderSetDeliveryAddressAction) update action.
	OldAddress *Address `json:"oldAddress,omitempty"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Delivery Address](ctp:api:type:OrderSetDeliveryAddressAction) update action. *

func (DeliveryAddressSetMessage) MarshalJSON ¶ 

func (obj DeliveryAddressSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DeliveryAddressSetMessage) UnmarshalJSON ¶ 

func (obj *DeliveryAddressSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DeliveryAddressSetMessagePayload ¶ 

type DeliveryAddressSetMessagePayload struct {
	// Unique identifier of the [Parcel](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// [Address](ctp:api:type:Address) after the [Set Delivery Address](ctp:api:type:OrderSetDeliveryAddressAction) update action.
	Address *Address `json:"address,omitempty"`
	// [Address](ctp:api:type:Address) before the [Set Delivery Address](ctp:api:type:OrderSetDeliveryAddressAction) update action.
	OldAddress *Address `json:"oldAddress,omitempty"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Delivery Address](ctp:api:type:OrderSetDeliveryAddressAction) update action. *

func (DeliveryAddressSetMessagePayload) MarshalJSON ¶ 

func (obj DeliveryAddressSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DeliveryDraft ¶ added in v1.2.0 

type DeliveryDraft struct {
	// User-defined unique identifier of the Delivery.
	Key *string `json:"key,omitempty"`
	// Line Items or Custom Line Items to deliver.
	// It can also be specified individually for each [Parcel](ctp:api:type:Parcel).
	Items []DeliveryItem `json:"items"`
	// Information regarding the appearance, content, and shipment of a parcel.
	Parcels []ParcelDraft `json:"parcels"`
	// Address to which the Parcels are delivered.
	Address *AddressDraft `json:"address,omitempty"`
	// Custom Fields for the Delivery.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (DeliveryDraft) MarshalJSON ¶ added in v1.2.0 

func (obj DeliveryDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DeliveryFormat ¶ 

type DeliveryFormat interface{}

type DeliveryItem ¶ 

type DeliveryItem struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) or [CustomLineItem](ctp:api:type:CustomLineItem) delivered.
	ID string `json:"id"`
	// Number of Line Items or Custom Line Items delivered.
	Quantity int `json:"quantity"`
}

type DeliveryItemsUpdatedMessage ¶ 

type DeliveryItemsUpdatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// [Delivery Items](ctp:api:type:DeliveryItem) after the [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) update action.
	Items []DeliveryItem `json:"items"`
	// [Delivery Items](ctp:api:type:DeliveryItem) before the [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) update action.
	OldItems []DeliveryItem `json:"oldItems"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) update action. *

func (DeliveryItemsUpdatedMessage) MarshalJSON ¶ 

func (obj DeliveryItemsUpdatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DeliveryItemsUpdatedMessage) UnmarshalJSON ¶ 

func (obj *DeliveryItemsUpdatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DeliveryItemsUpdatedMessagePayload ¶ 

type DeliveryItemsUpdatedMessagePayload struct {
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// [Delivery Items](ctp:api:type:DeliveryItem) after the [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) update action.
	Items []DeliveryItem `json:"items"`
	// [Delivery Items](ctp:api:type:DeliveryItem) before the [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) update action.
	OldItems []DeliveryItem `json:"oldItems"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) update action. *

func (DeliveryItemsUpdatedMessagePayload) MarshalJSON ¶ 

func (obj DeliveryItemsUpdatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DeliveryPayload ¶ 

type DeliveryPayload interface{}

* * All payloads for the PlatformFormat(ctp:api:type:PlatformFormat) share these common fields. *

type DeliveryRemovedMessage ¶ 

type DeliveryRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Delivery](ctp:api:type:Delivery) that was removed from the [Order](ctp:api:type:Order).
	Delivery Delivery `json:"delivery"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Remove Delivery](ctp:api:type:OrderRemoveDeliveryAction) update action. *

func (DeliveryRemovedMessage) MarshalJSON ¶ 

func (obj DeliveryRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DeliveryRemovedMessage) UnmarshalJSON ¶ 

func (obj *DeliveryRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DeliveryRemovedMessagePayload ¶ 

type DeliveryRemovedMessagePayload struct {
	// The [Delivery](ctp:api:type:Delivery) that was removed from the [Order](ctp:api:type:Order).
	Delivery Delivery `json:"delivery"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Remove Delivery](ctp:api:type:OrderRemoveDeliveryAction) update action. *

func (DeliveryRemovedMessagePayload) MarshalJSON ¶ 

func (obj DeliveryRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Destination ¶ 

type Destination interface{}

type DirectDiscount ¶ added in v1.2.0 

type DirectDiscount struct {
	// Unique identifier of the Direct Discount.
	ID string `json:"id"`
	// Effect of the Discount on the Cart.
	Value CartDiscountValue `json:"value"`
	// Segment of the Cart that is discounted.
	//
	// Empty when the `value` is set to `giftLineItem`.
	Target CartDiscountTarget `json:"target,omitempty"`
}

* * Represents a CartDiscount(ctp:api:type:CartDiscount) that is only associated with a single Cart or Order. *

func (*DirectDiscount) UnmarshalJSON ¶ added in v1.2.0 

func (obj *DirectDiscount) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DirectDiscountDraft ¶ added in v1.2.0 

type DirectDiscountDraft struct {
	// Defines the effect the Discount will have.
	Value CartDiscountValue `json:"value"`
	// Defines what segment of the Cart will be discounted.
	//
	// If `value` is set to `giftLineItem`, this must not be set.
	Target CartDiscountTarget `json:"target,omitempty"`
}

* * Represents a CartDiscount(ctp:api:type:CartDiscount) that can only be associated with a single Cart or Order. * * Direct Discounts are always active and valid, and have the default `Stacking` StackingMode(ctp:api:type:StackingMode). * They apply in the order in which they are listed in the `directDiscounts` array of [Carts](ctp:api:type:Cart) or [Orders](ctp:api:type:Order), and do not have a sorting order like Cart Discounts. * * If a Direct Discount is present, any matching Cart Discounts in the Project are ignored. * Additionally, a Cart or Order supports either Discount Codes or Direct Discounts at the same time. *

func (*DirectDiscountDraft) UnmarshalJSON ¶ added in v1.2.0 

func (obj *DirectDiscountDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DirectDiscountReference ¶ added in v1.3.0 

type DirectDiscountReference struct {
	// Unique identifier of the referenced [DirectDiscount](ctp:api:type:DirectDiscount).
	ID string `json:"id"`
}

* * Reference(ctp:api:type:Reference) to a DirectDiscount(ctp:api:type:DirectDiscount). *

func (DirectDiscountReference) MarshalJSON ¶ added in v1.3.0 

func (obj DirectDiscountReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCode ¶ 

type DiscountCode struct {
	// Unique identifier of the DiscountCode.
	ID string `json:"id"`
	// Current version of the DiscountCode.
	Version int `json:"version"`
	// Date and time (UTC) the DiscountCode was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the DiscountCode was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-defined unique identifier of the DiscountCode.
	Key *string `json:"key,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Name of the DiscountCode.
	Name *LocalizedString `json:"name,omitempty"`
	// Description of the DiscountCode.
	Description *LocalizedString `json:"description,omitempty"`
	// User-defined unique identifier of the DiscountCode [added to the Cart](/../api/projects/carts#add-discountcode) to apply the related [CartDiscounts](ctp:api:type:CartDiscount).
	Code string `json:"code"`
	// Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
	CartDiscounts []CartDiscountReference `json:"cartDiscounts"`
	// DiscountCode can only be applied to Carts that match this predicate.
	CartPredicate *string `json:"cartPredicate,omitempty"`
	// Indicates if the DiscountCode is active and can be applied to the Cart.
	IsActive bool `json:"isActive"`
	// Array generated from the Cart predicate.
	// It contains the references of all the resources that are addressed in the predicate.
	References []Reference `json:"references"`
	// Number of times the DiscountCode can be applied.
	// DiscountCode application is counted at the time of Order creation or edit. However, Order cancellation or deletion does not decrement the count.
	MaxApplications *int `json:"maxApplications,omitempty"`
	// Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported).
	// DiscountCode application is counted at the time of Order creation or edit. However, Order cancellation or deletion does not decrement the count.
	MaxApplicationsPerCustomer *int `json:"maxApplicationsPerCustomer,omitempty"`
	// Custom Fields of the DiscountCode.
	Custom *CustomFields `json:"custom,omitempty"`
	// Groups to which the DiscountCode belongs to.
	Groups []string `json:"groups"`
	// Date and time (UTC) from which the DiscountCode is effective.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the DiscountCode is effective.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Used and managed by the API and must not be used in customer logic.
	// The value can change at any time due to internal and external factors.
	ApplicationVersion *int `json:"applicationVersion,omitempty"`
}

func (*DiscountCode) UnmarshalJSON ¶ 

func (obj *DiscountCode) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountCodeChangeCartDiscountsAction ¶ 

type DiscountCodeChangeCartDiscountsAction struct {
	// New value to set.
	CartDiscounts []CartDiscountResourceIdentifier `json:"cartDiscounts"`
}

func (DiscountCodeChangeCartDiscountsAction) MarshalJSON ¶ 

func (obj DiscountCodeChangeCartDiscountsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeChangeGroupsAction ¶ 

type DiscountCodeChangeGroupsAction struct {
	// New value to set. An empty array removes the DiscountCode from all groups.
	Groups []string `json:"groups"`
}

func (DiscountCodeChangeGroupsAction) MarshalJSON ¶ 

func (obj DiscountCodeChangeGroupsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeChangeIsActiveAction ¶ 

type DiscountCodeChangeIsActiveAction struct {
	// New value to set. Set to `true` to activate the DiscountCode for all matching Discounts.
	IsActive bool `json:"isActive"`
}

func (DiscountCodeChangeIsActiveAction) MarshalJSON ¶ 

func (obj DiscountCodeChangeIsActiveAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeCreatedMessage ¶ added in v1.5.0 

type DiscountCodeCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Discount Code](ctp:api:type:DiscountCode) that was created.
	DiscountCode DiscountCode `json:"discountCode"`
}

* * Generated after a successful [Create DiscountCode](ctp:api:endpoint:/{projectKey}/discount-codes:POST) request. *

func (DiscountCodeCreatedMessage) MarshalJSON ¶ added in v1.5.0 

func (obj DiscountCodeCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DiscountCodeCreatedMessage) UnmarshalJSON ¶ added in v1.5.0 

func (obj *DiscountCodeCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountCodeCreatedMessagePayload ¶ added in v1.5.0 

type DiscountCodeCreatedMessagePayload struct {
	// The [Discount Code](ctp:api:type:DiscountCode) that was created.
	DiscountCode DiscountCode `json:"discountCode"`
}

* * Generated after a successful [Create DiscountCode](ctp:api:endpoint:/{projectKey}/discount-codes:POST) request. *

func (DiscountCodeCreatedMessagePayload) MarshalJSON ¶ added in v1.5.0 

func (obj DiscountCodeCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeDeletedMessage ¶ added in v1.5.0 

type DiscountCodeDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete DiscountCode](ctp:api:endpoint:/{projectKey}/discount-codes/{id}:DELETE) request. *

func (DiscountCodeDeletedMessage) MarshalJSON ¶ added in v1.5.0 

func (obj DiscountCodeDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DiscountCodeDeletedMessage) UnmarshalJSON ¶ added in v1.5.0 

func (obj *DiscountCodeDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountCodeDeletedMessagePayload ¶ added in v1.5.0 

type DiscountCodeDeletedMessagePayload struct {
}

* * Generated after a successful [Delete DiscountCode](ctp:api:endpoint:/{projectKey}/discount-codes/{id}:DELETE) request. *

func (DiscountCodeDeletedMessagePayload) MarshalJSON ¶ added in v1.5.0 

func (obj DiscountCodeDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeDraft ¶ 

type DiscountCodeDraft struct {
	// User-defined unique identifier for the DiscountCode.
	Key *string `json:"key,omitempty"`
	// Name of the DiscountCode.
	Name *LocalizedString `json:"name,omitempty"`
	// Description of the DiscountCode.
	Description *LocalizedString `json:"description,omitempty"`
	// User-defined unique identifier for the DiscountCode that can be [added to the Cart](/../api/projects/carts#add-discountcode) to apply the related [CartDiscounts](ctp:api:type:CartDiscount).
	// It cannot be modified after the DiscountCode is created.
	Code string `json:"code"`
	// Specify what CartDiscounts the API applies when you add the DiscountCode to the Cart.
	CartDiscounts []CartDiscountResourceIdentifier `json:"cartDiscounts"`
	// DiscountCode can only be applied to Carts that match this predicate.
	CartPredicate *string `json:"cartPredicate,omitempty"`
	// Only active DiscountCodes can be applied to the Cart.
	IsActive *bool `json:"isActive,omitempty"`
	// Number of times the DiscountCode can be applied.
	MaxApplications *int `json:"maxApplications,omitempty"`
	// Number of times the DiscountCode can be applied per Customer.
	MaxApplicationsPerCustomer *int `json:"maxApplicationsPerCustomer,omitempty"`
	// Custom Fields for the DiscountCode.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Groups to which the DiscountCode will belong to.
	Groups []string `json:"groups"`
	// Date and time (UTC) from which the DiscountCode is effective. Must be earlier than `validUntil`.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the DiscountCode is effective. Must be later than `validFrom`.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

func (DiscountCodeDraft) MarshalJSON ¶ 

func (obj DiscountCodeDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeInfo ¶ 

type DiscountCodeInfo struct {
	// Discount Code associated with the Cart or Order.
	DiscountCode DiscountCodeReference `json:"discountCode"`
	// Indicates the state of the Discount Code applied to the Cart or Order.
	State DiscountCodeState `json:"state"`
}

type DiscountCodeKeySetMessage ¶ added in v1.5.0 

type DiscountCodeKeySetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// `key` value of the [Discount Code](ctp:api:type:DiscountCode) after the [Set Key](ctp:api:type:DiscountCodeSetKeyAction) update action.
	Key *string `json:"key,omitempty"`
	// `key` value of the [Discount Code](ctp:api:type:DiscountCode) before the [Set Key](ctp:api:type:DiscountCodeSetKeyAction) update action.
	OldKey *string `json:"oldKey,omitempty"`
}

* * Generated after a successful [Set Key](ctp:api:type:DiscountCodeSetKeyAction) update action. *

func (DiscountCodeKeySetMessage) MarshalJSON ¶ added in v1.5.0 

func (obj DiscountCodeKeySetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DiscountCodeKeySetMessage) UnmarshalJSON ¶ added in v1.5.0 

func (obj *DiscountCodeKeySetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountCodeKeySetMessagePayload ¶ added in v1.5.0 

type DiscountCodeKeySetMessagePayload struct {
	// `key` value of the [Discount Code](ctp:api:type:DiscountCode) after the [Set Key](ctp:api:type:DiscountCodeSetKeyAction) update action.
	Key *string `json:"key,omitempty"`
	// `key` value of the [Discount Code](ctp:api:type:DiscountCode) before the [Set Key](ctp:api:type:DiscountCodeSetKeyAction) update action.
	OldKey *string `json:"oldKey,omitempty"`
}

* * Generated after a successful [Set Key](ctp:api:type:DiscountCodeSetKeyAction) update action. *

func (DiscountCodeKeySetMessagePayload) MarshalJSON ¶ added in v1.5.0 

func (obj DiscountCodeKeySetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeNonApplicableError ¶ 

type DiscountCodeNonApplicableError struct {
	// `"The discountCode $discountCodeId cannot be applied to the cart."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Discount Code passed to the Cart.
	DiscountCode *string `json:"discountCode,omitempty"`
	// `"DoesNotExist"` or `"TimeRangeNonApplicable"`
	Reason *string `json:"reason,omitempty"`
	// Unique identifier of the Discount Code.
	DiscountCodeId *string `json:"discountCodeId,omitempty"`
	// Date and time (UTC) from which the Discount Code is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Discount Code is valid.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Date and time (UTC) the Discount Code validity check was last performed.
	ValidityCheckTime *time.Time `json:"validityCheckTime,omitempty"`
}

* * Returned when the Cart contains a Discount Code with a DiscountCodeState(ctp:api:type:DiscountCodeState) other than `MatchesCart`. * * The error is returned as a failed response to: * * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. *

func (*DiscountCodeNonApplicableError) DecodeStruct ¶ added in v1.1.0 

func (obj *DiscountCodeNonApplicableError) DecodeStruct(src map[string]interface{}) error

func (DiscountCodeNonApplicableError) Error ¶ 

func (obj DiscountCodeNonApplicableError) Error() string

func (DiscountCodeNonApplicableError) MarshalJSON ¶ 

func (obj DiscountCodeNonApplicableError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DiscountCodeNonApplicableError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *DiscountCodeNonApplicableError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountCodePagedQueryResponse ¶ 

type DiscountCodePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [DiscountCodes](ctp:api:type:DiscountCode) matching the query.
	Results []DiscountCode `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of DiscountCode(ctp:api:type:DiscountCode). *

type DiscountCodeReference ¶ 

type DiscountCodeReference struct {
	// Unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode).
	ID string `json:"id"`
	// Contains the representation of the expanded DiscountCode. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for DiscountCodes.
	Obj *DiscountCode `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a DiscountCode(ctp:api:type:DiscountCode). *

func (DiscountCodeReference) MarshalJSON ¶ 

func (obj DiscountCodeReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeResourceIdentifier ¶ 

type DiscountCodeResourceIdentifier struct {
	// Unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a DiscountCode(ctp:api:type:DiscountCode). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (DiscountCodeResourceIdentifier) MarshalJSON ¶ 

func (obj DiscountCodeResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetCartPredicateAction ¶ 

type DiscountCodeSetCartPredicateAction struct {
	// Value to set. If empty, any existing value will be removed.
	CartPredicate *string `json:"cartPredicate,omitempty"`
}

func (DiscountCodeSetCartPredicateAction) MarshalJSON ¶ 

func (obj DiscountCodeSetCartPredicateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetCustomFieldAction ¶ 

type DiscountCodeSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (DiscountCodeSetCustomFieldAction) MarshalJSON ¶ 

func (obj DiscountCodeSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetCustomTypeAction ¶ 

type DiscountCodeSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the DiscountCode with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the DiscountCode.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the DiscountCode.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (DiscountCodeSetCustomTypeAction) MarshalJSON ¶ 

func (obj DiscountCodeSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetDescriptionAction ¶ 

type DiscountCodeSetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (DiscountCodeSetDescriptionAction) MarshalJSON ¶ 

func (obj DiscountCodeSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetKeyAction ¶ added in v1.5.0 

type DiscountCodeSetKeyAction struct {
	// Unique value to set.
	// If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

* * This action generates a [DiscountCodeKeySet](ctp:api:type:DiscountCodeKeySetMessage) Message. *

func (DiscountCodeSetKeyAction) MarshalJSON ¶ added in v1.5.0 

func (obj DiscountCodeSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetMaxApplicationsAction ¶ 

type DiscountCodeSetMaxApplicationsAction struct {
	// Value to set. If empty, any existing value will be removed.
	MaxApplications *int `json:"maxApplications,omitempty"`
}

func (DiscountCodeSetMaxApplicationsAction) MarshalJSON ¶ 

func (obj DiscountCodeSetMaxApplicationsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetMaxApplicationsPerCustomerAction ¶ 

type DiscountCodeSetMaxApplicationsPerCustomerAction struct {
	// Value to set. If empty, any existing value will be removed.
	MaxApplicationsPerCustomer *int `json:"maxApplicationsPerCustomer,omitempty"`
}

func (DiscountCodeSetMaxApplicationsPerCustomerAction) MarshalJSON ¶ 

func (obj DiscountCodeSetMaxApplicationsPerCustomerAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetNameAction ¶ 

type DiscountCodeSetNameAction struct {
	// Value to set. If empty, any existing value will be removed.
	Name *LocalizedString `json:"name,omitempty"`
}

func (DiscountCodeSetNameAction) MarshalJSON ¶ 

func (obj DiscountCodeSetNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetValidFromAction ¶ 

type DiscountCodeSetValidFromAction struct {
	// Value to set that must be earlier than `validUntil`. If empty, any existing value will be removed.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
}

func (DiscountCodeSetValidFromAction) MarshalJSON ¶ 

func (obj DiscountCodeSetValidFromAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetValidFromAndUntilAction ¶ 

type DiscountCodeSetValidFromAndUntilAction struct {
	// Value to set that must be earlier than `validUntil`. If empty, any existing value will be removed.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Value to set that must be later than `validFrom`. If empty, any existing value will be removed.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

func (DiscountCodeSetValidFromAndUntilAction) MarshalJSON ¶ 

func (obj DiscountCodeSetValidFromAndUntilAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeSetValidUntilAction ¶ 

type DiscountCodeSetValidUntilAction struct {
	// Value to set that must be later than `validFrom`. If empty, any existing value will be removed.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

func (DiscountCodeSetValidUntilAction) MarshalJSON ¶ 

func (obj DiscountCodeSetValidUntilAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DiscountCodeState ¶ 

type DiscountCodeState string

* * Indicates the state of a Discount Code in a Cart. * * If an Order is created from a Cart with a state other than `MatchesCart`, a [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) error is returned. * 

const (
	DiscountCodeStateNotActive                            DiscountCodeState = "NotActive"
	DiscountCodeStateNotValid                             DiscountCodeState = "NotValid"
	DiscountCodeStateDoesNotMatchCart                     DiscountCodeState = "DoesNotMatchCart"
	DiscountCodeStateMatchesCart                          DiscountCodeState = "MatchesCart"
	DiscountCodeStateMaxApplicationReached                DiscountCodeState = "MaxApplicationReached"
	DiscountCodeStateApplicationStoppedByPreviousDiscount DiscountCodeState = "ApplicationStoppedByPreviousDiscount"
)

type DiscountCodeUpdate ¶ 

type DiscountCodeUpdate struct {
	// Expected version of the DiscountCode on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the DiscountCode.
	Actions []DiscountCodeUpdateAction `json:"actions"`
}

func (*DiscountCodeUpdate) UnmarshalJSON ¶ 

func (obj *DiscountCodeUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountCodeUpdateAction ¶ 

type DiscountCodeUpdateAction interface{}

type DiscountOnTotalPrice ¶ added in v1.4.0 

type DiscountOnTotalPrice struct {
	// Money value of the discount on the total price of the Cart or Order.
	DiscountedAmount TypedMoney `json:"discountedAmount"`
	// Discounts that impact the total price of the Cart or Order.
	IncludedDiscounts []DiscountedTotalPricePortion `json:"includedDiscounts"`
	// Money value of the discount on the total net price of the Cart or Order.
	// Present only when `taxedPrice` of the Cart or Order exists.
	DiscountedNetAmount TypedMoney `json:"discountedNetAmount,omitempty"`
	// Money value of the discount on the total gross price of the Cart or Order.
	// Present only when `taxedPrice` of the Cart or Order exists.
	DiscountedGrossAmount TypedMoney `json:"discountedGrossAmount,omitempty"`
}

func (*DiscountOnTotalPrice) UnmarshalJSON ¶ added in v1.4.0 

func (obj *DiscountOnTotalPrice) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountedLineItemPortion ¶ 

type DiscountedLineItemPortion struct {
	// A [CartDiscountReference](ctp:api:type:CartDiscountReference) or [DirectDiscountReference](ctp:api:type:DirectDiscountReference) of the applicable discount on the Line Item.
	Discount Reference `json:"discount"`
	// Money value of the applicable discount.
	DiscountedAmount TypedMoney `json:"discountedAmount"`
}

func (*DiscountedLineItemPortion) UnmarshalJSON ¶ 

func (obj *DiscountedLineItemPortion) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountedLineItemPortionDraft ¶ added in v1.5.0 

type DiscountedLineItemPortionDraft struct {
	// A [CartDiscountReference](ctp:api:type:CartDiscountReference) or [DirectDiscountReference](ctp:api:type:DirectDiscountReference) for the discount applicable on the Line Item.
	Discount Reference `json:"discount"`
	// Money value for the discount applicable.
	DiscountedAmount TypedMoneyDraft `json:"discountedAmount"`
}

func (*DiscountedLineItemPortionDraft) UnmarshalJSON ¶ added in v1.5.0 

func (obj *DiscountedLineItemPortionDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountedLineItemPrice ¶ 

type DiscountedLineItemPrice struct {
	// Money value of the discounted Line Item or Custom Line Item.
	Value TypedMoney `json:"value"`
	// Discount applicable on the Line Item or Custom Line Item.
	IncludedDiscounts []DiscountedLineItemPortion `json:"includedDiscounts"`
}

func (*DiscountedLineItemPrice) UnmarshalJSON ¶ 

func (obj *DiscountedLineItemPrice) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountedLineItemPriceDraft ¶ 

type DiscountedLineItemPriceDraft struct {
	// Discounted money value.
	Value Money `json:"value"`
	// Discounts to be applied.
	IncludedDiscounts []DiscountedLineItemPortionDraft `json:"includedDiscounts"`
}

type DiscountedLineItemPriceForQuantity ¶ 

type DiscountedLineItemPriceForQuantity struct {
	// Number of Line Items or Custom Line Items in the Cart.
	Quantity int `json:"quantity"`
	// Discounted price of the Line Item or Custom Line Item.
	DiscountedPrice DiscountedLineItemPrice `json:"discountedPrice"`
}

type DiscountedPrice ¶ 

type DiscountedPrice struct {
	// Money value of the discounted price.
	Value TypedMoney `json:"value"`
	// [ProductDiscount](ctp:api:type:ProductDiscount) related to the discounted price.
	Discount ProductDiscountReference `json:"discount"`
}

func (*DiscountedPrice) UnmarshalJSON ¶ 

func (obj *DiscountedPrice) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DiscountedPriceDraft ¶ 

type DiscountedPriceDraft struct {
	// Sets the money value for the discounted price.
	Value Money `json:"value"`
	// Relates the referenced [ProductDiscount](ctp:api:type:ProductDiscount) to the discounted price.
	Discount ProductDiscountReference `json:"discount"`
}

type DiscountedTotalPricePortion ¶ added in v1.4.0 

type DiscountedTotalPricePortion struct {
	// Cart Discount related to the discounted price.
	Discount CartDiscountReference `json:"discount"`
	// Money value of the discount.
	DiscountedAmount TypedMoney `json:"discountedAmount"`
}

func (*DiscountedTotalPricePortion) UnmarshalJSON ¶ added in v1.4.0 

func (obj *DiscountedTotalPricePortion) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type Division ¶ added in v1.2.0 

type Division struct {
	// Unique identifier of the Business Unit.
	ID string `json:"id"`
	// Current version of the Business Unit.
	Version int `json:"version"`
	// Date and time (UTC) the Business Unit was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Business Unit was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the Business Unit.
	Key string `json:"key"`
	// Indicates whether the Business Unit can be edited and used in [Orders](/../api/projects/orders).
	Status BusinessUnitStatus `json:"status"`
	// References to [Stores](ctp:api:type:Store) the Business Unit is associated with. Only present when `storeMode` is `Explicit`.
	//
	// If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores.
	//
	// If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store.
	Stores []StoreKeyReference `json:"stores"`
	// Defines whether the Stores of the Division are set explicitly or inherited from a parent Business Unit.
	StoreMode BusinessUnitStoreMode `json:"storeMode"`
	// Name of the Business Unit.
	Name string `json:"name"`
	// Email address of the Business Unit.
	ContactEmail *string `json:"contactEmail,omitempty"`
	// Custom Fields for the Business Unit.
	Custom *CustomFields `json:"custom,omitempty"`
	// Addresses used by the Business Unit.
	Addresses []Address `json:"addresses"`
	// Unique identifiers of addresses used as shipping addresses.
	ShippingAddressIds []string `json:"shippingAddressIds"`
	// Unique identifier of the address used as the default shipping address.
	DefaultShippingAddressId *string `json:"defaultShippingAddressId,omitempty"`
	// Unique identifiers of addresses used as billing addresses.
	BillingAddressIds []string `json:"billingAddressIds"`
	// Unique identifier of the address used as the default billing address.
	DefaultBillingAddressId *string `json:"defaultBillingAddressId,omitempty"`
	// Determines whether the Division can inherit Associates from a parent.
	AssociateMode BusinessUnitAssociateMode `json:"associateMode"`
	// Associates that are part of the Business Unit in specific [roles](ctp:api:type:AssociateRole).
	Associates []Associate `json:"associates"`
	// Associates that are inherited from a parent Business Unit. The value of this field is [eventually consistent](/../api/general-concepts#eventual-consistency) and is only present when the `associateMode` is set to `ExplicitAndFromParent`.
	InheritedAssociates []InheritedAssociate `json:"inheritedAssociates"`
	// Parent unit of the Division.
	ParentUnit BusinessUnitKeyReference `json:"parentUnit"`
	// Top-level unit of the Business Unit. The top-level unit is of `unitType` `Company`.
	TopLevelUnit BusinessUnitKeyReference `json:"topLevelUnit"`
}

* * Business Unit type to model divisions that are part of the Company(ctp:api:type:Company) or a higher-order Division. * Contains specific fields and values that differentiate a Division from the generic BusinessUnit(ctp:api:type:BusinessUnit). *

func (Division) MarshalJSON ¶ added in v1.2.0 

func (obj Division) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DivisionDraft ¶ added in v1.2.0 

type DivisionDraft struct {
	// User-defined unique identifier for the Business Unit.
	Key string `json:"key"`
	// Indicates whether the Business Unit can be edited and used in [Orders](/../api/projects/orders).
	Status *BusinessUnitStatus `json:"status,omitempty"`
	// Sets the [Stores](ctp:api:type:Store) the Business Unit is associated with. Can only be set when `storeMode` is `Explicit`.
	// Defaults to empty for [Companies](ctp:api:type:BusinessUnitType) and not set for [Divisions](ctp:api:type:BusinessUnitType).
	//
	// If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores.
	//
	// If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store.
	Stores []StoreResourceIdentifier `json:"stores"`
	// If not set, the Division inherits the [Stores](ctp:api:type:Store) from a parent unit.
	// Set this to `Explicit` if you want to set the Stores explicitly in the `stores` field instead.
	StoreMode *BusinessUnitStoreMode `json:"storeMode,omitempty"`
	// Name of the Business Unit.
	Name string `json:"name"`
	// Email address of the Business Unit.
	ContactEmail *string `json:"contactEmail,omitempty"`
	// Determines whether the Division can inherit Associates from a parent.
	AssociateMode *BusinessUnitAssociateMode `json:"associateMode,omitempty"`
	// List of members that are part of the Business Unit in specific [roles](ctp:api:type:AssociateRole).
	Associates []AssociateDraft `json:"associates"`
	// Addresses used by the Business Unit.
	Addresses []BaseAddress `json:"addresses"`
	// Indexes of entries in `addresses` to set as shipping addresses.
	// The `shippingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
	ShippingAddresses []int `json:"shippingAddresses"`
	// Index of the entry in `addresses` to set as the default shipping address.
	DefaultShippingAddress *int `json:"defaultShippingAddress,omitempty"`
	// Indexes of entries in `addresses` to set as billing addresses.
	// The `billingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
	BillingAddresses []int `json:"billingAddresses"`
	// Index of the entry in `addresses` to set as the default billing address.
	DefaultBillingAddress *int `json:"defaultBillingAddress,omitempty"`
	// Custom Fields for the Business Unit.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// The parent unit of this Division. Can be a Company or a Division.
	ParentUnit BusinessUnitResourceIdentifier `json:"parentUnit"`
}

* * Draft type to model divisions that are part of a Company(ctp:api:type:Company) or a higher-order Division(ctp:api:type:Division). * Contains the fields and values of the generic BusinessUnitDraft(ctp:api:type:BusinessUnitDraft) that are used specifically for creating a Division. *

func (DivisionDraft) MarshalJSON ¶ added in v1.2.0 

func (obj DivisionDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type DuplicateAttributeValueError ¶ 

type DuplicateAttributeValueError struct {
	// `"Attribute can't have the same value in a different variant."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting Attributes.
	Attribute Attribute `json:"attribute"`
}

* * Returned when the `Unique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request. *

func (*DuplicateAttributeValueError) DecodeStruct ¶ added in v1.1.0 

func (obj *DuplicateAttributeValueError) DecodeStruct(src map[string]interface{}) error

func (DuplicateAttributeValueError) Error ¶ 

func (obj DuplicateAttributeValueError) Error() string

func (DuplicateAttributeValueError) MarshalJSON ¶ 

func (obj DuplicateAttributeValueError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DuplicateAttributeValueError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *DuplicateAttributeValueError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DuplicateAttributeValuesError ¶ 

type DuplicateAttributeValuesError struct {
	// `"The set of attributes must be unique across all variants."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting Attributes.
	Attributes []Attribute `json:"attributes"`
}

* * Returned when the `CombinationUnique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request. *

func (*DuplicateAttributeValuesError) DecodeStruct ¶ added in v1.1.0 

func (obj *DuplicateAttributeValuesError) DecodeStruct(src map[string]interface{}) error

func (DuplicateAttributeValuesError) Error ¶ 

func (obj DuplicateAttributeValuesError) Error() string

func (DuplicateAttributeValuesError) MarshalJSON ¶ 

func (obj DuplicateAttributeValuesError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DuplicateAttributeValuesError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *DuplicateAttributeValuesError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DuplicateEnumValuesError ¶ 

type DuplicateEnumValuesError struct {
	// `"The enum values contain duplicate keys: $listOfDuplicateKeys."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Duplicate keys.
	Duplicates []string `json:"duplicates"`
}

* * Returned when an AttributeEnumType(ctp:api:type:AttributeEnumType) or AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) contains duplicate keys. *

func (*DuplicateEnumValuesError) DecodeStruct ¶ added in v1.1.0 

func (obj *DuplicateEnumValuesError) DecodeStruct(src map[string]interface{}) error

func (DuplicateEnumValuesError) Error ¶ 

func (obj DuplicateEnumValuesError) Error() string

func (DuplicateEnumValuesError) MarshalJSON ¶ 

func (obj DuplicateEnumValuesError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DuplicateEnumValuesError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *DuplicateEnumValuesError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

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 ¶ added in v1.1.0 

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 DuplicateFieldWithConflictingResourceError ¶ 

type DuplicateFieldWithConflictingResourceError struct {
	// `"A duplicate value $duplicateValue exists for field $field on $conflictingResource."`
	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"`
	// Reference to the resource that has the conflicting value.
	ConflictingResource Reference `json:"conflictingResource"`
}

* * Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate. *

func (*DuplicateFieldWithConflictingResourceError) DecodeStruct ¶ added in v1.1.0 

func (obj *DuplicateFieldWithConflictingResourceError) DecodeStruct(src map[string]interface{}) error

func (DuplicateFieldWithConflictingResourceError) Error ¶ 

func (obj DuplicateFieldWithConflictingResourceError) Error() string

func (DuplicateFieldWithConflictingResourceError) MarshalJSON ¶ 

func (obj DuplicateFieldWithConflictingResourceError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DuplicateFieldWithConflictingResourceError) UnmarshalJSON ¶ 

func (obj *DuplicateFieldWithConflictingResourceError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DuplicatePriceKeyError ¶ added in v1.3.0 

type DuplicatePriceKeyError struct {
	// `"Duplicate price key: $priceKey. The price key must be unique per variant."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting Embedded Price.
	ConflictingPrice Price `json:"conflictingPrice"`
}

* * Returned when a Price key conflicts with an existing key. * * Keys of Embedded Prices must be unique per ProductVariant. *

func (*DuplicatePriceKeyError) DecodeStruct ¶ added in v1.3.0 

func (obj *DuplicatePriceKeyError) DecodeStruct(src map[string]interface{}) error

func (DuplicatePriceKeyError) Error ¶ added in v1.3.0 

func (obj DuplicatePriceKeyError) Error() string

func (DuplicatePriceKeyError) MarshalJSON ¶ added in v1.3.0 

func (obj DuplicatePriceKeyError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DuplicatePriceKeyError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *DuplicatePriceKeyError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DuplicatePriceScopeError ¶ 

type DuplicatePriceScopeError struct {
	// `"Duplicate price scope: $priceScope. The combination of currency, country, customerGroup and channel must be unique for each price of a product variant."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting Embedded Price.
	ConflictingPrice Price `json:"conflictingPrice"`
}

* * Returned when a Price scope conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request. * * Every Price of a Product Variant must have a distinct combination of currency, Customer Group, country, and Channel that constitute the scope of a Price. *

func (*DuplicatePriceScopeError) DecodeStruct ¶ added in v1.1.0 

func (obj *DuplicatePriceScopeError) DecodeStruct(src map[string]interface{}) error

func (DuplicatePriceScopeError) Error ¶ 

func (obj DuplicatePriceScopeError) Error() string

func (DuplicatePriceScopeError) MarshalJSON ¶ 

func (obj DuplicatePriceScopeError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DuplicatePriceScopeError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *DuplicatePriceScopeError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DuplicateStandalonePriceScopeError ¶ 

type DuplicateStandalonePriceScopeError struct {
	// `"Duplicate standalone price scope for SKU: $sku. The combination of SKU, currency, country, customerGroup, channel, validFrom and validUntil must be unique for each standalone price."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Reference to the conflicting Standalone Price.
	ConflictingStandalonePrice StandalonePriceReference `json:"conflictingStandalonePrice"`
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the conflicting Standalone Price is associated.
	Sku string `json:"sku"`
	// Currency code of the country.
	Currency string `json:"currency"`
	// Country code of the geographic location.
	Country *string `json:"country,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) for which the Standalone Price is valid.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
	// [Channel](ctp:api:type:Channel) for which the Standalone Price is valid.
	Channel *ChannelResourceIdentifier `json:"channel,omitempty"`
	// Date and time (UTC) from which the Standalone Price is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Standalone Price is valid.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

* * Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price. * Every Standalone Price associated with the same SKU must have a distinct combination of currency, country, Customer Group, Channel, and validity periods (`validFrom` and `validUntil`). * * The error is returned as a failed response to the [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request. *

func (*DuplicateStandalonePriceScopeError) DecodeStruct ¶ added in v1.1.0 

func (obj *DuplicateStandalonePriceScopeError) DecodeStruct(src map[string]interface{}) error

func (DuplicateStandalonePriceScopeError) Error ¶ 

func (obj DuplicateStandalonePriceScopeError) Error() string

func (DuplicateStandalonePriceScopeError) MarshalJSON ¶ 

func (obj DuplicateStandalonePriceScopeError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DuplicateStandalonePriceScopeError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *DuplicateStandalonePriceScopeError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type DuplicateVariantValuesError ¶ 

type DuplicateVariantValuesError struct {
	// `"A duplicate combination of the variant values (sku, key, images, prices, attributes) exists."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Every Product Variant must have a distinct combination of SKU, prices, and custom Attribute values.
	VariantValues VariantValues `json:"variantValues"`
}

* * Returned when a [Product Variant](ctp:api:type:ProductVariant) value conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request. *

func (*DuplicateVariantValuesError) DecodeStruct ¶ added in v1.1.0 

func (obj *DuplicateVariantValuesError) DecodeStruct(src map[string]interface{}) error

func (DuplicateVariantValuesError) Error ¶ 

func (obj DuplicateVariantValuesError) Error() string

func (DuplicateVariantValuesError) MarshalJSON ¶ 

func (obj DuplicateVariantValuesError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*DuplicateVariantValuesError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *DuplicateVariantValuesError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type EditPreviewFailedError ¶ 

type EditPreviewFailedError struct {
	// `"Error while applying staged actions. ShippingMethods could not be determined."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// State of the OrderEdit where the `stagedActions` cannot be applied to the Order.
	Result OrderEditPreviewFailure `json:"result"`
}

* * Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated. * * The error is returned as a failed response to the [Get Shipping Methods for an OrderEdit](ctp:api:endpoint:/{projectKey}/shipping-methods/matching-orderedit:GET) request. *

func (*EditPreviewFailedError) DecodeStruct ¶ added in v1.1.0 

func (obj *EditPreviewFailedError) DecodeStruct(src map[string]interface{}) error

func (EditPreviewFailedError) Error ¶ 

func (obj EditPreviewFailedError) Error() string

func (EditPreviewFailedError) MarshalJSON ¶ 

func (obj EditPreviewFailedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*EditPreviewFailedError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *EditPreviewFailedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type EnumKeyAlreadyExistsError ¶ 

type EnumKeyAlreadyExistsError struct {
	// `"The $attributeName attribute definition already contains an enum value with the key $enumKey."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting enum key.
	ConflictingEnumKey string `json:"conflictingEnumKey"`
	// Name of the conflicting Attribute.
	ConflictingAttributeName string `json:"conflictingAttributeName"`
}

* * Returned when an AttributeEnumType(ctp:api:type:AttributeEnumType) or AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) contains a key that already exists. *

func (*EnumKeyAlreadyExistsError) DecodeStruct ¶ added in v1.1.0 

func (obj *EnumKeyAlreadyExistsError) DecodeStruct(src map[string]interface{}) error

func (EnumKeyAlreadyExistsError) Error ¶ 

func (obj EnumKeyAlreadyExistsError) Error() string

func (EnumKeyAlreadyExistsError) MarshalJSON ¶ 

func (obj EnumKeyAlreadyExistsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*EnumKeyAlreadyExistsError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *EnumKeyAlreadyExistsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type EnumKeyDoesNotExistError ¶ 

type EnumKeyDoesNotExistError struct {
	// `"The $fieldName field definition does not contain an enum value with the key $enumKey."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting enum key.
	ConflictingEnumKey string `json:"conflictingEnumKey"`
	// Name of the conflicting Attribute.
	ConflictingAttributeName string `json:"conflictingAttributeName"`
}

* * Returned when an AttributeEnumType(ctp:api:type:AttributeEnumType) or AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) already contains a value with the given key. * * The error is returned as a failed response to the [Change the key of an EnumValue](ctp:api:type:ProductTypeChangeEnumKeyAction) update action. *

func (*EnumKeyDoesNotExistError) DecodeStruct ¶ added in v1.1.0 

func (obj *EnumKeyDoesNotExistError) DecodeStruct(src map[string]interface{}) error

func (EnumKeyDoesNotExistError) Error ¶ 

func (obj EnumKeyDoesNotExistError) Error() string

func (EnumKeyDoesNotExistError) MarshalJSON ¶ 

func (obj EnumKeyDoesNotExistError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*EnumKeyDoesNotExistError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *EnumKeyDoesNotExistError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type EnumValueIsUsedError ¶ 

type EnumValueIsUsedError struct {
	// `"$enumKeysTranscript is used by some products and cannot be deleted because the $attributeName attribute is required."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when an enum value cannot be removed from an Attribute as it is being used by a Product. * * The error is returned as a failed response to the [Remove EnumValues from AttributeDefinition](ctp:api:type:ProductTypeRemoveEnumValuesAction) update action. *

func (*EnumValueIsUsedError) DecodeStruct ¶ added in v1.1.0 

func (obj *EnumValueIsUsedError) DecodeStruct(src map[string]interface{}) error

func (EnumValueIsUsedError) Error ¶ 

func (obj EnumValueIsUsedError) Error() string

func (EnumValueIsUsedError) MarshalJSON ¶ 

func (obj EnumValueIsUsedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*EnumValueIsUsedError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *EnumValueIsUsedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type EnumValuesMustMatchError ¶ 

type EnumValuesMustMatchError struct {
	// `"The given values must be equal to the existing enum values."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when during an order update of AttributeEnumType(ctp:api:type:AttributeEnumType) or AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) the new enum values do not match the existing ones. * * The error is returned as a failed response to the [Change the order of EnumValues](ctp:api:type:ProductTypeChangePlainEnumValueOrderAction) and [Change the order of LocalizedEnumValues](ctp:api:type:ProductTypeChangeLocalizedEnumValueOrderAction) update actions. *

func (*EnumValuesMustMatchError) DecodeStruct ¶ added in v1.1.0 

func (obj *EnumValuesMustMatchError) DecodeStruct(src map[string]interface{}) error

func (EnumValuesMustMatchError) Error ¶ 

func (obj EnumValuesMustMatchError) Error() string

func (EnumValuesMustMatchError) MarshalJSON ¶ 

func (obj EnumValuesMustMatchError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*EnumValuesMustMatchError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *EnumValuesMustMatchError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ErrorByExtension ¶ 

type ErrorByExtension struct {
	// Unique identifier of the Extension.
	ID string `json:"id"`
	// User-defined unique identifier of the Extension.
	Key *string `json:"key,omitempty"`
}

type ErrorObject ¶ 

type ErrorObject interface{}

* * Represents a single error. Multiple errors may be included in an ErrorResponse(ctp:api: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 EventBridgeDestination ¶ 

type EventBridgeDestination struct {
	// AWS region that receives the events.
	Region string `json:"region"`
	// ID of the AWS account that receives the events.
	AccountId string `json:"accountId"`
}

* * [AWS EventBridge](https://aws.amazon.com/eventbridge/) can be used to push events and messages to a serverless event bus that can forward them to AWS SQS, SNS, Lambda, and other AWS services based on forwarding rules. * Once the Subscription is created, an equivalent "partner event source" is created in AWS EventBridge. This event source must be associated with an event bus for the Subscription setup to be complete. *

func (EventBridgeDestination) MarshalJSON ¶ 

func (obj EventBridgeDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Extension ¶ 

type Extension struct {
	// Unique identifier of the Extension.
	ID string `json:"id"`
	// Current version of the Extension.
	Version int `json:"version"`
	// Date and time (UTC) the Extension was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Extension was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the Extension.
	Key *string `json:"key,omitempty"`
	// The configuration for the Extension, including its type, location and authentication details.
	Destination ExtensionDestination `json:"destination"`
	// Describes what triggers the Extension.
	Triggers []ExtensionTrigger `json:"triggers"`
	// Maximum time (in milliseconds) that the Extension can respond within.
	// If no timeout is provided, the default value is used for all types of Extensions.
	// The maximum value is 10000 ms (10 seconds) for `payment` Extensions and 2000 ms (2 seconds) for all other Extensions.
	TimeoutInMs *int `json:"timeoutInMs,omitempty"`
}

func (*Extension) UnmarshalJSON ¶ 

func (obj *Extension) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExtensionAction ¶ 

type ExtensionAction string

* * An Extension gets called during any of the following requests of an API call, but before the result is persisted. * 

const (
	ExtensionActionCreate ExtensionAction = "Create"
	ExtensionActionUpdate ExtensionAction = "Update"
)

type ExtensionBadResponseError ¶ 

type ExtensionBadResponseError struct {
	// Description of the invalid Extension response. For example, `"The extension did not return the expected JSON."`.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// User-defined localized description of the error.
	LocalizedMessage *LocalizedString `json:"localizedMessage,omitempty"`
	// Any information that should be returned to the API caller.
	ExtensionExtraInfo *interface{} `json:"extensionExtraInfo,omitempty"`
	// Additional errors related to the API Extension.
	ExtensionErrors []ExtensionError `json:"extensionErrors"`
	// The response body returned by the Extension.
	ExtensionBody *string `json:"extensionBody,omitempty"`
	// Http status code returned by the Extension.
	ExtensionStatusCode *int `json:"extensionStatusCode,omitempty"`
	// Unique identifier of the Extension.
	ExtensionId string `json:"extensionId"`
	// User-defined unique identifier of the Extension.
	ExtensionKey *string `json:"extensionKey,omitempty"`
}

* * Returned when the response from the API Extension could not be parsed successfully (such as a `500` HTTP status code, or an invalid JSON response). *

func (*ExtensionBadResponseError) DecodeStruct ¶ added in v1.1.0 

func (obj *ExtensionBadResponseError) DecodeStruct(src map[string]interface{}) error

func (ExtensionBadResponseError) Error ¶ 

func (obj ExtensionBadResponseError) Error() string

func (ExtensionBadResponseError) MarshalJSON ¶ 

func (obj ExtensionBadResponseError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ExtensionBadResponseError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ExtensionBadResponseError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExtensionChangeDestinationAction ¶ 

type ExtensionChangeDestinationAction struct {
	// New value to set. Must not be empty.
	Destination ExtensionDestination `json:"destination"`
}

func (ExtensionChangeDestinationAction) MarshalJSON ¶ 

func (obj ExtensionChangeDestinationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ExtensionChangeDestinationAction) UnmarshalJSON ¶ 

func (obj *ExtensionChangeDestinationAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExtensionChangeTriggersAction ¶ 

type ExtensionChangeTriggersAction struct {
	// New value to set. Must not be empty.
	Triggers []ExtensionTrigger `json:"triggers"`
}

func (ExtensionChangeTriggersAction) MarshalJSON ¶ 

func (obj ExtensionChangeTriggersAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ExtensionDestination ¶ 

type ExtensionDestination interface{}

* * Generic type for destinations.

type ExtensionDraft ¶ 

type ExtensionDraft struct {
	// User-defined unique identifier for the Extension.
	Key *string `json:"key,omitempty"`
	// Defines where the Extension can be reached.
	Destination ExtensionDestination `json:"destination"`
	// Describes what triggers the Extension.
	Triggers []ExtensionTrigger `json:"triggers"`
	// Maximum time (in milliseconds) the Extension can respond within.
	// If no timeout is provided, the default value is used for all types of Extensions.
	// The maximum value is 10000 ms (10 seconds) for `payment` Extensions and 2000 ms (2 seconds) for all other Extensions.
	//
	// This limit can be increased per Project after we review the performance impact.
	// Please contact our support via the [Support Portal](https://support.commercetools.com) and provide the Region, Project key, and use case.
	TimeoutInMs *int `json:"timeoutInMs,omitempty"`
}

func (*ExtensionDraft) UnmarshalJSON ¶ 

func (obj *ExtensionDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExtensionError ¶ added in v1.2.0 

type ExtensionError struct {
	// Error code caused by the Extension. For example, `InvalidField`.
	Code string `json:"code"`
	// Plain text description of the error.
	Message string `json:"message"`
	// Unique identifier of the Extension.
	ExtensionId string `json:"extensionId"`
	// User-defined unique identifier of the Extension.
	ExtensionKey *string `json:"extensionKey,omitempty"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

func (ExtensionError) Error ¶ added in v1.2.0 

func (obj ExtensionError) Error() string

func (ExtensionError) MarshalJSON ¶ added in v1.2.0 

func (obj ExtensionError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ExtensionError) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ExtensionError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExtensionInput ¶ 

type ExtensionInput struct {
	// `Create` or `Update` request.
	Action ExtensionAction `json:"action"`
	// Expanded reference to the resource that triggered the Extension.
	Resource Reference `json:"resource"`
}

func (*ExtensionInput) UnmarshalJSON ¶ 

func (obj *ExtensionInput) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExtensionNoResponseError ¶ 

type ExtensionNoResponseError struct {
	// `"Extension did not respond in time."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of the API Extension.
	ExtensionId string `json:"extensionId"`
	// User-defined unique identifier of the API Extension, if available.
	ExtensionKey *string `json:"extensionKey,omitempty"`
}

* * Returned when the API Extension does not respond within the [time limit](/../api/projects/api-extensions#time-limits), or could not be reached. *

func (*ExtensionNoResponseError) DecodeStruct ¶ added in v1.1.0 

func (obj *ExtensionNoResponseError) DecodeStruct(src map[string]interface{}) error

func (ExtensionNoResponseError) Error ¶ 

func (obj ExtensionNoResponseError) Error() string

func (ExtensionNoResponseError) MarshalJSON ¶ 

func (obj ExtensionNoResponseError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ExtensionNoResponseError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ExtensionNoResponseError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExtensionPagedQueryResponse ¶ 

type ExtensionPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Extensions matching the query.
	Results []Extension `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of Extension(ctp:api:type:Extension). *

type ExtensionPredicateEvaluationFailedError ¶ added in v1.2.0 

type ExtensionPredicateEvaluationFailedError struct {
	// `"The compared field $fieldName is not present."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Details about the API Extension that was involved in the error.
	ErrorByExtension ErrorByExtension `json:"errorByExtension"`
}

* * Returned when the predicate defined in the ExtensionTrigger(ctp:api:type:ExtensionTrigger) could not be evaluated due to a missing field. *

func (*ExtensionPredicateEvaluationFailedError) DecodeStruct ¶ added in v1.2.0 

func (obj *ExtensionPredicateEvaluationFailedError) DecodeStruct(src map[string]interface{}) error

func (ExtensionPredicateEvaluationFailedError) Error ¶ added in v1.2.0 

func (obj ExtensionPredicateEvaluationFailedError) Error() string

func (ExtensionPredicateEvaluationFailedError) MarshalJSON ¶ added in v1.2.0 

func (obj ExtensionPredicateEvaluationFailedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ExtensionPredicateEvaluationFailedError) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ExtensionPredicateEvaluationFailedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExtensionResourceTypeId ¶ 

type ExtensionResourceTypeId string

* * Extensions are available for: * 

const (
	ExtensionResourceTypeIdCart         ExtensionResourceTypeId = "cart"
	ExtensionResourceTypeIdOrder        ExtensionResourceTypeId = "order"
	ExtensionResourceTypeIdPayment      ExtensionResourceTypeId = "payment"
	ExtensionResourceTypeIdCustomer     ExtensionResourceTypeId = "customer"
	ExtensionResourceTypeIdQuoteRequest ExtensionResourceTypeId = "quote-request"
	ExtensionResourceTypeIdStagedQuote  ExtensionResourceTypeId = "staged-quote"
	ExtensionResourceTypeIdQuote        ExtensionResourceTypeId = "quote"
	ExtensionResourceTypeIdBusinessUnit ExtensionResourceTypeId = "business-unit"
)

type ExtensionSetKeyAction ¶ 

type ExtensionSetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (ExtensionSetKeyAction) MarshalJSON ¶ 

func (obj ExtensionSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ExtensionSetTimeoutInMsAction ¶ 

type ExtensionSetTimeoutInMsAction struct {
	// Value to set. If not defined, the maximum value is used.
	// If no timeout is provided, the default value is used for all types of Extensions.
	// The maximum value is 10000 ms (10 seconds) for `payment` Extensions and 2000 ms (2 seconds) for all other Extensions.
	//
	// This limit can be increased per Project after we review the performance impact.
	// Please contact our support via the [Support Portal](https://support.commercetools.com/) and provide the Region, Project key, and use case.
	TimeoutInMs *int `json:"timeoutInMs,omitempty"`
}

func (ExtensionSetTimeoutInMsAction) MarshalJSON ¶ 

func (obj ExtensionSetTimeoutInMsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ExtensionTrigger ¶ 

type ExtensionTrigger struct {
	// `cart`, `order`, `payment`, `customer`, `quote-request`, `staged-quote`, `quote`, and `business-unit` are supported.
	ResourceTypeId ExtensionResourceTypeId `json:"resourceTypeId"`
	// `Create` and `Update` requests are supported.
	Actions []ExtensionAction `json:"actions"`
	// Valid [predicate](/../api/predicates/query) that controls the conditions under which the API Extension is called. The Extension is not triggered when the specified condition is not fulfilled.
	Condition *string `json:"condition,omitempty"`
}

type ExtensionUpdate ¶ 

type ExtensionUpdate struct {
	// Expected version of the Extension on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Extension.
	Actions []ExtensionUpdateAction `json:"actions"`
}

func (*ExtensionUpdate) UnmarshalJSON ¶ 

func (obj *ExtensionUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExtensionUpdateAction ¶ 

type ExtensionUpdateAction interface{}

type ExtensionUpdateActionsFailedError ¶ 

type ExtensionUpdateActionsFailedError struct {
	// `"The extension returned update actions that could not be executed."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// User-defined localized description of the error.
	LocalizedMessage *LocalizedString `json:"localizedMessage,omitempty"`
	// Any information that should be returned to the API caller.
	ExtensionExtraInfo *interface{} `json:"extensionExtraInfo,omitempty"`
	// Additional errors related to the API Extension.
	ExtensionErrors []ExtensionError `json:"extensionErrors"`
}

* * Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist). * This would result in a [400 Bad Request](#400-bad-request) response if the same update action was sent from a regular client. *

func (*ExtensionUpdateActionsFailedError) DecodeStruct ¶ added in v1.1.0 

func (obj *ExtensionUpdateActionsFailedError) DecodeStruct(src map[string]interface{}) error

func (ExtensionUpdateActionsFailedError) Error ¶ 

func (obj ExtensionUpdateActionsFailedError) Error() string

func (ExtensionUpdateActionsFailedError) MarshalJSON ¶ 

func (obj ExtensionUpdateActionsFailedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ExtensionUpdateActionsFailedError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ExtensionUpdateActionsFailedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExternalLineItemTotalPrice ¶ 

type ExternalLineItemTotalPrice struct {
	// Price of the Line Item.
	Price Money `json:"price"`
	// Total price of the Line Item.
	TotalPrice Money `json:"totalPrice"`
}

type ExternalOAuth ¶ 

type ExternalOAuth struct {
	// URL with authorization header. If the Project is hosted in the China (AWS, Ningxia) Region, verify that the URL is not blocked due to firewall restrictions.
	Url string `json:"url"`
	// Must not contain any leading or trailing whitespaces. Partially hidden on retrieval.
	AuthorizationHeader string `json:"authorizationHeader"`
}

* * Represents a RFC 7662 compliant [OAuth 2.0 Token Introspection](https://datatracker.ietf.org/doc/html/rfc7662) endpoint. For more information, see [Requesting an access token using an external OAuth 2.0 server](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server). * * You can only configure **one** external OAuth 2.0 endpoint per Project. To authenticate using multiple external services (such as social network logins), use a middle layer authentication service. *

type ExternalOAuthFailedError ¶ 

type ExternalOAuthFailedError struct {
	// Plain text description detailing the external OAuth error. For example, `"External OAuth did not respond in time."`.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when an [external OAuth Introspection endpoint](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`). *

func (*ExternalOAuthFailedError) DecodeStruct ¶ added in v1.1.0 

func (obj *ExternalOAuthFailedError) DecodeStruct(src map[string]interface{}) error

func (ExternalOAuthFailedError) Error ¶ 

func (obj ExternalOAuthFailedError) Error() string

func (ExternalOAuthFailedError) MarshalJSON ¶ 

func (obj ExternalOAuthFailedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ExternalOAuthFailedError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ExternalOAuthFailedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ExternalTaxAmountDraft ¶ 

type ExternalTaxAmountDraft struct {
	// Total gross amount (`totalNet` + `taxPortions`) of the Line Item or Custom Line Item.
	TotalGross Money `json:"totalGross"`
	// Tax Rates and subrates of states and countries.
	TaxRate ExternalTaxRateDraft `json:"taxRate"`
}

* * Cannot be used in LineItemDraft(ctp:api:type:LineItemDraft) or CustomLineItemDraft(ctp:api:type:CustomLineItemDraft). * * Can only be set by these update actions: * * - [Set LineItem TaxAmount](ctp:api:type:CartSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:CartSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:CartSetShippingMethodTaxAmountAction) on Carts * - [Set LineItem TaxAmount](ctp:api:type:StagedOrderSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:StagedOrderSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:StagedOrderSetShippingMethodTaxAmountAction) on Order Edits *

type ExternalTaxRateDraft ¶ 

type ExternalTaxRateDraft struct {
	// Name of the Tax Rate.
	Name string `json:"name"`
	// Percentage in the range of 0-1.
	//
	// - If no `subRates` are specified, a value must be defined.
	// - If `subRates` are specified, this can be omitted or its value must be the sum of all `subRates` amounts.
	Amount *float64 `json:"amount,omitempty"`
	// - If set to `false`, the related price is considered the net price and the provided `amount` is applied to calculate the gross price.
	// - If set to `true`, the related price is considered the gross price, and the provided `amount` is applied to calculate the net price.
	IncludedInPrice *bool `json:"includedInPrice,omitempty"`
	// Country for which the tax applies.
	Country string `json:"country"`
	// State within the specified country.
	State *string `json:"state,omitempty"`
	// For countries (such as the US) where the total tax is a combination of multiple taxes (such as state and local taxes). The total of all subrates must equal the TaxRate `amount`.
	SubRates []SubRate `json:"subRates"`
}

* * Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation). *

func (ExternalTaxRateDraft) MarshalJSON ¶ 

func (obj ExternalTaxRateDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type FacetRange ¶ 

type FacetRange struct {
	From         float64 `json:"from"`
	FromStr      string  `json:"fromStr"`
	To           float64 `json:"to"`
	ToStr        string  `json:"toStr"`
	Count        int     `json:"count"`
	ProductCount *int    `json:"productCount,omitempty"`
	Total        float64 `json:"total"`
	Min          float64 `json:"min"`
	Max          float64 `json:"max"`
	Mean         float64 `json:"mean"`
}

type FacetResult ¶ 

type FacetResult interface{}

type FacetResults ¶ 

type FacetResults map[string]FacetResult

type FacetTerm ¶ 

type FacetTerm struct {
	Term         interface{} `json:"term"`
	Count        int         `json:"count"`
	ProductCount *int        `json:"productCount,omitempty"`
}

type FacetTypes ¶ 

type FacetTypes string
const (
	FacetTypesTerms  FacetTypes = "terms"
	FacetTypesRange  FacetTypes = "range"
	FacetTypesFilter FacetTypes = "filter"
)

type FeatureRemovedError ¶ 

type FeatureRemovedError struct {
	// Description of the feature that is removed.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the requested feature was removed. *

func (*FeatureRemovedError) DecodeStruct ¶ added in v1.1.0 

func (obj *FeatureRemovedError) DecodeStruct(src map[string]interface{}) error

func (FeatureRemovedError) Error ¶ 

func (obj FeatureRemovedError) Error() string

func (FeatureRemovedError) MarshalJSON ¶ 

func (obj FeatureRemovedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*FeatureRemovedError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *FeatureRemovedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type FieldContainer ¶ 

type FieldContainer map[string]interface{}

type FieldDefinition ¶ 

type FieldDefinition struct {
	// Data type of the Custom Field to define.
	Type FieldType `json:"type"`
	// Name of the Custom Field to define.
	// Must be unique for a given [ResourceTypeId](ctp:api:type:ResourceTypeId).
	// In case there is a FieldDefinition with the same `name` in another [Type](ctp:api:type:Type), both FieldDefinitions must have the same `type`.
	Name string `json:"name"`
	// A human-readable label for the field.
	Label LocalizedString `json:"label"`
	// Defines whether the field is required to have a value.
	Required bool `json:"required"`
	// Defines the visual representation of the field in user interfaces like the Merchant Center.
	// It is only relevant for string-based [FieldTypes](ctp:api:type:FieldType) like [CustomFieldStringType](ctp:api:type:CustomFieldStringType) and [CustomFieldLocalizedStringType](ctp:api:type:CustomFieldLocalizedStringType).
	InputHint *TypeTextInputHint `json:"inputHint,omitempty"`
}

* * Defines a [Custom Field](/../api/projects/custom-fields) and its meta-information. * This FieldDefinition is similar to an AttributeDefinition(ctp:api:type:AttributeDefinition) of [Product Types](/../api/projects/productTypes). *

func (*FieldDefinition) UnmarshalJSON ¶ 

func (obj *FieldDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type FieldType ¶ 

type FieldType interface{}

type FilteredFacetResult ¶ 

type FilteredFacetResult struct {
	Count        int  `json:"count"`
	ProductCount *int `json:"productCount,omitempty"`
}

func (FilteredFacetResult) MarshalJSON ¶ 

func (obj FilteredFacetResult) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

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://support.commercetools.com). *

func (*GeneralError) DecodeStruct ¶ added in v1.1.0 

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 ¶ added in v1.1.0 

func (obj *GeneralError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GenericRequestError ¶ 

type GenericRequestError struct {
	Content    []byte
	StatusCode int
	Response   *http.Response
}

func (GenericRequestError) Error ¶ 

func (e GenericRequestError) Error() string

type GeoJson ¶ 

type GeoJson interface{}

* * GeoJSON Geometry represents a [Geometry Object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1) as defined in the GeoJSON standard. *

type GeoJsonPoint ¶ 

type GeoJsonPoint struct {
	// Longitude (stored on index `[0]`) and latitude (stored on index `[1]`) of the [Point](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2).
	Coordinates []float64 `json:"coordinates"`
}

func (GeoJsonPoint) MarshalJSON ¶ 

func (obj GeoJsonPoint) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type GoogleCloudFunctionDestination ¶ added in v1.3.0 

type GoogleCloudFunctionDestination struct {
	// URL to the target function.
	Url string `json:"url"`
}

* * For GoogleCloudFunction destinations, you need to grant permissions to the `extensions@commercetools-platform.iam.gserviceaccount.com` service account to invoke your function. If your function's version is 1st gen, grant the service account the IAM role `Cloud Functions Invoker`. For version 2nd gen, assign the IAM role `Cloud Run Invoker` using the Cloud Run console. *

func (GoogleCloudFunctionDestination) MarshalJSON ¶ added in v1.3.0 

func (obj GoogleCloudFunctionDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type GoogleCloudPubSubDestination ¶ 

type GoogleCloudPubSubDestination struct {
	// ID of the Google Cloud project that contains the Pub/Sub topic.
	ProjectId string `json:"projectId"`
	// Name of the topic.
	Topic string `json:"topic"`
}

* * Destination for [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/) that can be used * for [Pull subscriptions](https://cloud.google.com/pubsub/docs/pull) as well as for [Push subscriptions](https://cloud.google.com/pubsub/docs/push). * The `topic` must give the `pubsub.topics.publish` permission to the service account `subscriptions@commercetools-platform.iam.gserviceaccount.com`. * If used with the CloudEventsFormat(#cloudeventsformat), the message conforms to the [PubSub Protocol Binding](https://github.com/google/knative-gcp/blob/master/docs/spec/pubsub-protocol-binding.md) of the [Structured Content Mode](https://github.com/google/knative-gcp/blob/master/docs/spec/pubsub-protocol-binding.md#32-structured-content-mode). *

func (GoogleCloudPubSubDestination) MarshalJSON ¶ 

func (obj GoogleCloudPubSubDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type GraphQLAnonymousIdAlreadyInUseError ¶ added in v1.3.0 

type GraphQLAnonymousIdAlreadyInUseError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the anonymous ID is being used by another resource. * * The client application should choose another anonymous ID or retrieve an automatically generated one. *

func (*GraphQLAnonymousIdAlreadyInUseError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLAnonymousIdAlreadyInUseError) DecodeStruct(src map[string]interface{}) error

func (GraphQLAnonymousIdAlreadyInUseError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLAnonymousIdAlreadyInUseError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLAnonymousIdAlreadyInUseError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLAnonymousIdAlreadyInUseError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLAssociateMissingPermissionError ¶ added in v1.3.0 

type GraphQLAssociateMissingPermissionError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// [ResourceIdentifier](ctp:api:type:CustomerResourceIdentifier) to the [Associate](ctp:api:type:Associate) that tried to perform the action.
	Associate CustomerResourceIdentifier `json:"associate"`
	// [ResourceIdentifier](ctp:api:type:BusinessUnitResourceIdentifier) to the [BusinessUnit](ctp:api:type:BusinessUnit).
	BusinessUnit BusinessUnitResourceIdentifier `json:"businessUnit"`
	// [ResourceIdentifier](ctp:api:type:CustomerResourceIdentifier) of the [Associate](ctp:api:type:Associate) on whose behalf the action is performed.
	AssociateOnBehalf *CustomerResourceIdentifier `json:"associateOnBehalf,omitempty"`
	// The Permissions that the [Associate](ctp:api:type:Associate) performing the action lacks. At least one of these Permissions is needed.
	Permissions []Permission `json:"permissions"`
}

* * Returned when an Associate(/projects/business-units#associate) is missing a Permission(/projects/associate-roles#ctp:api:type:Permission) on a [B2B resource](/associates-overview#b2b-resources). *

func (*GraphQLAssociateMissingPermissionError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLAssociateMissingPermissionError) DecodeStruct(src map[string]interface{}) error

func (GraphQLAssociateMissingPermissionError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLAssociateMissingPermissionError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLAssociateMissingPermissionError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLAssociateMissingPermissionError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLAttributeDefinitionAlreadyExistsError ¶ added in v1.3.0 

type GraphQLAttributeDefinitionAlreadyExistsError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of the Product Type containing the conflicting name.
	ConflictingProductTypeId string `json:"conflictingProductTypeId"`
	// Name of the Product Type containing the conflicting name.
	ConflictingProductTypeName string `json:"conflictingProductTypeName"`
	// Name of the conflicting Attribute.
	ConflictingAttributeName string `json:"conflictingAttributeName"`
}

* * Returned when the `name` of the AttributeDefinition(ctp:api:type:AttributeDefinition) conflicts with an existing Attribute. * * The error is returned as a failed response to the [Create ProductType](ctp:api:endpoint:/{projectKey}/product-types:POST) request or [Change AttributeDefinition Name](ctp:api:type:ProductTypeChangeAttributeNameAction) update action. *

func (*GraphQLAttributeDefinitionAlreadyExistsError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLAttributeDefinitionAlreadyExistsError) DecodeStruct(src map[string]interface{}) error

func (GraphQLAttributeDefinitionAlreadyExistsError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLAttributeDefinitionAlreadyExistsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLAttributeDefinitionAlreadyExistsError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLAttributeDefinitionAlreadyExistsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLAttributeDefinitionTypeConflictError ¶ added in v1.3.0 

type GraphQLAttributeDefinitionTypeConflictError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of the Product Type containing the conflicting name.
	ConflictingProductTypeId string `json:"conflictingProductTypeId"`
	// Name of the Product Type containing the conflicting name.
	ConflictingProductTypeName string `json:"conflictingProductTypeName"`
	// Name of the conflicting Attribute.
	ConflictingAttributeName string `json:"conflictingAttributeName"`
}

* * Returned when the `type` is different for an AttributeDefinition using the same `name` in multiple Product Types. * * The error is returned as a failed response to the [Create ProductType](ctp:api:endpoint:/{projectKey}/product-types:POST) request. *

func (*GraphQLAttributeDefinitionTypeConflictError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLAttributeDefinitionTypeConflictError) DecodeStruct(src map[string]interface{}) error

func (GraphQLAttributeDefinitionTypeConflictError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLAttributeDefinitionTypeConflictError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLAttributeDefinitionTypeConflictError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLAttributeDefinitionTypeConflictError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLAttributeNameDoesNotExistError ¶ added in v1.3.0 

type GraphQLAttributeNameDoesNotExistError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Non-existent Attribute name.
	InvalidAttributeName string `json:"invalidAttributeName"`
}

* * Returned when an AttributeDefinition(ctp:api:type:AttributeDefinition) does not exist for an Attribute `name`. * * The error is returned as a failed response to the [Change AttributeDefinition Name](ctp:api:type:ProductTypeChangeAttributeNameAction) update action. *

func (*GraphQLAttributeNameDoesNotExistError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLAttributeNameDoesNotExistError) DecodeStruct(src map[string]interface{}) error

func (GraphQLAttributeNameDoesNotExistError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLAttributeNameDoesNotExistError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLAttributeNameDoesNotExistError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLAttributeNameDoesNotExistError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLBadGatewayError ¶ added in v1.3.0 

type GraphQLBadGatewayError struct {
	// 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 (*GraphQLBadGatewayError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLBadGatewayError) DecodeStruct(src map[string]interface{}) error

func (GraphQLBadGatewayError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLBadGatewayError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLBadGatewayError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLBadGatewayError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLConcurrentModificationError ¶ added in v1.3.0 

type GraphQLConcurrentModificationError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// 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 (*GraphQLConcurrentModificationError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLConcurrentModificationError) DecodeStruct(src map[string]interface{}) error

func (GraphQLConcurrentModificationError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLConcurrentModificationError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLConcurrentModificationError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLConcurrentModificationError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLContentTooLargeError ¶ added in v1.4.0 

type GraphQLContentTooLargeError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the request results in too much data being returned from the API. Adjust the request query to reduce the size of the data returned. *

func (*GraphQLContentTooLargeError) DecodeStruct ¶ added in v1.4.0 

func (obj *GraphQLContentTooLargeError) DecodeStruct(src map[string]interface{}) error

func (GraphQLContentTooLargeError) MarshalJSON ¶ added in v1.4.0 

func (obj GraphQLContentTooLargeError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLContentTooLargeError) UnmarshalJSON ¶ added in v1.4.0 

func (obj *GraphQLContentTooLargeError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLCountryNotConfiguredInStoreError ¶ added in v1.3.0 

type GraphQLCountryNotConfiguredInStoreError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Countries configured for the Store.
	StoreCountries []string `json:"storeCountries"`
	// The country that is not configured for the Store but referenced on the Cart or Order.
	Country string `json:"country"`
}

* * Returned when a Cart(ctp:api:type:Cart) or an Order(ctp:api:type:Order) in a Store(ctp:api:type:Store) references a country that is not included in the countries configured for the Store. * * The error is returned as a failed response to: * * - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/carts:POST) request and [Set Country](ctp:api:type:CartSetCountryAction) update action on Carts. * - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/me/carts:POST) request and [Set Country](ctp:api:type:MyCartSetCountryAction) update action on My Carts. * - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. * - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. * - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders. * - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. * - [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) request on Order Import. * - [Set Country](ctp:api:type:StagedOrderSetCountryAction) on Order Edits. *

func (*GraphQLCountryNotConfiguredInStoreError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLCountryNotConfiguredInStoreError) DecodeStruct(src map[string]interface{}) error

func (GraphQLCountryNotConfiguredInStoreError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLCountryNotConfiguredInStoreError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLCountryNotConfiguredInStoreError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLCountryNotConfiguredInStoreError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDiscountCodeNonApplicableError ¶ added in v1.3.0 

type GraphQLDiscountCodeNonApplicableError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Discount Code passed to the Cart.
	DiscountCode *string `json:"discountCode,omitempty"`
	// `"DoesNotExist"` or `"TimeRangeNonApplicable"`
	Reason *string `json:"reason,omitempty"`
	// Unique identifier of the Discount Code.
	DiscountCodeId *string `json:"discountCodeId,omitempty"`
	// Date and time (UTC) from which the Discount Code is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Discount Code is valid.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Date and time (UTC) the Discount Code validity check was last performed.
	ValidityCheckTime *time.Time `json:"validityCheckTime,omitempty"`
}

* * Returned when the Cart contains a Discount Code with a DiscountCodeState(ctp:api:type:DiscountCodeState) other than `MatchesCart`. * * The error is returned as a failed response to: * * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. *

func (*GraphQLDiscountCodeNonApplicableError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDiscountCodeNonApplicableError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDiscountCodeNonApplicableError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDiscountCodeNonApplicableError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDiscountCodeNonApplicableError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDiscountCodeNonApplicableError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDuplicateAttributeValueError ¶ added in v1.3.0 

type GraphQLDuplicateAttributeValueError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting Attributes.
	Attribute Attribute `json:"attribute"`
}

* * Returned when the `Unique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request. *

func (*GraphQLDuplicateAttributeValueError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDuplicateAttributeValueError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDuplicateAttributeValueError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDuplicateAttributeValueError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDuplicateAttributeValueError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDuplicateAttributeValueError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDuplicateAttributeValuesError ¶ added in v1.3.0 

type GraphQLDuplicateAttributeValuesError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting Attributes.
	Attributes []Attribute `json:"attributes"`
}

* * Returned when the `CombinationUnique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request. *

func (*GraphQLDuplicateAttributeValuesError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDuplicateAttributeValuesError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDuplicateAttributeValuesError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDuplicateAttributeValuesError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDuplicateAttributeValuesError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDuplicateAttributeValuesError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDuplicateEnumValuesError ¶ added in v1.3.0 

type GraphQLDuplicateEnumValuesError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Duplicate keys.
	Duplicates []string `json:"duplicates"`
}

* * Returned when an AttributeEnumType(ctp:api:type:AttributeEnumType) or AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) contains duplicate keys. *

func (*GraphQLDuplicateEnumValuesError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDuplicateEnumValuesError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDuplicateEnumValuesError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDuplicateEnumValuesError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDuplicateEnumValuesError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDuplicateEnumValuesError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDuplicateFieldError ¶ added in v1.3.0 

type GraphQLDuplicateFieldError struct {
	// 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 (*GraphQLDuplicateFieldError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDuplicateFieldError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDuplicateFieldError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDuplicateFieldError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDuplicateFieldError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDuplicateFieldError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDuplicateFieldWithConflictingResourceError ¶ added in v1.3.0 

type GraphQLDuplicateFieldWithConflictingResourceError struct {
	// 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"`
	// Reference to the resource that has the conflicting value.
	ConflictingResource Reference `json:"conflictingResource"`
}

* * Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate. *

func (*GraphQLDuplicateFieldWithConflictingResourceError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDuplicateFieldWithConflictingResourceError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDuplicateFieldWithConflictingResourceError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDuplicateFieldWithConflictingResourceError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDuplicateFieldWithConflictingResourceError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDuplicateFieldWithConflictingResourceError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDuplicatePriceKeyError ¶ added in v1.3.0 

type GraphQLDuplicatePriceKeyError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting Embedded Price.
	ConflictingPrice Price `json:"conflictingPrice"`
}

* * Returned when a Price key conflicts with an existing key. * * Keys of Embedded Prices must be unique per ProductVariant. *

func (*GraphQLDuplicatePriceKeyError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDuplicatePriceKeyError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDuplicatePriceKeyError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDuplicatePriceKeyError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDuplicatePriceKeyError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDuplicatePriceKeyError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDuplicatePriceScopeError ¶ added in v1.3.0 

type GraphQLDuplicatePriceScopeError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting Embedded Price.
	ConflictingPrice Price `json:"conflictingPrice"`
}

* * Returned when a Price scope conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request. * * Every Price of a Product Variant must have a distinct combination of currency, Customer Group, country, and Channel that constitute the scope of a Price. *

func (*GraphQLDuplicatePriceScopeError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDuplicatePriceScopeError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDuplicatePriceScopeError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDuplicatePriceScopeError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDuplicatePriceScopeError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDuplicatePriceScopeError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDuplicateStandalonePriceScopeError ¶ added in v1.3.0 

type GraphQLDuplicateStandalonePriceScopeError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Reference to the conflicting Standalone Price.
	ConflictingStandalonePrice StandalonePriceReference `json:"conflictingStandalonePrice"`
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the conflicting Standalone Price is associated.
	Sku string `json:"sku"`
	// Currency code of the country.
	Currency string `json:"currency"`
	// Country code of the geographic location.
	Country *string `json:"country,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) for which the Standalone Price is valid.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
	// [Channel](ctp:api:type:Channel) for which the Standalone Price is valid.
	Channel *ChannelResourceIdentifier `json:"channel,omitempty"`
	// Date and time (UTC) from which the Standalone Price is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Standalone Price is valid.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

* * Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price. * Every Standalone Price associated with the same SKU must have a distinct combination of currency, country, Customer Group, Channel, and validity periods (`validFrom` and `validUntil`). * * The error is returned as a failed response to the [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request. *

func (*GraphQLDuplicateStandalonePriceScopeError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDuplicateStandalonePriceScopeError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDuplicateStandalonePriceScopeError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDuplicateStandalonePriceScopeError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDuplicateStandalonePriceScopeError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDuplicateStandalonePriceScopeError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLDuplicateVariantValuesError ¶ added in v1.3.0 

type GraphQLDuplicateVariantValuesError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Every Product Variant must have a distinct combination of SKU, prices, and custom Attribute values.
	VariantValues VariantValues `json:"variantValues"`
}

* * Returned when a [Product Variant](ctp:api:type:ProductVariant) value conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request. *

func (*GraphQLDuplicateVariantValuesError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLDuplicateVariantValuesError) DecodeStruct(src map[string]interface{}) error

func (GraphQLDuplicateVariantValuesError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLDuplicateVariantValuesError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLDuplicateVariantValuesError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLDuplicateVariantValuesError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLEditPreviewFailedError ¶ added in v1.3.0 

type GraphQLEditPreviewFailedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// State of the OrderEdit where the `stagedActions` cannot be applied to the Order.
	Result OrderEditPreviewFailure `json:"result"`
}

* * Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated. * * The error is returned as a failed response to the [Get Shipping Methods for an OrderEdit](ctp:api:endpoint:/{projectKey}/shipping-methods/matching-orderedit:GET) request. *

func (*GraphQLEditPreviewFailedError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLEditPreviewFailedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLEditPreviewFailedError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLEditPreviewFailedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLEditPreviewFailedError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLEditPreviewFailedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLEnumKeyAlreadyExistsError ¶ added in v1.3.0 

type GraphQLEnumKeyAlreadyExistsError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting enum key.
	ConflictingEnumKey string `json:"conflictingEnumKey"`
	// Name of the conflicting Attribute.
	ConflictingAttributeName string `json:"conflictingAttributeName"`
}

* * Returned when an AttributeEnumType(ctp:api:type:AttributeEnumType) or AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) contains a key that already exists. *

func (*GraphQLEnumKeyAlreadyExistsError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLEnumKeyAlreadyExistsError) DecodeStruct(src map[string]interface{}) error

func (GraphQLEnumKeyAlreadyExistsError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLEnumKeyAlreadyExistsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLEnumKeyAlreadyExistsError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLEnumKeyAlreadyExistsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLEnumKeyDoesNotExistError ¶ added in v1.3.0 

type GraphQLEnumKeyDoesNotExistError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Conflicting enum key.
	ConflictingEnumKey string `json:"conflictingEnumKey"`
	// Name of the conflicting Attribute.
	ConflictingAttributeName string `json:"conflictingAttributeName"`
}

* * Returned when an AttributeEnumType(ctp:api:type:AttributeEnumType) or AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) already contains a value with the given key. * * The error is returned as a failed response to the [Change the key of an EnumValue](ctp:api:type:ProductTypeChangeEnumKeyAction) update action. *

func (*GraphQLEnumKeyDoesNotExistError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLEnumKeyDoesNotExistError) DecodeStruct(src map[string]interface{}) error

func (GraphQLEnumKeyDoesNotExistError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLEnumKeyDoesNotExistError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLEnumKeyDoesNotExistError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLEnumKeyDoesNotExistError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLEnumValueIsUsedError ¶ added in v1.3.0 

type GraphQLEnumValueIsUsedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when an enum value cannot be removed from an Attribute as it is being used by a Product. * * The error is returned as a failed response to the [Remove EnumValues from AttributeDefinition](ctp:api:type:ProductTypeRemoveEnumValuesAction) update action. *

func (*GraphQLEnumValueIsUsedError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLEnumValueIsUsedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLEnumValueIsUsedError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLEnumValueIsUsedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLEnumValueIsUsedError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLEnumValueIsUsedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLEnumValuesMustMatchError ¶ added in v1.3.0 

type GraphQLEnumValuesMustMatchError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when during an order update of AttributeEnumType(ctp:api:type:AttributeEnumType) or AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) the new enum values do not match the existing ones. * * The error is returned as a failed response to the [Change the order of EnumValues](ctp:api:type:ProductTypeChangePlainEnumValueOrderAction) and [Change the order of LocalizedEnumValues](ctp:api:type:ProductTypeChangeLocalizedEnumValueOrderAction) update actions. *

func (*GraphQLEnumValuesMustMatchError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLEnumValuesMustMatchError) DecodeStruct(src map[string]interface{}) error

func (GraphQLEnumValuesMustMatchError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLEnumValuesMustMatchError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLEnumValuesMustMatchError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLEnumValuesMustMatchError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLError ¶ 

type GraphQLError struct {
	Message   string                 `json:"message"`
	Locations []GraphQLErrorLocation `json:"locations"`
	Path      []interface{}          `json:"path"`
	// Represents a single error.
	Extensions GraphQLErrorObject `json:"extensions"`
}

func (GraphQLError) Error ¶ 

func (obj GraphQLError) Error() string

func (GraphQLError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLErrorLocation ¶ 

type GraphQLErrorLocation struct {
	Line   int `json:"line"`
	Column int `json:"column"`
}

type GraphQLErrorObject ¶ added in v1.3.0 

type GraphQLErrorObject interface{}

* * Represents a single error.

type GraphQLExtensionBadResponseError ¶ added in v1.3.0 

type GraphQLExtensionBadResponseError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// User-defined localized description of the error.
	LocalizedMessage *LocalizedString `json:"localizedMessage,omitempty"`
	// Any information that should be returned to the API caller.
	ExtensionExtraInfo *interface{} `json:"extensionExtraInfo,omitempty"`
	// Additional errors related to the API Extension.
	ExtensionErrors []ExtensionError `json:"extensionErrors"`
	// The response body returned by the Extension.
	ExtensionBody *string `json:"extensionBody,omitempty"`
	// Http status code returned by the Extension.
	ExtensionStatusCode *int `json:"extensionStatusCode,omitempty"`
	// Unique identifier of the Extension.
	ExtensionId string `json:"extensionId"`
	// User-defined unique identifier of the Extension.
	ExtensionKey *string `json:"extensionKey,omitempty"`
}

* * Returned when the response from the API Extension could not be parsed successfully (such as a `500` HTTP status code, or an invalid JSON response). *

func (*GraphQLExtensionBadResponseError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLExtensionBadResponseError) DecodeStruct(src map[string]interface{}) error

func (GraphQLExtensionBadResponseError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLExtensionBadResponseError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLExtensionBadResponseError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLExtensionBadResponseError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLExtensionNoResponseError ¶ added in v1.3.0 

type GraphQLExtensionNoResponseError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of the API Extension.
	ExtensionId string `json:"extensionId"`
	// User-defined unique identifier of the API Extension, if available.
	ExtensionKey *string `json:"extensionKey,omitempty"`
}

* * Returned when the API Extension does not respond within the [time limit](/../api/projects/api-extensions#time-limits), or could not be reached. *

func (*GraphQLExtensionNoResponseError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLExtensionNoResponseError) DecodeStruct(src map[string]interface{}) error

func (GraphQLExtensionNoResponseError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLExtensionNoResponseError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLExtensionNoResponseError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLExtensionNoResponseError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLExtensionPredicateEvaluationFailedError ¶ added in v1.3.0 

type GraphQLExtensionPredicateEvaluationFailedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Details about the API Extension that was involved in the error.
	ErrorByExtension ErrorByExtension `json:"errorByExtension"`
}

* * Returned when the predicate defined in the ExtensionTrigger(ctp:api:type:ExtensionTrigger) could not be evaluated due to a missing field. *

func (*GraphQLExtensionPredicateEvaluationFailedError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLExtensionPredicateEvaluationFailedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLExtensionPredicateEvaluationFailedError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLExtensionPredicateEvaluationFailedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLExtensionPredicateEvaluationFailedError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLExtensionPredicateEvaluationFailedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLExtensionUpdateActionsFailedError ¶ added in v1.3.0 

type GraphQLExtensionUpdateActionsFailedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// User-defined localized description of the error.
	LocalizedMessage *LocalizedString `json:"localizedMessage,omitempty"`
	// Any information that should be returned to the API caller.
	ExtensionExtraInfo *interface{} `json:"extensionExtraInfo,omitempty"`
	// Additional errors related to the API Extension.
	ExtensionErrors []ExtensionError `json:"extensionErrors"`
}

* * Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist). * This would result in a [400 Bad Request](#400-bad-request) response if the same update action was sent from a regular client. *

func (*GraphQLExtensionUpdateActionsFailedError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLExtensionUpdateActionsFailedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLExtensionUpdateActionsFailedError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLExtensionUpdateActionsFailedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLExtensionUpdateActionsFailedError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLExtensionUpdateActionsFailedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLExternalOAuthFailedError ¶ added in v1.3.0 

type GraphQLExternalOAuthFailedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when an [external OAuth Introspection endpoint](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`). *

func (*GraphQLExternalOAuthFailedError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLExternalOAuthFailedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLExternalOAuthFailedError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLExternalOAuthFailedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLExternalOAuthFailedError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLExternalOAuthFailedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLFeatureRemovedError ¶ added in v1.3.0 

type GraphQLFeatureRemovedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the requested feature was removed. *

func (*GraphQLFeatureRemovedError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLFeatureRemovedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLFeatureRemovedError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLFeatureRemovedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLFeatureRemovedError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLFeatureRemovedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLGeneralError ¶ added in v1.3.0 

type GraphQLGeneralError struct {
	// 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://support.commercetools.com). *

func (*GraphQLGeneralError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLGeneralError) DecodeStruct(src map[string]interface{}) error

func (GraphQLGeneralError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLGeneralError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLGeneralError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLGeneralError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInsufficientScopeError ¶ added in v1.3.0 

type GraphQLInsufficientScopeError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

func (*GraphQLInsufficientScopeError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInsufficientScopeError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInsufficientScopeError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInsufficientScopeError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInsufficientScopeError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInsufficientScopeError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInternalConstraintViolatedError ¶ added in v1.3.0 

type GraphQLInternalConstraintViolatedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when certain API-specific constraints were not met. For example, the specified [Discount Code](ctp:api:type:DiscountCode) was never applied and cannot be updated. *

func (*GraphQLInternalConstraintViolatedError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInternalConstraintViolatedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInternalConstraintViolatedError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInternalConstraintViolatedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInternalConstraintViolatedError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInternalConstraintViolatedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInvalidCredentialsError ¶ added in v1.3.0 

type GraphQLInvalidCredentialsError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails. * * The error is returned as a failed response to: * * - [Authenticate a global Customer (Sign-in)](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate Customer (Sign-in) in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests on Customers. * - [Authenticating Customer (Sign-in)](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate Customer (Sign-in) in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile. *

func (*GraphQLInvalidCredentialsError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInvalidCredentialsError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInvalidCredentialsError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInvalidCredentialsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInvalidCredentialsError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInvalidCredentialsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInvalidCurrentPasswordError ¶ added in v1.3.0 

type GraphQLInvalidCurrentPasswordError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the current password of the Customer does not match. * * The error is returned as a failed response to: * * - [Change Customer Password](ctp:api:endpoint:/{projectKey}/customers/password:POST) and [Change Customer Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password:POST) requests on Customers. * - [Change Customer Password](ctp:api:endpoint:/{projectKey}/me/password:POST) and [Change Customer Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/password:POST) requests on My Customer Profile. *

func (*GraphQLInvalidCurrentPasswordError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInvalidCurrentPasswordError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInvalidCurrentPasswordError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInvalidCurrentPasswordError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInvalidCurrentPasswordError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInvalidCurrentPasswordError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInvalidFieldError ¶ added in v1.3.0 

type GraphQLInvalidFieldError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Name of the field with the invalid value.
	Field string `json:"field"`
	// Value invalid for the field.
	InvalidValue interface{} `json:"invalidValue"`
	// Fixed set of allowed values for the field, if any.
	AllowedValues []interface{} `json:"allowedValues"`
}

* * Returned when a field has an invalid value. *

func (*GraphQLInvalidFieldError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInvalidFieldError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInvalidFieldError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInvalidFieldError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInvalidFieldError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInvalidFieldError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInvalidInputError ¶ added in v1.3.0 

type GraphQLInvalidInputError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when an invalid input has been sent. *

func (*GraphQLInvalidInputError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInvalidInputError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInvalidInputError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInvalidInputError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInvalidInputError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInvalidInputError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInvalidItemShippingDetailsError ¶ added in v1.3.0 

type GraphQLInvalidItemShippingDetailsError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// `"LineItem"` or `"CustomLineItem"`
	Subject string `json:"subject"`
	// Unique identifier of the Line Item or Custom Line Item.
	ItemId string `json:"itemId"`
}

* * Returned when Line Item or Custom Line Item quantities set under ItemShippingDetails(ctp:api:type:ItemShippingDetails) do not match the sum of the quantities in their respective shipping details. * * The error is returned as a failed response to the [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. *

func (*GraphQLInvalidItemShippingDetailsError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInvalidItemShippingDetailsError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInvalidItemShippingDetailsError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInvalidItemShippingDetailsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInvalidItemShippingDetailsError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInvalidItemShippingDetailsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInvalidJsonInputError ¶ added in v1.3.0 

type GraphQLInvalidJsonInputError struct {
	// 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 (*GraphQLInvalidJsonInputError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInvalidJsonInputError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInvalidJsonInputError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInvalidJsonInputError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInvalidJsonInputError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInvalidJsonInputError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInvalidOperationError ¶ added in v1.3.0 

type GraphQLInvalidOperationError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the resources involved in the request are not in a valid state for the operation. * * The client application should validate the constraints described in the error message before sending the request. *

func (*GraphQLInvalidOperationError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInvalidOperationError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInvalidOperationError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInvalidOperationError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInvalidOperationError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInvalidOperationError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInvalidSubjectError ¶ added in v1.3.0 

type GraphQLInvalidSubjectError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

func (*GraphQLInvalidSubjectError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInvalidSubjectError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInvalidSubjectError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInvalidSubjectError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInvalidSubjectError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInvalidSubjectError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLInvalidTokenError ¶ added in v1.3.0 

type GraphQLInvalidTokenError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

func (*GraphQLInvalidTokenError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLInvalidTokenError) DecodeStruct(src map[string]interface{}) error

func (GraphQLInvalidTokenError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLInvalidTokenError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLInvalidTokenError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLInvalidTokenError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLLanguageUsedInStoresError ¶ added in v1.3.0 

type GraphQLLanguageUsedInStoresError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a language cannot be removed from a Project as it is being used by a Store. * * The error is returned as a failed response to the [Change Languages](ctp:api:type:ProjectChangeLanguagesAction) update action. *

func (*GraphQLLanguageUsedInStoresError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLLanguageUsedInStoresError) DecodeStruct(src map[string]interface{}) error

func (GraphQLLanguageUsedInStoresError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLLanguageUsedInStoresError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLLanguageUsedInStoresError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLLanguageUsedInStoresError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLMatchingPriceNotFoundError ¶ added in v1.3.0 

type GraphQLMatchingPriceNotFoundError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of a [Product](ctp:api:type:Product).
	ProductId string `json:"productId"`
	// Unique identifier of a [ProductVariant](ctp:api:type:ProductVariant) in the Product.
	VariantId int `json:"variantId"`
	// Currency code of the country.
	Currency *string `json:"currency,omitempty"`
	// Country code of the geographic location.
	Country *string `json:"country,omitempty"`
	// Customer Group associated with the Price.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// Channel associated with the Price.
	Channel *ChannelReference `json:"channel,omitempty"`
}

* * Returned when the Product Variant does not have a Price according to the Product(ctp:api:type:Product) `priceMode` value for a selected currency, country, Customer Group, or Channel. * * The error is returned as a failed response to: * * - [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), and [Add DiscountCode](ctp:api:type:CartAddDiscountCodeAction) update actions on Carts. * - [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction), and [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update actions on Order Edits. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. *

func (*GraphQLMatchingPriceNotFoundError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLMatchingPriceNotFoundError) DecodeStruct(src map[string]interface{}) error

func (GraphQLMatchingPriceNotFoundError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLMatchingPriceNotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLMatchingPriceNotFoundError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLMatchingPriceNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLMaxCartDiscountsReachedError ¶ added in v1.4.0 

type GraphQLMaxCartDiscountsReachedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Cart Discount cannot be created or activated as the [limit](/../api/limits#cart-discounts) for active Cart Discounts has been reached. * * The error is returned as a failed response to: * * - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests * - [Change IsActive](ctp:api:type:CartDiscountChangeIsActiveAction) update action *

func (*GraphQLMaxCartDiscountsReachedError) DecodeStruct ¶ added in v1.4.0 

func (obj *GraphQLMaxCartDiscountsReachedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLMaxCartDiscountsReachedError) MarshalJSON ¶ added in v1.4.0 

func (obj GraphQLMaxCartDiscountsReachedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLMaxCartDiscountsReachedError) UnmarshalJSON ¶ added in v1.4.0 

func (obj *GraphQLMaxCartDiscountsReachedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLMaxResourceLimitExceededError ¶ added in v1.3.0 

type GraphQLMaxResourceLimitExceededError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Resource type that reached its maximum limit of configured elements (for example, 100 Zones per Project).
	ExceededResource ReferenceTypeId `json:"exceededResource"`
}

* * Returned when a resource type cannot be created as it has reached its [limits](/../api/limits). * * The limits must be adjusted for this resource before sending the request again. *

func (*GraphQLMaxResourceLimitExceededError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLMaxResourceLimitExceededError) DecodeStruct(src map[string]interface{}) error

func (GraphQLMaxResourceLimitExceededError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLMaxResourceLimitExceededError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLMaxResourceLimitExceededError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLMaxResourceLimitExceededError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLMaxStoreReferencesReachedError ¶ added in v1.4.0 

type GraphQLMaxStoreReferencesReachedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Store cannot be added to a Cart Discount as the [limit](/../api/limits#cart-discounts-stores) for Stores configured for a Cart Discount has been reached. * * The error is returned as a failed response to: * * - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests * - [Add Store](ctp:api:type:CartDiscountAddStoreAction) and [Set Store](ctp:api:type:CartDiscountSetStoresAction) update actions *

func (*GraphQLMaxStoreReferencesReachedError) DecodeStruct ¶ added in v1.4.0 

func (obj *GraphQLMaxStoreReferencesReachedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLMaxStoreReferencesReachedError) MarshalJSON ¶ added in v1.4.0 

func (obj GraphQLMaxStoreReferencesReachedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLMaxStoreReferencesReachedError) UnmarshalJSON ¶ added in v1.4.0 

func (obj *GraphQLMaxStoreReferencesReachedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLMissingRoleOnChannelError ¶ added in v1.3.0 

type GraphQLMissingRoleOnChannelError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a given [Channel](ctp:api:type:Channel).
	Channel *ChannelResourceIdentifier `json:"channel,omitempty"`
	// - `ProductDistribution` for Product Distribution Channels allowed for the Store. Also required for [Standalone Prices](ctp:api:type:StandalonePrice).
	// - `InventorySupply` for Inventory Supply Channels allowed for the Store.
	MissingRole ChannelRoleEnum `json:"missingRole"`
}

* * Returned when one of the following states occur: * * - Channel(ctp:api:type:Channel) is added or set on a Store(ctp:api:type:Store) with missing Channel `roles`. * - [Standalone Price](ctp:api:type:StandalonePrice) references a Channel that does not contain the `ProductDistribution` role. * * The error is returned as a failed response to: * * - [Add Distribution Channel](ctp:api:type:StoreAddDistributionChannelAction), [Set Distribution Channel](ctp:api:type:StoreSetDistributionChannelsAction), [Add Supply Channel](ctp:api:type:StoreAddSupplyChannelAction), and [Set Supply Channel](ctp:api:type:StoreSetSupplyChannelsAction) update actions. * - [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request. *

func (*GraphQLMissingRoleOnChannelError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLMissingRoleOnChannelError) DecodeStruct(src map[string]interface{}) error

func (GraphQLMissingRoleOnChannelError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLMissingRoleOnChannelError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLMissingRoleOnChannelError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLMissingRoleOnChannelError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLMissingTaxRateForCountryError ¶ added in v1.3.0 

type GraphQLMissingTaxRateForCountryError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of the [TaxCategory](ctp:api:type:TaxCategory).
	TaxCategoryId string `json:"taxCategoryId"`
	// Country code of the geographic location.
	Country *string `json:"country,omitempty"`
	// State within the country, such as Texas in the United States.
	State *string `json:"state,omitempty"`
}

* * Returned when the Tax Category of at least one of the `lineItems`, `customLineItems`, or `shippingInfo` in the Cart(ctp:api:type:Cart) is missing the TaxRate(ctp:api:type:TaxRate) matching `country` and `state` given in the `shippingAddress` of that Cart. * * The error is returned as a failed response to: * * - [Set Default Shipping Address](ctp:api:type:CustomerSetDefaultShippingAddressAction), [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), [Set Shipping Address](ctp:api:type:CartSetShippingAddressAction), [Add LineItem](ctp:api:type:MyCartAddLineItemAction), [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), and [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update actions * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. *

func (*GraphQLMissingTaxRateForCountryError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLMissingTaxRateForCountryError) DecodeStruct(src map[string]interface{}) error

func (GraphQLMissingTaxRateForCountryError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLMissingTaxRateForCountryError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLMissingTaxRateForCountryError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLMissingTaxRateForCountryError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLMoneyOverflowError ¶ added in v1.3.0 

type GraphQLMoneyOverflowError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Money(ctp:api:type:Money) operation overflows the 64-bit integer range. * See [Money usage](/types#usage) for more information. *

func (*GraphQLMoneyOverflowError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLMoneyOverflowError) DecodeStruct(src map[string]interface{}) error

func (GraphQLMoneyOverflowError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLMoneyOverflowError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLMoneyOverflowError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLMoneyOverflowError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLNoMatchingProductDiscountFoundError ¶ added in v1.3.0 

type GraphQLNoMatchingProductDiscountFoundError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant. * * The error is returned as a failed response to the [Get Matching ProductDiscount](ctp:api:endpoint:/{projectKey}/product-discounts/matching:POST) request. *

func (*GraphQLNoMatchingProductDiscountFoundError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLNoMatchingProductDiscountFoundError) DecodeStruct(src map[string]interface{}) error

func (GraphQLNoMatchingProductDiscountFoundError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLNoMatchingProductDiscountFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLNoMatchingProductDiscountFoundError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLNoMatchingProductDiscountFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLObjectNotFoundError ¶ added in v1.3.0 

type GraphQLObjectNotFoundError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the requested resource was not found. *

func (*GraphQLObjectNotFoundError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLObjectNotFoundError) DecodeStruct(src map[string]interface{}) error

func (GraphQLObjectNotFoundError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLObjectNotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLObjectNotFoundError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLObjectNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLOutOfStockError ¶ added in v1.3.0 

type GraphQLOutOfStockError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifiers of the Line Items that are out of stock.
	LineItems []string `json:"lineItems"`
	// SKUs of the Line Items that are out of stock.
	Skus []string `json:"skus"`
}

* * Returned when some of the [Line Items](ctp:api:type:LineItem) are out of stock at the time of placing an Order(ctp:api:type:Order). * * The error is returned as a failed response to: * * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. *

func (*GraphQLOutOfStockError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLOutOfStockError) DecodeStruct(src map[string]interface{}) error

func (GraphQLOutOfStockError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLOutOfStockError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLOutOfStockError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLOutOfStockError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLOverCapacityError ¶ added in v1.3.0 

type GraphQLOverCapacityError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the service is having trouble handling the load. * * The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. *

func (*GraphQLOverCapacityError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLOverCapacityError) DecodeStruct(src map[string]interface{}) error

func (GraphQLOverCapacityError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLOverCapacityError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLOverCapacityError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLOverCapacityError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLOverlappingStandalonePriceValidityError ¶ added in v1.3.0 

type GraphQLOverlappingStandalonePriceValidityError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Reference to the conflicting Standalone Price.
	ConflictingStandalonePrice StandalonePriceReference `json:"conflictingStandalonePrice"`
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the conflicting Standalone Price is associated.
	Sku string `json:"sku"`
	// Currency code of the country.
	Currency string `json:"currency"`
	// Country code of the geographic location.
	Country *string `json:"country,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) for which the Standalone Price is valid.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
	// [Channel](ctp:api:type:Channel) for which the Standalone Price is valid.
	Channel *ChannelResourceIdentifier `json:"channel,omitempty"`
	// Date and time (UTC) from which the Standalone Price is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Standalone Price is valid.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Date and time (UTC) from which the conflicting Standalone Price is valid.
	ConflictingValidFrom *time.Time `json:"conflictingValidFrom,omitempty"`
	// Date and time (UTC) until which the conflicting Standalone Price is valid.
	ConflictingValidUntil *time.Time `json:"conflictingValidUntil,omitempty"`
}

* * Returned when a given Price validity period conflicts with an existing one. * Every Standalone Price associated with the same SKU and with the same combination of currency, country, Customer Group, and Channel, must have non-overlapping validity periods (`validFrom` and `validUntil`). * * The error is returned as a failed response to the [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request. *

func (*GraphQLOverlappingStandalonePriceValidityError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLOverlappingStandalonePriceValidityError) DecodeStruct(src map[string]interface{}) error

func (GraphQLOverlappingStandalonePriceValidityError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLOverlappingStandalonePriceValidityError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLOverlappingStandalonePriceValidityError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLOverlappingStandalonePriceValidityError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLPendingOperationError ¶ added in v1.3.0 

type GraphQLPendingOperationError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed. * * The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. * If the error persists, report it using the [Support Portal](https://support.commercetools.com). *

func (*GraphQLPendingOperationError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLPendingOperationError) DecodeStruct(src map[string]interface{}) error

func (GraphQLPendingOperationError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLPendingOperationError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLPendingOperationError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLPendingOperationError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLPriceChangedError ¶ added in v1.3.0 

type GraphQLPriceChangedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifiers of the Line Items for which the Price or [TaxRate](ctp:api:type:TaxRate) has changed.
	LineItems []string `json:"lineItems"`
	// `true` if the [ShippingRate](ctp:api:type:ShippingRate) has changed.
	Shipping bool `json:"shipping"`
}

* * Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart. * * The error is returned as a failed response to: * * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. *

func (*GraphQLPriceChangedError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLPriceChangedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLPriceChangedError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLPriceChangedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLPriceChangedError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLPriceChangedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLProductAssignmentMissingError ¶ added in v1.3.0 

type GraphQLProductAssignmentMissingError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// [Reference](ctp:api:type:Reference) to the [Product](ctp:api:type:Product) for which the error was returned.
	Product ProductReference `json:"product"`
}

* * Returned when a Product is not assigned to the Product Selection. * The error is returned as a failed response either to the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) or to the [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action. *

func (*GraphQLProductAssignmentMissingError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLProductAssignmentMissingError) DecodeStruct(src map[string]interface{}) error

func (GraphQLProductAssignmentMissingError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLProductAssignmentMissingError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLProductAssignmentMissingError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLProductAssignmentMissingError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLProductPresentWithDifferentVariantSelectionError ¶ added in v1.3.0 

type GraphQLProductPresentWithDifferentVariantSelectionError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// [Reference](ctp:api:type:Reference) to the [Product](ctp:api:type:Product) for which the error was returned.
	Product ProductReference `json:"product"`
	// Existing Product Variant Selection or Exclusion for the [Product](/../api/projects/products) in the [Product Selection](/../api/projects/product-selections).
	ExistingVariantSelection ProductVariantSelection `json:"existingVariantSelection"`
}

* * Returned when a Product is already assigned to a [Product Selection](/../api/projects/product-selections), but the Product Selection has either a different [Product Variant Selection](ctp:api:type:ProductVariantSelection) or a different [Product Variant Exclusion](ctp:api:type:ProductVariantExclusion). * * The error is returned as a failed response either to the [Add Product](ctp:api:type:ProductSelectionAddProductAction) or to the [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action. *

func (*GraphQLProductPresentWithDifferentVariantSelectionError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLProductPresentWithDifferentVariantSelectionError) DecodeStruct(src map[string]interface{}) error

func (GraphQLProductPresentWithDifferentVariantSelectionError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLProductPresentWithDifferentVariantSelectionError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLProductPresentWithDifferentVariantSelectionError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLProductPresentWithDifferentVariantSelectionError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLProjectNotConfiguredForLanguagesError ¶ added in v1.3.0 

type GraphQLProjectNotConfiguredForLanguagesError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Languages configured for the Store.
	Languages []string `json:"languages"`
}

* * Returned when the languages set for a Store are not supported by the Project. * * The error is returned as a failed response to the [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action. *

func (*GraphQLProjectNotConfiguredForLanguagesError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLProjectNotConfiguredForLanguagesError) DecodeStruct(src map[string]interface{}) error

func (GraphQLProjectNotConfiguredForLanguagesError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLProjectNotConfiguredForLanguagesError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLProjectNotConfiguredForLanguagesError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLProjectNotConfiguredForLanguagesError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLQueryComplexityLimitExceededError ¶ added in v1.3.0 

type GraphQLQueryComplexityLimitExceededError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

func (*GraphQLQueryComplexityLimitExceededError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLQueryComplexityLimitExceededError) DecodeStruct(src map[string]interface{}) error

func (GraphQLQueryComplexityLimitExceededError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLQueryComplexityLimitExceededError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLQueryComplexityLimitExceededError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLQueryComplexityLimitExceededError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLQueryTimedOutError ¶ added in v1.3.0 

type GraphQLQueryTimedOutError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the query times out. * * If a query constantly times out, please check if it follows the [performance best practices](/../api/predicates/query#performance-considerations). *

func (*GraphQLQueryTimedOutError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLQueryTimedOutError) DecodeStruct(src map[string]interface{}) error

func (GraphQLQueryTimedOutError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLQueryTimedOutError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLQueryTimedOutError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLQueryTimedOutError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLReferenceExistsError ¶ added in v1.3.0 

type GraphQLReferenceExistsError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Type of referenced resource.
	ReferencedBy *ReferenceTypeId `json:"referencedBy,omitempty"`
}

* * Returned when a resource cannot be deleted because it is being referenced by another resource. *

func (*GraphQLReferenceExistsError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLReferenceExistsError) DecodeStruct(src map[string]interface{}) error

func (GraphQLReferenceExistsError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLReferenceExistsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLReferenceExistsError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLReferenceExistsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLReferencedResourceNotFoundError ¶ added in v1.3.0 

type GraphQLReferencedResourceNotFoundError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Type of referenced resource.
	TypeId ReferenceTypeId `json:"typeId"`
	// Unique identifier of the referenced resource, if known.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced resource, if known.
	Key *string `json:"key,omitempty"`
}

* * Returned when a resource referenced by a Reference(ctp:api:type:Reference) or a ResourceIdentifier(ctp:api:type:ResourceIdentifier) could not be found. *

func (*GraphQLReferencedResourceNotFoundError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLReferencedResourceNotFoundError) DecodeStruct(src map[string]interface{}) error

func (GraphQLReferencedResourceNotFoundError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLReferencedResourceNotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLReferencedResourceNotFoundError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLReferencedResourceNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLRequest ¶ 

type GraphQLRequest struct {
	Query         string               `json:"query"`
	OperationName *string              `json:"operationName,omitempty"`
	Variables     *GraphQLVariablesMap `json:"variables,omitempty"`
}

type GraphQLRequiredFieldError ¶ added in v1.3.0 

type GraphQLRequiredFieldError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Name of the field missing the value.
	Field string `json:"field"`
}

* * Returned when a value is not defined for a required field. *

func (*GraphQLRequiredFieldError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLRequiredFieldError) DecodeStruct(src map[string]interface{}) error

func (GraphQLRequiredFieldError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLRequiredFieldError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLRequiredFieldError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLRequiredFieldError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLResourceNotFoundError ¶ added in v1.3.0 

type GraphQLResourceNotFoundError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the resource addressed by the request URL does not exist. *

func (*GraphQLResourceNotFoundError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLResourceNotFoundError) DecodeStruct(src map[string]interface{}) error

func (GraphQLResourceNotFoundError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLResourceNotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLResourceNotFoundError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLResourceNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLResourceSizeLimitExceededError ¶ added in v1.3.0 

type GraphQLResourceSizeLimitExceededError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the resource exceeds the maximum allowed size of 16 MB. *

func (*GraphQLResourceSizeLimitExceededError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLResourceSizeLimitExceededError) DecodeStruct(src map[string]interface{}) error

func (GraphQLResourceSizeLimitExceededError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLResourceSizeLimitExceededError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLResourceSizeLimitExceededError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLResourceSizeLimitExceededError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLResponse ¶ 

type GraphQLResponse struct {
	Data   interface{}    `json:"data,omitempty"`
	Errors []GraphQLError `json:"errors"`
}

func (GraphQLResponse) MarshalJSON ¶ 

func (obj GraphQLResponse) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type GraphQLSearchDeactivatedError ¶ added in v1.3.0 

type GraphQLSearchDeactivatedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the indexing of Product information is deactivated in a Project. * * To activate indexing, call [Change Product Search Indexing Enabled](ctp:api:type:ProjectChangeProductSearchIndexingEnabledAction) and set `enabled` to `true`. *

func (*GraphQLSearchDeactivatedError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLSearchDeactivatedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLSearchDeactivatedError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLSearchDeactivatedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLSearchDeactivatedError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLSearchDeactivatedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLSearchExecutionFailureError ¶ added in v1.3.0 

type GraphQLSearchExecutionFailureError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a search query could not be completed due to an unexpected failure. *

func (*GraphQLSearchExecutionFailureError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLSearchExecutionFailureError) DecodeStruct(src map[string]interface{}) error

func (GraphQLSearchExecutionFailureError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLSearchExecutionFailureError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLSearchExecutionFailureError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLSearchExecutionFailureError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLSearchFacetPathNotFoundError ¶ added in v1.3.0 

type GraphQLSearchFacetPathNotFoundError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a search facet path could not be found. *

func (*GraphQLSearchFacetPathNotFoundError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLSearchFacetPathNotFoundError) DecodeStruct(src map[string]interface{}) error

func (GraphQLSearchFacetPathNotFoundError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLSearchFacetPathNotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLSearchFacetPathNotFoundError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLSearchFacetPathNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLSearchIndexingInProgressError ¶ added in v1.3.0 

type GraphQLSearchIndexingInProgressError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the indexing of Product information is still in progress for Projects that have indexing activated. *

func (*GraphQLSearchIndexingInProgressError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLSearchIndexingInProgressError) DecodeStruct(src map[string]interface{}) error

func (GraphQLSearchIndexingInProgressError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLSearchIndexingInProgressError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLSearchIndexingInProgressError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLSearchIndexingInProgressError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLSemanticErrorError ¶ added in v1.3.0 

type GraphQLSemanticErrorError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a [Discount predicate](/../api/predicates/predicate-operators) or [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions) is not semantically correct. *

func (*GraphQLSemanticErrorError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLSemanticErrorError) DecodeStruct(src map[string]interface{}) error

func (GraphQLSemanticErrorError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLSemanticErrorError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLSemanticErrorError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLSemanticErrorError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLShippingMethodDoesNotMatchCartError ¶ added in v1.3.0 

type GraphQLShippingMethodDoesNotMatchCartError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the Cart contains a ShippingMethod(ctp:api:type:ShippingMethod) that is not allowed for the Cart(ctp:api:type:Cart). In this case, the ShippingMethodState(ctp:api:type:ShippingMethodState) value is `DoesNotMatchCart`. * * The error is returned as a failed response to the [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) or [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. *

func (*GraphQLShippingMethodDoesNotMatchCartError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLShippingMethodDoesNotMatchCartError) DecodeStruct(src map[string]interface{}) error

func (GraphQLShippingMethodDoesNotMatchCartError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLShippingMethodDoesNotMatchCartError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLShippingMethodDoesNotMatchCartError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLShippingMethodDoesNotMatchCartError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLStoreCartDiscountsLimitReachedError ¶ added in v1.4.0 

type GraphQLStoreCartDiscountsLimitReachedError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Stores for which the limit for active Cart Discounts that can exist has been reached.
	Stores []StoreKeyReference `json:"stores"`
}

* * Returned when a Cart Discount cannot be created or assigned to a Store as the [limit](/../api/limits#cart-discounts) for active Cart Discounts in a Store has been reached for one or more Stores in the request. * * The error is returned as a failed response to: * * - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests * - [Add Store](ctp:api:type:CartDiscountAddStoreAction) and [Set Store](ctp:api:type:CartDiscountSetStoresAction) update actions *

func (*GraphQLStoreCartDiscountsLimitReachedError) DecodeStruct ¶ added in v1.4.0 

func (obj *GraphQLStoreCartDiscountsLimitReachedError) DecodeStruct(src map[string]interface{}) error

func (GraphQLStoreCartDiscountsLimitReachedError) MarshalJSON ¶ added in v1.4.0 

func (obj GraphQLStoreCartDiscountsLimitReachedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLStoreCartDiscountsLimitReachedError) UnmarshalJSON ¶ added in v1.4.0 

func (obj *GraphQLStoreCartDiscountsLimitReachedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLSyntaxErrorError ¶ added in v1.3.0 

type GraphQLSyntaxErrorError struct {
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax. *

func (*GraphQLSyntaxErrorError) DecodeStruct ¶ added in v1.3.0 

func (obj *GraphQLSyntaxErrorError) DecodeStruct(src map[string]interface{}) error

func (GraphQLSyntaxErrorError) MarshalJSON ¶ added in v1.3.0 

func (obj GraphQLSyntaxErrorError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*GraphQLSyntaxErrorError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *GraphQLSyntaxErrorError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type GraphQLVariablesMap ¶ 

type GraphQLVariablesMap map[string]interface{}

type HighPrecisionMoney ¶ 

type HighPrecisionMoney struct {
	// Amount in the smallest indivisible unit of a currency, such as:
	//
	// * Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as `500`).
	// * The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as `5`).
	CentAmount int `json:"centAmount"`
	// Currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
	CurrencyCode string `json:"currencyCode"`
	// Number of digits after the decimal separator, greater than the default number of fraction digits for a currency.
	FractionDigits int `json:"fractionDigits"`
	// Amount in 1 / (10 ^ `fractionDigits`) of a currency.
	PreciseAmount int `json:"preciseAmount"`
}

* * Money object that stores an amount of a fraction of the smallest indivisible unit of the specified currency.

func (HighPrecisionMoney) MarshalJSON ¶ 

func (obj HighPrecisionMoney) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type HighPrecisionMoneyDraft ¶ 

type HighPrecisionMoneyDraft struct {
	// Amount in the smallest indivisible unit of a currency. This field is optional for high precision. If provided, it is checked for validity. Example:
	//
	// A Price of 1.015 USD can be rounded either to 1.01 USD or 1.02 USD. If it lies outside of this range, an error message stating that centAmount must be rounded correctly will be returned.
	//
	// If `centAmount` is not provided, the API calculates the value automatically using the default rounding mode half even.
	CentAmount *int `json:"centAmount,omitempty"`
	// Currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
	CurrencyCode string `json:"currencyCode"`
	// Number of fraction digits for a specified high precision money. It must be greater than the default number of fraction digits for the specified currency.
	FractionDigits int `json:"fractionDigits"`
	// Amount in 1 / (10 ^ `fractionDigits`) of a currency.
	PreciseAmount int `json:"preciseAmount"`
}

* * Money draft object to store an amount of a fraction of the smallest indivisible unit of the specified currency.

func (HighPrecisionMoneyDraft) MarshalJSON ¶ 

func (obj HighPrecisionMoneyDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Hit ¶ 

type Hit struct {
	// Unique identifier of the Order.
	ID string `json:"id"`
	// Current version of the Order.
	Version int `json:"version"`
	// The higher the value is, the more relevant the hit is for the search request.
	Relevance *float64 `json:"relevance,omitempty"`
}

type HttpDestination ¶ 

type HttpDestination struct {
	// URL to the target destination. If the Project is hosted in the China (AWS, Ningxia) Region, verify that the URL is not blocked due to firewall restrictions.
	Url string `json:"url"`
	// Authentication methods (such as `Basic` or `Bearer`).
	Authentication HttpDestinationAuthentication `json:"authentication,omitempty"`
}

* * We recommend an encrypted `HTTPS` connection for production setups. However, we also accept unencrypted `HTTP` connections for development purposes. HTTP redirects will not be followed and cache headers will be ignored. *

func (HttpDestination) MarshalJSON ¶ 

func (obj HttpDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*HttpDestination) UnmarshalJSON ¶ 

func (obj *HttpDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type HttpDestinationAuthentication ¶ 

type HttpDestinationAuthentication interface{}

type Image ¶ 

type Image struct {
	// URL of the image in its original size that must be unique within a single [ProductVariant](ctp:api:type:ProductVariant). If the Project is hosted in the China (AWS, Ningxia) Region, verify that the URL is not blocked due to firewall restrictions.
	Url string `json:"url"`
	// Dimensions of the original image.
	Dimensions ImageDimensions `json:"dimensions"`
	// Custom label for the image.
	Label *string `json:"label,omitempty"`
}

type ImageDimensions ¶ 

type ImageDimensions struct {
	// Width of the image.
	W int `json:"w"`
	// Height of the image.
	H int `json:"h"`
}

type IndividualExclusionProductSelectionType ¶ added in v1.3.0 

type IndividualExclusionProductSelectionType struct {
	// The name of the ProductSelection which is recommended to be unique.
	Name LocalizedString `json:"name"`
}

func (IndividualExclusionProductSelectionType) MarshalJSON ¶ added in v1.3.0 

func (obj IndividualExclusionProductSelectionType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type IndividualProductSelectionType ¶ 

type IndividualProductSelectionType struct {
	// The name of the ProductSelection which is recommended to be unique.
	Name LocalizedString `json:"name"`
}

func (IndividualProductSelectionType) MarshalJSON ¶ 

func (obj IndividualProductSelectionType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InheritedAssociate ¶ added in v1.3.0 

type InheritedAssociate struct {
	// Inherited roles of the Associate within a Business Unit.
	AssociateRoleAssignments []InheritedAssociateRoleAssignment `json:"associateRoleAssignments"`
	// The [Customer](ctp:api:type:Customer) that acts as an Associate in the Business Unit.
	Customer CustomerReference `json:"customer"`
}

type InheritedAssociateRoleAssignment ¶ added in v1.3.0 

type InheritedAssociateRoleAssignment struct {
	// Inherited role the Associate holds within a Business Unit.
	AssociateRole AssociateRoleKeyReference `json:"associateRole"`
	// Reference to the parent Business Unit where the assignment is defined explicitly.
	Source BusinessUnitKeyReference `json:"source"`
}

type InsufficientScopeError ¶ 

type InsufficientScopeError struct {
	// Plain text description of the cause of the error.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

func (*InsufficientScopeError) DecodeStruct ¶ added in v1.1.0 

func (obj *InsufficientScopeError) DecodeStruct(src map[string]interface{}) error

func (InsufficientScopeError) Error ¶ 

func (obj InsufficientScopeError) Error() string

func (InsufficientScopeError) MarshalJSON ¶ 

func (obj InsufficientScopeError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InsufficientScopeError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InsufficientScopeError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InternalConstraintViolatedError ¶ 

type InternalConstraintViolatedError struct {
	// Plain text description of the constraints that were violated.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when certain API-specific constraints were not met. For example, the specified [Discount Code](ctp:api:type:DiscountCode) was never applied and cannot be updated. *

func (*InternalConstraintViolatedError) DecodeStruct ¶ added in v1.1.0 

func (obj *InternalConstraintViolatedError) DecodeStruct(src map[string]interface{}) error

func (InternalConstraintViolatedError) Error ¶ 

func (obj InternalConstraintViolatedError) Error() string

func (InternalConstraintViolatedError) MarshalJSON ¶ 

func (obj InternalConstraintViolatedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InternalConstraintViolatedError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InternalConstraintViolatedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InvalidCredentialsError ¶ 

type InvalidCredentialsError struct {
	// `"Account with the given credentials not found."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails. * * The error is returned as a failed response to: * * - [Authenticate a global Customer (Sign-in)](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate Customer (Sign-in) in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests on Customers. * - [Authenticating Customer (Sign-in)](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate Customer (Sign-in) in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile. *

func (*InvalidCredentialsError) DecodeStruct ¶ added in v1.1.0 

func (obj *InvalidCredentialsError) DecodeStruct(src map[string]interface{}) error

func (InvalidCredentialsError) Error ¶ 

func (obj InvalidCredentialsError) Error() string

func (InvalidCredentialsError) MarshalJSON ¶ 

func (obj InvalidCredentialsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InvalidCredentialsError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InvalidCredentialsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InvalidCurrentPasswordError ¶ 

type InvalidCurrentPasswordError struct {
	// `"The given current password does not match."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the current password of the Customer does not match. * * The error is returned as a failed response to: * * - [Change Customer Password](ctp:api:endpoint:/{projectKey}/customers/password:POST) and [Change Customer Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password:POST) requests on Customers. * - [Change Customer Password](ctp:api:endpoint:/{projectKey}/me/password:POST) and [Change Customer Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/password:POST) requests on My Customer Profile. *

func (*InvalidCurrentPasswordError) DecodeStruct ¶ added in v1.1.0 

func (obj *InvalidCurrentPasswordError) DecodeStruct(src map[string]interface{}) error

func (InvalidCurrentPasswordError) Error ¶ 

func (obj InvalidCurrentPasswordError) Error() string

func (InvalidCurrentPasswordError) MarshalJSON ¶ 

func (obj InvalidCurrentPasswordError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InvalidCurrentPasswordError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InvalidCurrentPasswordError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InvalidFieldError ¶ 

type InvalidFieldError struct {
	// `"The value $invalidValue is not valid for field $field."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Name of the field with the invalid value.
	Field string `json:"field"`
	// Value invalid for the field.
	InvalidValue interface{} `json:"invalidValue"`
	// Fixed set of allowed values for the field, if any.
	AllowedValues []interface{} `json:"allowedValues"`
}

* * Returned when a field has an invalid value. *

func (*InvalidFieldError) DecodeStruct ¶ added in v1.1.0 

func (obj *InvalidFieldError) DecodeStruct(src map[string]interface{}) error

func (InvalidFieldError) Error ¶ 

func (obj InvalidFieldError) Error() string

func (InvalidFieldError) MarshalJSON ¶ 

func (obj InvalidFieldError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InvalidFieldError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InvalidFieldError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InvalidInputError ¶ 

type InvalidInputError struct {
	// Description of the constraints that are not met by the request. For example, `"Invalid $propertyName. It may be a non-empty string up to $maxLength"`.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when an invalid input has been sent. *

func (*InvalidInputError) DecodeStruct ¶ added in v1.1.0 

func (obj *InvalidInputError) DecodeStruct(src map[string]interface{}) error

func (InvalidInputError) Error ¶ 

func (obj InvalidInputError) Error() string

func (InvalidInputError) MarshalJSON ¶ 

func (obj InvalidInputError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InvalidInputError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InvalidInputError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InvalidItemShippingDetailsError ¶ 

type InvalidItemShippingDetailsError struct {
	// `"Inconsistent shipping details for $subject with ID $itemId. $subject quantity is $itemQuantity and shippingTargets quantity sum is $quantitySum."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// `"LineItem"` or `"CustomLineItem"`
	Subject string `json:"subject"`
	// Unique identifier of the Line Item or Custom Line Item.
	ItemId string `json:"itemId"`
}

* * Returned when Line Item or Custom Line Item quantities set under ItemShippingDetails(ctp:api:type:ItemShippingDetails) do not match the sum of the quantities in their respective shipping details. * * The error is returned as a failed response to the [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. *

func (*InvalidItemShippingDetailsError) DecodeStruct ¶ added in v1.1.0 

func (obj *InvalidItemShippingDetailsError) DecodeStruct(src map[string]interface{}) error

func (InvalidItemShippingDetailsError) Error ¶ 

func (obj InvalidItemShippingDetailsError) Error() string

func (InvalidItemShippingDetailsError) MarshalJSON ¶ 

func (obj InvalidItemShippingDetailsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InvalidItemShippingDetailsError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InvalidItemShippingDetailsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

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 ¶ added in v1.1.0 

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 ¶ added in v1.1.0 

func (obj *InvalidJsonInputError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InvalidOperationError ¶ 

type InvalidOperationError struct {
	// Plain text description of the error.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the resources involved in the request are not in a valid state for the operation. * * The client application should validate the constraints described in the error message before sending the request. *

func (*InvalidOperationError) DecodeStruct ¶ added in v1.1.0 

func (obj *InvalidOperationError) DecodeStruct(src map[string]interface{}) error

func (InvalidOperationError) Error ¶ 

func (obj InvalidOperationError) Error() string

func (InvalidOperationError) MarshalJSON ¶ 

func (obj InvalidOperationError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InvalidOperationError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InvalidOperationError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InvalidSubjectError ¶ 

type InvalidSubjectError struct {
	// Plain text description of the cause of the error.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

func (*InvalidSubjectError) DecodeStruct ¶ added in v1.1.0 

func (obj *InvalidSubjectError) DecodeStruct(src map[string]interface{}) error

func (InvalidSubjectError) Error ¶ 

func (obj InvalidSubjectError) Error() string

func (InvalidSubjectError) MarshalJSON ¶ 

func (obj InvalidSubjectError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InvalidSubjectError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InvalidSubjectError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InvalidTokenError ¶ 

type InvalidTokenError struct {
	// Plain text description of the cause of the error.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

func (*InvalidTokenError) DecodeStruct ¶ added in v1.1.0 

func (obj *InvalidTokenError) DecodeStruct(src map[string]interface{}) error

func (InvalidTokenError) Error ¶ 

func (obj InvalidTokenError) Error() string

func (InvalidTokenError) MarshalJSON ¶ 

func (obj InvalidTokenError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InvalidTokenError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *InvalidTokenError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InventoryEntry ¶ 

type InventoryEntry struct {
	// Unique identifier of the InventoryEntry.
	ID string `json:"id"`
	// Current version of the InventoryEntry.
	Version int `json:"version"`
	// Date and time (UTC) the InventoryEntry was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the InventoryEntry was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the InventoryEntry.
	Key *string `json:"key,omitempty"`
	// [ProductVariant](ctp:api:type:ProductVariant) `sku` of the InventoryEntry.
	Sku string `json:"sku"`
	// [Channel](ctp:api:type:Channel) that supplies this InventoryEntry.
	SupplyChannel *ChannelReference `json:"supplyChannel,omitempty"`
	// Overall amount of stock (`availableQuantity` + reserved).
	QuantityOnStock int `json:"quantityOnStock"`
	// Available amount of stock (`quantityOnStock` - reserved).
	AvailableQuantity int `json:"availableQuantity"`
	// How often the InventoryEntry is restocked (in days).
	RestockableInDays *int `json:"restockableInDays,omitempty"`
	// Date and time of the next restock.
	ExpectedDelivery *time.Time `json:"expectedDelivery,omitempty"`
	// Custom Fields of the InventoryEntry.
	Custom *CustomFields `json:"custom,omitempty"`
}

type InventoryEntryAddQuantityAction ¶ 

type InventoryEntryAddQuantityAction struct {
	// Value to add to `quantityOnStock`.
	Quantity int `json:"quantity"`
}

* * Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.

func (InventoryEntryAddQuantityAction) MarshalJSON ¶ 

func (obj InventoryEntryAddQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntryChangeQuantityAction ¶ 

type InventoryEntryChangeQuantityAction struct {
	// Value to set for `quantityOnStock`.
	Quantity int `json:"quantity"`
}

* * Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.

func (InventoryEntryChangeQuantityAction) MarshalJSON ¶ 

func (obj InventoryEntryChangeQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntryCreatedMessage ¶ 

type InventoryEntryCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [InventoryEntry](ctp:api:type:InventoryEntry) that was created.
	InventoryEntry InventoryEntry `json:"inventoryEntry"`
}

* * Generated after a successful [Create InventoryEntry](ctp:api:endpoint:/{projectKey}/inventory:POST) request. *

func (InventoryEntryCreatedMessage) MarshalJSON ¶ 

func (obj InventoryEntryCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InventoryEntryCreatedMessage) UnmarshalJSON ¶ 

func (obj *InventoryEntryCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InventoryEntryCreatedMessagePayload ¶ 

type InventoryEntryCreatedMessagePayload struct {
	// [InventoryEntry](ctp:api:type:InventoryEntry) that was created.
	InventoryEntry InventoryEntry `json:"inventoryEntry"`
}

* * Generated after a successful [Create InventoryEntry](ctp:api:endpoint:/{projectKey}/inventory:POST) request. *

func (InventoryEntryCreatedMessagePayload) MarshalJSON ¶ 

func (obj InventoryEntryCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntryDeletedMessage ¶ 

type InventoryEntryDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `sku` of the [InventoryEntry](ctp:api:type:InventoryEntry) that was deleted.
	Sku string `json:"sku"`
	// [Reference](ctp:api:type:Reference) to the [Channel](ctp:api:type:Channel) where the [InventoryEntry](ctp:api:type:InventoryEntry) was deleted.
	SupplyChannel *ChannelReference `json:"supplyChannel,omitempty"`
}

* * Generated after a successful [Delete InventoryEntry](/../api/projects/inventory#delete-inventoryentry) request. *

func (InventoryEntryDeletedMessage) MarshalJSON ¶ 

func (obj InventoryEntryDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InventoryEntryDeletedMessage) UnmarshalJSON ¶ 

func (obj *InventoryEntryDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InventoryEntryDeletedMessagePayload ¶ 

type InventoryEntryDeletedMessagePayload struct {
	// The `sku` of the [InventoryEntry](ctp:api:type:InventoryEntry) that was deleted.
	Sku string `json:"sku"`
	// [Reference](ctp:api:type:Reference) to the [Channel](ctp:api:type:Channel) where the [InventoryEntry](ctp:api:type:InventoryEntry) was deleted.
	SupplyChannel *ChannelReference `json:"supplyChannel,omitempty"`
}

* * Generated after a successful [Delete InventoryEntry](/../api/projects/inventory#delete-inventoryentry) request. *

func (InventoryEntryDeletedMessagePayload) MarshalJSON ¶ 

func (obj InventoryEntryDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntryDraft ¶ 

type InventoryEntryDraft struct {
	// [ProductVariant](ctp:api:type:ProductVariant) `sku` of the InventoryEntry.
	Sku string `json:"sku"`
	// User-defined unique identifier for the InventoryEntry.
	Key *string `json:"key,omitempty"`
	// [Channel](ctp:api:type:Channel) that supplies this InventoryEntry.
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
	// Overall amount of stock.
	QuantityOnStock int `json:"quantityOnStock"`
	// How often the InventoryEntry is restocked (in days).
	RestockableInDays *int `json:"restockableInDays,omitempty"`
	// Date and time of the next restock.
	ExpectedDelivery *time.Time `json:"expectedDelivery,omitempty"`
	// Custom Fields of the InventoryEntry.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

type InventoryEntryQuantitySetMessage ¶ 

type InventoryEntryQuantitySetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Quantity on stock for the [InventoryEntry](ctp:api:type:InventoryEntry) before the quantity was updated.
	OldQuantityOnStock int `json:"oldQuantityOnStock"`
	// Quantity on stock for the [InventoryEntry](ctp:api:type:InventoryEntry) after the quantity was updated.
	NewQuantityOnStock int `json:"newQuantityOnStock"`
	// Available quantity for the [InventoryEntry](ctp:api:type:InventoryEntry) before the quantity was updated.
	OldAvailableQuantity int `json:"oldAvailableQuantity"`
	// Available quantity for the [InventoryEntry](ctp:api:type:InventoryEntry) after the quantity was updated.
	NewAvailableQuantity int `json:"newAvailableQuantity"`
	// [Reference](ctp:api:type:Reference) to the [Channel](ctp:api:type:Channel) where the [InventoryEntry](ctp:api:type:InventoryEntry) quantity was set.
	SupplyChannel *ChannelReference `json:"supplyChannel,omitempty"`
}

* * Generated after a successful [Add Quantity](ctp:api:type:InventoryEntryAddQuantityAction), [Remove Quantity](ctp:api:type:InventoryEntryRemoveQuantityAction) or [Change Quantity](ctp:api:type:InventoryEntryChangeQuantityAction) update action. * Inventory changes as a result of [Order creation](ctp:api:endpoint:/{projectKey}/orders:POST) do not trigger this message. *

func (InventoryEntryQuantitySetMessage) MarshalJSON ¶ 

func (obj InventoryEntryQuantitySetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*InventoryEntryQuantitySetMessage) UnmarshalJSON ¶ 

func (obj *InventoryEntryQuantitySetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InventoryEntryQuantitySetMessagePayload ¶ 

type InventoryEntryQuantitySetMessagePayload struct {
	// Quantity on stock for the [InventoryEntry](ctp:api:type:InventoryEntry) before the quantity was updated.
	OldQuantityOnStock int `json:"oldQuantityOnStock"`
	// Quantity on stock for the [InventoryEntry](ctp:api:type:InventoryEntry) after the quantity was updated.
	NewQuantityOnStock int `json:"newQuantityOnStock"`
	// Available quantity for the [InventoryEntry](ctp:api:type:InventoryEntry) before the quantity was updated.
	OldAvailableQuantity int `json:"oldAvailableQuantity"`
	// Available quantity for the [InventoryEntry](ctp:api:type:InventoryEntry) after the quantity was updated.
	NewAvailableQuantity int `json:"newAvailableQuantity"`
	// [Reference](ctp:api:type:Reference) to the [Channel](ctp:api:type:Channel) where the [InventoryEntry](ctp:api:type:InventoryEntry) quantity was set.
	SupplyChannel *ChannelReference `json:"supplyChannel,omitempty"`
}

* * Generated after a successful [Add Quantity](ctp:api:type:InventoryEntryAddQuantityAction), [Remove Quantity](ctp:api:type:InventoryEntryRemoveQuantityAction) or [Change Quantity](ctp:api:type:InventoryEntryChangeQuantityAction) update action. * Inventory changes as a result of [Order creation](ctp:api:endpoint:/{projectKey}/orders:POST) do not trigger this message. *

func (InventoryEntryQuantitySetMessagePayload) MarshalJSON ¶ 

func (obj InventoryEntryQuantitySetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntryReference ¶ 

type InventoryEntryReference struct {
	// Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry).
	ID string `json:"id"`
	// Contains the representation of the expanded InventoryEntry. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for InventoryEntries.
	Obj *InventoryEntry `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to an InventoryEntry(ctp:api:type:InventoryEntry). *

func (InventoryEntryReference) MarshalJSON ¶ 

func (obj InventoryEntryReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntryRemoveQuantityAction ¶ 

type InventoryEntryRemoveQuantityAction struct {
	// Value to remove from `quantityOnStock`.
	Quantity int `json:"quantity"`
}

* * Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.

func (InventoryEntryRemoveQuantityAction) MarshalJSON ¶ 

func (obj InventoryEntryRemoveQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntryResourceIdentifier ¶ 

type InventoryEntryResourceIdentifier struct {
	// Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to an InventoryEntry(ctp:api:type:InventoryEntry). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (InventoryEntryResourceIdentifier) MarshalJSON ¶ 

func (obj InventoryEntryResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntrySetCustomFieldAction ¶ 

type InventoryEntrySetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (InventoryEntrySetCustomFieldAction) MarshalJSON ¶ 

func (obj InventoryEntrySetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntrySetCustomTypeAction ¶ 

type InventoryEntrySetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the InventoryEntry with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the InventoryEntry.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the InventoryEntry.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (InventoryEntrySetCustomTypeAction) MarshalJSON ¶ 

func (obj InventoryEntrySetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntrySetExpectedDeliveryAction ¶ 

type InventoryEntrySetExpectedDeliveryAction struct {
	// Value to set. If empty, any existing value will be removed.
	ExpectedDelivery *time.Time `json:"expectedDelivery,omitempty"`
}

func (InventoryEntrySetExpectedDeliveryAction) MarshalJSON ¶ 

func (obj InventoryEntrySetExpectedDeliveryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntrySetKeyAction ¶ 

type InventoryEntrySetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (InventoryEntrySetKeyAction) MarshalJSON ¶ 

func (obj InventoryEntrySetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntrySetRestockableInDaysAction ¶ 

type InventoryEntrySetRestockableInDaysAction struct {
	// Value to set. If empty, any existing value will be removed.
	RestockableInDays *int `json:"restockableInDays,omitempty"`
}

func (InventoryEntrySetRestockableInDaysAction) MarshalJSON ¶ 

func (obj InventoryEntrySetRestockableInDaysAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntrySetSupplyChannelAction ¶ 

type InventoryEntrySetSupplyChannelAction struct {
	// Value to set. If empty, any existing value will be removed.
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
}

* * If an entry with the same `sku` and `supplyChannel` already exists, an [DuplicateField](ctp:api:type:DuplicateFieldError) error is returned.

func (InventoryEntrySetSupplyChannelAction) MarshalJSON ¶ 

func (obj InventoryEntrySetSupplyChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type InventoryEntryUpdate ¶ 

type InventoryEntryUpdate struct {
	// Expected version of the InventoryEntry on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the InventoryEntry.
	Actions []InventoryEntryUpdateAction `json:"actions"`
}

func (*InventoryEntryUpdate) UnmarshalJSON ¶ 

func (obj *InventoryEntryUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type InventoryEntryUpdateAction ¶ 

type InventoryEntryUpdateAction interface{}

type InventoryMode ¶ 

type InventoryMode string

* * Indicates how Line Items in a Cart are tracked. * 

const (
	InventoryModeNone           InventoryMode = "None"
	InventoryModeTrackOnly      InventoryMode = "TrackOnly"
	InventoryModeReserveOnOrder InventoryMode = "ReserveOnOrder"
)

type InventoryPagedQueryResponse ¶ 

type InventoryPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Inventory entries](ctp:api:type:InventoryEntry) matching the query.
	Results []InventoryEntry `json:"results"`
}

type IronMqDestination ¶ 

type IronMqDestination struct {
	Uri string `json:"uri"`
}

func (IronMqDestination) MarshalJSON ¶ 

func (obj IronMqDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ItemShippingDetails ¶ 

type ItemShippingDetails struct {
	// Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped.
	Targets []ItemShippingTarget `json:"targets"`
	// - `true` if the quantity of Line Items or Custom Line Items is equal to the sum of sub-quantities defined in `targets`.
	// - `false` if the quantity of Line Items or Custom Line Items is not equal to the sum of sub-quantities defined in `targets`.
	//   Ordering a Cart when the value is `false` returns an [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) error.
	Valid bool `json:"valid"`
}

type ItemShippingDetailsDraft ¶ 

type ItemShippingDetailsDraft struct {
	// Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped.
	//
	// If multiple shipping addresses are present for a Line Item or Custom Line Item, sub-quantities must be specified.
	Targets []ItemShippingTarget `json:"targets"`
}

* * For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items. *

type ItemShippingTarget ¶ 

type ItemShippingTarget struct {
	// Key of the address in the [Cart](ctp:api:type:Cart) `itemShippingAddresses`.
	// Duplicate address keys are not allowed.
	AddressKey string `json:"addressKey"`
	// Quantity of Line Items or Custom Line Items shipped to the address with the specified `addressKey`.
	//
	// If a quantity is updated to `0` when defining [ItemShippingDetailsDraft](ctp:api:type:ItemShippingDetailsDraft), the `targets` are removed from a Line Item or Custom Line Item in the resulting [ItemShippingDetails](ctp:api:type:ItemShippingDetails).
	Quantity int `json:"quantity"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	//
	// It connects Line Item or Custom Line Item quantities with individual Shipping Methods.
	ShippingMethodKey *string `json:"shippingMethodKey,omitempty"`
}

* * Determines the address (as a reference to an address in `itemShippingAddresses`) and the quantity shipped to the address. * * If multiple shipping addresses are present for a Line Item or Custom Line Item, sub-quantities must be specified. * An array of addresses and sub-quantities is stored per Line Item or Custom Line Item. *

type ItemState ¶ 

type ItemState struct {
	// Number of Line Items or Custom Line Items in this State.
	Quantity int `json:"quantity"`
	// State of the Line Items or Custom Line Items in a custom workflow.
	State StateReference `json:"state"`
}

type KeyReference ¶ 

type KeyReference interface{}

* * A KeyReference represents a loose reference to another resource in the same Project identified by the resource's `key` field. If available, the `key` is immutable and mandatory. KeyReferences do not support [Reference Expansion](/general-concepts#reference-expansion). *

type LanguageUsedInStoresError ¶ 

type LanguageUsedInStoresError struct {
	// `"Language(s) in use by a store cannot be deleted. Remove them in all the stores of this project first."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a language cannot be removed from a Project as it is being used by a Store. * * The error is returned as a failed response to the [Change Languages](ctp:api:type:ProjectChangeLanguagesAction) update action. *

func (*LanguageUsedInStoresError) DecodeStruct ¶ added in v1.1.0 

func (obj *LanguageUsedInStoresError) DecodeStruct(src map[string]interface{}) error

func (LanguageUsedInStoresError) Error ¶ 

func (obj LanguageUsedInStoresError) Error() string

func (LanguageUsedInStoresError) MarshalJSON ¶ 

func (obj LanguageUsedInStoresError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*LanguageUsedInStoresError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *LanguageUsedInStoresError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type LastModifiedBy ¶ 

type LastModifiedBy struct {
	// `id` of the [API Client](ctp:api:type:ApiClient) which modified the resource.
	ClientId *string `json:"clientId,omitempty"`
	// [External user ID](/../api/general-concepts#external-user-ids) provided by `X-External-User-ID` HTTP Header or [`external_user_id:{externalUserId}`](/../api/scopes#external_user_idexternaluserid) scope.
	ExternalUserId *string `json:"externalUserId,omitempty"`
	// Indicates the [Customer](ctp:api:type:Customer) who modified the resource using a token from the [password flow](/authorization#password-flow).
	Customer *CustomerReference `json:"customer,omitempty"`
	// Indicates the [anonymous session](ctp:api:type:AnonymousSession) during which the resource was modified.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// Indicates the [Customer](ctp:api:type:Customer) who modified the resource in the context of a [Business Unit](ctp:api:type:BusinessUnit). Only present when an Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).
	Associate *CustomerReference `json:"associate,omitempty"`
}

* * Present on resources modified after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).

type LineItem ¶ 

type LineItem struct {
	// Unique identifier of the LineItem.
	ID string `json:"id"`
	// User-defined unique identifier of the LineItem.
	Key *string `json:"key,omitempty"`
	// `id` of the [Product](ctp:api:type:Product) the Line Item is based on.
	ProductId string `json:"productId"`
	// `key` of the [Product](ctp:api:type:Product).
	//
	// This field is only present on:
	//
	// - Line Items in a [Cart](ctp:api:type:Cart) when the `key` is available on that specific Product at the time the LineItem was created or updated on the Cart.
	// - Line Items in an [Order](ctp:api:type:Order) when the `key` is available on the specific Product at the time the Order was created from the Cart.
	//
	// Present on resources created or updated after 3 December 2021.
	ProductKey *string `json:"productKey,omitempty"`
	// Name of the Product.
	Name LocalizedString `json:"name"`
	// `slug` of the current version of the Product. Updated automatically if the `slug` changes. Empty if the Product has been deleted.
	// The `productSlug` field of LineItem is not expanded when using [Reference Expansion](/../api/general-concepts#reference-expansion).
	ProductSlug *LocalizedString `json:"productSlug,omitempty"`
	// Product Type of the Product.
	ProductType ProductTypeReference `json:"productType"`
	// Holds the data of the Product Variant added to the Cart.
	//
	// The data is saved at the time the Product Variant is added to the Cart and is not updated automatically when Product Variant data changes.
	// Must be updated using the [Recalculate](ctp:api:type:CartRecalculateAction) update action.
	Variant ProductVariant `json:"variant"`
	// Price of a Line Item selected from the Product Variant according to the [Product](ctp:api:type:Product) `priceMode`. If the `priceMode` is `Embedded` [ProductPriceMode](ctp:api:type:ProductPriceModeEnum) and the `variant` field hasn't been updated, the price may not correspond to a price in `variant.prices`.
	Price Price `json:"price"`
	// Number of Line Items of the given Product Variant present in the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order).
	Quantity int `json:"quantity"`
	// Total price of this Line Item equalling `price` multiplied by `quantity`. If the Line Item is discounted, the total price is the `discountedPricePerQuantity` multiplied by `quantity`.
	// Includes taxes if the [TaxRate](ctp:api:type:TaxRate) `includedInPrice` is `true`.
	TotalPrice CentPrecisionMoney `json:"totalPrice"`
	// Discounted price of a single quantity of the Line Item.
	DiscountedPricePerQuantity []DiscountedLineItemPriceForQuantity `json:"discountedPricePerQuantity"`
	// Automatically set after `taxRate` is set.
	TaxedPrice *TaxedItemPrice `json:"taxedPrice,omitempty"`
	// Total taxed prices based on the quantity of Line Item assigned to each [Shipping Method](ctp:api:type:ShippingMethod). Only applicable for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	// Automatically set after `perMethodTaxRate` is set.
	TaxedPricePortions []MethodTaxedPrice `json:"taxedPricePortions"`
	// State of the Line Item in the [Cart](ctp:api:type:Cart) or the [Order](ctp:api:type:Order).
	State []ItemState `json:"state"`
	// - For a Cart with `Platform` [TaxMode](ctp:api:type:TaxMode), the `taxRate` of Line Items is set automatically once a shipping address is set. The rate is based on the [TaxCategory](ctp:api:type:TaxCategory) that applies for the shipping address.
	// - For a Cart with `External` TaxMode, the `taxRate` of Line Items can be set using [ExternalTaxRateDraft](ctp:api:type:ExternalTaxRateDraft).
	TaxRate *TaxRate `json:"taxRate,omitempty"`
	// Tax Rate per Shipping Method for a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode). For a Cart with `Platform` [TaxMode](ctp:api:type:TaxMode) it is automatically set after the [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).
	// For a Cart with `External` [TaxMode](ctp:api:type:TaxMode), the Tax Rate must be set with [ExternalTaxRateDraft](ctp:api:type:ExternalTaxRateDraft).
	PerMethodTaxRate []MethodTaxRate `json:"perMethodTaxRate"`
	// Identifies [Inventory entries](/../api/projects/inventory) that are reserved. The referenced Channel has the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelReference `json:"supplyChannel,omitempty"`
	// Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price. The referenced Channel has the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	DistributionChannel *ChannelReference `json:"distributionChannel,omitempty"`
	// Indicates how the Price for the Line Item is set.
	PriceMode LineItemPriceMode `json:"priceMode"`
	// Indicates how the Line Item is added to the Cart.
	LineItemMode LineItemMode `json:"lineItemMode"`
	// Inventory mode specific to this Line Item only, and valid for the entire `quantity` of the Line Item.
	// Only present if the inventory mode is different from the `inventoryMode` specified on the [Cart](ctp:api:type:Cart).
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Container for Line Item-specific addresses.
	ShippingDetails *ItemShippingDetails `json:"shippingDetails,omitempty"`
	// Custom Fields of the Line Item.
	Custom *CustomFields `json:"custom,omitempty"`
	// Date and time (UTC) the Line Item was added to the Cart.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Date and time (UTC) the Line Item was last updated.
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`
}

* * The representation of a [Line Item](/../api/carts-orders-overview#line-items) in a Cart(ctp:api:type:Cart) or in an Order(ctp:api:type:Order). *

type LineItemDraft ¶ 

type LineItemDraft struct {
	// User-defined unique identifier of the LineItem.
	Key *string `json:"key,omitempty"`
	// `id` of a published [Product](ctp:api:type:Product).
	ProductId *string `json:"productId,omitempty"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant) in the Product.
	// If not provided, the Master Variant is used.
	VariantId *int `json:"variantId,omitempty"`
	// `sku` of the [ProductVariant](ctp:api:type:ProductVariant).
	Sku *string `json:"sku,omitempty"`
	// Quantity of the Product Variant to add to the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// Date and time (UTC) the Product Variant is added to the Cart.
	// If not set, it defaults to the current date and time.
	//
	// Optional for backwards compatibility reasons.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price.
	// The referenced Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	//
	// If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set,
	// the Channel must match one of the Store's distribution channels.
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
	// Used to identify [Inventory entries](/../api/projects/inventory) that must be reserved.
	// The referenced Channel must have the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` value, and the `priceMode` to `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalPrice *Money `json:"externalPrice,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` and `totalPrice` values, and the `priceMode` to `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
	// Sets the external Tax Rate for the Line Item, if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Sets the external Tax Rates for individual Shipping Methods, if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode) and `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	PerMethodExternalTaxRate []MethodExternalTaxRateDraft `json:"perMethodExternalTaxRate"`
	// Inventory mode specific to the Line Item only, and valid for the entire `quantity` of the Line Item.
	// Set only if the inventory mode should be different from the `inventoryMode` specified on the [Cart](ctp:api:type:Cart).
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Container for Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// Custom Fields for the Line Item.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * For Product Variant identification, either the `productId` and `variantId`, or `sku` must be provided. *

func (LineItemDraft) MarshalJSON ¶ added in v1.4.0 

func (obj LineItemDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type LineItemImportDraft ¶ 

type LineItemImportDraft struct {
	// Name of the Line Item.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier of the Line Item.
	Key *string `json:"key,omitempty"`
	// The Product Variant to use as a [Line Item](ctp:api:type:LineItem).
	Variant ProductVariantImportDraft `json:"variant"`
	// `id` of the [Product](ctp:api:type:Product) the Product Variant belongs to.
	//
	// If provided, you must also set `variant.id`.
	ProductId *string `json:"productId,omitempty"`
	// The number of Product Variants in the LineItem. Can be a negative value.
	Quantity int `json:"quantity"`
	// The Line Item price for `quantity` = `1`. The amount can be negative.
	Price PriceDraft `json:"price"`
	// The tax rate used to calculate the `taxedPrice` of the Order.
	TaxRate *TaxRate `json:"taxRate,omitempty"`
	// The Channel used to [select a Price](ctp:api:type:LineItemPriceSelection).
	// This Channel must have the `ProductDistribution` role.
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
	// The Channel used to supply Line Items.
	// By providing supply Channel information, you can uniquely identify [Inventory entries](ctp:api:type:InventoryEntry) that should be reserved.
	// This Channel must have the `InventorySupply` role.
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
	// Inventory mode specific to the LineItem, valid for the entire `quantity` of the LineItem.
	// Set only if Inventory mode should be different from the `inventoryMode` specified on the [OrderImportDraft](ctp:api:type:OrderImportDraft).
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Container for Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// States of the Line Item.
	State []ItemState `json:"state"`
	// Custom Fields of the LineItem.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * Represents a snapshot of a Product Variant at the time it was imported with the Order. The Product Variant can be specified by providing a `productId` and `variant.id`, or by providing a `variant.sku`. *

func (LineItemImportDraft) MarshalJSON ¶ 

func (obj LineItemImportDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type LineItemMode ¶ 

type LineItemMode string

* * Indicates how a Line Item was added to a Cart. * 

const (
	LineItemModeStandard     LineItemMode = "Standard"
	LineItemModeGiftLineItem LineItemMode = "GiftLineItem"
)

type LineItemPriceMode ¶ 

type LineItemPriceMode string

* * This mode indicates how the price is set for the Line Item. * 

const (
	LineItemPriceModePlatform      LineItemPriceMode = "Platform"
	LineItemPriceModeExternalPrice LineItemPriceMode = "ExternalPrice"
	LineItemPriceModeExternalTotal LineItemPriceMode = "ExternalTotal"
)

type LineItemReturnItem ¶ 

type LineItemReturnItem struct {
	// Unique identifier of the Return Item.
	ID string `json:"id"`
	// User-defined unique identifier of the LineItemReturnItem.
	Key *string `json:"key,omitempty"`
	// Number of Line Items returned.
	Quantity int `json:"quantity"`
	// User-defined description for the return.
	Comment *string `json:"comment,omitempty"`
	// Shipment status of the Return Item.
	ShipmentState ReturnShipmentState `json:"shipmentState"`
	// Payment status of the Return Item:
	//
	// - `NonRefundable`, for items in the `Advised` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
	// - `Initial`, for items in the `Returned` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
	PaymentState ReturnPaymentState `json:"paymentState"`
	// Custom Fields of the Return Item.
	Custom *CustomFields `json:"custom,omitempty"`
	// Date and time (UTC) the Return Item was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Date and time (UTC) the Return Item was intitially created.
	CreatedAt time.Time `json:"createdAt"`
	// `id` of the returned [LineItem](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
}

func (LineItemReturnItem) MarshalJSON ¶ 

func (obj LineItemReturnItem) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type LineItemStateTransitionMessage ¶ 

type LineItemStateTransitionMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Line Item](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// User-defined unique identifier of the LineItem.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Date and time (UTC) when the transition of the [Line Item](ctp:api:type:LineItem) [State](ctp:api:type:State) was performed.
	TransitionDate time.Time `json:"transitionDate"`
	// Number of [Line Items](ctp:api:type:LineItem) for which the [State](ctp:api:type:State) was transitioned.
	Quantity int `json:"quantity"`
	// [State](ctp:api:type:State) the [Line Item](ctp:api:type:LineItem) was transitioned from.
	FromState StateReference `json:"fromState"`
	// [State](ctp:api:type:State) the [Line Item](ctp:api:type:LineItem) was transitioned to.
	ToState StateReference `json:"toState"`
}

* * Generated after a successful [Transition LineItem State](ctp:api:type:OrderTransitionLineItemStateAction) update action. *

func (LineItemStateTransitionMessage) MarshalJSON ¶ 

func (obj LineItemStateTransitionMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*LineItemStateTransitionMessage) UnmarshalJSON ¶ 

func (obj *LineItemStateTransitionMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type LineItemStateTransitionMessagePayload ¶ 

type LineItemStateTransitionMessagePayload struct {
	// Unique identifier of the [Line Item](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// User-defined unique identifier of the LineItem.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Date and time (UTC) when the transition of the [Line Item](ctp:api:type:LineItem) [State](ctp:api:type:State) was performed.
	TransitionDate time.Time `json:"transitionDate"`
	// Number of [Line Items](ctp:api:type:LineItem) for which the [State](ctp:api:type:State) was transitioned.
	Quantity int `json:"quantity"`
	// [State](ctp:api:type:State) the [Line Item](ctp:api:type:LineItem) was transitioned from.
	FromState StateReference `json:"fromState"`
	// [State](ctp:api:type:State) the [Line Item](ctp:api:type:LineItem) was transitioned to.
	ToState StateReference `json:"toState"`
}

* * Generated after a successful [Transition LineItem State](ctp:api:type:OrderTransitionLineItemStateAction) update action. *

func (LineItemStateTransitionMessagePayload) MarshalJSON ¶ 

func (obj LineItemStateTransitionMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type LocalizedString ¶ 

type LocalizedString map[string]string

* * JSON object where the keys are of type [Locale](ctp:api:type:Locale), and the values are the strings used for the corresponding language. *

type Location ¶ 

type Location struct {
	// Country code of the geographic location.
	Country string `json:"country"`
	// State within the country.
	State *string `json:"state,omitempty"`
}

* * A geographical location representing a country and optionally a state within this country. A location can only be assigned to one Zone.

type MatchingPriceNotFoundError ¶ 

type MatchingPriceNotFoundError struct {
	// `"The variant $variantId of product $productId does not contain a price for currency $currencyCode, $country, $customerGroup, $channel."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of a [Product](ctp:api:type:Product).
	ProductId string `json:"productId"`
	// Unique identifier of a [ProductVariant](ctp:api:type:ProductVariant) in the Product.
	VariantId int `json:"variantId"`
	// Currency code of the country.
	Currency *string `json:"currency,omitempty"`
	// Country code of the geographic location.
	Country *string `json:"country,omitempty"`
	// Customer Group associated with the Price.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// Channel associated with the Price.
	Channel *ChannelReference `json:"channel,omitempty"`
}

* * Returned when the Product Variant does not have a Price according to the Product(ctp:api:type:Product) `priceMode` value for a selected currency, country, Customer Group, or Channel. * * The error is returned as a failed response to: * * - [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), and [Add DiscountCode](ctp:api:type:CartAddDiscountCodeAction) update actions on Carts. * - [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction), and [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update actions on Order Edits. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. *

func (*MatchingPriceNotFoundError) DecodeStruct ¶ added in v1.1.0 

func (obj *MatchingPriceNotFoundError) DecodeStruct(src map[string]interface{}) error

func (MatchingPriceNotFoundError) Error ¶ 

func (obj MatchingPriceNotFoundError) Error() string

func (MatchingPriceNotFoundError) MarshalJSON ¶ 

func (obj MatchingPriceNotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*MatchingPriceNotFoundError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *MatchingPriceNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MaxCartDiscountsReachedError ¶ added in v1.4.0 

type MaxCartDiscountsReachedError struct {
	// `"Maximum number of active cart discounts reached ($max)."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Cart Discount cannot be created or activated as the [limit](/../api/limits#cart-discounts) for active Cart Discounts has been reached. * * The error is returned as a failed response to: * * - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests * - [Change IsActive](ctp:api:type:CartDiscountChangeIsActiveAction) update action *

func (*MaxCartDiscountsReachedError) DecodeStruct ¶ added in v1.4.0 

func (obj *MaxCartDiscountsReachedError) DecodeStruct(src map[string]interface{}) error

func (MaxCartDiscountsReachedError) Error ¶ added in v1.4.0 

func (obj MaxCartDiscountsReachedError) Error() string

func (MaxCartDiscountsReachedError) MarshalJSON ¶ added in v1.4.0 

func (obj MaxCartDiscountsReachedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*MaxCartDiscountsReachedError) UnmarshalJSON ¶ added in v1.4.0 

func (obj *MaxCartDiscountsReachedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MaxResourceLimitExceededError ¶ 

type MaxResourceLimitExceededError struct {
	// `"You have exceeded the limit of $limit resources of type $resourceTypeId."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Resource type that reached its maximum limit of configured elements (for example, 100 Zones per Project).
	ExceededResource ReferenceTypeId `json:"exceededResource"`
}

* * Returned when a resource type cannot be created as it has reached its [limits](/../api/limits). * * The limits must be adjusted for this resource before sending the request again. *

func (*MaxResourceLimitExceededError) DecodeStruct ¶ added in v1.1.0 

func (obj *MaxResourceLimitExceededError) DecodeStruct(src map[string]interface{}) error

func (MaxResourceLimitExceededError) Error ¶ 

func (obj MaxResourceLimitExceededError) Error() string

func (MaxResourceLimitExceededError) MarshalJSON ¶ 

func (obj MaxResourceLimitExceededError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*MaxResourceLimitExceededError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *MaxResourceLimitExceededError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MaxStoreReferencesReachedError ¶ added in v1.4.0 

type MaxStoreReferencesReachedError struct {
	// `"Maximum number of store discounts on a single cart discount reached $max".`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Store cannot be added to a Cart Discount as the [limit](/../api/limits#cart-discounts-stores) for Stores configured for a Cart Discount has been reached. * * The error is returned as a failed response to: * * - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests * - [Add Store](ctp:api:type:CartDiscountAddStoreAction) and [Set Store](ctp:api:type:CartDiscountSetStoresAction) update actions *

func (*MaxStoreReferencesReachedError) DecodeStruct ¶ added in v1.4.0 

func (obj *MaxStoreReferencesReachedError) DecodeStruct(src map[string]interface{}) error

func (MaxStoreReferencesReachedError) Error ¶ added in v1.4.0 

func (obj MaxStoreReferencesReachedError) Error() string

func (MaxStoreReferencesReachedError) MarshalJSON ¶ added in v1.4.0 

func (obj MaxStoreReferencesReachedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*MaxStoreReferencesReachedError) UnmarshalJSON ¶ added in v1.4.0 

func (obj *MaxStoreReferencesReachedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type Message ¶ 

type Message interface{}

* * Base representation of a Message containing common fields to all [Message Types](/../api/projects/messages#message-types). *

type MessageDeliveryPayload ¶ 

type MessageDeliveryPayload struct {
	// `key` of the [Project](ctp:api:type:Project).
	// Useful in message processing if the Destination receives events from multiple Projects.
	ProjectKey string `json:"projectKey"`
	// Reference to the resource that triggered the message.
	Resource Reference `json:"resource"`
	// User-defined unique identifiers of the resource.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique ID of the message.
	ID string `json:"id"`
	// Last seen version of the resource.
	Version int `json:"version"`
	// Date and time (UTC) the resource was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the resource was last modified.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Used to ensure all messages of the resource are processed in correct order.
	// The `sequenceNumber` of the next message of the resource is a successor of the `sequenceNumber` of the current message.
	SequenceNumber int `json:"sequenceNumber"`
	// Version of the resource on which the change was performed.
	ResourceVersion int `json:"resourceVersion"`
	// If the payload does not fit into the size limit or its format is not accepted by the messaging service, the `payloadNotIncluded` field is present.
	PayloadNotIncluded *PayloadNotIncluded `json:"payloadNotIncluded,omitempty"`
}

* * This payload is sent for a MessageSubscription(ctp:api:type:MessageSubscription). *

func (MessageDeliveryPayload) MarshalJSON ¶ 

func (obj MessageDeliveryPayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*MessageDeliveryPayload) UnmarshalJSON ¶ 

func (obj *MessageDeliveryPayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MessagePagedQueryResponse ¶ 

type MessagePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// [Messages](ctp:api:type:Message) matching the query.
	Results []Message `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of Message(ctp:api:type:Message). *

func (*MessagePagedQueryResponse) UnmarshalJSON ¶ 

func (obj *MessagePagedQueryResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MessagePayload ¶ 

type MessagePayload interface{}

type MessageSubscription ¶ 

type MessageSubscription struct {
	// Unique identifier for the type of resource, for example, `order`.
	ResourceTypeId MessageSubscriptionResourceTypeId `json:"resourceTypeId"`
	// Must contain valid message types for the resource. For example, for resource type `product` the message type `ProductPublished` is valid.
	// If no `types` of messages are given, the Subscription will receive all messages for this resource.
	Types []string `json:"types"`
}

* * For supported resources and message types, see [Message Types](/../api/projects/messages#message-types). Messages will be delivered even if the Messages Query HTTP API [is not enabled](/../api/projects/messages#enable-querying-messages-via-the-api). * * For MessageSubscriptions, the format of the payload is MessageDeliveryPayload(ctp:api:type:MessageDeliveryPayload). *

func (MessageSubscription) MarshalJSON ¶ 

func (obj MessageSubscription) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MessageSubscriptionResourceTypeId ¶ added in v1.2.0 

type MessageSubscriptionResourceTypeId string

* * Resource types supported by [MessageSubscriptions](ctp:api:type:MessageSubscription): * 

const (
	MessageSubscriptionResourceTypeIdApprovalFlow          MessageSubscriptionResourceTypeId = "approval-flow"
	MessageSubscriptionResourceTypeIdApprovalRule          MessageSubscriptionResourceTypeId = "approval-rule"
	MessageSubscriptionResourceTypeIdAssociateRole         MessageSubscriptionResourceTypeId = "associate-role"
	MessageSubscriptionResourceTypeIdBusinessUnit          MessageSubscriptionResourceTypeId = "business-unit"
	MessageSubscriptionResourceTypeIdCategory              MessageSubscriptionResourceTypeId = "category"
	MessageSubscriptionResourceTypeIdCustomer              MessageSubscriptionResourceTypeId = "customer"
	MessageSubscriptionResourceTypeIdCustomerEmailToken    MessageSubscriptionResourceTypeId = "customer-email-token"
	MessageSubscriptionResourceTypeIdCustomerGroup         MessageSubscriptionResourceTypeId = "customer-group"
	MessageSubscriptionResourceTypeIdCustomerPasswordToken MessageSubscriptionResourceTypeId = "customer-password-token"
	MessageSubscriptionResourceTypeIdInventoryEntry        MessageSubscriptionResourceTypeId = "inventory-entry"
	MessageSubscriptionResourceTypeIdOrder                 MessageSubscriptionResourceTypeId = "order"
	MessageSubscriptionResourceTypeIdPayment               MessageSubscriptionResourceTypeId = "payment"
	MessageSubscriptionResourceTypeIdProduct               MessageSubscriptionResourceTypeId = "product"
	MessageSubscriptionResourceTypeIdProductSelection      MessageSubscriptionResourceTypeId = "product-selection"
	MessageSubscriptionResourceTypeIdQuote                 MessageSubscriptionResourceTypeId = "quote"
	MessageSubscriptionResourceTypeIdQuoteRequest          MessageSubscriptionResourceTypeId = "quote-request"
	MessageSubscriptionResourceTypeIdReview                MessageSubscriptionResourceTypeId = "review"
	MessageSubscriptionResourceTypeIdStagedQuote           MessageSubscriptionResourceTypeId = "staged-quote"
	MessageSubscriptionResourceTypeIdStandalonePrice       MessageSubscriptionResourceTypeId = "standalone-price"
	MessageSubscriptionResourceTypeIdStore                 MessageSubscriptionResourceTypeId = "store"
)

type MessagesConfiguration ¶ 

type MessagesConfiguration struct {
	// When `true`, the [Messages Query](/../api/projects/messages) feature is active.
	Enabled bool `json:"enabled"`
	// Specifies the number of days each Message should be available via the [Messages Query](/../api/projects/messages) API.
	// For Messages older than the specified period, it is not guaranteed that they are still accessible via the API.
	// This field may not be present on Projects created before 8 October 2018.
	DeleteDaysAfterCreation *int `json:"deleteDaysAfterCreation,omitempty"`
}

* * Holds the configuration for the [Messages Query](/../api/projects/messages) feature for the Project.

type MessagesConfigurationDraft ¶ 

type MessagesConfigurationDraft struct {
	// Setting to `true` activates the [Messages Query](/../api/projects/messages) feature.
	Enabled bool `json:"enabled"`
	// Specifies the number of days each Message should be available via the [Messages Query](/../api/projects/messages) API. For Messages older than the specified period, it is not guaranteed that they are still accessible via the API.
	DeleteDaysAfterCreation int `json:"deleteDaysAfterCreation"`
}

* * Defines the configuration for the [Messages Query](/../api/projects/messages) feature for the Project.

type MethodExternalTaxRateDraft ¶ added in v1.4.0 

type MethodExternalTaxRateDraft struct {
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingMethodKey string `json:"shippingMethodKey"`
	// External Tax Rate for the Shipping Method, if the Cart has `External` [TaxMode](ctp:api:type:TaxMode).
	TaxRate *ExternalTaxRateDraft `json:"taxRate,omitempty"`
}

type MethodTaxRate ¶ added in v1.2.0 

type MethodTaxRate struct {
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingMethodKey string `json:"shippingMethodKey"`
	// Tax Rate for the Shipping Method.
	TaxRate *TaxRate `json:"taxRate,omitempty"`
}

type MethodTaxedPrice ¶ added in v1.2.0 

type MethodTaxedPrice struct {
	// User-defined unique identifier of the [Shipping Method](ctp:api:type:ShippingMethod) in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingMethodKey string `json:"shippingMethodKey"`
	// Total taxed price based on the quantity of the Line Item or Custom Line Item assigned to the Shipping Method identified by `shippingMethodKey`.
	TaxedPrice *TaxedItemPrice `json:"taxedPrice,omitempty"`
}

type MissingRoleOnChannelError ¶ 

type MissingRoleOnChannelError struct {
	// `"Given channel with $idOrKeyOfChannel does not have the required role $role."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a given [Channel](ctp:api:type:Channel).
	Channel *ChannelResourceIdentifier `json:"channel,omitempty"`
	// - `ProductDistribution` for Product Distribution Channels allowed for the Store. Also required for [Standalone Prices](ctp:api:type:StandalonePrice).
	// - `InventorySupply` for Inventory Supply Channels allowed for the Store.
	MissingRole ChannelRoleEnum `json:"missingRole"`
}

* * Returned when one of the following states occur: * * - Channel(ctp:api:type:Channel) is added or set on a Store(ctp:api:type:Store) with missing Channel `roles`. * - [Standalone Price](ctp:api:type:StandalonePrice) references a Channel that does not contain the `ProductDistribution` role. * * The error is returned as a failed response to: * * - [Add Distribution Channel](ctp:api:type:StoreAddDistributionChannelAction), [Set Distribution Channel](ctp:api:type:StoreSetDistributionChannelsAction), [Add Supply Channel](ctp:api:type:StoreAddSupplyChannelAction), and [Set Supply Channel](ctp:api:type:StoreSetSupplyChannelsAction) update actions. * - [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request. *

func (*MissingRoleOnChannelError) DecodeStruct ¶ added in v1.1.0 

func (obj *MissingRoleOnChannelError) DecodeStruct(src map[string]interface{}) error

func (MissingRoleOnChannelError) Error ¶ 

func (obj MissingRoleOnChannelError) Error() string

func (MissingRoleOnChannelError) MarshalJSON ¶ 

func (obj MissingRoleOnChannelError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*MissingRoleOnChannelError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *MissingRoleOnChannelError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MissingTaxRateForCountryError ¶ 

type MissingTaxRateForCountryError struct {
	// `"Tax category $taxCategoryId is missing a tax rate for country $countriesAndStates."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifier of the [TaxCategory](ctp:api:type:TaxCategory).
	TaxCategoryId string `json:"taxCategoryId"`
	// Country code of the geographic location.
	Country *string `json:"country,omitempty"`
	// State within the country, such as Texas in the United States.
	State *string `json:"state,omitempty"`
}

* * Returned when the Tax Category of at least one of the `lineItems`, `customLineItems`, or `shippingInfo` in the Cart(ctp:api:type:Cart) is missing the TaxRate(ctp:api:type:TaxRate) matching `country` and `state` given in the `shippingAddress` of that Cart. * * The error is returned as a failed response to: * * - [Set Default Shipping Address](ctp:api:type:CustomerSetDefaultShippingAddressAction), [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), [Set Shipping Address](ctp:api:type:CartSetShippingAddressAction), [Add LineItem](ctp:api:type:MyCartAddLineItemAction), [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), and [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update actions * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. *

func (*MissingTaxRateForCountryError) DecodeStruct ¶ added in v1.1.0 

func (obj *MissingTaxRateForCountryError) DecodeStruct(src map[string]interface{}) error

func (MissingTaxRateForCountryError) Error ¶ 

func (obj MissingTaxRateForCountryError) Error() string

func (MissingTaxRateForCountryError) MarshalJSON ¶ 

func (obj MissingTaxRateForCountryError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*MissingTaxRateForCountryError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *MissingTaxRateForCountryError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type Money ¶ 

type Money struct {
	// Amount in the smallest indivisible unit of a currency, such as:
	//
	// * Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as `500`).
	// * The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as `5`).
	CentAmount int `json:"centAmount"`
	// Currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
	CurrencyCode string `json:"currencyCode"`
}

* * Draft type that stores amounts only in cent precision for the specified currency. *

type MoneyOverflowError ¶ added in v1.3.0 

type MoneyOverflowError struct {
	// `"A Money operation resulted in an overflow."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Money(ctp:api:type:Money) operation overflows the 64-bit integer range. * See [Money usage](/types#usage) for more information. *

func (*MoneyOverflowError) DecodeStruct ¶ added in v1.3.0 

func (obj *MoneyOverflowError) DecodeStruct(src map[string]interface{}) error

func (MoneyOverflowError) Error ¶ added in v1.3.0 

func (obj MoneyOverflowError) Error() string

func (MoneyOverflowError) MarshalJSON ¶ added in v1.3.0 

func (obj MoneyOverflowError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*MoneyOverflowError) UnmarshalJSON ¶ added in v1.3.0 

func (obj *MoneyOverflowError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MoneyType ¶ 

type MoneyType string

* * Determines the type of money used. 

const (
	MoneyTypeCentPrecision MoneyType = "centPrecision"
	MoneyTypeHighPrecision MoneyType = "highPrecision"
)

type MultiBuyCustomLineItemsTarget ¶ 

type MultiBuyCustomLineItemsTarget struct {
	// Valid [CustomLineItems target predicate](/../api/projects/predicates#customlineitem-field-identifiers). The Discount will be applied to Custom Line Items that are matched by the predicate.
	Predicate string `json:"predicate"`
	// Number of Custom Line Items to be present in order to trigger an application of this Discount.
	TriggerQuantity int `json:"triggerQuantity"`
	// Number of Custom Line Items that are discounted per application of this Discount.
	// It must be less than or equal to the `triggerQuantity`.
	DiscountedQuantity int `json:"discountedQuantity"`
	// Maximum number of times this Discount can be applied.
	// Do not set if the Discount should be applied an unlimited number of times.
	MaxOccurrence *int `json:"maxOccurrence,omitempty"`
	// Discounts particular Line Items only according to the SelectionMode.
	SelectionMode SelectionMode `json:"selectionMode"`
}

* * This Discount target is similar to `MultiBuyLineItems`, but is applied on Custom Line Items instead of Line Items. *

func (MultiBuyCustomLineItemsTarget) MarshalJSON ¶ 

func (obj MultiBuyCustomLineItemsTarget) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MultiBuyLineItemsTarget ¶ 

type MultiBuyLineItemsTarget struct {
	// Valid [LineItem target predicate](/../api/projects/predicates#lineitem-field-identifiers). The Discount will be applied to Line Items that are matched by the predicate.
	Predicate string `json:"predicate"`
	// Number of Line Items to be present in order to trigger an application of this Discount.
	TriggerQuantity int `json:"triggerQuantity"`
	// Number of Line Items that are discounted per application of this Discount.
	// It must be less than or equal to the `triggerQuantity`.
	DiscountedQuantity int `json:"discountedQuantity"`
	// Maximum number of times this Discount can be applied.
	// Do not set if the Discount should be applied an unlimited number of times.
	MaxOccurrence *int `json:"maxOccurrence,omitempty"`
	// Discounts particular Line Items only according to the SelectionMode.
	SelectionMode SelectionMode `json:"selectionMode"`
}

func (MultiBuyLineItemsTarget) MarshalJSON ¶ 

func (obj MultiBuyLineItemsTarget) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitAddAddressAction ¶ added in v1.2.0 

type MyBusinessUnitAddAddressAction struct {
	// The address to add to `addresses`.
	Address BaseAddress `json:"address"`
}

* * Adding an address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAddressAdded](ctp:api:type:BusinessUnitAddressAddedMessage) Message. *

func (MyBusinessUnitAddAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitAddAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitAddBillingAddressIdAction ¶ added in v1.2.0 

type MyBusinessUnitAddBillingAddressIdAction struct {
	// ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to add as a billing address. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Adding a billing address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressAdded](ctp:api:type:BusinessUnitBillingAddressAddedMessage) Message. *

func (MyBusinessUnitAddBillingAddressIdAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitAddBillingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitAddShippingAddressIdAction ¶ added in v1.2.0 

type MyBusinessUnitAddShippingAddressIdAction struct {
	// ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Adding a shipping address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressAdded](ctp:api:type:BusinessUnitShippingAddressAddedMessage) Message. *

func (MyBusinessUnitAddShippingAddressIdAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitAddShippingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitAssociateDraft ¶ added in v1.2.0 

type MyBusinessUnitAssociateDraft struct {
	// Expected version of the BusinessUnit on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// [Customer](ctp:api:type:Customer) to create and assign to the Business Unit.
	Customer MyCustomerDraft `json:"customer"`
	// Roles assigned to the new Associate within a Business Unit. Can only contain [AssociateRoles](ctp:api:type:AssociateRole) with the `buyerAssignable` property set to `true`.
	AssociateRoleAssignments []AssociateRoleAssignmentDraft `json:"associateRoleAssignments"`
}

type MyBusinessUnitChangeAddressAction ¶ added in v1.2.0 

type MyBusinessUnitChangeAddressAction struct {
	// ID of the address to change. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to change. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
	// New address to set.
	Address BaseAddress `json:"address"`
}

* * Changing the address on a Business Unit generates the [BusinessUnitAddressChanged](ctp:api:type:BusinessUnitAddressChangedMessage) Message. *

func (MyBusinessUnitChangeAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitChangeAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitChangeAssociateAction ¶ added in v1.2.0 

type MyBusinessUnitChangeAssociateAction struct {
	// The Associate to add.
	Associate AssociateDraft `json:"associate"`
}

* * Updating the Associate(ctp:api:type:Associate) on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAssociateChanged](ctp:api:type:BusinessUnitAssociateChangedMessage) Message. *

func (MyBusinessUnitChangeAssociateAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitChangeAssociateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitChangeNameAction ¶ added in v1.2.0 

type MyBusinessUnitChangeNameAction struct {
	// New name to set.
	Name string `json:"name"`
}

* * Updating the name on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitNameChanged](ctp:api:type:BusinessUnitNameChangedMessage) Message. *

func (MyBusinessUnitChangeNameAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitChangeParentUnitAction ¶ added in v1.2.0 

type MyBusinessUnitChangeParentUnitAction struct {
	// New parent unit of the [Business Unit](ctp:api:type:BusinessUnit). The new parent unit must have the same top-level unit as the old parent unit.
	ParentUnit BusinessUnitResourceIdentifier `json:"parentUnit"`
}

* * Changing the parent of a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitParentChanged](ctp:api:type:BusinessUnitParentChangedMessage) Message. *

func (MyBusinessUnitChangeParentUnitAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitChangeParentUnitAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitDraft ¶ added in v1.2.0 

type MyBusinessUnitDraft interface{}

type MyBusinessUnitRemoveAddressAction ¶ added in v1.2.0 

type MyBusinessUnitRemoveAddressAction struct {
	// ID of the address to be removed. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to be removed. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removing the address from a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAddressRemoved](ctp:api:type:BusinessUnitAddressRemovedMessage) Message. *

func (MyBusinessUnitRemoveAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitRemoveAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitRemoveAssociateAction ¶ added in v1.2.0 

type MyBusinessUnitRemoveAssociateAction struct {
	// [Associate](ctp:api:type:Associate) to remove.
	Customer CustomerResourceIdentifier `json:"customer"`
}

* * Removing an Associate(ctp:api:type:Associate) from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAssociateRemoved](ctp:api:type:BusinessUnitAssociateRemovedMessage) Message. *

func (MyBusinessUnitRemoveAssociateAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitRemoveAssociateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitRemoveBillingAddressIdAction ¶ added in v1.2.0 

type MyBusinessUnitRemoveBillingAddressIdAction struct {
	// ID of the billing address to be removed. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the billing address to be removed. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removing a billing address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressRemoved](ctp:api:type:BusinessUnitBillingAddressRemovedMessage) Message. *

func (MyBusinessUnitRemoveBillingAddressIdAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitRemoveBillingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitRemoveShippingAddressIdAction ¶ added in v1.2.0 

type MyBusinessUnitRemoveShippingAddressIdAction struct {
	// ID of the shipping address to be removed. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the shipping address to be removed. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removing a shipping address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressRemoved](ctp:api:type:BusinessUnitShippingAddressRemovedMessage) Message. *

func (MyBusinessUnitRemoveShippingAddressIdAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitRemoveShippingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitSetAddressCustomFieldAction ¶ added in v1.2.0 

type MyBusinessUnitSetAddressCustomFieldAction struct {
	// ID of the `address` to be extended.
	AddressId string `json:"addressId"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

* * Adding a Custom Field to an Address of a Business Unit generates the [BusinessUnitAddressCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitAddressCustomFieldRemoved](ctp:api:type:BusinessUnitAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message. *

func (MyBusinessUnitSetAddressCustomFieldAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitSetAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitSetAddressCustomTypeAction ¶ added in v1.2.0 

type MyBusinessUnitSetAddressCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the `address` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `address`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `address`.
	Fields *FieldContainer `json:"fields,omitempty"`
	// ID of the `address` to be extended.
	AddressId string `json:"addressId"`
}

* * Adding or updating a Custom Type to an Address of a Business Unit generates the [BusinessUnitAddressCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, and removing one generates the [BusinessUnitAddressCustomTypeRemoved](ctp:api:type:BusinessUnitAddressCustomTypeRemovedMessage) Message. *

func (MyBusinessUnitSetAddressCustomTypeAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitSetAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitSetContactEmailAction ¶ added in v1.2.0 

type MyBusinessUnitSetContactEmailAction struct {
	// Email to set.
	// If `contactEmail` is absent or `null`, the existing contact email, if any, will be removed.
	ContactEmail *string `json:"contactEmail,omitempty"`
}

* * Setting the contact email on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitContactEmailSet](ctp:api:type:BusinessUnitContactEmailSetMessage) Message. *

func (MyBusinessUnitSetContactEmailAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitSetContactEmailAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitSetCustomFieldAction ¶ added in v1.2.0 

type MyBusinessUnitSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

* * Adding a Custom Field to a Business Unit generates the [BusinessUnitCustomFieldAdded](ctp:api:type:BusinessUnitCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitCustomFieldRemoved](ctp:api:type:BusinessUnitCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message. *

func (MyBusinessUnitSetCustomFieldAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitSetCustomTypeAction ¶ added in v1.2.0 

type MyBusinessUnitSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the BusinessUnit with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the BusinessUnit.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) for the BusinessUnit.
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * Adding or updating a Custom Type on a Business Unit generates the [BusinessUnitCustomTypeSet](ctp:api:type:BusinessUnitCustomTypeSetMessage) Message, removing one generates the [BusinessUnitCustomTypeRemoved](ctp:api:type:BusinessUnitCustomTypeRemovedMessage) Message. *

func (MyBusinessUnitSetCustomTypeAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitSetDefaultBillingAddressAction ¶ added in v1.2.0 

type MyBusinessUnitSetDefaultBillingAddressAction struct {
	// ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to add as a billing address. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Setting the default billing address on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitDefaultBillingAddressSet](ctp:api:type:BusinessUnitDefaultBillingAddressSetMessage) Message. *

func (MyBusinessUnitSetDefaultBillingAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitSetDefaultBillingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitSetDefaultShippingAddressAction ¶ added in v1.2.0 

type MyBusinessUnitSetDefaultShippingAddressAction struct {
	// ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
	AddressId *string `json:"addressId,omitempty"`
	// Key of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Setting the default shipping address on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitDefaultShippingAddressSet](ctp:api:type:BusinessUnitDefaultShippingAddressSetMessage) Message. *

func (MyBusinessUnitSetDefaultShippingAddressAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyBusinessUnitSetDefaultShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyBusinessUnitUpdate ¶ added in v1.2.0 

type MyBusinessUnitUpdate struct {
	// Expected version of the BusinessUnit on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the BusinessUnit.
	Actions []BusinessUnitUpdateAction `json:"actions"`
}

func (*MyBusinessUnitUpdate) UnmarshalJSON ¶ added in v1.2.0 

func (obj *MyBusinessUnitUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MyBusinessUnitUpdateAction ¶ added in v1.2.0 

type MyBusinessUnitUpdateAction interface{}

type MyCartAddDiscountCodeAction ¶ 

type MyCartAddDiscountCodeAction struct {
	// `code` of a [DiscountCode](ctp:api:type:DiscountCode).
	Code string `json:"code"`
}

* * Adds a DiscountCode(ctp:api:type:DiscountCode) to the Cart to activate the related [CartDiscounts](/../api/projects/cartDiscounts). * Adding a Discount Code is only possible if no DirectDiscount(ctp:api:type:DirectDiscount) has been applied to the Cart. * Discount Codes can be added to [frozen Carts](ctp:api:type:FrozenCarts), but their DiscountCodeState(ctp:api:type:DiscountCodeState) is then `DoesNotMatchCart`. * * The maximum number of Discount Codes in a Cart is restricted by a [limit](/../api/limits#carts). * * Specific Error Code: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) *

func (MyCartAddDiscountCodeAction) MarshalJSON ¶ 

func (obj MyCartAddDiscountCodeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartAddItemShippingAddressAction ¶ 

type MyCartAddItemShippingAddressAction struct {
	// Address to append to `itemShippingAddresses`.
	//
	// The new address must have a key that is unique accross this Cart.
	Address BaseAddress `json:"address"`
}

* * Adds an address to a Cart when shipping to multiple addresses is desired. *

func (MyCartAddItemShippingAddressAction) MarshalJSON ¶ 

func (obj MyCartAddItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartAddLineItemAction ¶ 

type MyCartAddLineItemAction struct {
	// User-defined unique identifier of the LineItem.
	Key *string `json:"key,omitempty"`
	// `id` of the [Product](ctp:api:type:Product).
	//
	// Either the `productId` and `variantId`, or `sku` must be provided.
	ProductId *string `json:"productId,omitempty"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant) in the Product.
	//
	// If not given, the Master Variant is used.
	//
	// Either the `productId` and `variantId`, or `sku` must be provided.
	VariantId *int `json:"variantId,omitempty"`
	// `sku` of the [ProductVariant](ctp:api:type:ProductVariant).
	//
	// Either the `productId` and `variantId`, or `sku` must be provided.
	Sku *string `json:"sku,omitempty"`
	// Number of Line Items to add to the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// Date and time (UTC) the Line Item was added to the Cart.
	// If not set, it defaults to the current date and time.
	//
	// Optional for backwards compatibility reasons.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price.
	// The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	// If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set, the Channel must match one of the Store's distribution channels.
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
	// Used to identify [Inventory entries](/../api/projects/inventory) that must be reserved.
	// The Channel must have the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
	// Container for Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// Custom Fields for the Line Item.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * If the Cart contains a LineItem(ctp:api:type:LineItem) for a Product Variant with the same LineItemMode(ctp:api:type:LineItemMode), [Custom Fields](/../api/projects/custom-fields), supply and distribution channel, then only the quantity of the existing Line Item is increased. * If LineItem(ctp:api:type:LineItem) `shippingDetails` is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. * The LineItem(ctp:api:type:LineItem) price is set as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). * * If the Tax Rate is not set, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. * * If the Line Items do not have a Price according to the Product(ctp:api:type:Product) `priceMode` value for a selected currency and/or country, Customer Group, or Channel, a [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) error is returned. *

func (MyCartAddLineItemAction) MarshalJSON ¶ 

func (obj MyCartAddLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartAddPaymentAction ¶ 

type MyCartAddPaymentAction struct {
	// Payment to add to the Cart.
	// Must not be assigned to another Order or active Cart already.
	Payment PaymentResourceIdentifier `json:"payment"`
}

func (MyCartAddPaymentAction) MarshalJSON ¶ 

func (obj MyCartAddPaymentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartApplyDeltaToLineItemShippingDetailsTargetsAction ¶ 

type MyCartApplyDeltaToLineItemShippingDetailsTargetsAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Using positive or negative quantities increases or decreases the number of items shipped to an address.
	TargetsDelta []ItemShippingTarget `json:"targetsDelta"`
}

* * To override the shipping details, see [Set LineItem ShippingDetails](ctp:api:type:MyCartSetLineItemShippingDetailsAction). *

func (MyCartApplyDeltaToLineItemShippingDetailsTargetsAction) MarshalJSON ¶ 

func (obj MyCartApplyDeltaToLineItemShippingDetailsTargetsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartChangeLineItemQuantityAction ¶ 

type MyCartChangeLineItemQuantityAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// New value to set.
	//
	// If `0`, the Line Item is removed from the Cart.
	Quantity int `json:"quantity"`
	// Deprecated. Will be ignored.
	ExternalPrice *Money `json:"externalPrice,omitempty"`
	// Deprecated. Will be ignored.
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
}

* * When multiple shipping addresses are set for a Line Item, * use the [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) and [Add LineItem](ctp:api:type:CartAddLineItemAction) update action * to change the shipping details. * Since it is not possible for the API to infer how the overall change in the Line Item quantity should be distributed over the sub-quantities, * the `shippingDetails` field is kept in its current state to avoid data loss. * * To change the Line Item quantity and shipping details together, * use this update action in combination with the [Set LineItem ShippingDetails](ctp:api:type:CartSetLineItemShippingDetailsAction) update action * in a single Cart update command. * * When the action applies to [LineItems](ctp:api:type:LineItem) with `ExternalTotal` LineItemPriceMode(ctp:api:type:LineItemPriceMode), * it will be changed to `ExternalPrice` and the existing `externalPrice` value, i.e. `LineItem.price`, will be retained. * The LineItem total will be calculated by the system instead, so that the `externalTotalPrice` will be dropped. *

func (MyCartChangeLineItemQuantityAction) MarshalJSON ¶ 

func (obj MyCartChangeLineItemQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartChangeTaxModeAction ¶ 

type MyCartChangeTaxModeAction struct {
	// The new TaxMode.
	TaxMode TaxMode `json:"taxMode"`
}

* * - When `External` TaxMode(ctp:api:type:TaxMode) is changed to `Platform` or `Disabled`, all previously set external Tax Rates are removed. * - When set to `Platform`, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's `shippingAddress`. *

func (MyCartChangeTaxModeAction) MarshalJSON ¶ 

func (obj MyCartChangeTaxModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartDraft ¶ 

type MyCartDraft struct {
	// Currency the Cart uses.
	Currency string `json:"currency"`
	// Email address of the Customer the Cart belongs to.
	CustomerEmail *string `json:"customerEmail,omitempty"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. The [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
	BusinessUnit *BusinessUnitResourceIdentifier `json:"businessUnit,omitempty"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Store the Cart should belong to. Once set, it cannot be updated.
	Store *StoreResourceIdentifier `json:"store,omitempty"`
	// [Line Items](ctp:api:type:LineItems) to add to the Cart.
	LineItems []MyLineItemDraft `json:"lineItems"`
	// Determines how Tax Rates are set. The `Disabled` TaxMode **cannot** be set.
	TaxMode *TaxMode `json:"taxMode,omitempty"`
	// Determines how stock quantities are tracked for Line Items in the Cart.
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Billing address associated with the Cart.
	BillingAddress *BaseAddress `json:"billingAddress,omitempty"`
	// Shipping address associated with the Cart. Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
	ShippingAddress *BaseAddress `json:"shippingAddress,omitempty"`
	// Shipping Method for the Cart. If the referenced [ShippingMethod](ctp:api:type:ShippingMethod) has a `predicate` that does not match the Cart, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned when [creating a Cart](ctp:api:endpoint:/{projectKey}/carts:POST).
	ShippingMethod *ShippingMethodResourceIdentifier `json:"shippingMethod,omitempty"`
	// Multiple shipping addresses of the Cart. Each address must contain a `key` that is unique in this Cart.
	// The keys are used by [LineItems](ctp:api:type:LineItem) to reference these addresses under their `shippingDetails`.
	//
	// Eligible Shipping Methods or applicable Tax Rates are determined by the [Cart](ctp:api:type:Cart) `shippingAddress`, and not `itemShippingAddresses`.
	ItemShippingAddresses []BaseAddress `json:"itemShippingAddresses"`
	// - If set to `Single`, only a single Shipping Method can be added to the Cart.
	// - If set to `Multiple`, multiple Shipping Methods can be added to the Cart.
	ShippingMode *ShippingMode `json:"shippingMode,omitempty"`
	// `code` of the existing [DiscountCodes](ctp:api:type:DiscountCode) to add to the Cart.
	DiscountCodes []string `json:"discountCodes"`
	// Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	// If used for [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/me/carts:POST), the provided country must be one of the [Store's](ctp:api:type:Store) `countries`.
	Country *string `json:"country,omitempty"`
	// Languages of the Cart.
	// Can only contain languages supported by the [Project](ctp:api:type:Project).
	Locale *string `json:"locale,omitempty"`
	// Number of days after which a Cart with `Active` [CartState](ctp:api:type:CartState) is deleted since its last modification.
	// If not provided, the default value for this field configured in [Project settings](ctp:api:type:CartsConfiguration) is assigned.
	//
	// Create a [ChangeSubscription](ctp:api:type:ChangeSubscription) for Carts to receive a [ResourceDeletedDeliveryPayload](ctp:api:type:ResourceDeletedDeliveryPayload) upon deletion of the Cart.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
	// Custom Fields for the Cart.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * The `customerId` is determined by a [password flow token](/../api/authorization#password-flow) and * automatically set on the resulting Cart(ctp:api:type:Cart). * The `anonymousId` is determined by a [token for an anonymous session](ctp:api:type:AnonymousSession) and * automatically set on the resulting Cart(ctp:api:type:Cart). *

func (MyCartDraft) MarshalJSON ¶ 

func (obj MyCartDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartRecalculateAction ¶ 

type MyCartRecalculateAction struct {
	// - Leave empty or set to `false` to only update the Prices and TaxRates of the Line Items.
	// - Set to `true` to update the Line Items' product data (like `name`, `variant` and `productType`) also.
	UpdateProductData *bool `json:"updateProductData,omitempty"`
}

* * This update action does not set any Cart field in particular, but it triggers several [Cart updates](/../api/carts-orders-overview#cart-updates) * to bring prices and discounts to the latest state. Those can become stale over time when no Cart updates have been performed for a while and * prices on related Products have changed in the meanwhile. * * If the `priceMode` of the Product(ctp:api:type:Product) related to a Line Item is of `Embedded` [ProductPriceMode](ctp:api:type:ProductPriceModeEnum), * the updated `price` of that LineItem(ctp:api:type:LineItem) may not correspond to a Price in the `variant.prices` anymore. *

func (MyCartRecalculateAction) MarshalJSON ¶ 

func (obj MyCartRecalculateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartRemoveDiscountCodeAction ¶ 

type MyCartRemoveDiscountCodeAction struct {
	// Discount Code to remove from the Cart.
	DiscountCode DiscountCodeReference `json:"discountCode"`
}

func (MyCartRemoveDiscountCodeAction) MarshalJSON ¶ 

func (obj MyCartRemoveDiscountCodeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartRemoveItemShippingAddressAction ¶ 

type MyCartRemoveItemShippingAddressAction struct {
	// `key` of the Address to remove from `itemShippingAddresses`.
	AddressKey string `json:"addressKey"`
}

* * An address can only be removed if it is not referenced in any ItemShippingTarget(ctp:api:type:ItemShippingTarget) of the Cart. *

func (MyCartRemoveItemShippingAddressAction) MarshalJSON ¶ 

func (obj MyCartRemoveItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartRemoveLineItemAction ¶ 

type MyCartRemoveLineItemAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Amount to subtract from the LineItem's `quantity`.
	// If absent, the LineItem is removed from the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` to the given value when decreasing the quantity of a Line Item with the `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalPrice *Money `json:"externalPrice,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` and `totalPrice` to the given value when decreasing the quantity of a Line Item with the `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
	// Container for Line Item-specific addresses to remove.
	ShippingDetailsToRemove *ItemShippingDetailsDraft `json:"shippingDetailsToRemove,omitempty"`
}

* * The LineItem(ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). *

func (MyCartRemoveLineItemAction) MarshalJSON ¶ 

func (obj MyCartRemoveLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartRemovePaymentAction ¶ 

type MyCartRemovePaymentAction struct {
	// Payment to remove from the Cart.
	Payment PaymentResourceIdentifier `json:"payment"`
}

func (MyCartRemovePaymentAction) MarshalJSON ¶ 

func (obj MyCartRemovePaymentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetBillingAddressAction ¶ 

type MyCartSetBillingAddressAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Address *BaseAddress `json:"address,omitempty"`
}

func (MyCartSetBillingAddressAction) MarshalJSON ¶ 

func (obj MyCartSetBillingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetBusinessUnitAction ¶ added in v1.3.0 

type MyCartSetBusinessUnitAction struct {
	// New Business Unit to assign to the Cart, which must have access to the [Store](/../api/projects/stores) that is set on the Cart.
	// Additionally, the authenticated user must be an [Associate](/projects/business-units#associate) in the [Business Unit](/projects/business-units#businessunit).
	BusinessUnit BusinessUnitResourceIdentifier `json:"businessUnit"`
}

* * Updates the Business Unit on the Cart. The Cart must have an existing Business Unit assigned already. *

func (MyCartSetBusinessUnitAction) MarshalJSON ¶ added in v1.3.0 

func (obj MyCartSetBusinessUnitAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetCountryAction ¶ 

type MyCartSetCountryAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	//
	// If the Cart is bound to a `store`, the provided value must be included in the [Store's](ctp:api:type:Store) `countries`.
	// Otherwise a [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) error is returned.
	Country *string `json:"country,omitempty"`
}

* * Setting the country can lead to changes in the LineItem(ctp:api:type:LineItem) prices. *

func (MyCartSetCountryAction) MarshalJSON ¶ 

func (obj MyCartSetCountryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetCustomFieldAction ¶ 

type MyCartSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (MyCartSetCustomFieldAction) MarshalJSON ¶ 

func (obj MyCartSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetCustomTypeAction ¶ 

type MyCartSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Cart with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Cart.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Cart.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (MyCartSetCustomTypeAction) MarshalJSON ¶ 

func (obj MyCartSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetCustomerEmailAction ¶ 

type MyCartSetCustomerEmailAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Email *string `json:"email,omitempty"`
}

func (MyCartSetCustomerEmailAction) MarshalJSON ¶ 

func (obj MyCartSetCustomerEmailAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetDeleteDaysAfterLastModificationAction ¶ 

type MyCartSetDeleteDaysAfterLastModificationAction struct {
	// Value to set.
	// If not provided, the default value for this field configured in [Project settings](ctp:api:type:CartsConfiguration) is assigned.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
}

* * Number of days after which a Cart with `Active` CartState(ctp:api:type:CartState) is deleted since its last modification. * * If a ChangeSubscription(ctp:api:type:ChangeSubscription) exists for Carts, a ResourceDeletedDeliveryPayload(ctp:api:type:ResourceDeletedDeliveryPayload) is sent. *

func (MyCartSetDeleteDaysAfterLastModificationAction) MarshalJSON ¶ 

func (obj MyCartSetDeleteDaysAfterLastModificationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetLineItemCustomFieldAction ¶ 

type MyCartSetLineItemCustomFieldAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (MyCartSetLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj MyCartSetLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetLineItemCustomTypeAction ¶ 

type MyCartSetLineItemCustomTypeAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the LineItem with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Line Item.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Line Item.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (MyCartSetLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj MyCartSetLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetLineItemDistributionChannelAction ¶ 

type MyCartSetLineItemDistributionChannelAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// - If present, a [Reference](ctp:api:type:Reference) to the Channel is set for the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	// - If not present, the current [Reference](ctp:api:type:Reference) to a distribution channel is removed from the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	//   The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
}

* * Setting a distribution channel for a LineItem(ctp:api:type:LineItem) can lead to an updated `price` as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). *

func (MyCartSetLineItemDistributionChannelAction) MarshalJSON ¶ 

func (obj MyCartSetLineItemDistributionChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetLineItemShippingDetailsAction ¶ 

type MyCartSetLineItemShippingDetailsAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If empty, the existing value is removed.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
}

func (MyCartSetLineItemShippingDetailsAction) MarshalJSON ¶ 

func (obj MyCartSetLineItemShippingDetailsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetLineItemSupplyChannelAction ¶ 

type MyCartSetLineItemSupplyChannelAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// - If present, a [Reference](ctp:api:type:Reference) to the Channel is set for the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	// - If not present, the current [Reference](ctp:api:type:Reference) to a supply channel will be removed from the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	//   The Channel must have the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
}

* * Performing this action has no impact on inventory that should be reserved. *

func (MyCartSetLineItemSupplyChannelAction) MarshalJSON ¶ 

func (obj MyCartSetLineItemSupplyChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetLocaleAction ¶ 

type MyCartSetLocaleAction struct {
	// Value to set.
	// Must be one of the [Project](ctp:api:type:Project)'s `languages`.
	// If empty, any existing value will be removed.
	Locale *string `json:"locale,omitempty"`
}

func (MyCartSetLocaleAction) MarshalJSON ¶ 

func (obj MyCartSetLocaleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetShippingAddressAction ¶ 

type MyCartSetShippingAddressAction struct {
	// Value to set.
	// If not set, the shipping address is unset, and the `taxedPrice` and `taxRate` are unset in all Line Items.
	Address *BaseAddress `json:"address,omitempty"`
}

* * Setting the shipping address also sets the TaxRate(ctp:api:type:TaxRate) of Line Items and calculates the TaxedPrice(ctp:api:type:TaxedPrice). * * If a matching price cannot be found for the given shipping address during [Line Item Price selection](ctp:api:type:LineItemPriceSelection), * a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. * * If you want to allow shipping to states inside a country that are not explicitly covered by a TaxRate, * set the `countryTaxRateFallbackEnabled` field to `true` in the CartsConfiguration(ctp:api:type:CartsConfiguration) by using * the [Change CountryTaxRateFallbackEnabled](ctp:api:type:ProjectChangeCountryTaxRateFallbackEnabledAction) update action. *

func (MyCartSetShippingAddressAction) MarshalJSON ¶ 

func (obj MyCartSetShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartSetShippingMethodAction ¶ 

type MyCartSetShippingMethodAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	//
	// If the referenced Shipping Method has a predicate that does not match the Cart, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
	ShippingMethod *ShippingMethodResourceIdentifier `json:"shippingMethod,omitempty"`
	// An external Tax Rate can be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
}

* * To set the Cart's Shipping Method the Cart must have the `Single` ShippingMode(ctp:api:type:ShippingMode) and a `shippingAddress`. *

func (MyCartSetShippingMethodAction) MarshalJSON ¶ 

func (obj MyCartSetShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCartUpdate ¶ 

type MyCartUpdate struct {
	// Expected version of the Cart on which the changes apply.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Cart.
	Actions []MyCartUpdateAction `json:"actions"`
}

func (*MyCartUpdate) UnmarshalJSON ¶ 

func (obj *MyCartUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MyCartUpdateAction ¶ 

type MyCartUpdateAction interface{}

type MyCartUpdateItemShippingAddressAction ¶ 

type MyCartUpdateItemShippingAddressAction struct {
	// The new Address with the same `key` as the Address it will replace.
	Address BaseAddress `json:"address"`
}

* * Updates an address in `itemShippingAddresses` by keeping the Address `key`. *

func (MyCartUpdateItemShippingAddressAction) MarshalJSON ¶ 

func (obj MyCartUpdateItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCompanyDraft ¶ added in v1.2.0 

type MyCompanyDraft struct {
	// User-defined unique identifier for the BusinessUnit.
	Key string `json:"key"`
	// Name of the Business Unit.
	Name string `json:"name"`
	// Email address of the Business Unit.
	ContactEmail *string `json:"contactEmail,omitempty"`
	// Custom Fields for the Business Unit.
	Custom *CustomFields `json:"custom,omitempty"`
	// Addresses used by the Business Unit.
	Addresses []BaseAddress `json:"addresses"`
	// Indexes of entries in `addresses` to set as shipping addresses.
	// The `shippingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
	ShippingAddresses []int `json:"shippingAddresses"`
	// Index of the entry in `addresses` to set as the default shipping address.
	DefaultShippingAddress *int `json:"defaultShippingAddress,omitempty"`
	// Indexes of entries in `addresses` to set as billing addresses.
	// The `billingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
	BillingAddresses []int `json:"billingAddresses"`
	// Index of the entry in `addresses` to set as the default billing address.
	DefaultBillingAddress *int `json:"defaultBillingAddress,omitempty"`
}

* * Draft type to represent the top level of a business. * Contains the fields and values of the generic MyBusinessUnitDraft(ctp:api:type:BusinessUnitDraft) that are used specifically for creating a Company(ctp:api:type:Company). *

func (MyCompanyDraft) MarshalJSON ¶ added in v1.2.0 

func (obj MyCompanyDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerAddAddressAction ¶ 

type MyCustomerAddAddressAction struct {
	// Value to append to the `addresses` array.
	Address BaseAddress `json:"address"`
}

* * Adding an address to the Customer produces the [CustomerAddressAdded](ctp:api:type:CustomerAddressAddedMessage) Message. *

func (MyCustomerAddAddressAction) MarshalJSON ¶ 

func (obj MyCustomerAddAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerAddBillingAddressIdAction ¶ 

type MyCustomerAddBillingAddressIdAction struct {
	// `id` of the [Address](ctp:api:type:Address) to become a billing address.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to become a billing address.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Adds an address from the `addresses` array to `billingAddressIds`. Either `addressId` or `addressKey` is required. *

func (MyCustomerAddBillingAddressIdAction) MarshalJSON ¶ 

func (obj MyCustomerAddBillingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerAddShippingAddressIdAction ¶ 

type MyCustomerAddShippingAddressIdAction struct {
	// `id` of the [Address](ctp:api:type:Address) to become a shipping address.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to become a shipping address.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Adds an address from the `addresses` array to `shippingAddressIds`. Either `addressId` or `addressKey` is required. *

func (MyCustomerAddShippingAddressIdAction) MarshalJSON ¶ 

func (obj MyCustomerAddShippingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerChangeAddressAction ¶ 

type MyCustomerChangeAddressAction struct {
	// `id` of the [Address](ctp:api:type:Address) to change.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to change.
	AddressKey *string `json:"addressKey,omitempty"`
	// Value to set.
	Address BaseAddress `json:"address"`
}

* * Changing an address of the Customer produces the [CustomerAddressChanged](ctp:api:type:CustomerAddressChangedMessage) Message. * * Either `addressId` or `addressKey` is required. *

func (MyCustomerChangeAddressAction) MarshalJSON ¶ 

func (obj MyCustomerChangeAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerChangeEmailAction ¶ 

type MyCustomerChangeEmailAction struct {
	// New value to set.
	Email string `json:"email"`
}

* * Changing the email of the Customer produces the [CustomerEmailChanged](ctp:api:type:CustomerEmailChangedMessage) Message. *

func (MyCustomerChangeEmailAction) MarshalJSON ¶ 

func (obj MyCustomerChangeEmailAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerChangePassword ¶ 

type MyCustomerChangePassword struct {
	// Expected version of the Customer on which the changes should be applied.
	Version int `json:"version"`
	// Current password of the Customer.
	//
	// If the current password does not match, an [InvalidCurrentPassword](ctp:api:type:InvalidCurrentPasswordError) error is returned.
	CurrentPassword string `json:"currentPassword"`
	// New password to be set.
	NewPassword string `json:"newPassword"`
}

type MyCustomerDraft ¶ 

type MyCustomerDraft struct {
	// Email address of the Customer that is [unique](/../api/customers-overview#customer-uniqueness) for an entire Project or Store the Customer is assigned to.
	// It is the mandatory unique identifier of a Customer.
	Email string `json:"email"`
	// Password of the Customer.
	Password string `json:"password"`
	// Given name (first name) of the Customer.
	FirstName *string `json:"firstName,omitempty"`
	// Family name (last name) of the Customer.
	LastName *string `json:"lastName,omitempty"`
	// Middle name of the Customer.
	MiddleName *string `json:"middleName,omitempty"`
	// Title of the Customer, for example, 'Dr.'.
	Title *string `json:"title,omitempty"`
	// Salutation of the Customer, for example, 'Mr.' or 'Mrs.'.
	Salutation *string `json:"salutation,omitempty"`
	// Date of birth of the Customer.
	DateOfBirth *Date `json:"dateOfBirth,omitempty"`
	// Company name of the Customer.
	CompanyName *string `json:"companyName,omitempty"`
	// Individual VAT ID of the Customer.
	VatId *string `json:"vatId,omitempty"`
	// Addresses of the Customer.
	Addresses []BaseAddress `json:"addresses"`
	// Index of the address in the `addresses` array to use as the default shipping address.
	// The `defaultShippingAddressId` of the Customer will be set to the `id` of that address.
	DefaultShippingAddress *int `json:"defaultShippingAddress,omitempty"`
	// Index of the address in the `addresses` array to use as the default billing address.
	// The `defaultBillingAddressId` of the Customer will be set to the `id` of that address.
	DefaultBillingAddress *int `json:"defaultBillingAddress,omitempty"`
	// Custom Fields for the Customer.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Preferred language of the Customer. Must be one of the languages supported by the [Project](ctp:api:type:Project).
	Locale *string `json:"locale,omitempty"`
	// Sets the [Stores](ctp:api:type:Store) for the Customer.
	Stores []StoreResourceIdentifier `json:"stores"`
}

func (MyCustomerDraft) MarshalJSON ¶ 

func (obj MyCustomerDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerEmailVerify ¶ added in v1.2.0 

type MyCustomerEmailVerify struct {
	// Value of the token to verify Customer email.
	TokenValue string `json:"tokenValue"`
}

type MyCustomerRemoveAddressAction ¶ 

type MyCustomerRemoveAddressAction struct {
	// `id` of the [Address](ctp:api:type:Address) to remove.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to remove.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removing an address of the Customer produces the [CustomerAddressRemoved](ctp:api:type:CustomerAddressRemovedMessage) Message. * * Either `addressId` or `addressKey` is required. *

func (MyCustomerRemoveAddressAction) MarshalJSON ¶ 

func (obj MyCustomerRemoveAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerRemoveBillingAddressIdAction ¶ 

type MyCustomerRemoveBillingAddressIdAction struct {
	// `id` of the [Address](ctp:api:type:Address) to remove from `billingAddressesIds`.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to remove from `billingAddressesIds`.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removes an existing billing address from `billingAddressesIds`. * If the billing address is the default billing address, the `defaultBillingAddressId` is unset. Either `addressId` or `addressKey` is required. *

func (MyCustomerRemoveBillingAddressIdAction) MarshalJSON ¶ 

func (obj MyCustomerRemoveBillingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerRemoveShippingAddressIdAction ¶ 

type MyCustomerRemoveShippingAddressIdAction struct {
	// `id` of the [Address](ctp:api:type:Address) to remove from `shippingAddressesIds`.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to remove from `shippingAddressesIds`.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Removes an existing shipping address from `shippingAddressesIds`. * If the shipping address is the default shipping address, the `defaultShippingAddressId` is unset. Either `addressId` or `addressKey` is required. *

func (MyCustomerRemoveShippingAddressIdAction) MarshalJSON ¶ 

func (obj MyCustomerRemoveShippingAddressIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerResetPassword ¶ 

type MyCustomerResetPassword struct {
	// Value of the token to reset the Customer password.
	TokenValue string `json:"tokenValue"`
	// New password to be set.
	NewPassword string `json:"newPassword"`
}

type MyCustomerSetCompanyNameAction ¶ 

type MyCustomerSetCompanyNameAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	CompanyName *string `json:"companyName,omitempty"`
}

* * Setting the `companyName` field on the Customer produces the [CustomerCompanyNameSet](ctp:api:type:CustomerCompanyNameSetMessage) Message. *

func (MyCustomerSetCompanyNameAction) MarshalJSON ¶ 

func (obj MyCustomerSetCompanyNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetCustomFieldAction ¶ 

type MyCustomerSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// If `value` is provided, it is set for the field defined by `name`.
	// Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	Value interface{} `json:"value,omitempty"`
}

* * Adding a Custom Field to a Customer generates the [CustomerCustomFieldAdded](ctp:api:type:CustomerCustomFieldAddedMessage) Message, removing one generates the [CustomerCustomFieldRemoved](ctp:api:type:CustomerCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message. *

func (MyCustomerSetCustomFieldAction) MarshalJSON ¶ 

func (obj MyCustomerSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetCustomTypeAction ¶ 

type MyCustomerSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the MyCustomer with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the MyCustomer.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the MyCustomer.
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * Adding or updating a Custom Type on a Customer generates the [CustomerCustomTypeSet](ctp:api:type:CustomerCustomTypeSetMessage) Message, removing one generates the [CustomerCustomTypeRemoved](ctp:api:type:CustomerCustomTypeRemovedMessage) Message. *

func (MyCustomerSetCustomTypeAction) MarshalJSON ¶ 

func (obj MyCustomerSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetDateOfBirthAction ¶ 

type MyCustomerSetDateOfBirthAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	DateOfBirth *Date `json:"dateOfBirth,omitempty"`
}

* * Setting the date of birth of the Customer produces the [CustomerDateOfBirthSet](ctp:api:type:CustomerDateOfBirthSetMessage) Message. *

func (MyCustomerSetDateOfBirthAction) MarshalJSON ¶ 

func (obj MyCustomerSetDateOfBirthAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetDefaultBillingAddressAction ¶ 

type MyCustomerSetDefaultBillingAddressAction struct {
	// `id` of the [Address](ctp:api:type:Address) to become the default billing address.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to become the default billing address.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Sets the default billing address from `addresses`. * If the address is not currently a billing address, it is added to `billingAddressIds`. Either `addressId` or `addressKey` is required. *

func (MyCustomerSetDefaultBillingAddressAction) MarshalJSON ¶ 

func (obj MyCustomerSetDefaultBillingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetDefaultShippingAddressAction ¶ 

type MyCustomerSetDefaultShippingAddressAction struct {
	// `id` of the [Address](ctp:api:type:Address) to become the default shipping address.
	AddressId *string `json:"addressId,omitempty"`
	// `key` of the [Address](ctp:api:type:Address) to become the default shipping address.
	AddressKey *string `json:"addressKey,omitempty"`
}

* * Sets the default shipping address from `addresses`. * If the address is not currently a shipping address, it is added to `shippingAddressIds`. Either `addressId` or `addressKey` is required. *

func (MyCustomerSetDefaultShippingAddressAction) MarshalJSON ¶ 

func (obj MyCustomerSetDefaultShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetFirstNameAction ¶ 

type MyCustomerSetFirstNameAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	FirstName *string `json:"firstName,omitempty"`
}

* * Setting the first name of the Customer produces the [CustomerFirstNameSet](ctp:api:type:CustomerFirstNameSetMessage) Message. *

func (MyCustomerSetFirstNameAction) MarshalJSON ¶ 

func (obj MyCustomerSetFirstNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetLastNameAction ¶ 

type MyCustomerSetLastNameAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	LastName *string `json:"lastName,omitempty"`
}

* * Setting the last name of the Customer produces the [CustomerLastNameSet](ctp:api:type:CustomerLastNameSetMessage) Message. *

func (MyCustomerSetLastNameAction) MarshalJSON ¶ 

func (obj MyCustomerSetLastNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetLocaleAction ¶ 

type MyCustomerSetLocaleAction struct {
	// Value to set.
	// Must be one of the languages supported by the [Project](ctp:api:type:Project).
	Locale *string `json:"locale,omitempty"`
}

func (MyCustomerSetLocaleAction) MarshalJSON ¶ 

func (obj MyCustomerSetLocaleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetMiddleNameAction ¶ 

type MyCustomerSetMiddleNameAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	MiddleName *string `json:"middleName,omitempty"`
}

func (MyCustomerSetMiddleNameAction) MarshalJSON ¶ 

func (obj MyCustomerSetMiddleNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetSalutationAction ¶ 

type MyCustomerSetSalutationAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Salutation *string `json:"salutation,omitempty"`
}

func (MyCustomerSetSalutationAction) MarshalJSON ¶ 

func (obj MyCustomerSetSalutationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetTitleAction ¶ 

type MyCustomerSetTitleAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Title *string `json:"title,omitempty"`
}

* * Setting the title of the Customer produces the CustomerTitleSetMessage(ctp:api:type:CustomerTitleSetMessage). *

func (MyCustomerSetTitleAction) MarshalJSON ¶ 

func (obj MyCustomerSetTitleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSetVatIdAction ¶ 

type MyCustomerSetVatIdAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	VatId *string `json:"vatId,omitempty"`
}

func (MyCustomerSetVatIdAction) MarshalJSON ¶ 

func (obj MyCustomerSetVatIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyCustomerSignin ¶ 

type MyCustomerSignin struct {
	// Email address of the Customer treated as [case-insensitive](/../api/customers-overview#email-case-insensitivity).
	Email string `json:"email"`
	// Password of the Customer.
	Password string `json:"password"`
	// - If `MergeWithExistingCustomerCart`, [LineItems](ctp:api:type:LineItem) of the anonymous Cart are merged with the recently modified active Customer Cart.
	// - If `UseAsNewActiveCustomerCart`, the anonymous Cart is used as the new active Customer Cart, and no [LineItems](ctp:api:type:LineItem) are merged.
	ActiveCartSignInMode *AnonymousCartSignInMode `json:"activeCartSignInMode,omitempty"`
	// - If `true`, the [LineItem](ctp:api:type:LineItem) Product data (`name`, `variant`, and `productType`) of the returned Cart is updated.
	// - If `false`, only the prices, discounts, and tax rates are updated.
	UpdateProductData *bool `json:"updateProductData,omitempty"`
}

type MyCustomerUpdate ¶ 

type MyCustomerUpdate struct {
	// Expected version of the Customer on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Customer.
	Actions []MyCustomerUpdateAction `json:"actions"`
}

func (*MyCustomerUpdate) UnmarshalJSON ¶ 

func (obj *MyCustomerUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MyCustomerUpdateAction ¶ 

type MyCustomerUpdateAction interface{}

type MyDivisionDraft ¶ added in v1.2.0 

type MyDivisionDraft struct {
	// User-defined unique identifier for the BusinessUnit.
	Key string `json:"key"`
	// Name of the Business Unit.
	Name string `json:"name"`
	// Email address of the Business Unit.
	ContactEmail *string `json:"contactEmail,omitempty"`
	// Custom Fields for the Business Unit.
	Custom *CustomFields `json:"custom,omitempty"`
	// Addresses used by the Business Unit.
	Addresses []BaseAddress `json:"addresses"`
	// Indexes of entries in `addresses` to set as shipping addresses.
	// The `shippingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
	ShippingAddresses []int `json:"shippingAddresses"`
	// Index of the entry in `addresses` to set as the default shipping address.
	DefaultShippingAddress *int `json:"defaultShippingAddress,omitempty"`
	// Indexes of entries in `addresses` to set as billing addresses.
	// The `billingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
	BillingAddresses []int `json:"billingAddresses"`
	// Index of the entry in `addresses` to set as the default billing address.
	DefaultBillingAddress *int `json:"defaultBillingAddress,omitempty"`
	// The parent unit of this Division. Can be a Company or a Division.
	ParentUnit BusinessUnitResourceIdentifier `json:"parentUnit"`
}

* * Draft type to model divisions that are part of the Company(ctp:api:type:Company) or a higher-order Division(ctp:api:type:Division). * Contains the fields and values of the generic MyBusinessUnitDraft(ctp:api:type:MyBusinessUnitDraft) that are used specifically for creating a Division. *

func (MyDivisionDraft) MarshalJSON ¶ added in v1.2.0 

func (obj MyDivisionDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyLineItemDraft ¶ 

type MyLineItemDraft struct {
	// User-defined unique identifier of the LineItem.
	Key *string `json:"key,omitempty"`
	// `id` of the [Product](ctp:api:type:Product).
	ProductId *string `json:"productId,omitempty"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant) in the Product.
	// If not provided, the Master Variant is used.
	VariantId *int `json:"variantId,omitempty"`
	// `sku` of the [ProductVariant](ctp:api:type:ProductVariant).
	Sku *string `json:"sku,omitempty"`
	// Number of Product Variants to add to the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// Date and time (UTC) the Product Variant is added to the Cart.
	// If not set, it defaults to the current date and time.
	//
	// Optional for backwards compatibility reasons.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Used to identify [Inventory entries](/../api/projects/inventory) that must be reserved.
	// The Channel must have the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
	// Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price.
	// The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	//
	// If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set,
	// the Channel must match one of the Store's distribution channels.
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
	// Container for Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// Custom Fields for the Cart.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * For Product Variant identification, either the `productId` and `variantId`, or `sku` must be provided. *

type MyOrderFromCartDraft ¶ 

type MyOrderFromCartDraft struct {
	// `id` of the [Cart](ctp:api:type:Cart) from which the Order is created.
	ID string `json:"id"`
	// Current `version` of the [Cart](ctp:api:type:Cart) from which the Order is created.
	Version int `json:"version"`
}

type MyOrderFromQuoteDraft ¶ added in v1.3.0 

type MyOrderFromQuoteDraft struct {
	// `id` of the [Quote](ctp:api:type:Quote) from which the Order is created.
	ID string `json:"id"`
	// Current `version` of the [Quote](ctp:api:type:Quote) from which the Order is created.
	Version int `json:"version"`
	// Set to `true`, if the `quoteState` of the referenced [Quote](ctp:api:type:Quote) should be set to `Accepted`.
	QuoteStateToAccepted *bool `json:"quoteStateToAccepted,omitempty"`
}

type MyPayment ¶ 

type MyPayment struct {
	// Unique identifier of the Payment.
	ID string `json:"id"`
	// Current version of the Payment.
	Version int `json:"version"`
	// Reference to a [Customer](ctp:api:type:Customer) associated with the Payment. Set automatically with a [password flow token](/../api/authorization#password-flow). Either `customer` or `anonymousId` is present.
	Customer *CustomerReference `json:"customer,omitempty"`
	// [Anonymous session](ctp:api:type:AnonymousSession) associated with the Payment. Set automatically with a [token for an anonymous session](ctp:api:type:AnonymousSession). Either `customer` or `anonymousId` is present.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// Money value the Payment intends to receive from the customer.
	// The value typically matches the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order) gross total.
	AmountPlanned CentPrecisionMoney `json:"amountPlanned"`
	// Information regarding the payment interface (for example, a PSP), and the specific payment method used.
	PaymentMethodInfo PaymentMethodInfo `json:"paymentMethodInfo"`
	// Financial transactions of the Payment. Each Transaction has a [TransactionType](ctp:api:type:TransactionType) and a [TransactionState](ctp:api:type:TransactionState).
	Transactions []Transaction `json:"transactions"`
	// Custom Fields defined for the Payment.
	Custom *CustomFields `json:"custom,omitempty"`
}

type MyPaymentAddTransactionAction ¶ 

type MyPaymentAddTransactionAction struct {
	// Transaction to add to the Payment.
	Transaction TransactionDraft `json:"transaction"`
}

* * Adding a Transaction to a Payment generates the [PaymentTransactionAdded](ctp:api:type:PaymentTransactionAddedMessage) Message. * Once a Transaction is added to the Payment, it can no longer be updated or deleted using the My Payments API. *

func (MyPaymentAddTransactionAction) MarshalJSON ¶ 

func (obj MyPaymentAddTransactionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyPaymentChangeAmountPlannedAction ¶ 

type MyPaymentChangeAmountPlannedAction struct {
	// New value to set.
	Amount Money `json:"amount"`
}

* * Can be used to update the Payment if a customer changes the Cart(ctp:api:type:Cart), or adds or removes a CartDiscount(ctp:api:type:CartDiscount) during checkout. *

func (MyPaymentChangeAmountPlannedAction) MarshalJSON ¶ 

func (obj MyPaymentChangeAmountPlannedAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyPaymentDraft ¶ 

type MyPaymentDraft struct {
	// Money value the Payment intends to receive from the customer.
	// The value usually matches the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order) gross total.
	AmountPlanned Money `json:"amountPlanned"`
	// Information regarding the payment interface (for example, a PSP), and the specific payment method used.
	PaymentMethodInfo *PaymentMethodInfo `json:"paymentMethodInfo,omitempty"`
	// Custom Fields for the Payment.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Financial transactions of the [TransactionTypes](ctp:api:type:TransactionType) `Authorization` or `Charge`.
	Transaction *MyTransactionDraft `json:"transaction,omitempty"`
}

type MyPaymentPagedQueryResponse ¶ 

type MyPaymentPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// [MyPayments](ctp:api:type:MyPayment) matching the query.
	Results []MyPayment `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of MyPayment(ctp:api:type:MyPayment). *

type MyPaymentSetCustomFieldAction ¶ 

type MyPaymentSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (MyPaymentSetCustomFieldAction) MarshalJSON ¶ 

func (obj MyPaymentSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyPaymentSetMethodInfoInterfaceAction ¶ 

type MyPaymentSetMethodInfoInterfaceAction struct {
	// Value to set.
	// Once set, the `paymentInterface` of the `paymentMethodInfo` cannot be changed.
	Interface string `json:"interface"`
}

func (MyPaymentSetMethodInfoInterfaceAction) MarshalJSON ¶ 

func (obj MyPaymentSetMethodInfoInterfaceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyPaymentSetMethodInfoMethodAction ¶ 

type MyPaymentSetMethodInfoMethodAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Method *string `json:"method,omitempty"`
}

func (MyPaymentSetMethodInfoMethodAction) MarshalJSON ¶ 

func (obj MyPaymentSetMethodInfoMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyPaymentSetMethodInfoNameAction ¶ 

type MyPaymentSetMethodInfoNameAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Name *LocalizedString `json:"name,omitempty"`
}

func (MyPaymentSetMethodInfoNameAction) MarshalJSON ¶ 

func (obj MyPaymentSetMethodInfoNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyPaymentSetTransactionCustomFieldAction ¶ 

type MyPaymentSetTransactionCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (MyPaymentSetTransactionCustomFieldAction) MarshalJSON ¶ 

func (obj MyPaymentSetTransactionCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyPaymentUpdate ¶ 

type MyPaymentUpdate struct {
	// Expected version of the Payment on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Payment.
	Actions []MyPaymentUpdateAction `json:"actions"`
}

func (*MyPaymentUpdate) UnmarshalJSON ¶ 

func (obj *MyPaymentUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MyPaymentUpdateAction ¶ 

type MyPaymentUpdateAction interface{}

type MyQuoteChangeMyQuoteStateAction ¶ added in v1.2.0 

type MyQuoteChangeMyQuoteStateAction struct {
	// New state to be set for the Quote.
	QuoteState MyQuoteState `json:"quoteState"`
}

* * When accepting, declining, or renegotiating [B2B Quotes](/../api/associates-overview#b2b-resources), the Customer must have the `AcceptMyQuotes`, `DeclineMyQuotes`, or `RenegotiateMyQuotes` Permission(ctp:api:type:Permission), respectively. If the required Permission(/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned.

func (MyQuoteChangeMyQuoteStateAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyQuoteChangeMyQuoteStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyQuoteRequestCancelAction ¶ added in v1.2.0 

type MyQuoteRequestCancelAction struct {
}

* * Transitions the `quoteRequestState` of the Quote Request to `Cancelled`. Can only be used when the Quote Request is in state `Submitted`. *

func (MyQuoteRequestCancelAction) MarshalJSON ¶ added in v1.2.0 

func (obj MyQuoteRequestCancelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyQuoteRequestDraft ¶ added in v1.2.0 

type MyQuoteRequestDraft struct {
	// `id` of the Cart from which the Quote Request is created.
	CartId string `json:"cartId"`
	// Current version of the Cart.
	CartVersion int `json:"cartVersion"`
	// Message from the Buyer included in the Quote Request.
	Comment *string `json:"comment,omitempty"`
}

type MyQuoteRequestUpdate ¶ added in v1.2.0 

type MyQuoteRequestUpdate struct {
	Version int                          `json:"version"`
	Actions []MyQuoteRequestUpdateAction `json:"actions"`
}

func (*MyQuoteRequestUpdate) UnmarshalJSON ¶ added in v1.2.0 

func (obj *MyQuoteRequestUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MyQuoteRequestUpdateAction ¶ added in v1.2.0 

type MyQuoteRequestUpdateAction interface{}

type MyQuoteState ¶ added in v1.2.0 

type MyQuoteState string

* * [QuoteStates](ctp:api:type:QuoteState) that can be set using the [Change My Quote State](ctp:api:type:MyQuoteChangeMyQuoteStateAction) update action. * 

const (
	MyQuoteStateDeclined MyQuoteState = "Declined"
	MyQuoteStateAccepted MyQuoteState = "Accepted"
)

type MyQuoteUpdate ¶ added in v1.2.0 

type MyQuoteUpdate struct {
	// Expected version of the [Quote](ctp:api:type:Quote) to which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the [Quote](ctp:api:type:Quote).
	Actions []MyQuoteUpdateAction `json:"actions"`
}

func (*MyQuoteUpdate) UnmarshalJSON ¶ added in v1.2.0 

func (obj *MyQuoteUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MyQuoteUpdateAction ¶ added in v1.2.0 

type MyQuoteUpdateAction interface{}

type MyShoppingListAddLineItemAction ¶ 

type MyShoppingListAddLineItemAction struct {
	// User-defined identifier of the ShoppingListLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
	Key *string `json:"key,omitempty"`
	// `sku` of the [ProductVariant](ctp:api:type:ProductVariant).
	Sku *string `json:"sku,omitempty"`
	// Unique identifier of a [Product](ctp:api:type:Product).
	ProductId *string `json:"productId,omitempty"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant). If not set, the ShoppingListLineItem refers to the Master Variant.
	VariantId *int `json:"variantId,omitempty"`
	// Number of Products in the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem).
	Quantity *int `json:"quantity,omitempty"`
	// Date and time the TextLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Custom Fields defined for the ShoppingListLineItem.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (MyShoppingListAddLineItemAction) MarshalJSON ¶ 

func (obj MyShoppingListAddLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListAddTextLineItemAction ¶ 

type MyShoppingListAddTextLineItemAction struct {
	// Name of the [TextLineItem](ctp:api:type:TextLineItem).
	Name LocalizedString `json:"name"`
	// User-defined identifier of the TextLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
	Key *string `json:"key,omitempty"`
	// Description of the TextLineItem.
	Description *LocalizedString `json:"description,omitempty"`
	// Number of entries in the TextLineItem.
	Quantity *int `json:"quantity,omitempty"`
	// Date and time the TextLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Custom Fields defined for the TextLineItem.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (MyShoppingListAddTextLineItemAction) MarshalJSON ¶ 

func (obj MyShoppingListAddTextLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListChangeLineItemQuantityAction ¶ 

type MyShoppingListChangeLineItemQuantityAction struct {
	// `id` of the ShoppingListLineItem to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the ShoppingListLineItem to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// New value to set. If `0`, the ShoppingListLineItem is removed from the ShoppingList.
	Quantity int `json:"quantity"`
}

func (MyShoppingListChangeLineItemQuantityAction) MarshalJSON ¶ 

func (obj MyShoppingListChangeLineItemQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListChangeLineItemsOrderAction ¶ 

type MyShoppingListChangeLineItemsOrderAction struct {
	// All existing [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) `id`s of the [ShoppingList](ctp:api:type:ShoppingList) in the desired new order.
	LineItemOrder []string `json:"lineItemOrder"`
}

func (MyShoppingListChangeLineItemsOrderAction) MarshalJSON ¶ 

func (obj MyShoppingListChangeLineItemsOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListChangeNameAction ¶ 

type MyShoppingListChangeNameAction struct {
	// New value to set. Must not be empty.
	Name LocalizedString `json:"name"`
}

func (MyShoppingListChangeNameAction) MarshalJSON ¶ 

func (obj MyShoppingListChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListChangeTextLineItemNameAction ¶ 

type MyShoppingListChangeTextLineItemNameAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// New value to set. Must not be empty.
	Name LocalizedString `json:"name"`
}

func (MyShoppingListChangeTextLineItemNameAction) MarshalJSON ¶ 

func (obj MyShoppingListChangeTextLineItemNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListChangeTextLineItemQuantityAction ¶ 

type MyShoppingListChangeTextLineItemQuantityAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// New value to set. If `0`, the TextLineItem is removed from the ShoppingList.
	Quantity int `json:"quantity"`
}

func (MyShoppingListChangeTextLineItemQuantityAction) MarshalJSON ¶ 

func (obj MyShoppingListChangeTextLineItemQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListChangeTextLineItemsOrderAction ¶ 

type MyShoppingListChangeTextLineItemsOrderAction struct {
	// All existing [TextLineItem](ctp:api:type:TextLineItem) `id`s in the desired new order.
	TextLineItemOrder []string `json:"textLineItemOrder"`
}

func (MyShoppingListChangeTextLineItemsOrderAction) MarshalJSON ¶ 

func (obj MyShoppingListChangeTextLineItemsOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListDraft ¶ 

type MyShoppingListDraft struct {
	// Name of the [ShoppingList](ctp:api:type:ShoppingList).
	Name LocalizedString `json:"name"`
	// Description of the ShoppingList.
	Description *LocalizedString `json:"description,omitempty"`
	// [Line Items](ctp:api:type:ShoppingListLineItem) (containing Products) to add to the ShoppingList.
	LineItems []ShoppingListLineItemDraft `json:"lineItems"`
	// [Line Items](ctp:api:type:TextLineItem) (containing text values) to add to the ShoppingList.
	TextLineItems []TextLineItemDraft `json:"textLineItems"`
	// Custom Fields defined for the ShoppingList.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Number of days after which the ShoppingList will be automatically deleted if it has not been modified. If not set, the [default value](ctp:api:type:ShoppingListsConfiguration) configured in the [Project](ctp:api:type:Project) is used.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
	// Assigns the new ShoppingList to the [Store](ctp:api:type:Store). The Store assignment can not be modified.
	Store *StoreResourceIdentifier `json:"store,omitempty"`
}

* * A MyShoppingListDraft(ctp:api:type:MyShoppingListDraft) is the object submitted as payload to the [Create MyShoppingList request](ctp:api:endpoint:/{projectKey}/me/shopping-lists:POST). * The `customer` field of ShoppingList(ctp:api:type:ShoppingList) is automatically set with * a [password flow token](/authorization#password-flow). * The `anonymousId` is automatically set with a [token for an anonymous session](/authorization#tokens-for-anonymous-sessions). * The `key` and `slug` fields can not be set. *

func (MyShoppingListDraft) MarshalJSON ¶ 

func (obj MyShoppingListDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListRemoveLineItemAction ¶ 

type MyShoppingListRemoveLineItemAction struct {
	// The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// The `key` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Amount to remove from the `quantity` of the ShoppingListLineItem. If not set, the ShoppingListLineItem is removed from the ShoppingList. If this value matches or exceeds the current `quantity` of the ShoppingListLineItem, the ShoppingListLineItem is removed from the ShoppingList.
	Quantity *int `json:"quantity,omitempty"`
}

func (MyShoppingListRemoveLineItemAction) MarshalJSON ¶ 

func (obj MyShoppingListRemoveLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListRemoveTextLineItemAction ¶ 

type MyShoppingListRemoveTextLineItemAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// Amount to remove from the `quantity` of the TextLineItem. If not set, the TextLineItem is removed from the ShoppingList. If this value matches or exceeds the current `quantity` of the TextLineItem, the TextLineItem is removed from the ShoppingList.
	Quantity *int `json:"quantity,omitempty"`
}

func (MyShoppingListRemoveTextLineItemAction) MarshalJSON ¶ 

func (obj MyShoppingListRemoveTextLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListSetCustomFieldAction ¶ 

type MyShoppingListSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (MyShoppingListSetCustomFieldAction) MarshalJSON ¶ 

func (obj MyShoppingListSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListSetCustomTypeAction ¶ 

type MyShoppingListSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the MyShoppingList with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the MyShoppingList.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the MyShoppingList.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (MyShoppingListSetCustomTypeAction) MarshalJSON ¶ 

func (obj MyShoppingListSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListSetDeleteDaysAfterLastModificationAction ¶ 

type MyShoppingListSetDeleteDaysAfterLastModificationAction struct {
	// Value to set. If empty, any existing value will be removed.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
}

func (MyShoppingListSetDeleteDaysAfterLastModificationAction) MarshalJSON ¶ 

func (obj MyShoppingListSetDeleteDaysAfterLastModificationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListSetDescriptionAction ¶ 

type MyShoppingListSetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (MyShoppingListSetDescriptionAction) MarshalJSON ¶ 

func (obj MyShoppingListSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListSetLineItemCustomFieldAction ¶ 

type MyShoppingListSetLineItemCustomFieldAction struct {
	// Unique identifier of an the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem). Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// The `key` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (MyShoppingListSetLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj MyShoppingListSetLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListSetLineItemCustomTypeAction ¶ 

type MyShoppingListSetLineItemCustomTypeAction struct {
	// Unique identifier of an existing [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) in the [ShoppingList](ctp:api:type:ShoppingList).
	LineItemId string `json:"lineItemId"`
	// Defines the [Type](ctp:api:type:Type) that extends the ShoppingListLineItem with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the ShoppingListLineItem.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ShoppingListLineItem.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (MyShoppingListSetLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj MyShoppingListSetLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListSetTextLineItemCustomFieldAction ¶ 

type MyShoppingListSetTextLineItemCustomFieldAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (MyShoppingListSetTextLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj MyShoppingListSetTextLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListSetTextLineItemCustomTypeAction ¶ 

type MyShoppingListSetTextLineItemCustomTypeAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the TextLineItem with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the TextLineItem.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the TextLineItem.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (MyShoppingListSetTextLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj MyShoppingListSetTextLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListSetTextLineItemDescriptionAction ¶ 

type MyShoppingListSetTextLineItemDescriptionAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (MyShoppingListSetTextLineItemDescriptionAction) MarshalJSON ¶ 

func (obj MyShoppingListSetTextLineItemDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type MyShoppingListUpdate ¶ 

type MyShoppingListUpdate struct {
	// Expected version of the ShoppingList on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// List of update actions to be performed on the ShoppingList.
	Actions []MyShoppingListUpdateAction `json:"actions"`
}

func (*MyShoppingListUpdate) UnmarshalJSON ¶ 

func (obj *MyShoppingListUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type MyShoppingListUpdateAction ¶ 

type MyShoppingListUpdateAction interface{}

type MyTransactionDraft ¶ 

type MyTransactionDraft struct {
	// Date and time (UTC) the Transaction took place.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Type of the Transaction.
	// Only `Authorization` or `Charge` is allowed.
	Type TransactionType `json:"type"`
	// Money value for the Transaction.
	Amount Money `json:"amount"`
	// Identifier used by the payment service that manages the Transaction.
	// Can be used to correlate the Transaction to an interface interaction.
	InteractionId *string `json:"interactionId,omitempty"`
	// Custom Fields of the Transaction.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

type NoMatchingProductDiscountFoundError ¶ 

type NoMatchingProductDiscountFoundError struct {
	// `"Couldn't find a matching product discount for: productId=$productId, variantId=$variantId, price=$price."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant. * * The error is returned as a failed response to the [Get Matching ProductDiscount](ctp:api:endpoint:/{projectKey}/product-discounts/matching:POST) request. *

func (*NoMatchingProductDiscountFoundError) DecodeStruct ¶ added in v1.1.0 

func (obj *NoMatchingProductDiscountFoundError) DecodeStruct(src map[string]interface{}) error

func (NoMatchingProductDiscountFoundError) Error ¶ 

func (obj NoMatchingProductDiscountFoundError) Error() string

func (NoMatchingProductDiscountFoundError) MarshalJSON ¶ 

func (obj NoMatchingProductDiscountFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*NoMatchingProductDiscountFoundError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *NoMatchingProductDiscountFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ObjectNotFoundError ¶ 

type ObjectNotFoundError struct {
	// `"A $resourceType with identifier $id was unexpectedly not found."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the requested resource was not found. *

func (*ObjectNotFoundError) DecodeStruct ¶ added in v1.1.0 

func (obj *ObjectNotFoundError) DecodeStruct(src map[string]interface{}) error

func (ObjectNotFoundError) Error ¶ 

func (obj ObjectNotFoundError) Error() string

func (ObjectNotFoundError) MarshalJSON ¶ 

func (obj ObjectNotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ObjectNotFoundError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ObjectNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type Order ¶ 

type Order struct {
	// Unique identifier of the Order.
	ID string `json:"id"`
	// Current version of the Order.
	Version int `json:"version"`
	// Date and time (UTC) the Order was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Order was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-defined identifier of the Order that is unique across a Project.
	OrderNumber *string `json:"orderNumber,omitempty"`
	// User-defined identifier of a purchase Order.
	//
	// It is typically set by the [Buyer](ctp:api:type:Buyer) and can be used with [Quotes](/quotes-overview) to track the purchase Order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
	// `id` of the [Customer](ctp:api:type:Customer) that the Order belongs to.
	CustomerId *string `json:"customerId,omitempty"`
	// Email address of the Customer that the Order belongs to.
	CustomerEmail *string `json:"customerEmail,omitempty"`
	// [Reference](ctp:api:type:Reference) to the Customer Group of the Customer that the Order belongs to.
	// Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// [Anonymous session](ctp:api:type:AnonymousSession) associated with the Order.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// [Reference](ctp:api:type:Reference) to a Business Unit the Order belongs to.
	BusinessUnit *BusinessUnitKeyReference `json:"businessUnit,omitempty"`
	// [Reference](ctp:api:type:Reference) to a Store the Order belongs to.
	Store *StoreKeyReference `json:"store,omitempty"`
	// [Line Items](ctp:api:type:LineItems) that are part of the Order.
	LineItems []LineItem `json:"lineItems"`
	// [Custom Line Items](ctp:api:type:CustomLineItems) that are part of the Order.
	CustomLineItems []CustomLineItem `json:"customLineItems"`
	// Sum of the `totalPrice` field of all [LineItems](ctp:api:type:LineItem) and [CustomLineItems](ctp:api:type:CustomLineItem), and if available, the `price` field of [ShippingInfo](ctp:api:type:ShippingInfo).
	// If a discount applies on `totalPrice`, this field holds the discounted value.
	//
	// Taxes are included if [TaxRate](ctp:api:type:TaxRate) `includedInPrice` is `true` for each price.
	TotalPrice TypedMoney `json:"totalPrice"`
	// - For `Platform` [TaxMode](ctp:api:type:TaxMode), it is automatically set when a [shipping address is set](ctp:api:type:OrderSetShippingAddressAction).
	// - For `External` [TaxMode](ctp:api:type:TaxMode), it is automatically set when `shippingAddress` and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
	//
	// If a discount applies on `totalPrice`, this field holds the discounted values.
	TaxedPrice *TaxedPrice `json:"taxedPrice,omitempty"`
	// Sum of the `taxedPrice` field of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods.
	TaxedShippingPrice *TaxedPrice `json:"taxedShippingPrice,omitempty"`
	// Discounts that apply on the total price of the Order.
	DiscountOnTotalPrice *DiscountOnTotalPrice `json:"discountOnTotalPrice,omitempty"`
	// Indicates how Tax Rates are set.
	TaxMode *TaxMode `json:"taxMode,omitempty"`
	// Indicates how monetary values are rounded when calculating taxes for `taxedPrice`.
	TaxRoundingMode *RoundingMode `json:"taxRoundingMode,omitempty"`
	// Indicates how taxes are calculated when calculating taxes for `taxedPrice`.
	TaxCalculationMode *TaxCalculationMode `json:"taxCalculationMode,omitempty"`
	// Indicates how stock quantities are tracked for Line Items in the Order.
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Billing address associated with the Order.
	BillingAddress *Address `json:"billingAddress,omitempty"`
	// Shipping address associated with the Order.
	// Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
	ShippingAddress *Address `json:"shippingAddress,omitempty"`
	// Indicates whether there can be one or multiple Shipping Methods.
	ShippingMode ShippingMode `json:"shippingMode"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) for `Single` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Shipping-related information for `Single` [ShippingMode](ctp:api:type:ShippingMode).
	// Automatically set when a [Shipping Method is set](ctp:api:type:StagedOrderSetShippingMethodAction).
	ShippingInfo *ShippingInfo `json:"shippingInfo,omitempty"`
	// Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it is [ClassificationShippingRateInput](ctp:api:type:ClassificationShippingRateInput).
	// - If `CartScore`, it is [ScoreShippingRateInput](ctp:api:type:ScoreShippingRateInput).
	// - If `CartValue`, it cannot be used.
	ShippingRateInput ShippingRateInput `json:"shippingRateInput,omitempty"`
	// Custom Fields of the Shipping Method for `Single` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingCustomFields *CustomFields `json:"shippingCustomFields,omitempty"`
	// Shipping-related information for `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	// Updated automatically each time a new [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).
	Shipping []Shipping `json:"shipping"`
	// Additional shipping addresses of the Order as specified by [LineItems](ctp:api:type:LineItem) using the `shippingDetails` field.
	// Eligible Shipping Methods or applicable Tax Rates are determined by the address in `shippingAddress`, and not `itemShippingAddresses`.
	ItemShippingAddresses []Address `json:"itemShippingAddresses"`
	// Discount Codes added to the Order.
	// An Order that has `directDiscounts` cannot have `discountCodes`.
	DiscountCodes []DiscountCodeInfo `json:"discountCodes"`
	// Direct Discounts added to the Order.
	// An Order that has `discountCodes` cannot have `directDiscounts`.
	DirectDiscounts []DirectDiscount `json:"directDiscounts"`
	// Automatically set when a Line Item with `GiftLineItem` [LineItemMode](ctp:api:type:LineItemMode) is [removed](ctp:api:type:StagedOrderRemoveLineItemAction) from the Order.
	RefusedGifts []CartDiscountReference `json:"refusedGifts"`
	// Payment information related to the Order.
	PaymentInfo *PaymentInfo `json:"paymentInfo,omitempty"`
	// Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	Country *string `json:"country,omitempty"`
	// Languages of the Order.
	// Can only contain languages supported by the [Project](ctp:api:type:Project).
	Locale *string `json:"locale,omitempty"`
	// Indicates the origin of the Cart from which the Order was created.
	Origin CartOrigin `json:"origin"`
	// [Reference](ctp:api:type:Reference) to the Cart for an [Order created from Cart](ctp:api:endpoint:/{projectKey}/orders:POST).
	// The referenced Cart will have the `Ordered` [CartState](ctp:api:type:CartState).
	Cart *CartReference `json:"cart,omitempty"`
	// [Reference](ctp:api:type:Reference) to the Quote for an [Order created from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST).
	Quote *QuoteReference `json:"quote,omitempty"`
	// Current status of the Order.
	OrderState OrderState `json:"orderState"`
	// Shipment status of the Order.
	ShipmentState *ShipmentState `json:"shipmentState,omitempty"`
	// Payment status of the Order.
	PaymentState *PaymentState `json:"paymentState,omitempty"`
	// [State](ctp:api:type:State) of the Order.
	// This reference can point to a State in a custom workflow.
	State *StateReference `json:"state,omitempty"`
	// Contains synchronization activity information of the Order (like export or import).
	// Can only be set with [Update SyncInfo](ctp:api:type:OrderUpdateSyncInfoAction) update action.
	SyncInfo []SyncInfo `json:"syncInfo"`
	// Contains information regarding the returns associated with the Order.
	ReturnInfo []ReturnInfo `json:"returnInfo"`
	// Internal-only field.
	LastMessageSequenceNumber *int `json:"lastMessageSequenceNumber,omitempty"`
	// Custom Fields of the Order.
	Custom *CustomFields `json:"custom,omitempty"`
	// User-defined date and time (UTC) of the Order.
	// Present only on an Order created using [Order Import](ctp:api:endpoint:/{projectKey}/orders/import:POST).
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
}

func (Order) MarshalJSON ¶ 

func (obj Order) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*Order) UnmarshalJSON ¶ 

func (obj *Order) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderAddDeliveryAction ¶ 

type OrderAddDeliveryAction struct {
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod), required for `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Line Items or Custom Line Items to be included in the Delivery.
	Items []DeliveryItem `json:"items"`
	// Address the `parcels` should be delivered to.
	Address *BaseAddress `json:"address,omitempty"`
	// Parcels of the Delivery.
	//
	// If provided, this update action produces the [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message.
	Parcels []ParcelDraft `json:"parcels"`
	// Custom Fields for the Delivery.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * A Delivery(ctp:api:type:Delivery) can only be added to an Order(ctp:api:type:Order) if * its `shippingInfo` (for `shippingMode` = `Single`), or its `shipping` (for `shippingMode` = `Multiple`) exists. * * Produces the [Delivery Added](ctp:api:type:DeliveryAddedMessage) Message. *

func (OrderAddDeliveryAction) MarshalJSON ¶ 

func (obj OrderAddDeliveryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderAddItemShippingAddressAction ¶ 

type OrderAddItemShippingAddressAction struct {
	// Address to append to `itemShippingAddresses`.
	// The new Address must have a `key` that is unique across this Order.
	Address BaseAddress `json:"address"`
}

* * Adds an address to an Order when shipping to multiple addresses is desired. *

func (OrderAddItemShippingAddressAction) MarshalJSON ¶ 

func (obj OrderAddItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderAddParcelToDeliveryAction ¶ 

type OrderAddParcelToDeliveryAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Value to set.
	Measurements *ParcelMeasurements `json:"measurements,omitempty"`
	// Value to set.
	TrackingData *TrackingData `json:"trackingData,omitempty"`
	// Value to set.
	Items []DeliveryItem `json:"items"`
	// Custom Fields for the Parcel.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * To add a Parcel, at least one Delivery(ctp:api:type:Delivery) must exist. * * Produces the [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message. *

func (OrderAddParcelToDeliveryAction) MarshalJSON ¶ 

func (obj OrderAddParcelToDeliveryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderAddPaymentAction ¶ 

type OrderAddPaymentAction struct {
	// Payment to add to the [PaymentInfo](ctp:api:type:PaymentInfo).
	// Must not be assigned to another Order or active Cart already.
	Payment PaymentResourceIdentifier `json:"payment"`
}

func (OrderAddPaymentAction) MarshalJSON ¶ 

func (obj OrderAddPaymentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderAddReturnInfoAction ¶ 

type OrderAddReturnInfoAction struct {
	// Value to set.
	ReturnTrackingId *string `json:"returnTrackingId,omitempty"`
	// Items to be returned.
	// Must not be empty.
	Items []ReturnItemDraft `json:"items"`
	// Value to set.
	// If not set, it defaults to the current date and time.
	ReturnDate *time.Time `json:"returnDate,omitempty"`
}

* * Produces the [Return Info Added](ctp:api:type:ReturnInfoAddedMessage) Message. *

func (OrderAddReturnInfoAction) MarshalJSON ¶ 

func (obj OrderAddReturnInfoAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderBillingAddressSetMessage ¶ 

type OrderBillingAddressSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Billing address on the Order after the [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) update action.
	Address *Address `json:"address,omitempty"`
	// Billing address on the Order before the [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) update action.
	OldAddress *Address `json:"oldAddress,omitempty"`
}

* * Generated after a successful [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) update action. *

func (OrderBillingAddressSetMessage) MarshalJSON ¶ 

func (obj OrderBillingAddressSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderBillingAddressSetMessage) UnmarshalJSON ¶ 

func (obj *OrderBillingAddressSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderBillingAddressSetMessagePayload ¶ 

type OrderBillingAddressSetMessagePayload struct {
	// Billing address on the Order after the [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) update action.
	Address *Address `json:"address,omitempty"`
	// Billing address on the Order before the [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) update action.
	OldAddress *Address `json:"oldAddress,omitempty"`
}

* * Generated after a successful [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) update action. *

func (OrderBillingAddressSetMessagePayload) MarshalJSON ¶ 

func (obj OrderBillingAddressSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderChangeOrderStateAction ¶ 

type OrderChangeOrderStateAction struct {
	// New status of the Order.
	OrderState OrderState `json:"orderState"`
}

* * Produces the [Order State Changed](ctp:api:type:OrderStateChangedMessage) Message. *

func (OrderChangeOrderStateAction) MarshalJSON ¶ 

func (obj OrderChangeOrderStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderChangePaymentStateAction ¶ 

type OrderChangePaymentStateAction struct {
	// New payment status of the Order.
	PaymentState PaymentState `json:"paymentState"`
}

* * Produces the [Order Payment State Changed](ctp:api:type:OrderPaymentStateChangedMessage) Message. *

func (OrderChangePaymentStateAction) MarshalJSON ¶ 

func (obj OrderChangePaymentStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderChangeShipmentStateAction ¶ 

type OrderChangeShipmentStateAction struct {
	// New shipment status of the Order.
	ShipmentState ShipmentState `json:"shipmentState"`
}

* * Produces the [Order Shipment State Changed](ctp:api:type:OrderShipmentStateChangedMessage) Message. *

func (OrderChangeShipmentStateAction) MarshalJSON ¶ 

func (obj OrderChangeShipmentStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCreatedMessage ¶ 

type OrderCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Order](ctp:api:type:Order) that was created.
	Order Order `json:"order"`
}

* * Generated after a successful [Create Order](ctp:api:endpoint:/{projectKey}/orders:POST) request. *

func (OrderCreatedMessage) MarshalJSON ¶ 

func (obj OrderCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCreatedMessage) UnmarshalJSON ¶ 

func (obj *OrderCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCreatedMessagePayload ¶ 

type OrderCreatedMessagePayload struct {
	// [Order](ctp:api:type:Order) that was created.
	Order Order `json:"order"`
}

* * Generated after a successful [Create Order](ctp:api:endpoint:/{projectKey}/orders:POST) request. *

func (OrderCreatedMessagePayload) MarshalJSON ¶ 

func (obj OrderCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomFieldAddedMessage ¶ added in v1.4.0 

type OrderCustomFieldAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction). *

func (OrderCustomFieldAddedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomFieldAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomFieldAddedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *OrderCustomFieldAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomFieldAddedMessagePayload ¶ added in v1.4.0 

type OrderCustomFieldAddedMessagePayload struct {
	// Name of the Custom Field that was added.
	Name string `json:"name"`
	// The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
}

* * Generated after adding a Custom Field using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction). *

func (OrderCustomFieldAddedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomFieldAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomFieldChangedMessage ¶ added in v1.4.0 

type OrderCustomFieldChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) update action.
	// When there has not been a Custom Field with the `name` on the Order before, an [Order Custom Field Added](ctp:api:type:OrderCustomFieldAddedMessage) Message is generated instead.
	PreviousValue interface{} `json:"previousValue,omitempty"`
}

* * Generated when an existing Custom Field has been changed using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) action. *

func (OrderCustomFieldChangedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomFieldChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomFieldChangedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *OrderCustomFieldChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomFieldChangedMessagePayload ¶ added in v1.4.0 

type OrderCustomFieldChangedMessagePayload struct {
	// Name of the Custom Field that changed.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) update action.
	Value interface{} `json:"value"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) update action.
	// When there has not been a Custom Field with the `name` on the Order before, an [Order Custom Field Added](ctp:api:type:OrderCustomFieldAddedMessage) Message is generated instead.
	PreviousValue interface{} `json:"previousValue,omitempty"`
}

* * Generated when an existing Custom Field has been changed using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) action. *

func (OrderCustomFieldChangedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomFieldChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomFieldRemovedMessage ¶ added in v1.4.0 

type OrderCustomFieldRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated when a Custom Field has been removed from the Order using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) action. *

func (OrderCustomFieldRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomFieldRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomFieldRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *OrderCustomFieldRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomFieldRemovedMessagePayload ¶ added in v1.4.0 

type OrderCustomFieldRemovedMessagePayload struct {
	// Name of the Custom Field that was removed.
	Name string `json:"name"`
}

* * Generated when a Custom Field has been removed from the Order using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) action. *

func (OrderCustomFieldRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomFieldRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomLineItemAddedMessage ¶ added in v1.2.0 

type OrderCustomLineItemAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Custom Line Item](ctp:api:type:CustomLineItem) that was added to the [Order](ctp:api:type:Order).
	CustomLineItem CustomLineItem `json:"customLineItem"`
}

* * Generated after a successful [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update action. *

func (OrderCustomLineItemAddedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj OrderCustomLineItemAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomLineItemAddedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *OrderCustomLineItemAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomLineItemAddedMessagePayload ¶ added in v1.2.0 

type OrderCustomLineItemAddedMessagePayload struct {
	// [Custom Line Item](ctp:api:type:CustomLineItem) that was added to the [Order](ctp:api:type:Order).
	CustomLineItem CustomLineItem `json:"customLineItem"`
}

* * Generated after a successful [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update action. *

func (OrderCustomLineItemAddedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj OrderCustomLineItemAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomLineItemDiscountSetMessage ¶ 

type OrderCustomLineItemDiscountSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier for the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// User-defined unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Array of [DiscountedLineItemPriceForQuantity](ctp:api:type:DiscountedLineItemPriceForQuantity) after the Discount recalculation.
	DiscountedPricePerQuantity []DiscountedLineItemPriceForQuantity `json:"discountedPricePerQuantity"`
	// [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Custom Line Item](ctp:api:type:CustomLineItem) after the Discount recalculation.
	TaxedPrice *TaxedItemPrice `json:"taxedPrice,omitempty"`
}

* * Generated after a successful recalculation of a Discount on a [Custom Line Item](ctp:api:type:CustomLineItem). *

func (OrderCustomLineItemDiscountSetMessage) MarshalJSON ¶ 

func (obj OrderCustomLineItemDiscountSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomLineItemDiscountSetMessage) UnmarshalJSON ¶ 

func (obj *OrderCustomLineItemDiscountSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomLineItemDiscountSetMessagePayload ¶ 

type OrderCustomLineItemDiscountSetMessagePayload struct {
	// Unique identifier for the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// User-defined unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Array of [DiscountedLineItemPriceForQuantity](ctp:api:type:DiscountedLineItemPriceForQuantity) after the Discount recalculation.
	DiscountedPricePerQuantity []DiscountedLineItemPriceForQuantity `json:"discountedPricePerQuantity"`
	// [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Custom Line Item](ctp:api:type:CustomLineItem) after the Discount recalculation.
	TaxedPrice *TaxedItemPrice `json:"taxedPrice,omitempty"`
}

* * Generated after a successful recalculation of a Discount on a [Custom Line Item](ctp:api:type:CustomLineItem). *

func (OrderCustomLineItemDiscountSetMessagePayload) MarshalJSON ¶ 

func (obj OrderCustomLineItemDiscountSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomLineItemQuantityChangedMessage ¶ added in v1.2.0 

type OrderCustomLineItemQuantityChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// User-defined unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// [Custom Line Item](ctp:api:type:CustomLineItem) quantity after the [Change Custom Line Item Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action.
	Quantity int `json:"quantity"`
	// [Custom Line Item](ctp:api:type:CustomLineItem) quantity before the [Change Custom Line Item Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action.
	OldQuantity int `json:"oldQuantity"`
}

* * Generated after a successful [Change CustomLineItem Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action. *

func (OrderCustomLineItemQuantityChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj OrderCustomLineItemQuantityChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomLineItemQuantityChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *OrderCustomLineItemQuantityChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomLineItemQuantityChangedMessagePayload ¶ added in v1.2.0 

type OrderCustomLineItemQuantityChangedMessagePayload struct {
	// Unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// User-defined unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// [Custom Line Item](ctp:api:type:CustomLineItem) quantity after the [Change Custom Line Item Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action.
	Quantity int `json:"quantity"`
	// [Custom Line Item](ctp:api:type:CustomLineItem) quantity before the [Change Custom Line Item Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action.
	OldQuantity int `json:"oldQuantity"`
}

* * Generated after a successful [Change CustomLineItem Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action. *

func (OrderCustomLineItemQuantityChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj OrderCustomLineItemQuantityChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomLineItemRemovedMessage ¶ added in v1.2.0 

type OrderCustomLineItemRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// User-defined unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// [Custom Line Item](ctp:api:type:CustomLineItem) that was removed from the [Order](ctp:api:type:Order).
	CustomLineItem CustomLineItem `json:"customLineItem"`
}

* * Generated after a successful [Remove CustomLineItem](ctp:api:type:StagedOrderRemoveCustomLineItemAction) update action. *

func (OrderCustomLineItemRemovedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj OrderCustomLineItemRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomLineItemRemovedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *OrderCustomLineItemRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomLineItemRemovedMessagePayload ¶ added in v1.2.0 

type OrderCustomLineItemRemovedMessagePayload struct {
	// Unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// User-defined unique identifier of the [Custom Line Item](ctp:api:type:CustomLineItem).
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// [Custom Line Item](ctp:api:type:CustomLineItem) that was removed from the [Order](ctp:api:type:Order).
	CustomLineItem CustomLineItem `json:"customLineItem"`
}

* * Generated after a successful [Remove CustomLineItem](ctp:api:type:StagedOrderRemoveCustomLineItemAction) update action. *

func (OrderCustomLineItemRemovedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj OrderCustomLineItemRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomTypeRemovedMessage ¶ added in v1.4.0 

type OrderCustomTypeRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after a successful [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction) with empty parameters. *

func (OrderCustomTypeRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomTypeRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomTypeRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *OrderCustomTypeRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomTypeRemovedMessagePayload ¶ added in v1.4.0 

type OrderCustomTypeRemovedMessagePayload struct {
	// `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after a successful [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction) with empty parameters. *

func (OrderCustomTypeRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomTypeRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomTypeSetMessage ¶ added in v1.4.0 

type OrderCustomTypeSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Custom Fields that have been set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after a successful [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction). *

func (OrderCustomTypeSetMessage) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomTypeSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomTypeSetMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *OrderCustomTypeSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomTypeSetMessagePayload ¶ added in v1.4.0 

type OrderCustomTypeSetMessagePayload struct {
	// The Custom Fields that have been set.
	CustomFields CustomFields `json:"customFields"`
	// `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
	PreviousTypeId *string `json:"previousTypeId,omitempty"`
}

* * Generated after a successful [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction). *

func (OrderCustomTypeSetMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj OrderCustomTypeSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomerEmailSetMessage ¶ 

type OrderCustomerEmailSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Email address on the [Order](ctp:api:type:Order) after the [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) update action.
	Email *string `json:"email,omitempty"`
	// Email address on the [Order](ctp:api:type:Order) before the [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) update action.
	OldEmail *string `json:"oldEmail,omitempty"`
}

* * Generated after a successful [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) update action. *

func (OrderCustomerEmailSetMessage) MarshalJSON ¶ 

func (obj OrderCustomerEmailSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomerEmailSetMessage) UnmarshalJSON ¶ 

func (obj *OrderCustomerEmailSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomerEmailSetMessagePayload ¶ 

type OrderCustomerEmailSetMessagePayload struct {
	// Email address on the [Order](ctp:api:type:Order) after the [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) update action.
	Email *string `json:"email,omitempty"`
	// Email address on the [Order](ctp:api:type:Order) before the [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) update action.
	OldEmail *string `json:"oldEmail,omitempty"`
}

* * Generated after a successful [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) update action. *

func (OrderCustomerEmailSetMessagePayload) MarshalJSON ¶ 

func (obj OrderCustomerEmailSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomerGroupSetMessage ¶ 

type OrderCustomerGroupSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) on the [Order](ctp:api:type:Order) after the [Set Customer Group](ctp:api:type:StagedOrderSetCustomerGroupAction) update action.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) on the [Order](ctp:api:type:Order) before the [Set Customer Group](ctp:api:type:StagedOrderSetCustomerGroupAction) update action.
	OldCustomerGroup *CustomerGroupReference `json:"oldCustomerGroup,omitempty"`
}

* * Generated after a successful [Set Customer Group](ctp:api:type:StagedOrderSetCustomerGroupAction) update action. *

func (OrderCustomerGroupSetMessage) MarshalJSON ¶ 

func (obj OrderCustomerGroupSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomerGroupSetMessage) UnmarshalJSON ¶ 

func (obj *OrderCustomerGroupSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomerGroupSetMessagePayload ¶ 

type OrderCustomerGroupSetMessagePayload struct {
	// [CustomerGroup](ctp:api:type:CustomerGroup) on the [Order](ctp:api:type:Order) after the [Set Customer Group](ctp:api:type:StagedOrderSetCustomerGroupAction) update action.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) on the [Order](ctp:api:type:Order) before the [Set Customer Group](ctp:api:type:StagedOrderSetCustomerGroupAction) update action.
	OldCustomerGroup *CustomerGroupReference `json:"oldCustomerGroup,omitempty"`
}

* * Generated after a successful [Set Customer Group](ctp:api:type:StagedOrderSetCustomerGroupAction) update action. *

func (OrderCustomerGroupSetMessagePayload) MarshalJSON ¶ 

func (obj OrderCustomerGroupSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderCustomerSetMessage ¶ 

type OrderCustomerSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Customer](ctp:api:type:Customer) on the [Order](ctp:api:type:Order) after the [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
	Customer *CustomerReference `json:"customer,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) on the [Order](ctp:api:type:Order) after the [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// [Customer](ctp:api:type:Customer) on the [Order](ctp:api:type:Order) before the [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
	OldCustomer *CustomerReference `json:"oldCustomer,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) on the [Order](ctp:api:type:Order) before the [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
	OldCustomerGroup *CustomerGroupReference `json:"oldCustomerGroup,omitempty"`
}

* * Generated after a successful [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action. *

func (OrderCustomerSetMessage) MarshalJSON ¶ 

func (obj OrderCustomerSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderCustomerSetMessage) UnmarshalJSON ¶ 

func (obj *OrderCustomerSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderCustomerSetMessagePayload ¶ 

type OrderCustomerSetMessagePayload struct {
	// [Customer](ctp:api:type:Customer) on the [Order](ctp:api:type:Order) after the [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
	Customer *CustomerReference `json:"customer,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) on the [Order](ctp:api:type:Order) after the [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// [Customer](ctp:api:type:Customer) on the [Order](ctp:api:type:Order) before the [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
	OldCustomer *CustomerReference `json:"oldCustomer,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) on the [Order](ctp:api:type:Order) before the [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
	OldCustomerGroup *CustomerGroupReference `json:"oldCustomerGroup,omitempty"`
}

* * Generated after a successful [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action. *

func (OrderCustomerSetMessagePayload) MarshalJSON ¶ 

func (obj OrderCustomerSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderDeletedMessage ¶ 

type OrderDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Order](ctp:api:type:Order) that has been deleted.
	Order Order `json:"order"`
}

* * Generated after a successful [Delete Order](/../api/projects/orders#delete-order) request. *

func (OrderDeletedMessage) MarshalJSON ¶ 

func (obj OrderDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderDeletedMessage) UnmarshalJSON ¶ 

func (obj *OrderDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderDeletedMessagePayload ¶ 

type OrderDeletedMessagePayload struct {
	// [Order](ctp:api:type:Order) that has been deleted.
	Order Order `json:"order"`
}

* * Generated after a successful [Delete Order](/../api/projects/orders#delete-order) request. *

func (OrderDeletedMessagePayload) MarshalJSON ¶ 

func (obj OrderDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderDiscountCodeAddedMessage ¶ 

type OrderDiscountCodeAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [DiscountCode](ctp:api:type:DiscountCode) that was added.
	DiscountCode DiscountCodeReference `json:"discountCode"`
}

* * Generated after a successful [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action. *

func (OrderDiscountCodeAddedMessage) MarshalJSON ¶ 

func (obj OrderDiscountCodeAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderDiscountCodeAddedMessage) UnmarshalJSON ¶ 

func (obj *OrderDiscountCodeAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderDiscountCodeAddedMessagePayload ¶ 

type OrderDiscountCodeAddedMessagePayload struct {
	// [DiscountCode](ctp:api:type:DiscountCode) that was added.
	DiscountCode DiscountCodeReference `json:"discountCode"`
}

* * Generated after a successful [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action. *

func (OrderDiscountCodeAddedMessagePayload) MarshalJSON ¶ 

func (obj OrderDiscountCodeAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderDiscountCodeRemovedMessage ¶ 

type OrderDiscountCodeRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [DiscountCode](ctp:api:type:DiscountCode) that was removed.
	DiscountCode DiscountCodeReference `json:"discountCode"`
}

* * Generated after a successful [Remove DiscountCode](ctp:api:type:StagedOrderRemoveDiscountCodeAction) update action. *

func (OrderDiscountCodeRemovedMessage) MarshalJSON ¶ 

func (obj OrderDiscountCodeRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderDiscountCodeRemovedMessage) UnmarshalJSON ¶ 

func (obj *OrderDiscountCodeRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderDiscountCodeRemovedMessagePayload ¶ 

type OrderDiscountCodeRemovedMessagePayload struct {
	// [DiscountCode](ctp:api:type:DiscountCode) that was removed.
	DiscountCode DiscountCodeReference `json:"discountCode"`
}

* * Generated after a successful [Remove DiscountCode](ctp:api:type:StagedOrderRemoveDiscountCodeAction) update action. *

func (OrderDiscountCodeRemovedMessagePayload) MarshalJSON ¶ 

func (obj OrderDiscountCodeRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderDiscountCodeStateSetMessage ¶ 

type OrderDiscountCodeStateSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [DiscountCode](ctp:api:type:DiscountCode) that changed due to the recalculation.
	DiscountCode DiscountCodeReference `json:"discountCode"`
	// [DiscountCodeState](ctp:api:type:DiscountCodeState) after the recalculation.
	State DiscountCodeState `json:"state"`
	// [DiscountCodeState](ctp:api:type:DiscountCodeState) before the recalculation.
	OldState *DiscountCodeState `json:"oldState,omitempty"`
}

* * Generated after the DiscountCodeState(ctp:api:type:DiscountCodeState) changes due to a [recalculation](/../api/projects/carts#recalculate). *

func (OrderDiscountCodeStateSetMessage) MarshalJSON ¶ 

func (obj OrderDiscountCodeStateSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderDiscountCodeStateSetMessage) UnmarshalJSON ¶ 

func (obj *OrderDiscountCodeStateSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderDiscountCodeStateSetMessagePayload ¶ 

type OrderDiscountCodeStateSetMessagePayload struct {
	// [DiscountCode](ctp:api:type:DiscountCode) that changed due to the recalculation.
	DiscountCode DiscountCodeReference `json:"discountCode"`
	// [DiscountCodeState](ctp:api:type:DiscountCodeState) after the recalculation.
	State DiscountCodeState `json:"state"`
	// [DiscountCodeState](ctp:api:type:DiscountCodeState) before the recalculation.
	OldState *DiscountCodeState `json:"oldState,omitempty"`
}

* * Generated after the DiscountCodeState(ctp:api:type:DiscountCodeState) changes due to a [recalculation](/../api/projects/carts#recalculate). *

func (OrderDiscountCodeStateSetMessagePayload) MarshalJSON ¶ 

func (obj OrderDiscountCodeStateSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEdit ¶ 

type OrderEdit struct {
	// Unique identifier of the Order Edit.
	ID string `json:"id"`
	// Current version of the Order Edit.
	Version int `json:"version"`
	// Date and time (UTC) the Order Edit was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Order Edit was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-defined unique identifier of the Order Edit.
	Key *string `json:"key,omitempty"`
	// [Reference](ctp:api:type:Reference) to the Order updated with this edit.
	Resource OrderReference `json:"resource"`
	// Update actions applied to the Order referenced by `resource`.
	StagedActions []StagedOrderUpdateAction `json:"stagedActions"`
	// For applied edits, it's a summary of the changes on the Order.
	// For unapplied edits, it's a preview of the changes.
	Result OrderEditResult `json:"result"`
	// User-defined information regarding the Order Edit.
	Comment *string `json:"comment,omitempty"`
	// Custom Fields of the Order Edit.
	Custom *CustomFields `json:"custom,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
}

func (*OrderEdit) UnmarshalJSON ¶ 

func (obj *OrderEdit) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderEditAddStagedActionAction ¶ 

type OrderEditAddStagedActionAction struct {
	// Order update action to append to the `stagedActions` array.
	StagedAction StagedOrderUpdateAction `json:"stagedAction"`
}

* * If the [edit was applied](ctp:api:endpoint:/{projectKey}/orders/edits/{id}/apply:POST), this cannot be updated. *

func (OrderEditAddStagedActionAction) MarshalJSON ¶ 

func (obj OrderEditAddStagedActionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderEditAddStagedActionAction) UnmarshalJSON ¶ 

func (obj *OrderEditAddStagedActionAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderEditApplied ¶ 

type OrderEditApplied struct {
	// Date and time (UTC) the Order was edited.
	AppliedAt time.Time `json:"appliedAt"`
	// Prices of the Order before the edit.
	ExcerptBeforeEdit OrderExcerpt `json:"excerptBeforeEdit"`
	// Prices of the Order after the edit.
	ExcerptAfterEdit OrderExcerpt `json:"excerptAfterEdit"`
}

* * Result of a succesful application of `stagedActions` to the Order. *

func (OrderEditApplied) MarshalJSON ¶ 

func (obj OrderEditApplied) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEditAppliedMessage ¶ 

type OrderEditAppliedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [OrderEdit](ctp:api:type:OrderEdit) that was applied.
	Edit OrderEdit `json:"edit"`
	// Information about a successfully applied [OrderEdit](ctp:api:type:OrderEdit).
	Result OrderEditApplied `json:"result"`
}

* * Generated after successfully [applying an OrderEdit](ctp:api:endpoint:/{projectKey}/orders/edits/{id}/apply:POST). *

func (OrderEditAppliedMessage) MarshalJSON ¶ 

func (obj OrderEditAppliedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderEditAppliedMessage) UnmarshalJSON ¶ 

func (obj *OrderEditAppliedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderEditAppliedMessagePayload ¶ 

type OrderEditAppliedMessagePayload struct {
	// [OrderEdit](ctp:api:type:OrderEdit) that was applied.
	Edit OrderEdit `json:"edit"`
	// Information about a successfully applied [OrderEdit](ctp:api:type:OrderEdit).
	Result OrderEditApplied `json:"result"`
}

* * Generated after successfully [applying an OrderEdit](ctp:api:endpoint:/{projectKey}/orders/edits/{id}/apply:POST). *

func (OrderEditAppliedMessagePayload) MarshalJSON ¶ 

func (obj OrderEditAppliedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEditApply ¶ 

type OrderEditApply struct {
	// Current `version` of the OrderEdit to be applied.
	EditVersion int `json:"editVersion"`
	// Current `version` of the [Order](ctp:api:type:Order) to which the OrderEdit is applied.
	ResourceVersion int `json:"resourceVersion"`
}

* * If the `editVersion` and/or `resourceVersion` do not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. *

type OrderEditDraft ¶ 

type OrderEditDraft struct {
	// User-defined unique identifier for the Order Edit.
	Key *string `json:"key,omitempty"`
	// [Reference](ctp:api:type:Reference) to the Order updated with this edit.
	Resource OrderReference `json:"resource"`
	// Update actions to apply to the Order referenced in `resource`.
	// Cannot be updated if the [edit has been applied](ctp:api:endpoint:/{projectKey}/orders/edits/{id}/apply:POST).
	StagedActions []StagedOrderUpdateAction `json:"stagedActions"`
	// Custom Fields for the Order Edit.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// User-defined description regarding the Order Edit.
	Comment *string `json:"comment,omitempty"`
	// Set to `true` if you want to [peview](ctp:api:type:OrderEditPreviewSuccess) the edited Order first without persisting it (dry run).
	// A dry run allows checking for potential [errors](ctp:api:type:OrderEditPreviewFailure) when trying to apply the `stagedActions`.
	//
	// Order [API Extensions](/../api/projects/api-extensions), if any, are also called in dry runs.
	DryRun *bool `json:"dryRun,omitempty"`
}

func (OrderEditDraft) MarshalJSON ¶ 

func (obj OrderEditDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderEditDraft) UnmarshalJSON ¶ 

func (obj *OrderEditDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderEditNotProcessed ¶ 

type OrderEditNotProcessed struct {
}

* * Indicates that the edit has not been applied or processed in any way. *

func (OrderEditNotProcessed) MarshalJSON ¶ 

func (obj OrderEditNotProcessed) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEditPagedQueryResponse ¶ 

type OrderEditPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [OrderEdits](ctp:api:type:OrderEdit) matching the query.
	Results []OrderEdit `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of OrderEdit(ctp:api:type:OrderEdit). *

type OrderEditPreviewFailure ¶ 

type OrderEditPreviewFailure struct {
	// Errors returned.
	Errors []ErrorObject `json:"errors"`
}

* * Result of a failed application of `stagedActions` to the Order. The data is calculated on the fly and is not queryable. *

func (OrderEditPreviewFailure) MarshalJSON ¶ 

func (obj OrderEditPreviewFailure) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderEditPreviewFailure) UnmarshalJSON ¶ 

func (obj *OrderEditPreviewFailure) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderEditPreviewSuccess ¶ 

type OrderEditPreviewSuccess struct {
	// A preview of the edited [Order](ctp:api:type:Order) as it will be after all `stagedActions` (incl. optional Order [API Extensions](/../api/projects/api-extensions)) are applied.
	Preview StagedOrder `json:"preview"`
	// Messages that will be generated if the edit is applied.
	MessagePayloads []MessagePayload `json:"messagePayloads"`
}

* * The data is not persisted but is dynamically pulled by dry-running the update actions from `stagedActions` on the current version of the related Order(ctp:api:type:Order), not from the Order version at the time the OrderEdit was created. Therefore, it cannot be queried. *

func (OrderEditPreviewSuccess) MarshalJSON ¶ 

func (obj OrderEditPreviewSuccess) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderEditPreviewSuccess) UnmarshalJSON ¶ 

func (obj *OrderEditPreviewSuccess) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderEditReference ¶ 

type OrderEditReference struct {
	// Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit).
	ID string `json:"id"`
	// Contains the representation of the expanded Order Edit. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Order Edits.
	Obj *OrderEdit `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to an OrderEdit(ctp:api:type:OrderEdit). *

func (OrderEditReference) MarshalJSON ¶ 

func (obj OrderEditReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEditResourceIdentifier ¶ 

type OrderEditResourceIdentifier struct {
	// Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to an OrderEdit(ctp:api:type:OrderEdit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (OrderEditResourceIdentifier) MarshalJSON ¶ 

func (obj OrderEditResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEditResult ¶ 

type OrderEditResult interface{}

type OrderEditSetCommentAction ¶ 

type OrderEditSetCommentAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Comment *string `json:"comment,omitempty"`
}

func (OrderEditSetCommentAction) MarshalJSON ¶ 

func (obj OrderEditSetCommentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEditSetCustomFieldAction ¶ 

type OrderEditSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderEditSetCustomFieldAction) MarshalJSON ¶ 

func (obj OrderEditSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEditSetCustomTypeAction ¶ 

type OrderEditSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Order Edit with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Order Edit.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Order Edit.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderEditSetCustomTypeAction) MarshalJSON ¶ 

func (obj OrderEditSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEditSetKeyAction ¶ 

type OrderEditSetKeyAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (OrderEditSetKeyAction) MarshalJSON ¶ 

func (obj OrderEditSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderEditSetStagedActionsAction ¶ 

type OrderEditSetStagedActionsAction struct {
	// Value to replace the `stagedActions` of the Order Edit.
	StagedActions []StagedOrderUpdateAction `json:"stagedActions"`
}

* * If the [edit is applied](ctp:api:endpoint:/{projectKey}/orders/edits/{id}/apply:POST), `stagedActions` cannot be updated. *

func (OrderEditSetStagedActionsAction) MarshalJSON ¶ 

func (obj OrderEditSetStagedActionsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderEditSetStagedActionsAction) UnmarshalJSON ¶ 

func (obj *OrderEditSetStagedActionsAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderEditUpdate ¶ 

type OrderEditUpdate struct {
	// Expected version of the Order Edit on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Order Edit.
	Actions []OrderEditUpdateAction `json:"actions"`
	// If set to `true`, the Order Edit is applied on the [Order](ctp:api:type:Order) without persisting it.
	DryRun *bool `json:"dryRun,omitempty"`
}

func (*OrderEditUpdate) UnmarshalJSON ¶ 

func (obj *OrderEditUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderEditUpdateAction ¶ 

type OrderEditUpdateAction interface{}

type OrderExcerpt ¶ 

type OrderExcerpt struct {
	// Total price of the Order.
	TotalPrice TypedMoney `json:"totalPrice"`
	// Taxed price of the Order.
	TaxedPrice *TaxedPrice `json:"taxedPrice,omitempty"`
	// Current version of the Order.
	Version int `json:"version"`
}

* * Excerpt of the Order extracting the total and the taxed price. *

func (*OrderExcerpt) UnmarshalJSON ¶ 

func (obj *OrderExcerpt) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderFromCartDraft ¶ 

type OrderFromCartDraft struct {
	// `id` of the [Cart](ctp:api:type:Cart) used to create the Order.
	ID *string `json:"id,omitempty"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Cart from which the Order is created.
	//
	// This field is required, but is marked as optional for backwards compatibility reasons.
	Cart *CartResourceIdentifier `json:"cart,omitempty"`
	// `version` of the [Cart](ctp:api:type:Cart) from which the Order is created.
	Version int `json:"version"`
	// User-defined identifier for the Order that is unique across a Project.
	// Once set, the value cannot be changed.
	OrderNumber *string `json:"orderNumber,omitempty"`
	// User-defined identifier for a purchase Order.
	//
	// It is typically set by the [Buyer](ctp:api:type:Buyer) and can be used with [Quotes](/quotes-overview) to track the purchase Order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
	// Payment status for the Order.
	PaymentState *PaymentState `json:"paymentState,omitempty"`
	// Shipment status for the Order.
	ShipmentState *ShipmentState `json:"shipmentState,omitempty"`
	// Current status for the Order.
	OrderState *OrderState `json:"orderState,omitempty"`
	// State for the Order in a custom workflow.
	State *StateResourceIdentifier `json:"state,omitempty"`
	// Custom Fields for the Order.
	// The Custom Fields' type must match the Custom Fields' type in the referenced [Cart](ctp:api:type:Cart).
	//
	// - If empty, the Custom Fields on the referenced [Cart](ctp:api:type:Cart) are added to the Order automatically.
	// - If specified, the Custom Fields are merged with the Custom Fields on the referenced [Cart](ctp:api:type:Cart) and added to the Order.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

type OrderFromQuoteDraft ¶ added in v1.2.0 

type OrderFromQuoteDraft struct {
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Quote from which the Order is created.
	// If the referenced [Quote](ctp:api:type:Quote) has expired (`validTo` check) or its `quoteState` is `Accepted`, `Declined`, or `Withdrawn`, the Order creation will fail.
	Quote QuoteResourceIdentifier `json:"quote"`
	// `version` of the [Quote](ctp:api:type:Quote) from which the Order is created.
	Version int `json:"version"`
	// If `true`, the `quoteState` of the referenced [Quote](ctp:api:type:Quote) will be set to `Accepted`.
	QuoteStateToAccepted *bool `json:"quoteStateToAccepted,omitempty"`
	// User-defined identifier for the Order that is unique across a Project.
	// Once set, the value cannot be changed.
	OrderNumber *string `json:"orderNumber,omitempty"`
	// Payment status for the Order.
	PaymentState *PaymentState `json:"paymentState,omitempty"`
	// Shipment status for the Order.
	ShipmentState *ShipmentState `json:"shipmentState,omitempty"`
	// Current status for the Order.
	OrderState *OrderState `json:"orderState,omitempty"`
	// State of the Order in a custom workflow.
	State *StateResourceIdentifier `json:"state,omitempty"`
}

type OrderImportCustomLineItemStateAction ¶ 

type OrderImportCustomLineItemStateAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// New status of the Custom Line Items.
	State []ItemState `json:"state"`
}

* * The import of States does not follow any predefined rules and should be only used if no transitions are defined. * The `quantity` in the [ItemStates](ctp:api:type:ItemState) must match the sum of all Custom Line Item states' quantities. *

func (OrderImportCustomLineItemStateAction) MarshalJSON ¶ 

func (obj OrderImportCustomLineItemStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderImportDraft ¶ 

type OrderImportDraft struct {
	// User-defined identifier of the Order. Must be unique across a Project.
	// Once set, the value cannot be changed.
	OrderNumber *string `json:"orderNumber,omitempty"`
	// User-defined identifier for a purchase Order.
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
	// The `id` of the [Customer](ctp:api:type:Customer) the Order belongs to.
	CustomerId *string `json:"customerId,omitempty"`
	// The Email address of the Customer the Order belongs to. Can be used instead of `customerId` when no check against existing [Customers](ctp:api:type:Customer) is required.
	CustomerEmail *string `json:"customerEmail,omitempty"`
	// The Customer Group of the Customer the Order belongs to.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Order should belong to.
	// When the `customerId` of the Order is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
	BusinessUnit *BusinessUnitResourceIdentifier `json:"businessUnit,omitempty"`
	// The Store the Order belongs to.
	// Used for [filtering](#filtering).
	//
	// If a [LineItemImportDraft](ctp:api:type:LineItemImportDraft) or a [CustomLineItemImportDraft](ctp:api:type:CustomLineItemImportDraft) specifies a `distributionChannel` or a `supplyChannel` that is not defined for the referenced Store, the Order Import gets rejected.
	// The same applies when the provided `country` is not defined for the referenced Store.
	Store *StoreResourceIdentifier `json:"store,omitempty"`
	// [Line Items](ctp:api:type:LineItems) to add to the Order.
	//
	// If not specified, `customLineItems` must not be empty.
	LineItems []LineItemImportDraft `json:"lineItems"`
	// [Custom Line Items](ctp:api:type:CustomLineItems) to add to the Cart.
	//
	// If not specified, `lineItems` must not be empty.
	CustomLineItems []CustomLineItemImportDraft `json:"customLineItems"`
	// The total Price of the Order. The amount can be negative.
	TotalPrice Money `json:"totalPrice"`
	// Include TaxedPrice information for the Order. If not included, and if you have Tax Rates set for Line Items and Custom Line Items, the Order total will not be recalculated.
	TaxedPrice *TaxedPriceDraft `json:"taxedPrice,omitempty"`
	// Determines how monetary values are rounded when calculating taxes for `taxedPrice`.
	TaxRoundingMode *RoundingMode `json:"taxRoundingMode,omitempty"`
	// Determines how taxes are calculated for `taxedPrice`.
	TaxCalculationMode *TaxCalculationMode `json:"taxCalculationMode,omitempty"`
	// Determines how stock quantities are tracked for Line Items in the Cart.
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Billing address associated with the Order.
	BillingAddress *BaseAddress `json:"billingAddress,omitempty"`
	// Shipping address associated with the Order.
	ShippingAddress *BaseAddress `json:"shippingAddress,omitempty"`
	// Addresses for Orders with multiple shipping addresses. Addresses must include a value for `key`.
	ItemShippingAddresses []BaseAddress `json:"itemShippingAddresses"`
	// Shipping-related information of the Order.
	ShippingInfo *ShippingInfoImportDraft `json:"shippingInfo,omitempty"`
	// Payment information associated with the Order.
	PaymentInfo *PaymentInfo `json:"paymentInfo,omitempty"`
	// Payment status of the Order.
	PaymentState *PaymentState `json:"paymentState,omitempty"`
	// Shipment status of the Order.
	ShipmentState *ShipmentState `json:"shipmentState,omitempty"`
	// Current status of the Order.
	OrderState *OrderState `json:"orderState,omitempty"`
	// State of the Order in a custom workflow.
	State *StateReference `json:"state,omitempty"`
	// Include a value to associate a country with the Order.
	Country *string `json:"country,omitempty"`
	// Indicates the origin of the Order.
	Origin *CartOrigin `json:"origin,omitempty"`
	// User-defined date and time for the Order. This value does not influence the `createdAt` or `lastModifiedAt` values of the Order created by the Order Import.
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	// Custom Fields for the Order.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * A snapshot of an Order at the time it was imported. *

func (OrderImportDraft) MarshalJSON ¶ 

func (obj OrderImportDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderImportLineItemStateAction ¶ 

type OrderImportLineItemStateAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// New status of the Line Items.
	State []ItemState `json:"state"`
}

* * The import of States does not follow any predefined rules and should be only used if no transitions are defined. * The `quantity` in the [ItemStates](ctp:api:type:ItemState) must match the sum of all Line Items states' quantities. *

func (OrderImportLineItemStateAction) MarshalJSON ¶ 

func (obj OrderImportLineItemStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderImportedMessage ¶ 

type OrderImportedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Order](ctp:api:type:Order) that was imported.
	Order Order `json:"order"`
}

* * Generated after a successful [Order Import](ctp:api:endpoint:/{projectKey}/orders/import:POST). *

func (OrderImportedMessage) MarshalJSON ¶ 

func (obj OrderImportedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderImportedMessage) UnmarshalJSON ¶ 

func (obj *OrderImportedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderImportedMessagePayload ¶ 

type OrderImportedMessagePayload struct {
	// [Order](ctp:api:type:Order) that was imported.
	Order Order `json:"order"`
}

* * Generated after a successful [Order Import](ctp:api:endpoint:/{projectKey}/orders/import:POST). *

func (OrderImportedMessagePayload) MarshalJSON ¶ 

func (obj OrderImportedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderLineItemAddedMessage ¶ 

type OrderLineItemAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Line Item](ctp:api:type:LineItem) that was added to the [Order](ctp:api:type:Order).
	LineItem LineItem `json:"lineItem"`
	// Quantity of [Line Items](ctp:api:type:LineItem) that were added to the [Order](ctp:api:type:Order).
	AddedQuantity int `json:"addedQuantity"`
}

* * Generated after a successful [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction) update action. *

func (OrderLineItemAddedMessage) MarshalJSON ¶ 

func (obj OrderLineItemAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderLineItemAddedMessage) UnmarshalJSON ¶ 

func (obj *OrderLineItemAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderLineItemAddedMessagePayload ¶ 

type OrderLineItemAddedMessagePayload struct {
	// [Line Item](ctp:api:type:LineItem) that was added to the [Order](ctp:api:type:Order).
	LineItem LineItem `json:"lineItem"`
	// Quantity of [Line Items](ctp:api:type:LineItem) that were added to the [Order](ctp:api:type:Order).
	AddedQuantity int `json:"addedQuantity"`
}

* * Generated after a successful [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction) update action. *

func (OrderLineItemAddedMessagePayload) MarshalJSON ¶ 

func (obj OrderLineItemAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderLineItemDiscountSetMessage ¶ 

type OrderLineItemDiscountSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier for the [Line Item](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// User-defined unique identifier of the LineItem.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Array of [DiscountedLineItemPriceForQuantity](ctp:api:type:DiscountedLineItemPriceForQuantity) after the Discount recalculation.
	DiscountedPricePerQuantity []DiscountedLineItemPriceForQuantity `json:"discountedPricePerQuantity"`
	// Total Price of the [Line Item](ctp:api:type:LineItem) after the Discount recalculation.
	TotalPrice Money `json:"totalPrice"`
	// [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Line Item](ctp:api:type:LineItem) after the Discount recalculation.
	TaxedPrice *TaxedItemPrice `json:"taxedPrice,omitempty"`
	// Total taxed prices based on the quantity of Line Item assigned to each [Shipping Method](ctp:api:type:ShippingMethod). Only applicable for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	// Automatically set after `perMethodTaxRate` is set.
	TaxedPricePortions []MethodTaxedPrice `json:"taxedPricePortions"`
}

* * Generated after a successful recalculation of a Discount on a [Line Item](ctp:api:type:LineItem). *

func (OrderLineItemDiscountSetMessage) MarshalJSON ¶ 

func (obj OrderLineItemDiscountSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderLineItemDiscountSetMessage) UnmarshalJSON ¶ 

func (obj *OrderLineItemDiscountSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderLineItemDiscountSetMessagePayload ¶ 

type OrderLineItemDiscountSetMessagePayload struct {
	// Unique identifier for the [Line Item](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// User-defined unique identifier of the LineItem.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Array of [DiscountedLineItemPriceForQuantity](ctp:api:type:DiscountedLineItemPriceForQuantity) after the Discount recalculation.
	DiscountedPricePerQuantity []DiscountedLineItemPriceForQuantity `json:"discountedPricePerQuantity"`
	// Total Price of the [Line Item](ctp:api:type:LineItem) after the Discount recalculation.
	TotalPrice Money `json:"totalPrice"`
	// [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Line Item](ctp:api:type:LineItem) after the Discount recalculation.
	TaxedPrice *TaxedItemPrice `json:"taxedPrice,omitempty"`
	// Total taxed prices based on the quantity of Line Item assigned to each [Shipping Method](ctp:api:type:ShippingMethod). Only applicable for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	// Automatically set after `perMethodTaxRate` is set.
	TaxedPricePortions []MethodTaxedPrice `json:"taxedPricePortions"`
}

* * Generated after a successful recalculation of a Discount on a [Line Item](ctp:api:type:LineItem). *

func (OrderLineItemDiscountSetMessagePayload) MarshalJSON ¶ 

func (obj OrderLineItemDiscountSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderLineItemDistributionChannelSetMessage ¶ 

type OrderLineItemDistributionChannelSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Line Item](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// User-defined unique identifier of the LineItem.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// [Distribution Channel](ctp:api:type:Channel) that was set.
	DistributionChannel *ChannelReference `json:"distributionChannel,omitempty"`
}

* * Generated after a successful [Set LineItem DistributionChannel](/../api/projects/order-edits#set-lineitem-distributionchannel) update action. *

func (OrderLineItemDistributionChannelSetMessage) MarshalJSON ¶ 

func (obj OrderLineItemDistributionChannelSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderLineItemDistributionChannelSetMessage) UnmarshalJSON ¶ 

func (obj *OrderLineItemDistributionChannelSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderLineItemDistributionChannelSetMessagePayload ¶ 

type OrderLineItemDistributionChannelSetMessagePayload struct {
	// Unique identifier of the [Line Item](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// User-defined unique identifier of the LineItem.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// [Distribution Channel](ctp:api:type:Channel) that was set.
	DistributionChannel *ChannelReference `json:"distributionChannel,omitempty"`
}

* * Generated after a successful [Set LineItem DistributionChannel](/../api/projects/order-edits#set-lineitem-distributionchannel) update action. *

func (OrderLineItemDistributionChannelSetMessagePayload) MarshalJSON ¶ 

func (obj OrderLineItemDistributionChannelSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderLineItemRemovedMessage ¶ 

type OrderLineItemRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Line Item](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// User-defined unique identifier of the LineItem.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Quantity of [Line Items](ctp:api:type:LineItem) that were removed during the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	RemovedQuantity int `json:"removedQuantity"`
	// [Line Item](ctp:api:type:LineItem) quantity after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewQuantity int `json:"newQuantity"`
	// [ItemStates](ctp:api:type:ItemState) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewState []ItemState `json:"newState"`
	// `totalPrice` of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewTotalPrice CentPrecisionMoney `json:"newTotalPrice"`
	// [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewTaxedPrice *TaxedItemPrice `json:"newTaxedPrice,omitempty"`
	// [Price](ctp:api:type:Price) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewPrice *Price `json:"newPrice,omitempty"`
	// [Shipping Details](ctp:api:type:ItemShippingDetails) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewShippingDetail *ItemShippingDetails `json:"newShippingDetail,omitempty"`
}

* * Generated after a successful [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. *

func (OrderLineItemRemovedMessage) MarshalJSON ¶ 

func (obj OrderLineItemRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderLineItemRemovedMessage) UnmarshalJSON ¶ 

func (obj *OrderLineItemRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderLineItemRemovedMessagePayload ¶ 

type OrderLineItemRemovedMessagePayload struct {
	// Unique identifier of the [Line Item](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// User-defined unique identifier of the LineItem.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Quantity of [Line Items](ctp:api:type:LineItem) that were removed during the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	RemovedQuantity int `json:"removedQuantity"`
	// [Line Item](ctp:api:type:LineItem) quantity after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewQuantity int `json:"newQuantity"`
	// [ItemStates](ctp:api:type:ItemState) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewState []ItemState `json:"newState"`
	// `totalPrice` of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewTotalPrice CentPrecisionMoney `json:"newTotalPrice"`
	// [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewTaxedPrice *TaxedItemPrice `json:"newTaxedPrice,omitempty"`
	// [Price](ctp:api:type:Price) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewPrice *Price `json:"newPrice,omitempty"`
	// [Shipping Details](ctp:api:type:ItemShippingDetails) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
	NewShippingDetail *ItemShippingDetails `json:"newShippingDetail,omitempty"`
}

* * Generated after a successful [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. *

func (OrderLineItemRemovedMessagePayload) MarshalJSON ¶ 

func (obj OrderLineItemRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderMessage ¶ 

type OrderMessage interface{}

type OrderMessagePayload ¶ 

type OrderMessagePayload interface{}

type OrderPagedQueryResponse ¶ 

type OrderPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](ctp:api:type:QueryPredicate), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Orders](ctp:api:type:Order) matching the query.
	Results []Order `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of Order(ctp:api:type:Order). *

type OrderPagedSearchResponse ¶ 

type OrderPagedSearchResponse struct {
	// Total number of results matching the query.
	Total int `json:"total"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset *int `json:"offset,omitempty"`
	// Number of [results requested](/../api/general-concepts#limit).
	Limit *int `json:"limit,omitempty"`
	// Actual results.
	Hits []Hit `json:"hits"`
}

type OrderPaymentAddedMessage ¶ 

type OrderPaymentAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Payment](ctp:api:type:Payment) that was added to the [Order](ctp:api:type:Order).
	Payment PaymentReference `json:"payment"`
}

* * Generated after a successful [Add Payment](ctp:api:type:OrderAddPaymentAction) update action or when a Payment(ctp:api:type:Payment) is added via [Order Edits](ctp:api:type:StagedOrderAddPaymentAction). *

func (OrderPaymentAddedMessage) MarshalJSON ¶ 

func (obj OrderPaymentAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderPaymentAddedMessage) UnmarshalJSON ¶ 

func (obj *OrderPaymentAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderPaymentAddedMessagePayload ¶ 

type OrderPaymentAddedMessagePayload struct {
	// [Payment](ctp:api:type:Payment) that was added to the [Order](ctp:api:type:Order).
	Payment PaymentReference `json:"payment"`
}

* * Generated after a successful [Add Payment](ctp:api:type:OrderAddPaymentAction) update action or when a Payment(ctp:api:type:Payment) is added via [Order Edits](ctp:api:type:StagedOrderAddPaymentAction). *

func (OrderPaymentAddedMessagePayload) MarshalJSON ¶ 

func (obj OrderPaymentAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderPaymentStateChangedMessage ¶ 

type OrderPaymentStateChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [PaymentState](ctp:api:type:PaymentState) after the [Change Payment State](ctp:api:type:OrderChangePaymentStateAction) update action.
	PaymentState PaymentState `json:"paymentState"`
	// [PaymentState](ctp:api:type:PaymentState) before the [Change Payment State](ctp:api:type:OrderChangePaymentStateAction) update action.
	OldPaymentState *PaymentState `json:"oldPaymentState,omitempty"`
}

* * Generated after a successful [Change PaymentState](ctp:api:type:OrderChangePaymentStateAction) update action. *

func (OrderPaymentStateChangedMessage) MarshalJSON ¶ 

func (obj OrderPaymentStateChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderPaymentStateChangedMessage) UnmarshalJSON ¶ 

func (obj *OrderPaymentStateChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderPaymentStateChangedMessagePayload ¶ 

type OrderPaymentStateChangedMessagePayload struct {
	// [PaymentState](ctp:api:type:PaymentState) after the [Change Payment State](ctp:api:type:OrderChangePaymentStateAction) update action.
	PaymentState PaymentState `json:"paymentState"`
	// [PaymentState](ctp:api:type:PaymentState) before the [Change Payment State](ctp:api:type:OrderChangePaymentStateAction) update action.
	OldPaymentState *PaymentState `json:"oldPaymentState,omitempty"`
}

* * Generated after a successful [Change PaymentState](ctp:api:type:OrderChangePaymentStateAction) update action. *

func (OrderPaymentStateChangedMessagePayload) MarshalJSON ¶ 

func (obj OrderPaymentStateChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderPurchaseOrderNumberSetMessage ¶ added in v1.3.0 

type OrderPurchaseOrderNumberSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Purchase order number on the [Order](ctp:api:type:Order) after the [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) update action.
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
	// Purchase order number on the [Order](ctp:api:type:Order) before the [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) update action.
	OldPurchaseOrderNumber *string `json:"oldPurchaseOrderNumber,omitempty"`
}

* * Generated after a successful [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) update action. *

func (OrderPurchaseOrderNumberSetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj OrderPurchaseOrderNumberSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderPurchaseOrderNumberSetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *OrderPurchaseOrderNumberSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderPurchaseOrderNumberSetMessagePayload ¶ added in v1.3.0 

type OrderPurchaseOrderNumberSetMessagePayload struct {
	// Purchase order number on the [Order](ctp:api:type:Order) after the [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) update action.
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
	// Purchase order number on the [Order](ctp:api:type:Order) before the [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) update action.
	OldPurchaseOrderNumber *string `json:"oldPurchaseOrderNumber,omitempty"`
}

* * Generated after a successful [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) update action. *

func (OrderPurchaseOrderNumberSetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj OrderPurchaseOrderNumberSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderReference ¶ 

type OrderReference struct {
	// Unique identifier of the referenced [Order](ctp:api:type:Order).
	ID string `json:"id"`
	// Contains the representation of the expanded Order. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Orders.
	Obj *Order `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to an Order(ctp:api:type:Order). *

func (OrderReference) MarshalJSON ¶ 

func (obj OrderReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderRemoveDeliveryAction ¶ 

type OrderRemoveDeliveryAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
}

* * Produces the [DeliveryRemoved](ctp:api:type:DeliveryRemovedMessage) Message. *

func (OrderRemoveDeliveryAction) MarshalJSON ¶ 

func (obj OrderRemoveDeliveryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderRemoveItemShippingAddressAction ¶ 

type OrderRemoveItemShippingAddressAction struct {
	// `key` of the Address to remove from `itemShippingAddresses`.
	AddressKey string `json:"addressKey"`
}

* * An address can only be removed if it is not referenced in any ItemShippingTarget(ctp:api:type:ItemShippingTarget) of the Cart. * In such case, change the Line Item shipping address to a different `addressKey` first using the [Set LineItemShippingDetails](ctp:api:type:OrderSetLineItemShippingDetailsAction) update action, before you remove the obsolete address. *

func (OrderRemoveItemShippingAddressAction) MarshalJSON ¶ 

func (obj OrderRemoveItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderRemoveParcelFromDeliveryAction ¶ 

type OrderRemoveParcelFromDeliveryAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
}

* * Produces the [ParcelRemovedFromDelivery](ctp:api:type:ParcelRemovedFromDeliveryMessage) Message. *

func (OrderRemoveParcelFromDeliveryAction) MarshalJSON ¶ 

func (obj OrderRemoveParcelFromDeliveryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderRemovePaymentAction ¶ 

type OrderRemovePaymentAction struct {
	// Payment to remove from the [PaymentInfo](ctp:api:type:PaymentInfo).
	Payment PaymentResourceIdentifier `json:"payment"`
}

func (OrderRemovePaymentAction) MarshalJSON ¶ 

func (obj OrderRemovePaymentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderReturnShipmentStateChangedMessage ¶ 

type OrderReturnShipmentStateChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [ReturnItem](ctp:api:type:ReturnItem).
	ReturnItemId string `json:"returnItemId"`
	// State of the [ReturnItem](ctp:api:type:ReturnItem) after the [Set Return Shipment State](ctp:api:type:OrderSetReturnShipmentStateAction) update action.
	ReturnShipmentState ReturnShipmentState `json:"returnShipmentState"`
}

* * Generated after a successful [Set ReturnShipmentState](ctp:api:type:OrderSetReturnShipmentStateAction) update action on [Orders](ctp:api:type:Order) and [Order Edits](ctp:api:type:OrderEdit). *

func (OrderReturnShipmentStateChangedMessage) MarshalJSON ¶ 

func (obj OrderReturnShipmentStateChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderReturnShipmentStateChangedMessage) UnmarshalJSON ¶ 

func (obj *OrderReturnShipmentStateChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderReturnShipmentStateChangedMessagePayload ¶ 

type OrderReturnShipmentStateChangedMessagePayload struct {
	// Unique identifier of the [ReturnItem](ctp:api:type:ReturnItem).
	ReturnItemId string `json:"returnItemId"`
	// State of the [ReturnItem](ctp:api:type:ReturnItem) after the [Set Return Shipment State](ctp:api:type:OrderSetReturnShipmentStateAction) update action.
	ReturnShipmentState ReturnShipmentState `json:"returnShipmentState"`
}

* * Generated after a successful [Set ReturnShipmentState](ctp:api:type:OrderSetReturnShipmentStateAction) update action on [Orders](ctp:api:type:Order) and [Order Edits](ctp:api:type:OrderEdit). *

func (OrderReturnShipmentStateChangedMessagePayload) MarshalJSON ¶ 

func (obj OrderReturnShipmentStateChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSearchAndExpression ¶ added in v1.3.0 

type OrderSearchAndExpression struct {
	And []OrderSearchQuery `json:"and"`
}

type OrderSearchAnyValue ¶ added in v1.3.0 

type OrderSearchAnyValue struct {
	Field           string      `json:"field"`
	Boost           *int        `json:"boost,omitempty"`
	CustomType      *string     `json:"customType,omitempty"`
	Value           interface{} `json:"value"`
	Language        *string     `json:"language,omitempty"`
	CaseInsensitive *bool       `json:"caseInsensitive,omitempty"`
}

type OrderSearchCompoundExpression ¶ added in v1.3.0 

type OrderSearchCompoundExpression map[string]interface{}

type OrderSearchDateRangeExpression ¶ added in v1.3.0 

type OrderSearchDateRangeExpression struct {
	Range OrderSearchDateRangeValue `json:"range"`
}

type OrderSearchDateRangeValue ¶ added in v1.3.0 

type OrderSearchDateRangeValue struct {
	Field      string     `json:"field"`
	Boost      *int       `json:"boost,omitempty"`
	CustomType *string    `json:"customType,omitempty"`
	Gte        *time.Time `json:"gte,omitempty"`
	Lte        *time.Time `json:"lte,omitempty"`
}

type OrderSearchExactExpression ¶ added in v1.3.0 

type OrderSearchExactExpression struct {
	Exact OrderSearchAnyValue `json:"exact"`
}

type OrderSearchExistsExpression ¶ added in v1.3.0 

type OrderSearchExistsExpression struct {
	Exists OrderSearchQueryExpressionValue `json:"exists"`
}

type OrderSearchFilterExpression ¶ added in v1.3.0 

type OrderSearchFilterExpression struct {
	Filter []OrderSearchQueryExpression `json:"filter"`
}

type OrderSearchFullTextExpression ¶ added in v1.3.0 

type OrderSearchFullTextExpression struct {
	FullText OrderSearchFullTextValue `json:"fullText"`
}

type OrderSearchFullTextValue ¶ added in v1.3.0 

type OrderSearchFullTextValue struct {
	Field      string                `json:"field"`
	Boost      *int                  `json:"boost,omitempty"`
	CustomType *string               `json:"customType,omitempty"`
	Value      string                `json:"value"`
	Language   *string               `json:"language,omitempty"`
	MustMatch  *OrderSearchMatchType `json:"mustMatch,omitempty"`
}

type OrderSearchLongRangeExpression ¶ added in v1.3.0 

type OrderSearchLongRangeExpression struct {
	Range OrderSearchLongRangeValue `json:"range"`
}

type OrderSearchLongRangeValue ¶ added in v1.3.0 

type OrderSearchLongRangeValue struct {
	Field      string  `json:"field"`
	Boost      *int    `json:"boost,omitempty"`
	CustomType *string `json:"customType,omitempty"`
	Gte        *int    `json:"gte,omitempty"`
	Lte        *int    `json:"lte,omitempty"`
}

type OrderSearchMatchType ¶ added in v1.3.0 

type OrderSearchMatchType string
const (
	OrderSearchMatchTypeAny OrderSearchMatchType = "any"
	OrderSearchMatchTypeAll OrderSearchMatchType = "all"
)

type OrderSearchNotExpression ¶ added in v1.3.0 

type OrderSearchNotExpression struct {
	Not []OrderSearchQuery `json:"not"`
}

type OrderSearchNumberRangeExpression ¶ added in v1.3.0 

type OrderSearchNumberRangeExpression struct {
	Range OrderSearchNumberRangeValue `json:"range"`
}

type OrderSearchNumberRangeValue ¶ added in v1.3.0 

type OrderSearchNumberRangeValue struct {
	Field      string   `json:"field"`
	Boost      *int     `json:"boost,omitempty"`
	CustomType *string  `json:"customType,omitempty"`
	Gte        *float64 `json:"gte,omitempty"`
	Lte        *float64 `json:"lte,omitempty"`
}

type OrderSearchOrExpression ¶ added in v1.3.0 

type OrderSearchOrExpression struct {
	Or []OrderSearchQuery `json:"or"`
}

type OrderSearchPrefixExpression ¶ added in v1.3.0 

type OrderSearchPrefixExpression struct {
	Prefix OrderSearchStringValue `json:"prefix"`
}

type OrderSearchQuery ¶ 

type OrderSearchQuery map[string]interface{}

type OrderSearchQueryExpression ¶ added in v1.3.0 

type OrderSearchQueryExpression map[string]interface{}

type OrderSearchQueryExpressionValue ¶ added in v1.3.0 

type OrderSearchQueryExpressionValue struct {
	Field      string  `json:"field"`
	Boost      *int    `json:"boost,omitempty"`
	CustomType *string `json:"customType,omitempty"`
}

type OrderSearchRequest ¶ 

type OrderSearchRequest struct {
	// The Order search query.
	Query OrderSearchQuery `json:"query"`
	// Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.
	Sort []OrderSearchSorting `json:"sort"`
	// The maximum number of search results to be returned.
	Limit *int `json:"limit,omitempty"`
	// The number of search results to be skipped in the response for pagination.
	Offset *int `json:"offset,omitempty"`
}

func (OrderSearchRequest) MarshalJSON ¶ added in v1.2.0 

func (obj OrderSearchRequest) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSearchSortMode ¶ added in v1.3.0 

type OrderSearchSortMode string
const (
	OrderSearchSortModeMin OrderSearchSortMode = "min"
	OrderSearchSortModeMax OrderSearchSortMode = "max"
	OrderSearchSortModeAvg OrderSearchSortMode = "avg"
	OrderSearchSortModeSum OrderSearchSortMode = "sum"
)

type OrderSearchSortOrder ¶ added in v1.3.0 

type OrderSearchSortOrder string
const (
	OrderSearchSortOrderAsc  OrderSearchSortOrder = "asc"
	OrderSearchSortOrderDesc OrderSearchSortOrder = "desc"
)

type OrderSearchSorting ¶ added in v1.2.0 

type OrderSearchSorting struct {
	Field    string                      `json:"field"`
	Language *string                     `json:"language,omitempty"`
	Order    *OrderSearchSortOrder       `json:"order,omitempty"`
	Mode     *OrderSearchSortMode        `json:"mode,omitempty"`
	Filter   *OrderSearchQueryExpression `json:"filter,omitempty"`
}

type OrderSearchStatus ¶ 

type OrderSearchStatus string

* * Specifies the status of the [Order Search](/../api/projects/order-search) index. 

const (
	OrderSearchStatusActivated   OrderSearchStatus = "Activated"
	OrderSearchStatusDeactivated OrderSearchStatus = "Deactivated"
)

type OrderSearchStringValue ¶ added in v1.3.0 

type OrderSearchStringValue struct {
	Field           string  `json:"field"`
	Boost           *int    `json:"boost,omitempty"`
	CustomType      *string `json:"customType,omitempty"`
	Value           string  `json:"value"`
	Language        *string `json:"language,omitempty"`
	CaseInsensitive *bool   `json:"caseInsensitive,omitempty"`
}

type OrderSearchWildCardExpression ¶ added in v1.3.0 

type OrderSearchWildCardExpression struct {
	Wildcard OrderSearchStringValue `json:"wildcard"`
}

type OrderSetBillingAddressAction ¶ 

type OrderSetBillingAddressAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Address *BaseAddress `json:"address,omitempty"`
}

* * This action updates the `billingAddress` on the Order, but it does not change the billing address on the referenced Cart(ctp:api:type:Cart) from which the Order is created. * * Produces the [Order Billing Address Set](ctp:api:type:OrderBillingAddressSetMessage) Message. *

func (OrderSetBillingAddressAction) MarshalJSON ¶ 

func (obj OrderSetBillingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetBillingAddressCustomFieldAction ¶ 

type OrderSetBillingAddressCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetBillingAddressCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetBillingAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetBillingAddressCustomTypeAction ¶ 

type OrderSetBillingAddressCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the `billingAddress` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `billingAddress`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `billingAddress`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetBillingAddressCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetBillingAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetCustomFieldAction ¶ 

type OrderSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetCustomLineItemCustomFieldAction ¶ 

type OrderSetCustomLineItemCustomFieldAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetCustomLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetCustomLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetCustomLineItemCustomTypeAction ¶ 

type OrderSetCustomLineItemCustomTypeAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Custom Line Item with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Custom Line Item.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Custom Line Item.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetCustomLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetCustomLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetCustomLineItemShippingDetailsAction ¶ 

type OrderSetCustomLineItemShippingDetailsAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
}

func (OrderSetCustomLineItemShippingDetailsAction) MarshalJSON ¶ 

func (obj OrderSetCustomLineItemShippingDetailsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetCustomTypeAction ¶ 

type OrderSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Order with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Order.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Order.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetCustomerEmailAction ¶ 

type OrderSetCustomerEmailAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Email *string `json:"email,omitempty"`
}

* * This action updates the `customerEmail` on the Order, but it does not change the Customer email on the Cart(ctp:api:type:Cart) the Order has been created from. * * Produces the [Order Customer Email Set](ctp:api:type:OrderCustomerEmailSetMessage) Message. *

func (OrderSetCustomerEmailAction) MarshalJSON ¶ 

func (obj OrderSetCustomerEmailAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetCustomerIdAction ¶ 

type OrderSetCustomerIdAction struct {
	// `id` of an existing [Customer](ctp:api:type:Customer).
	// If empty, any existing value is removed.
	CustomerId *string `json:"customerId,omitempty"`
}

* * Setting the Order's `customerId` does not recalculate prices or discounts on the Order. * If the Customer belongs to a Customer Group, `customerGroup` on the Order(ctp:api:type:Order) is updated automatically. * * Produces the [OrderCustomerSet](ctp:api:type:OrderCustomerSetMessage) Message. *

func (OrderSetCustomerIdAction) MarshalJSON ¶ 

func (obj OrderSetCustomerIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetDeliveryAddressAction ¶ 

type OrderSetDeliveryAddressAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	Address *BaseAddress `json:"address,omitempty"`
}

* * Produces the [DeliveryAddressSet](ctp:api:type:DeliveryAddressSetMessage) Message. *

func (OrderSetDeliveryAddressAction) MarshalJSON ¶ 

func (obj OrderSetDeliveryAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetDeliveryAddressCustomFieldAction ¶ 

type OrderSetDeliveryAddressCustomFieldAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetDeliveryAddressCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetDeliveryAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetDeliveryAddressCustomTypeAction ¶ 

type OrderSetDeliveryAddressCustomTypeAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the [Delivery](ctp:api:type:Delivery) `address` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the [Delivery](ctp:api:type:Delivery) `address`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the [Delivery](ctp:api:type:Delivery) `address`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetDeliveryAddressCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetDeliveryAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetDeliveryCustomFieldAction ¶ 

type OrderSetDeliveryCustomFieldAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetDeliveryCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetDeliveryCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetDeliveryCustomTypeAction ¶ 

type OrderSetDeliveryCustomTypeAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Delivery with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Delivery.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Delivery.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetDeliveryCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetDeliveryCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetDeliveryItemsAction ¶ 

type OrderSetDeliveryItemsAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	Items []DeliveryItem `json:"items"`
}

* * Produces the [Delivery Items Updated](ctp:api:type:DeliveryItemsUpdatedMessage) Message. *

func (OrderSetDeliveryItemsAction) MarshalJSON ¶ 

func (obj OrderSetDeliveryItemsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetItemShippingAddressCustomFieldAction ¶ 

type OrderSetItemShippingAddressCustomFieldAction struct {
	// `key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
	AddressKey string `json:"addressKey"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetItemShippingAddressCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetItemShippingAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetItemShippingAddressCustomTypeAction ¶ 

type OrderSetItemShippingAddressCustomTypeAction struct {
	// `key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
	AddressKey string `json:"addressKey"`
	// Defines the [Type](ctp:api:type:Type) that extends the `itemShippingAddress` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `itemShippingAddress`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `itemShippingAddress`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetItemShippingAddressCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetItemShippingAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetLineItemCustomFieldAction ¶ 

type OrderSetLineItemCustomFieldAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetLineItemCustomTypeAction ¶ 

type OrderSetLineItemCustomTypeAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Line Item with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Line Item.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Line Item.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetLineItemShippingDetailsAction ¶ 

type OrderSetLineItemShippingDetailsAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If empty, the existing value is removed.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
}

func (OrderSetLineItemShippingDetailsAction) MarshalJSON ¶ 

func (obj OrderSetLineItemShippingDetailsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetLocaleAction ¶ 

type OrderSetLocaleAction struct {
	// Value to set.
	// Must be one of the [Project](ctp:api:type:Project)'s languages.
	// If empty, any existing value is removed.
	Locale *string `json:"locale,omitempty"`
}

func (OrderSetLocaleAction) MarshalJSON ¶ 

func (obj OrderSetLocaleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetOrderNumberAction ¶ 

type OrderSetOrderNumberAction struct {
	// Value to set.
	// Must be unique across a Project.
	// Once set, the value cannot be changed.
	OrderNumber *string `json:"orderNumber,omitempty"`
}

func (OrderSetOrderNumberAction) MarshalJSON ¶ 

func (obj OrderSetOrderNumberAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetParcelCustomFieldAction ¶ 

type OrderSetParcelCustomFieldAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetParcelCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetParcelCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetParcelCustomTypeAction ¶ 

type OrderSetParcelCustomTypeAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Parcel with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Parcel.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Parcel.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetParcelCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetParcelCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetParcelItemsAction ¶ 

type OrderSetParcelItemsAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	Items []DeliveryItem `json:"items"`
}

* * Produces the [ParcelItemsUpdated](ctp:api:type:ParcelItemsUpdatedMessage) Message. *

func (OrderSetParcelItemsAction) MarshalJSON ¶ 

func (obj OrderSetParcelItemsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetParcelMeasurementsAction ¶ 

type OrderSetParcelMeasurementsAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	Measurements *ParcelMeasurements `json:"measurements,omitempty"`
}

* * Produces the [ParcelMeasurementsUpdated](ctp:api:type:ParcelMeasurementsUpdatedMessage) Message. *

func (OrderSetParcelMeasurementsAction) MarshalJSON ¶ 

func (obj OrderSetParcelMeasurementsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetParcelTrackingDataAction ¶ 

type OrderSetParcelTrackingDataAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	TrackingData *TrackingData `json:"trackingData,omitempty"`
}

* * Produces the [ParcelTrackingDataUpdated](ctp:api:type:ParcelTrackingDataUpdatedMessage) Message. *

func (OrderSetParcelTrackingDataAction) MarshalJSON ¶ 

func (obj OrderSetParcelTrackingDataAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetPurchaseOrderNumberAction ¶ added in v1.3.0 

type OrderSetPurchaseOrderNumberAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
}

* * Produces the [PurchaseOrderNumberSet](ctp:api:type:OrderPurchaseOrderNumberSetMessage) Message. *

func (OrderSetPurchaseOrderNumberAction) MarshalJSON ¶ added in v1.3.0 

func (obj OrderSetPurchaseOrderNumberAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetReturnInfoAction ¶ 

type OrderSetReturnInfoAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Items []ReturnInfoDraft `json:"items"`
}

* * Produces the [Return Info Set](ctp:api:type:ReturnInfoSetMessage) Message. *

func (OrderSetReturnInfoAction) MarshalJSON ¶ 

func (obj OrderSetReturnInfoAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetReturnItemCustomFieldAction ¶ 

type OrderSetReturnItemCustomFieldAction struct {
	// `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemId *string `json:"returnItemId,omitempty"`
	// `key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemKey *string `json:"returnItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetReturnItemCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetReturnItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetReturnItemCustomTypeAction ¶ 

type OrderSetReturnItemCustomTypeAction struct {
	// `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemId *string `json:"returnItemId,omitempty"`
	// `key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemKey *string `json:"returnItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Return Item with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Return Item.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Return Item.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetReturnItemCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetReturnItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetReturnPaymentStateAction ¶ 

type OrderSetReturnPaymentStateAction struct {
	// `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemId *string `json:"returnItemId,omitempty"`
	// `key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemKey *string `json:"returnItemKey,omitempty"`
	// New Payment status of the [ReturnItem](ctp:api:type:ReturnItem).
	PaymentState ReturnPaymentState `json:"paymentState"`
}

* * To set a ReturnPaymentState(ctp:api:type:ReturnPaymentState), the Order(ctp:api:type:Order) `returnInfo` must have at least one ReturnItem(ctp:api:type:ReturnItem). *

func (OrderSetReturnPaymentStateAction) MarshalJSON ¶ 

func (obj OrderSetReturnPaymentStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetReturnShipmentStateAction ¶ 

type OrderSetReturnShipmentStateAction struct {
	// `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemId *string `json:"returnItemId,omitempty"`
	// `key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemKey *string `json:"returnItemKey,omitempty"`
	// New shipment state of the [ReturnItem](ctp:api:type:ReturnItem).
	ShipmentState ReturnShipmentState `json:"shipmentState"`
}

* * To set a `ReturnShipmentState`, the Order(ctp:api:type:Order) `returnInfo` must have at least one ReturnItem(ctp:api:type:ReturnItem). * * Produces the [Order Return Shipment State Changed](ctp:api:type:OrderReturnShipmentStateChangedMessage) Message. *

func (OrderSetReturnShipmentStateAction) MarshalJSON ¶ 

func (obj OrderSetReturnShipmentStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetShippingAddressAction ¶ 

type OrderSetShippingAddressAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Address *BaseAddress `json:"address,omitempty"`
}

* * This action updates the `shippingAddress` on the Order, but it does not change the shipping address on the referenced Cart(ctp:api:type:Cart) from which the Order is created. * Also, it does not recalculate the Cart as taxes may not fit to the shipping address anymore. * * Produces the [Order Shipping Address Set](ctp:api:type:OrderShippingAddressSetMessage) Message. *

func (OrderSetShippingAddressAction) MarshalJSON ¶ 

func (obj OrderSetShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetShippingAddressCustomFieldAction ¶ 

type OrderSetShippingAddressCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (OrderSetShippingAddressCustomFieldAction) MarshalJSON ¶ 

func (obj OrderSetShippingAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetShippingAddressCustomTypeAction ¶ 

type OrderSetShippingAddressCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the `shippingAddress` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `shippingAddress`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `shippingAddress`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (OrderSetShippingAddressCustomTypeAction) MarshalJSON ¶ 

func (obj OrderSetShippingAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderSetStoreAction ¶ 

type OrderSetStoreAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	//
	// If `store` references the same Store the Order is currently assigned to or if you try to remove the value when no Store is currently assigned, a `400` error is returned.
	Store *StoreResourceIdentifier `json:"store,omitempty"`
}

* * Sets the Store(ctp:api:type:Store) the Order is assigned to. * It should be used to migrate Orders to a new Store. * No validations are performed (such as that the Customer is allowed to create Orders in the Store). * * Produces the [Order Store Set](ctp:api:type:OrderStoreSetMessage) Message. * Returns a `400` error if `store` references the same Store the Order is currently assigned to, including if you try to remove the value when no Store is currently assigned. *

func (OrderSetStoreAction) MarshalJSON ¶ 

func (obj OrderSetStoreAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderShipmentStateChangedMessage ¶ 

type OrderShipmentStateChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [ShipmentState](ctp:api:type:ShipmentState) after the [Change Shipment State](ctp:api:type:OrderChangeShipmentStateAction) update action.
	ShipmentState ShipmentState `json:"shipmentState"`
	// [ShipmentState](ctp:api:type:ShipmentState) before the [Change Shipment State](ctp:api:type:OrderChangeShipmentStateAction) update action.
	OldShipmentState *ShipmentState `json:"oldShipmentState,omitempty"`
}

* * Generated after a successful [Change ShipmentState](ctp:api:type:OrderChangeShipmentStateAction) update action. *

func (OrderShipmentStateChangedMessage) MarshalJSON ¶ 

func (obj OrderShipmentStateChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderShipmentStateChangedMessage) UnmarshalJSON ¶ 

func (obj *OrderShipmentStateChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderShipmentStateChangedMessagePayload ¶ 

type OrderShipmentStateChangedMessagePayload struct {
	// [ShipmentState](ctp:api:type:ShipmentState) after the [Change Shipment State](ctp:api:type:OrderChangeShipmentStateAction) update action.
	ShipmentState ShipmentState `json:"shipmentState"`
	// [ShipmentState](ctp:api:type:ShipmentState) before the [Change Shipment State](ctp:api:type:OrderChangeShipmentStateAction) update action.
	OldShipmentState *ShipmentState `json:"oldShipmentState,omitempty"`
}

* * Generated after a successful [Change ShipmentState](ctp:api:type:OrderChangeShipmentStateAction) update action. *

func (OrderShipmentStateChangedMessagePayload) MarshalJSON ¶ 

func (obj OrderShipmentStateChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderShippingAddressSetMessage ¶ 

type OrderShippingAddressSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Shipping address on the Order after the [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) update action.
	Address *Address `json:"address,omitempty"`
	// Shipping address on the Order before the [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) update action.
	OldAddress *Address `json:"oldAddress,omitempty"`
}

* * Generated after a successful [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) update action. *

func (OrderShippingAddressSetMessage) MarshalJSON ¶ 

func (obj OrderShippingAddressSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderShippingAddressSetMessage) UnmarshalJSON ¶ 

func (obj *OrderShippingAddressSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderShippingAddressSetMessagePayload ¶ 

type OrderShippingAddressSetMessagePayload struct {
	// Shipping address on the Order after the [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) update action.
	Address *Address `json:"address,omitempty"`
	// Shipping address on the Order before the [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) update action.
	OldAddress *Address `json:"oldAddress,omitempty"`
}

* * Generated after a successful [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) update action. *

func (OrderShippingAddressSetMessagePayload) MarshalJSON ¶ 

func (obj OrderShippingAddressSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderShippingInfoSetMessage ¶ 

type OrderShippingInfoSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [ShippingInfo](ctp:api:type:ShippingInfo) after the [Set Shipping Method](ctp:api:type:StagedOrderSetShippingMethodAction) or [Set Custom Shipping Method](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update action.
	ShippingInfo *ShippingInfo `json:"shippingInfo,omitempty"`
	// [ShippingInfo](ctp:api:type:ShippingInfo) before the [Set Shipping Method](ctp:api:type:StagedOrderSetShippingMethodAction) or [Set Custom Shipping Method](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update action.
	OldShippingInfo *ShippingInfo `json:"oldShippingInfo,omitempty"`
}

* * Generated after a successful [Set ShippingMethod](ctp:api:type:StagedOrderSetShippingMethodAction) and [Set Custom ShippingMethod](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update actions. *

func (OrderShippingInfoSetMessage) MarshalJSON ¶ 

func (obj OrderShippingInfoSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderShippingInfoSetMessage) UnmarshalJSON ¶ 

func (obj *OrderShippingInfoSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderShippingInfoSetMessagePayload ¶ 

type OrderShippingInfoSetMessagePayload struct {
	// [ShippingInfo](ctp:api:type:ShippingInfo) after the [Set Shipping Method](ctp:api:type:StagedOrderSetShippingMethodAction) or [Set Custom Shipping Method](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update action.
	ShippingInfo *ShippingInfo `json:"shippingInfo,omitempty"`
	// [ShippingInfo](ctp:api:type:ShippingInfo) before the [Set Shipping Method](ctp:api:type:StagedOrderSetShippingMethodAction) or [Set Custom Shipping Method](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update action.
	OldShippingInfo *ShippingInfo `json:"oldShippingInfo,omitempty"`
}

* * Generated after a successful [Set ShippingMethod](ctp:api:type:StagedOrderSetShippingMethodAction) and [Set Custom ShippingMethod](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update actions. *

func (OrderShippingInfoSetMessagePayload) MarshalJSON ¶ 

func (obj OrderShippingInfoSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderShippingRateInputSetMessage ¶ 

type OrderShippingRateInputSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [ShippingRateInput](ctp:api:type:ShippingRateInput) after the [Set ShippingRateInput](ctp:api:type:StagedOrderSetShippingRateInputAction) update action.
	ShippingRateInput ShippingRateInput `json:"shippingRateInput,omitempty"`
	// [ShippingRateInput](ctp:api:type:ShippingRateInput) before the [Set ShippingRateInput](ctp:api:type:StagedOrderSetShippingRateInputAction) update action.
	OldShippingRateInput ShippingRateInput `json:"oldShippingRateInput,omitempty"`
}

* * Generated after a successful [Set ShippingRateInput](ctp:api:type:StagedOrderSetShippingRateInputAction) update action. *

func (OrderShippingRateInputSetMessage) MarshalJSON ¶ 

func (obj OrderShippingRateInputSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderShippingRateInputSetMessage) UnmarshalJSON ¶ 

func (obj *OrderShippingRateInputSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderShippingRateInputSetMessagePayload ¶ 

type OrderShippingRateInputSetMessagePayload struct {
	// [ShippingRateInput](ctp:api:type:ShippingRateInput) after the [Set ShippingRateInput](ctp:api:type:StagedOrderSetShippingRateInputAction) update action.
	ShippingRateInput ShippingRateInput `json:"shippingRateInput,omitempty"`
	// [ShippingRateInput](ctp:api:type:ShippingRateInput) before the [Set ShippingRateInput](ctp:api:type:StagedOrderSetShippingRateInputAction) update action.
	OldShippingRateInput ShippingRateInput `json:"oldShippingRateInput,omitempty"`
}

* * Generated after a successful [Set ShippingRateInput](ctp:api:type:StagedOrderSetShippingRateInputAction) update action. *

func (OrderShippingRateInputSetMessagePayload) MarshalJSON ¶ 

func (obj OrderShippingRateInputSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderShippingRateInputSetMessagePayload) UnmarshalJSON ¶ 

func (obj *OrderShippingRateInputSetMessagePayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderState ¶ 

type OrderState string

* * Indicates the state of the Order. * 

const (
	OrderStateOpen      OrderState = "Open"
	OrderStateConfirmed OrderState = "Confirmed"
	OrderStateComplete  OrderState = "Complete"
	OrderStateCancelled OrderState = "Cancelled"
)

type OrderStateChangedMessage ¶ 

type OrderStateChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [OrderState](ctp:api:type:OrderState) after the [Change Order State](ctp:api:type:OrderChangeOrderStateAction) update action.
	OrderState OrderState `json:"orderState"`
	// [OrderState](ctp:api:type:OrderState) before the [Change Order State](ctp:api:type:OrderChangeOrderStateAction) update action.
	OldOrderState *OrderState `json:"oldOrderState,omitempty"`
}

* * Generated after a successful [Change OrderState](ctp:api:type:OrderChangeOrderStateAction) update action. *

func (OrderStateChangedMessage) MarshalJSON ¶ 

func (obj OrderStateChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderStateChangedMessage) UnmarshalJSON ¶ 

func (obj *OrderStateChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderStateChangedMessagePayload ¶ 

type OrderStateChangedMessagePayload struct {
	// [OrderState](ctp:api:type:OrderState) after the [Change Order State](ctp:api:type:OrderChangeOrderStateAction) update action.
	OrderState OrderState `json:"orderState"`
	// [OrderState](ctp:api:type:OrderState) before the [Change Order State](ctp:api:type:OrderChangeOrderStateAction) update action.
	OldOrderState *OrderState `json:"oldOrderState,omitempty"`
}

* * Generated after a successful [Change OrderState](ctp:api:type:OrderChangeOrderStateAction) update action. *

func (OrderStateChangedMessagePayload) MarshalJSON ¶ 

func (obj OrderStateChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderStateTransitionMessage ¶ 

type OrderStateTransitionMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [OrderState](ctp:api:type:OrderState) after the [Transition State](ctp:api:type:OrderTransitionStateAction) update action.
	State StateReference `json:"state"`
	// [OrderState](ctp:api:type:OrderState) before the [Transition State](ctp:api:type:OrderTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:OrderTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:OrderTransitionStateAction) update action. *

func (OrderStateTransitionMessage) MarshalJSON ¶ 

func (obj OrderStateTransitionMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderStateTransitionMessage) UnmarshalJSON ¶ 

func (obj *OrderStateTransitionMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderStateTransitionMessagePayload ¶ 

type OrderStateTransitionMessagePayload struct {
	// [OrderState](ctp:api:type:OrderState) after the [Transition State](ctp:api:type:OrderTransitionStateAction) update action.
	State StateReference `json:"state"`
	// [OrderState](ctp:api:type:OrderState) before the [Transition State](ctp:api:type:OrderTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:OrderTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:OrderTransitionStateAction) update action. *

func (OrderStateTransitionMessagePayload) MarshalJSON ¶ 

func (obj OrderStateTransitionMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderStoreSetMessage ¶ 

type OrderStoreSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Store](ctp:api:type:Store) that was set.
	Store *StoreKeyReference `json:"store,omitempty"`
}

* * Generated after a successful [Set Store](ctp:api:type:OrderSetStoreAction) update action. *

func (OrderStoreSetMessage) MarshalJSON ¶ 

func (obj OrderStoreSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OrderStoreSetMessage) UnmarshalJSON ¶ 

func (obj *OrderStoreSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderStoreSetMessagePayload ¶ 

type OrderStoreSetMessagePayload struct {
	// [Store](ctp:api:type:Store) that was set.
	Store *StoreKeyReference `json:"store,omitempty"`
}

* * Generated after a successful [Set Store](ctp:api:type:OrderSetStoreAction) update action. *

func (OrderStoreSetMessagePayload) MarshalJSON ¶ 

func (obj OrderStoreSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderTransitionCustomLineItemStateAction ¶ 

type OrderTransitionCustomLineItemStateAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Number of Custom Line Items that should transition [State](ctp:api:type:State).
	Quantity int `json:"quantity"`
	// [State](ctp:api:type:State) the Custom Line Item should transition from.
	FromState StateResourceIdentifier `json:"fromState"`
	// [State](ctp:api:type:State) the Custom Line Item should transition to.
	ToState StateResourceIdentifier `json:"toState"`
	// Date and time (UTC) to perform the [State](ctp:api:type:State) transition.
	ActualTransitionDate *time.Time `json:"actualTransitionDate,omitempty"`
}

* * Produces the [Custom Line Item State Transition](ctp:api:type:CustomLineItemStateTransitionMessage) Message. *

func (OrderTransitionCustomLineItemStateAction) MarshalJSON ¶ 

func (obj OrderTransitionCustomLineItemStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderTransitionLineItemStateAction ¶ 

type OrderTransitionLineItemStateAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Number of Line Items that should transition [State](ctp:api:type:State).
	Quantity int `json:"quantity"`
	// [State](ctp:api:type:State) the Line Item should transition from.
	FromState StateResourceIdentifier `json:"fromState"`
	// [State](ctp:api:type:State) the Line Item should transition to.
	ToState StateResourceIdentifier `json:"toState"`
	// Date and time (UTC) to perform the [State](ctp:api:type:State) transition.
	ActualTransitionDate *time.Time `json:"actualTransitionDate,omitempty"`
}

* * Produces the [Line Item State Transition](ctp:api:type:LineItemStateTransitionMessage) Message. *

func (OrderTransitionLineItemStateAction) MarshalJSON ¶ 

func (obj OrderTransitionLineItemStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderTransitionStateAction ¶ 

type OrderTransitionStateAction struct {
	// Value to set.
	// If there is no State yet, the new State must be an initial State.
	State StateResourceIdentifier `json:"state"`
	// Set to `true` to turn off validation.
	Force *bool `json:"force,omitempty"`
}

* * If the existing State(ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State. * If `transitions` is not set, no validation is performed. * * This update action produces the [Order State Transition](ctp:api:type:OrderStateTransitionMessage) Message. *

func (OrderTransitionStateAction) MarshalJSON ¶ 

func (obj OrderTransitionStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderUpdate ¶ 

type OrderUpdate struct {
	// Expected version of the Order on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Order.
	Actions []OrderUpdateAction `json:"actions"`
}

func (*OrderUpdate) UnmarshalJSON ¶ 

func (obj *OrderUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OrderUpdateAction ¶ 

type OrderUpdateAction interface{}

type OrderUpdateItemShippingAddressAction ¶ 

type OrderUpdateItemShippingAddressAction struct {
	// The new Address with the same `key` as the Address it will replace.
	Address BaseAddress `json:"address"`
}

* * Updates an address in `itemShippingAddresses` by keeping the Address `key`. *

func (OrderUpdateItemShippingAddressAction) MarshalJSON ¶ 

func (obj OrderUpdateItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderUpdateSyncInfoAction ¶ 

type OrderUpdateSyncInfoAction struct {
	// Set this to identify an external order instance, file, or other resource.
	ExternalId *string `json:"externalId,omitempty"`
	// The synchronization destination to set. Must not be empty.
	// The referenced Channel must have the [Channel Role](ctp:api:type:ChannelRoleEnum) `OrderExport` or `OrderImport`.
	// Otherwise this update action returns an [InvalidInput](ctp:api:type:InvalidInputError) error.
	Channel ChannelResourceIdentifier `json:"channel"`
	// If not set, it defaults to the current date and time.
	SyncedAt *time.Time `json:"syncedAt,omitempty"`
}

func (OrderUpdateSyncInfoAction) MarshalJSON ¶ 

func (obj OrderUpdateSyncInfoAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OutOfStockError ¶ 

type OutOfStockError struct {
	// `"Some line items are out of stock at the time of placing the order: $itemSku."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifiers of the Line Items that are out of stock.
	LineItems []string `json:"lineItems"`
	// SKUs of the Line Items that are out of stock.
	Skus []string `json:"skus"`
}

* * Returned when some of the [Line Items](ctp:api:type:LineItem) are out of stock at the time of placing an Order(ctp:api:type:Order). * * The error is returned as a failed response to: * * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. *

func (*OutOfStockError) DecodeStruct ¶ added in v1.1.0 

func (obj *OutOfStockError) DecodeStruct(src map[string]interface{}) error

func (OutOfStockError) Error ¶ 

func (obj OutOfStockError) Error() string

func (OutOfStockError) MarshalJSON ¶ 

func (obj OutOfStockError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OutOfStockError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *OutOfStockError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OverCapacityError ¶ 

type OverCapacityError struct {
	// Plain text description of the error.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the service is having trouble handling the load. * * The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. *

func (*OverCapacityError) DecodeStruct ¶ added in v1.1.0 

func (obj *OverCapacityError) DecodeStruct(src map[string]interface{}) error

func (OverCapacityError) Error ¶ 

func (obj OverCapacityError) Error() string

func (OverCapacityError) MarshalJSON ¶ 

func (obj OverCapacityError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OverCapacityError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *OverCapacityError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type OverlappingStandalonePriceValidityError ¶ 

type OverlappingStandalonePriceValidityError struct {
	// `Two standalone prices have overlapping validity periods."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Reference to the conflicting Standalone Price.
	ConflictingStandalonePrice StandalonePriceReference `json:"conflictingStandalonePrice"`
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the conflicting Standalone Price is associated.
	Sku string `json:"sku"`
	// Currency code of the country.
	Currency string `json:"currency"`
	// Country code of the geographic location.
	Country *string `json:"country,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) for which the Standalone Price is valid.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
	// [Channel](ctp:api:type:Channel) for which the Standalone Price is valid.
	Channel *ChannelResourceIdentifier `json:"channel,omitempty"`
	// Date and time (UTC) from which the Standalone Price is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Standalone Price is valid.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Date and time (UTC) from which the conflicting Standalone Price is valid.
	ConflictingValidFrom *time.Time `json:"conflictingValidFrom,omitempty"`
	// Date and time (UTC) until which the conflicting Standalone Price is valid.
	ConflictingValidUntil *time.Time `json:"conflictingValidUntil,omitempty"`
}

* * Returned when a given Price validity period conflicts with an existing one. * Every Standalone Price associated with the same SKU and with the same combination of currency, country, Customer Group, and Channel, must have non-overlapping validity periods (`validFrom` and `validUntil`). * * The error is returned as a failed response to the [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request. *

func (*OverlappingStandalonePriceValidityError) DecodeStruct ¶ added in v1.1.0 

func (obj *OverlappingStandalonePriceValidityError) DecodeStruct(src map[string]interface{}) error

func (OverlappingStandalonePriceValidityError) Error ¶ 

func (obj OverlappingStandalonePriceValidityError) Error() string

func (OverlappingStandalonePriceValidityError) MarshalJSON ¶ 

func (obj OverlappingStandalonePriceValidityError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*OverlappingStandalonePriceValidityError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *OverlappingStandalonePriceValidityError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PagedQueryResponse ¶ 

type PagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total   *int           `json:"total,omitempty"`
	Results []BaseResource `json:"results"`
	Meta    *interface{}   `json:"meta,omitempty"`
}

type Parcel ¶ 

type Parcel struct {
	// Unique identifier of the Parcel.
	ID string `json:"id"`
	// User-defined unique identifier of the Parcel.
	Key *string `json:"key,omitempty"`
	// Date and time (UTC) the Parcel was created.
	CreatedAt time.Time `json:"createdAt"`
	// Information about the dimensions of the Parcel.
	Measurements *ParcelMeasurements `json:"measurements,omitempty"`
	// Shipment tracking information of the Parcel.
	TrackingData *TrackingData `json:"trackingData,omitempty"`
	// Line Items or Custom Line Items delivered in this Parcel.
	Items []DeliveryItem `json:"items"`
	// Custom Fields of the Parcel.
	Custom *CustomFields `json:"custom,omitempty"`
}

* * Information regarding the appearance, content, and shipment of a Parcel. *

func (Parcel) MarshalJSON ¶ 

func (obj Parcel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ParcelAddedToDeliveryMessage ¶ 

type ParcelAddedToDeliveryMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	Delivery Delivery `json:"delivery"`
	// [Parcel](ctp:api:type:Parcel) that was added to the [Delivery](ctp:api:type:Delivery).
	Parcel Parcel `json:"parcel"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Add Parcel to Delivery](ctp:api:type:OrderAddParcelToDeliveryAction) update action. *

func (ParcelAddedToDeliveryMessage) MarshalJSON ¶ 

func (obj ParcelAddedToDeliveryMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ParcelAddedToDeliveryMessage) UnmarshalJSON ¶ 

func (obj *ParcelAddedToDeliveryMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ParcelAddedToDeliveryMessagePayload ¶ 

type ParcelAddedToDeliveryMessagePayload struct {
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	Delivery Delivery `json:"delivery"`
	// [Parcel](ctp:api:type:Parcel) that was added to the [Delivery](ctp:api:type:Delivery).
	Parcel Parcel `json:"parcel"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Add Parcel to Delivery](ctp:api:type:OrderAddParcelToDeliveryAction) update action. *

func (ParcelAddedToDeliveryMessagePayload) MarshalJSON ¶ 

func (obj ParcelAddedToDeliveryMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ParcelDraft ¶ 

type ParcelDraft struct {
	// User-defined unique identifier of the Parcel.
	Key *string `json:"key,omitempty"`
	// Information about the dimensions for the Parcel.
	Measurements *ParcelMeasurements `json:"measurements,omitempty"`
	// Shipment tracking information for the Parcel.
	TrackingData *TrackingData `json:"trackingData,omitempty"`
	// Line Items or Custom Line Items delivered in this Parcel.
	Items []DeliveryItem `json:"items"`
	// Custom Fields for the Parcel.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (ParcelDraft) MarshalJSON ¶ 

func (obj ParcelDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ParcelItemsUpdatedMessage ¶ 

type ParcelItemsUpdatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Parcel](ctp:api:type:Parcel).
	ParcelId string `json:"parcelId"`
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// [Delivery Items](ctp:api:type:DeliveryItem) after the [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) update action.
	Items []DeliveryItem `json:"items"`
	// [Delivery Items](ctp:api:type:DeliveryItem) before the [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) update action.
	OldItems []DeliveryItem `json:"oldItems"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) update action. *

func (ParcelItemsUpdatedMessage) MarshalJSON ¶ 

func (obj ParcelItemsUpdatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ParcelItemsUpdatedMessage) UnmarshalJSON ¶ 

func (obj *ParcelItemsUpdatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ParcelItemsUpdatedMessagePayload ¶ 

type ParcelItemsUpdatedMessagePayload struct {
	// Unique identifier of the [Parcel](ctp:api:type:Parcel).
	ParcelId string `json:"parcelId"`
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// [Delivery Items](ctp:api:type:DeliveryItem) after the [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) update action.
	Items []DeliveryItem `json:"items"`
	// [Delivery Items](ctp:api:type:DeliveryItem) before the [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) update action.
	OldItems []DeliveryItem `json:"oldItems"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) update action. *

func (ParcelItemsUpdatedMessagePayload) MarshalJSON ¶ 

func (obj ParcelItemsUpdatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ParcelMeasurements ¶ 

type ParcelMeasurements struct {
	// Height of the Parcel.
	HeightInMillimeter *int `json:"heightInMillimeter,omitempty"`
	// Length of the Parcel.
	LengthInMillimeter *int `json:"lengthInMillimeter,omitempty"`
	// Width of the Parcel.
	WidthInMillimeter *int `json:"widthInMillimeter,omitempty"`
	// Weight of the Parcel.
	WeightInGram *int `json:"weightInGram,omitempty"`
}

type ParcelMeasurementsUpdatedMessage ¶ 

type ParcelMeasurementsUpdatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// Unique identifier of the [Parcel](ctp:api:type:Parcel).
	ParcelId string `json:"parcelId"`
	// The [Parcel Measurements](ctp:api:type:ParcelMeasurements) that were set on the [Parcel](ctp:api:type:Parcel).
	Measurements *ParcelMeasurements `json:"measurements,omitempty"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Parcel Measurements](ctp:api:type:OrderSetParcelMeasurementsAction) update action. *

func (ParcelMeasurementsUpdatedMessage) MarshalJSON ¶ 

func (obj ParcelMeasurementsUpdatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ParcelMeasurementsUpdatedMessage) UnmarshalJSON ¶ 

func (obj *ParcelMeasurementsUpdatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ParcelMeasurementsUpdatedMessagePayload ¶ 

type ParcelMeasurementsUpdatedMessagePayload struct {
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// Unique identifier of the [Parcel](ctp:api:type:Parcel).
	ParcelId string `json:"parcelId"`
	// The [Parcel Measurements](ctp:api:type:ParcelMeasurements) that were set on the [Parcel](ctp:api:type:Parcel).
	Measurements *ParcelMeasurements `json:"measurements,omitempty"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Parcel Measurements](ctp:api:type:OrderSetParcelMeasurementsAction) update action. *

func (ParcelMeasurementsUpdatedMessagePayload) MarshalJSON ¶ 

func (obj ParcelMeasurementsUpdatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ParcelRemovedFromDeliveryMessage ¶ 

type ParcelRemovedFromDeliveryMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// [Parcel](ctp:api:type:Parcel) that was removed from the [Delivery](ctp:api:type:Delivery).
	Parcel Parcel `json:"parcel"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Remove Parcel from Delivery](ctp:api:type:OrderRemoveParcelFromDeliveryAction) update action. *

func (ParcelRemovedFromDeliveryMessage) MarshalJSON ¶ 

func (obj ParcelRemovedFromDeliveryMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ParcelRemovedFromDeliveryMessage) UnmarshalJSON ¶ 

func (obj *ParcelRemovedFromDeliveryMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ParcelRemovedFromDeliveryMessagePayload ¶ 

type ParcelRemovedFromDeliveryMessagePayload struct {
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// [Parcel](ctp:api:type:Parcel) that was removed from the [Delivery](ctp:api:type:Delivery).
	Parcel Parcel `json:"parcel"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Remove Parcel from Delivery](ctp:api:type:OrderRemoveParcelFromDeliveryAction) update action. *

func (ParcelRemovedFromDeliveryMessagePayload) MarshalJSON ¶ 

func (obj ParcelRemovedFromDeliveryMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ParcelTrackingDataUpdatedMessage ¶ 

type ParcelTrackingDataUpdatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// Unique identifier of the [Parcel](ctp:api:type:Parcel).
	ParcelId string `json:"parcelId"`
	// The [Tracking Data](ctp:api:type:TrackingData) that was added to the [Parcel](ctp:api:type:Parcel).
	TrackingData *TrackingData `json:"trackingData,omitempty"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Parcel Tracking Data](ctp:api:type:OrderSetParcelTrackingDataAction) update action. *

func (ParcelTrackingDataUpdatedMessage) MarshalJSON ¶ 

func (obj ParcelTrackingDataUpdatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ParcelTrackingDataUpdatedMessage) UnmarshalJSON ¶ 

func (obj *ParcelTrackingDataUpdatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ParcelTrackingDataUpdatedMessagePayload ¶ 

type ParcelTrackingDataUpdatedMessagePayload struct {
	// Unique identifier of the [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
	// Unique identifier of the [Parcel](ctp:api:type:Parcel).
	ParcelId string `json:"parcelId"`
	// The [Tracking Data](ctp:api:type:TrackingData) that was added to the [Parcel](ctp:api:type:Parcel).
	TrackingData *TrackingData `json:"trackingData,omitempty"`
	// User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Generated after a successful [Set Parcel Tracking Data](ctp:api:type:OrderSetParcelTrackingDataAction) update action. *

func (ParcelTrackingDataUpdatedMessagePayload) MarshalJSON ¶ 

func (obj ParcelTrackingDataUpdatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PayloadNotIncluded ¶ 

type PayloadNotIncluded struct {
	// Reason the payload is not included. For example, the payload is too large, or its content is not supported by the Subscription destination.
	Reason string `json:"reason"`
	// Value of the `type` field in the original payload.
	PayloadType string `json:"payloadType"`
}

type Payment ¶ 

type Payment struct {
	// Unique identifier of the Payment.
	ID string `json:"id"`
	// Current version of the Payment.
	Version int `json:"version"`
	// Date and time (UTC) the Payment was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Payment was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Reference to a [Customer](ctp:api:type:Customer) associated with the Payment.
	Customer *CustomerReference `json:"customer,omitempty"`
	// [Anonymous session](ctp:api:type:AnonymousSession) associated with the Payment.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// Additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).
	ExternalId *string `json:"externalId,omitempty"`
	// Identifier used by the payment service that processes the Payment (for example, a PSP).
	// The combination of `interfaceId` and the `paymentInterface` field on [PaymentMethodInfo](ctp:api:type:PaymentMethodInfo) must be unique.
	InterfaceId *string `json:"interfaceId,omitempty"`
	// Money value the Payment intends to receive from the customer.
	// The value typically matches the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order) gross total.
	AmountPlanned CentPrecisionMoney `json:"amountPlanned"`
	// Deprecated because its value can be calculated from the total amounts saved in the [Transactions](ctp:api:type:Transaction).
	AmountAuthorized TypedMoney `json:"amountAuthorized,omitempty"`
	// Deprecated because this field is of little practical value, as it is either not reliably known, or the authorization time is fixed for a PSP.
	AuthorizedUntil *string `json:"authorizedUntil,omitempty"`
	// Deprecated because its value can be calculated from the total amounts saved in the [Transactions](ctp:api:type:Transaction).
	AmountPaid TypedMoney `json:"amountPaid,omitempty"`
	// Deprecated because its value can be calculated from the total amounts saved in the [Transactions](ctp:api:type:Transaction).
	AmountRefunded TypedMoney `json:"amountRefunded,omitempty"`
	// Information regarding the payment interface (for example, a PSP), and the specific payment method used.
	PaymentMethodInfo PaymentMethodInfo `json:"paymentMethodInfo"`
	// Current status of the Payment.
	PaymentStatus PaymentStatus `json:"paymentStatus"`
	// Financial transactions of the Payment. Each Transaction has a [TransactionType](ctp:api:type:TransactionType) and a [TransactionState](ctp:api:type:TransactionState).
	Transactions []Transaction `json:"transactions"`
	// Represents information exchange with the payment service, for example, a PSP. An interaction may be a request sent, or a response or notification received from the payment service.
	InterfaceInteractions []CustomFields `json:"interfaceInteractions"`
	// Custom Fields for the Payment.
	Custom *CustomFields `json:"custom,omitempty"`
	// User-defined unique identifier of the Payment.
	Key *string `json:"key,omitempty"`
}

func (*Payment) UnmarshalJSON ¶ 

func (obj *Payment) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PaymentAddInterfaceInteractionAction ¶ 

type PaymentAddInterfaceInteractionAction struct {
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Type](ctp:api:type:Type).
	Type TypeResourceIdentifier `json:"type"`
	// [Custom Fields](/../api/projects/custom-fields) as per [FieldDefinitions](ctp:api:type:FieldDefinition) of the [Type](ctp:api:type:Type).
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * Adding a Payment interaction generates the [PaymentInteractionAdded](ctp:api:type:PaymentInteractionAddedMessage) Message. *

func (PaymentAddInterfaceInteractionAction) MarshalJSON ¶ 

func (obj PaymentAddInterfaceInteractionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentAddTransactionAction ¶ 

type PaymentAddTransactionAction struct {
	// Value to append to the `transactions` array.
	Transaction TransactionDraft `json:"transaction"`
}

* * Adding a Transaction to a Payment generates the [PaymentTransactionAdded](ctp:api:type:PaymentTransactionAddedMessage) Message. *

func (PaymentAddTransactionAction) MarshalJSON ¶ 

func (obj PaymentAddTransactionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentChangeAmountPlannedAction ¶ 

type PaymentChangeAmountPlannedAction struct {
	// New value to set.
	Amount Money `json:"amount"`
}

* * Can be used to update the Payment if a customer changes the Cart(ctp:api:type:Cart), or adds or removes a CartDiscount(ctp:api:type:CartDiscount) during checkout. *

func (PaymentChangeAmountPlannedAction) MarshalJSON ¶ 

func (obj PaymentChangeAmountPlannedAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentChangeTransactionInteractionIdAction ¶ 

type PaymentChangeTransactionInteractionIdAction struct {
	// Unique identifier of the [Transaction](ctp:api:type:Transaction).
	TransactionId string `json:"transactionId"`
	// New value to set.
	InteractionId string `json:"interactionId"`
}

func (PaymentChangeTransactionInteractionIdAction) MarshalJSON ¶ 

func (obj PaymentChangeTransactionInteractionIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentChangeTransactionStateAction ¶ 

type PaymentChangeTransactionStateAction struct {
	// Unique identifier of the [Transaction](ctp:api:type:Transaction).
	TransactionId string `json:"transactionId"`
	// New TransactionState.
	State TransactionState `json:"state"`
}

* * Changing the TransactionState(ctp:api:type:TransactionState) generates the [PaymentTransactionStateChanged](ctp:api:type:PaymentTransactionStateChangedMessage) Message. *

func (PaymentChangeTransactionStateAction) MarshalJSON ¶ 

func (obj PaymentChangeTransactionStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentChangeTransactionTimestampAction ¶ 

type PaymentChangeTransactionTimestampAction struct {
	// Unique identifier of the [Transaction](ctp:api:type:Transaction).
	TransactionId string `json:"transactionId"`
	// Timestamp of the Transaction as reported by the payment service.
	Timestamp time.Time `json:"timestamp"`
}

func (PaymentChangeTransactionTimestampAction) MarshalJSON ¶ 

func (obj PaymentChangeTransactionTimestampAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentCreatedMessage ¶ 

type PaymentCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Payment](ctp:api:type:Payment) that was created.
	Payment Payment `json:"payment"`
}

* * Generated after a successful [Create Payment](ctp:api:endpoint:/{projectKey}/payments:POST) request. *

func (PaymentCreatedMessage) MarshalJSON ¶ 

func (obj PaymentCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*PaymentCreatedMessage) UnmarshalJSON ¶ 

func (obj *PaymentCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PaymentCreatedMessagePayload ¶ 

type PaymentCreatedMessagePayload struct {
	// [Payment](ctp:api:type:Payment) that was created.
	Payment Payment `json:"payment"`
}

* * Generated after a successful [Create Payment](ctp:api:endpoint:/{projectKey}/payments:POST) request. *

func (PaymentCreatedMessagePayload) MarshalJSON ¶ 

func (obj PaymentCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentDraft ¶ 

type PaymentDraft struct {
	// Reference to a [Customer](ctp:api:type:Customer) associated with the Payment.
	Customer *CustomerResourceIdentifier `json:"customer,omitempty"`
	// [Anonymous session](ctp:api:type:AnonymousSession) associated with the Payment.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// Additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).
	ExternalId *string `json:"externalId,omitempty"`
	// Identifier used by the payment service that processes the Payment (for example, a PSP).
	// The combination of `interfaceId` and the `paymentInterface` field on [PaymentMethodInfo](ctp:api:type:PaymentMethodInfo) must be unique.
	// Once set, it cannot be changed.
	InterfaceId *string `json:"interfaceId,omitempty"`
	// Money value the Payment intends to receive from the customer.
	// The value typically matches the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order) gross total.
	AmountPlanned Money `json:"amountPlanned"`
	// Deprecated because the value can be calculated from the total amounts saved in the [Transactions](ctp:api:type:Transaction).
	AmountAuthorized *Money `json:"amountAuthorized,omitempty"`
	// Deprecated because this field is of little practical value, as it is either not reliably known, or the authorization time is fixed for a PSP.
	AuthorizedUntil *string `json:"authorizedUntil,omitempty"`
	// Deprecated because the value can be calculated from the total amounts saved in the [Transactions](ctp:api:type:Transaction).
	AmountPaid *Money `json:"amountPaid,omitempty"`
	// Deprecated because the value can be calculated from the total amounts saved in the [Transactions](ctp:api:type:Transaction).
	AmountRefunded *Money `json:"amountRefunded,omitempty"`
	// Information regarding the payment interface (for example, a PSP), and the specific payment method used.
	PaymentMethodInfo *PaymentMethodInfo `json:"paymentMethodInfo,omitempty"`
	// Current status of the Payment.
	PaymentStatus *PaymentStatusDraft `json:"paymentStatus,omitempty"`
	// Financial transactions of the Payment. Each Transaction has a [TransactionType](ctp:api:type:TransactionType) and a [TransactionState](ctp:api:type:TransactionState).
	Transactions []TransactionDraft `json:"transactions"`
	// Represents information exchange with the payment service, for example, a PSP. An interaction may be a request sent, or a response or notification received from the payment service.
	InterfaceInteractions []CustomFieldsDraft `json:"interfaceInteractions"`
	// Custom Fields for the Payment.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// User-defined unique identifier for the Payment.
	Key *string `json:"key,omitempty"`
}

func (PaymentDraft) MarshalJSON ¶ 

func (obj PaymentDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentInfo ¶ 

type PaymentInfo struct {
	// [References](ctp:api:type:Reference) to the Payments associated with the Order.
	Payments []PaymentReference `json:"payments"`
}

type PaymentInteractionAddedMessage ¶ 

type PaymentInteractionAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The interface interaction that was added to the [Payment](ctp:api:type:Payment).
	Interaction CustomFields `json:"interaction"`
}

* * Generated after a successful [Add InterfaceInteraction](ctp:api:type:PaymentAddInterfaceInteractionAction) update action. *

func (PaymentInteractionAddedMessage) MarshalJSON ¶ 

func (obj PaymentInteractionAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*PaymentInteractionAddedMessage) UnmarshalJSON ¶ 

func (obj *PaymentInteractionAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PaymentInteractionAddedMessagePayload ¶ 

type PaymentInteractionAddedMessagePayload struct {
	// The interface interaction that was added to the [Payment](ctp:api:type:Payment).
	Interaction CustomFields `json:"interaction"`
}

* * Generated after a successful [Add InterfaceInteraction](ctp:api:type:PaymentAddInterfaceInteractionAction) update action. *

func (PaymentInteractionAddedMessagePayload) MarshalJSON ¶ 

func (obj PaymentInteractionAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentMethodInfo ¶ 

type PaymentMethodInfo struct {
	// Payment service that processes the Payment (for example, a PSP).
	// Once set, it cannot be changed.
	// The combination of `paymentInterface` and the `interfaceId` of a [Payment](ctp:api:type:Payment) must be unique.
	PaymentInterface *string `json:"paymentInterface,omitempty"`
	// Payment method used, for example, credit card, or cash advance.
	Method *string `json:"method,omitempty"`
	// Localizable name of the payment method.
	Name *LocalizedString `json:"name,omitempty"`
}

type PaymentPagedQueryResponse ¶ 

type PaymentPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// [Payments](ctp:api:type:Payment) matching the query.
	Results []Payment `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of Payment(ctp:api:type:Payment). *

type PaymentReference ¶ 

type PaymentReference struct {
	// Unique identifier of the referenced [Payment](ctp:api:type:Payment).
	ID string `json:"id"`
	// Contains the representation of the expanded Payment. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Payments.
	Obj *Payment `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Payment(ctp:api:type:Payment). *

func (PaymentReference) MarshalJSON ¶ 

func (obj PaymentReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentResourceIdentifier ¶ 

type PaymentResourceIdentifier struct {
	// Unique identifier of the referenced [Payment](ctp:api:type:Payment). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [Payment](ctp:api:type:Payment). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) of a Payment(ctp:api:type:Payment). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (PaymentResourceIdentifier) MarshalJSON ¶ 

func (obj PaymentResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetAmountPaidAction ¶ 

type PaymentSetAmountPaidAction struct {
	// Draft type that stores amounts only in cent precision for the specified currency.
	Amount *Money `json:"amount,omitempty"`
}

func (PaymentSetAmountPaidAction) MarshalJSON ¶ 

func (obj PaymentSetAmountPaidAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetAmountRefundedAction ¶ 

type PaymentSetAmountRefundedAction struct {
	// Draft type that stores amounts only in cent precision for the specified currency.
	Amount *Money `json:"amount,omitempty"`
}

func (PaymentSetAmountRefundedAction) MarshalJSON ¶ 

func (obj PaymentSetAmountRefundedAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetAnonymousIdAction ¶ 

type PaymentSetAnonymousIdAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	AnonymousId *string `json:"anonymousId,omitempty"`
}

func (PaymentSetAnonymousIdAction) MarshalJSON ¶ 

func (obj PaymentSetAnonymousIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetAuthorizationAction ¶ 

type PaymentSetAuthorizationAction struct {
	// Draft type that stores amounts only in cent precision for the specified currency.
	Amount *Money     `json:"amount,omitempty"`
	Until  *time.Time `json:"until,omitempty"`
}

func (PaymentSetAuthorizationAction) MarshalJSON ¶ 

func (obj PaymentSetAuthorizationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetCustomFieldAction ¶ 

type PaymentSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (PaymentSetCustomFieldAction) MarshalJSON ¶ 

func (obj PaymentSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetCustomTypeAction ¶ 

type PaymentSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Payment with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Payment.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Payment.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (PaymentSetCustomTypeAction) MarshalJSON ¶ 

func (obj PaymentSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetCustomerAction ¶ 

type PaymentSetCustomerAction struct {
	// Value to set.
	// If empty, any existing reference is removed.
	Customer *CustomerResourceIdentifier `json:"customer,omitempty"`
}

func (PaymentSetCustomerAction) MarshalJSON ¶ 

func (obj PaymentSetCustomerAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetExternalIdAction ¶ 

type PaymentSetExternalIdAction struct {
	ExternalId *string `json:"externalId,omitempty"`
}

func (PaymentSetExternalIdAction) MarshalJSON ¶ 

func (obj PaymentSetExternalIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetInterfaceIdAction ¶ 

type PaymentSetInterfaceIdAction struct {
	// Value to set.
	// Once set, the `interfaceId` cannot be changed.
	InterfaceId string `json:"interfaceId"`
}

func (PaymentSetInterfaceIdAction) MarshalJSON ¶ 

func (obj PaymentSetInterfaceIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetKeyAction ¶ 

type PaymentSetKeyAction struct {
	// Value to set.
	// If `key` is absent or `null`, the existing key, if any, will be removed.
	Key *string `json:"key,omitempty"`
}

func (PaymentSetKeyAction) MarshalJSON ¶ 

func (obj PaymentSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetMethodInfoInterfaceAction ¶ 

type PaymentSetMethodInfoInterfaceAction struct {
	// Value to set.
	// Once set, the `paymentInterface` of the `paymentMethodInfo` cannot be changed.
	Interface string `json:"interface"`
}

func (PaymentSetMethodInfoInterfaceAction) MarshalJSON ¶ 

func (obj PaymentSetMethodInfoInterfaceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetMethodInfoMethodAction ¶ 

type PaymentSetMethodInfoMethodAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Method *string `json:"method,omitempty"`
}

func (PaymentSetMethodInfoMethodAction) MarshalJSON ¶ 

func (obj PaymentSetMethodInfoMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetMethodInfoNameAction ¶ 

type PaymentSetMethodInfoNameAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Name *LocalizedString `json:"name,omitempty"`
}

func (PaymentSetMethodInfoNameAction) MarshalJSON ¶ 

func (obj PaymentSetMethodInfoNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetStatusInterfaceCodeAction ¶ 

type PaymentSetStatusInterfaceCodeAction struct {
	// Value to set. If empty, any existing value will be removed.
	InterfaceCode *string `json:"interfaceCode,omitempty"`
}

* * Produces the [PaymentStatusInterfaceCodeSet](ctp:api:type:PaymentStatusInterfaceCodeSetMessage) Message.

func (PaymentSetStatusInterfaceCodeAction) MarshalJSON ¶ 

func (obj PaymentSetStatusInterfaceCodeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetStatusInterfaceTextAction ¶ 

type PaymentSetStatusInterfaceTextAction struct {
	// Value to set. If empty, any existing value will be removed.
	InterfaceText string `json:"interfaceText"`
}

func (PaymentSetStatusInterfaceTextAction) MarshalJSON ¶ 

func (obj PaymentSetStatusInterfaceTextAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetTransactionCustomFieldAction ¶ 

type PaymentSetTransactionCustomFieldAction struct {
	// Unique identifier of the [Transaction](ctp:api:type:Transaction).
	TransactionId string `json:"transactionId"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (PaymentSetTransactionCustomFieldAction) MarshalJSON ¶ 

func (obj PaymentSetTransactionCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentSetTransactionCustomTypeAction ¶ 

type PaymentSetTransactionCustomTypeAction struct {
	// Unique identifier of the [Transaction](ctp:api:type:Transaction). If the specified `transactionId` does not exist, the request will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	TransactionId string `json:"transactionId"`
	// Defines the [Type](ctp:api:type:Type) that extends the Transaction with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Transaction.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Transaction.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (PaymentSetTransactionCustomTypeAction) MarshalJSON ¶ 

func (obj PaymentSetTransactionCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentState ¶ 

type PaymentState string

* * Indicates the payment status for the Order. * 

const (
	PaymentStateBalanceDue PaymentState = "BalanceDue"
	PaymentStateFailed     PaymentState = "Failed"
	PaymentStatePending    PaymentState = "Pending"
	PaymentStateCreditOwed PaymentState = "CreditOwed"
	PaymentStatePaid       PaymentState = "Paid"
)

type PaymentStatus ¶ 

type PaymentStatus struct {
	// External reference that identifies the current status of the Payment.
	InterfaceCode *string `json:"interfaceCode,omitempty"`
	// Text describing the current status of the Payment.
	InterfaceText *string `json:"interfaceText,omitempty"`
	// [Reference](ctp:api:type:Reference) to a [State](ctp:api:type:State).
	State *StateReference `json:"state,omitempty"`
}

type PaymentStatusDraft ¶ 

type PaymentStatusDraft struct {
	// External reference that identifies the current status of the Payment.
	InterfaceCode *string `json:"interfaceCode,omitempty"`
	// Text describing the current status of the Payment.
	InterfaceText *string `json:"interfaceText,omitempty"`
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
	State *StateResourceIdentifier `json:"state,omitempty"`
}

type PaymentStatusInterfaceCodeSetMessage ¶ 

type PaymentStatusInterfaceCodeSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier for the [Payment](ctp:api:type:Payment) for which the [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action was applied.
	PaymentId string `json:"paymentId"`
	// The `interfaceCode` that was set during the [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action.
	InterfaceCode *string `json:"interfaceCode,omitempty"`
}

* * Generated after a successful [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action. *

func (PaymentStatusInterfaceCodeSetMessage) MarshalJSON ¶ 

func (obj PaymentStatusInterfaceCodeSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*PaymentStatusInterfaceCodeSetMessage) UnmarshalJSON ¶ 

func (obj *PaymentStatusInterfaceCodeSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PaymentStatusInterfaceCodeSetMessagePayload ¶ 

type PaymentStatusInterfaceCodeSetMessagePayload struct {
	// Unique identifier for the [Payment](ctp:api:type:Payment) for which the [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action was applied.
	PaymentId string `json:"paymentId"`
	// The `interfaceCode` that was set during the [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action.
	InterfaceCode *string `json:"interfaceCode,omitempty"`
}

* * Generated after a successful [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action. *

func (PaymentStatusInterfaceCodeSetMessagePayload) MarshalJSON ¶ 

func (obj PaymentStatusInterfaceCodeSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentStatusStateTransitionMessage ¶ 

type PaymentStatusStateTransitionMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [State](ctp:api:type:State) of the [Payment](ctp:api:type:Payment) after the [Transition State](ctp:api:type:PaymentTransitionStateAction) update action.
	State StateReference `json:"state"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Change Transaction State](ctp:api:type:PaymentChangeTransactionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:PaymentTransitionStateAction) update action. *

func (PaymentStatusStateTransitionMessage) MarshalJSON ¶ 

func (obj PaymentStatusStateTransitionMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*PaymentStatusStateTransitionMessage) UnmarshalJSON ¶ 

func (obj *PaymentStatusStateTransitionMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PaymentStatusStateTransitionMessagePayload ¶ 

type PaymentStatusStateTransitionMessagePayload struct {
	// [State](ctp:api:type:State) of the [Payment](ctp:api:type:Payment) after the [Transition State](ctp:api:type:PaymentTransitionStateAction) update action.
	State StateReference `json:"state"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Change Transaction State](ctp:api:type:PaymentChangeTransactionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:PaymentTransitionStateAction) update action. *

func (PaymentStatusStateTransitionMessagePayload) MarshalJSON ¶ 

func (obj PaymentStatusStateTransitionMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentTransactionAddedMessage ¶ 

type PaymentTransactionAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Transaction](ctp:api:type:Transaction) that was added to the [Payment](ctp:api:type:Payment).
	Transaction Transaction `json:"transaction"`
}

* * Generated after a successful [Add Transaction](ctp:api:type:PaymentAddTransactionAction) update action. *

func (PaymentTransactionAddedMessage) MarshalJSON ¶ 

func (obj PaymentTransactionAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*PaymentTransactionAddedMessage) UnmarshalJSON ¶ 

func (obj *PaymentTransactionAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PaymentTransactionAddedMessagePayload ¶ 

type PaymentTransactionAddedMessagePayload struct {
	// [Transaction](ctp:api:type:Transaction) that was added to the [Payment](ctp:api:type:Payment).
	Transaction Transaction `json:"transaction"`
}

* * Generated after a successful [Add Transaction](ctp:api:type:PaymentAddTransactionAction) update action. *

func (PaymentTransactionAddedMessagePayload) MarshalJSON ¶ 

func (obj PaymentTransactionAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentTransactionStateChangedMessage ¶ 

type PaymentTransactionStateChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier for the [Transaction](ctp:api:type:Transaction) for which the [Transaction State](ctp:api:type:TransactionState) changed.
	TransactionId string `json:"transactionId"`
	// [Transaction State](ctp:api:type:TransactionState) after the [Change Transaction State](ctp:api:type:PaymentChangeTransactionStateAction) update action.
	State TransactionState `json:"state"`
}

* * Generated after a successful [Change TransactionState](ctp:api:type:PaymentChangeTransactionStateAction) update action. *

func (PaymentTransactionStateChangedMessage) MarshalJSON ¶ 

func (obj PaymentTransactionStateChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*PaymentTransactionStateChangedMessage) UnmarshalJSON ¶ 

func (obj *PaymentTransactionStateChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PaymentTransactionStateChangedMessagePayload ¶ 

type PaymentTransactionStateChangedMessagePayload struct {
	// Unique identifier for the [Transaction](ctp:api:type:Transaction) for which the [Transaction State](ctp:api:type:TransactionState) changed.
	TransactionId string `json:"transactionId"`
	// [Transaction State](ctp:api:type:TransactionState) after the [Change Transaction State](ctp:api:type:PaymentChangeTransactionStateAction) update action.
	State TransactionState `json:"state"`
}

* * Generated after a successful [Change TransactionState](ctp:api:type:PaymentChangeTransactionStateAction) update action. *

func (PaymentTransactionStateChangedMessagePayload) MarshalJSON ¶ 

func (obj PaymentTransactionStateChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentTransitionStateAction ¶ 

type PaymentTransitionStateAction struct {
	// [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
	State StateResourceIdentifier `json:"state"`
	// Set to `true` to skip validations when transitioning to the new State.
	Force *bool `json:"force,omitempty"`
}

* * If the Payment has no current State(ctp:api:type:State), `initial` must be `true` for the new State. * If the existing State has transitions set, the new State must be a valid transition. * If the existing State has no transitions set, no validations are performed when transitioning to the new State. * * Transitioning the State of a Payment produces the [PaymentStatusStateTransition](ctp:api:type:PaymentStatusStateTransitionMessage) Message. *

func (PaymentTransitionStateAction) MarshalJSON ¶ 

func (obj PaymentTransitionStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentUpdate ¶ 

type PaymentUpdate struct {
	// Expected version of the Payment on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Payment.
	Actions []PaymentUpdateAction `json:"actions"`
}

func (*PaymentUpdate) UnmarshalJSON ¶ 

func (obj *PaymentUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PaymentUpdateAction ¶ 

type PaymentUpdateAction interface{}

type PendingOperationError ¶ 

type PendingOperationError struct {
	// Plain text description of the error.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed. * * The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. * If the error persists, report it using the [Support Portal](https://support.commercetools.com). *

func (*PendingOperationError) DecodeStruct ¶ added in v1.1.0 

func (obj *PendingOperationError) DecodeStruct(src map[string]interface{}) error

func (PendingOperationError) Error ¶ 

func (obj PendingOperationError) Error() string

func (PendingOperationError) MarshalJSON ¶ 

func (obj PendingOperationError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*PendingOperationError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *PendingOperationError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type Permission ¶ added in v1.3.0 

type Permission string

* * Permissions grant granular access to [Approval Rules](ctp:api:type:ApprovalRule), [Approval Flows](ctp:api:type:ApprovalFlow), [Business Units](ctp:api:type:BusinessUnit), [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), and [Quote Requests](ctp:api:type:QuoteRequest). * 

const (
	PermissionAddChildUnits                      Permission = "AddChildUnits"
	PermissionUpdateAssociates                   Permission = "UpdateAssociates"
	PermissionUpdateBusinessUnitDetails          Permission = "UpdateBusinessUnitDetails"
	PermissionUpdateParentUnit                   Permission = "UpdateParentUnit"
	PermissionViewMyCarts                        Permission = "ViewMyCarts"
	PermissionViewOthersCarts                    Permission = "ViewOthersCarts"
	PermissionUpdateMyCarts                      Permission = "UpdateMyCarts"
	PermissionUpdateOthersCarts                  Permission = "UpdateOthersCarts"
	PermissionCreateMyCarts                      Permission = "CreateMyCarts"
	PermissionCreateOthersCarts                  Permission = "CreateOthersCarts"
	PermissionDeleteMyCarts                      Permission = "DeleteMyCarts"
	PermissionDeleteOthersCarts                  Permission = "DeleteOthersCarts"
	PermissionViewMyOrders                       Permission = "ViewMyOrders"
	PermissionViewOthersOrders                   Permission = "ViewOthersOrders"
	PermissionUpdateMyOrders                     Permission = "UpdateMyOrders"
	PermissionUpdateOthersOrders                 Permission = "UpdateOthersOrders"
	PermissionCreateMyOrdersFromMyCarts          Permission = "CreateMyOrdersFromMyCarts"
	PermissionCreateMyOrdersFromMyQuotes         Permission = "CreateMyOrdersFromMyQuotes"
	PermissionCreateOrdersFromOthersCarts        Permission = "CreateOrdersFromOthersCarts"
	PermissionCreateOrdersFromOthersQuotes       Permission = "CreateOrdersFromOthersQuotes"
	PermissionViewMyQuotes                       Permission = "ViewMyQuotes"
	PermissionViewOthersQuotes                   Permission = "ViewOthersQuotes"
	PermissionAcceptMyQuotes                     Permission = "AcceptMyQuotes"
	PermissionAcceptOthersQuotes                 Permission = "AcceptOthersQuotes"
	PermissionDeclineMyQuotes                    Permission = "DeclineMyQuotes"
	PermissionDeclineOthersQuotes                Permission = "DeclineOthersQuotes"
	PermissionRenegotiateMyQuotes                Permission = "RenegotiateMyQuotes"
	PermissionRenegotiateOthersQuotes            Permission = "RenegotiateOthersQuotes"
	PermissionReassignMyQuotes                   Permission = "ReassignMyQuotes"
	PermissionReassignOthersQuotes               Permission = "ReassignOthersQuotes"
	PermissionViewMyQuoteRequests                Permission = "ViewMyQuoteRequests"
	PermissionViewOthersQuoteRequests            Permission = "ViewOthersQuoteRequests"
	PermissionUpdateMyQuoteRequests              Permission = "UpdateMyQuoteRequests"
	PermissionUpdateOthersQuoteRequests          Permission = "UpdateOthersQuoteRequests"
	PermissionCreateMyQuoteRequestsFromMyCarts   Permission = "CreateMyQuoteRequestsFromMyCarts"
	PermissionCreateQuoteRequestsFromOthersCarts Permission = "CreateQuoteRequestsFromOthersCarts"
	PermissionCreateApprovalRules                Permission = "CreateApprovalRules"
	PermissionUpdateApprovalRules                Permission = "UpdateApprovalRules"
	PermissionUpdateApprovalFlows                Permission = "UpdateApprovalFlows"
)

type PlatformFormat ¶ 

type PlatformFormat struct {
}

* * The PlatformFormat uses constructs that are similar to the ones used in the REST API, for example, on the [Messages Query HTTP API](/../api/projects/messages). *

func (PlatformFormat) MarshalJSON ¶ 

func (obj PlatformFormat) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Price ¶ 

type Price struct {
	// Unique identifier of this Price.
	ID string `json:"id"`
	// User-defined identifier of the Price. It is unique per [ProductVariant](ctp:api:type:ProductVariant).
	Key *string `json:"key,omitempty"`
	// Money value of this Price.
	Value TypedMoney `json:"value"`
	// Country for which this Price is valid.
	Country *string `json:"country,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) for which this Price is valid.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// `ProductDistribution` [Channel](ctp:api:type:Channel) for which this Price is valid.
	Channel *ChannelReference `json:"channel,omitempty"`
	// Date and time from which this Price is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time until this Price is valid. Prices that are no longer valid are not automatically removed, but they can be [removed](ctp:api:type:ProductRemovePriceAction) if necessary.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Is set if a [ProductDiscount](ctp:api:type:ProductDiscount) has been applied.
	// If set, the API uses the DiscountedPrice value for the [Line Item Price selection](ctp:api:type:LineItemPriceSelection).
	// When a [relative discount](ctp:api:type:ProductDiscountValueRelative) has been applied and the fraction part of the DiscountedPrice `value` is 0.5, the `value` is rounded in favor of the customer with [half-down rounding](https://en.wikipedia.org/wiki/Rounding#Round_half_down).
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
	// Present if different Prices for certain [LineItem](ctp:api:type:LineItem) quantities have been specified.
	//
	// If `discounted` is present, the tiered Price is ignored for a Product Variant.
	Tiers []PriceTier `json:"tiers"`
	// Custom Fields defined for the Price.
	Custom *CustomFields `json:"custom,omitempty"`
}

* * The representation for prices embedded in [LineItems](ctp:api:type:LineItem) and in [ProductVariants](ctp:api:type:ProductVariant) when the [ProductPriceMode](ctp:api:type:ProductPriceModeEnum) is `Embedded`. * For the `Standalone` ProductPriceMode refer to StandalonePrice(ctp:api:type:StandalonePrice).

func (Price) MarshalJSON ¶ 

func (obj Price) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*Price) UnmarshalJSON ¶ 

func (obj *Price) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PriceChangedError ¶ 

type PriceChangedError struct {
	// Plain text description of the reason for the Price change. For example, `"The price or tax of some line items changed at the time of placing the order: $lineItems."`.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Unique identifiers of the Line Items for which the Price or [TaxRate](ctp:api:type:TaxRate) has changed.
	LineItems []string `json:"lineItems"`
	// `true` if the [ShippingRate](ctp:api:type:ShippingRate) has changed.
	Shipping bool `json:"shipping"`
}

* * Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart. * * The error is returned as a failed response to: * * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. * - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. *

func (*PriceChangedError) DecodeStruct ¶ added in v1.1.0 

func (obj *PriceChangedError) DecodeStruct(src map[string]interface{}) error

func (PriceChangedError) Error ¶ 

func (obj PriceChangedError) Error() string

func (PriceChangedError) MarshalJSON ¶ 

func (obj PriceChangedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*PriceChangedError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *PriceChangedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PriceDraft ¶ 

type PriceDraft struct {
	// User-defined identifier for the Price. It must be unique per [ProductVariant](ctp:api:type:ProductVariant).
	Key *string `json:"key,omitempty"`
	// Money value of this Price.
	Value Money `json:"value"`
	// Set this field if this Price is only valid for the specified country.
	Country *string `json:"country,omitempty"`
	// Set this field if this Price is only valid for the referenced [CustomerGroup](ctp:api:type:CustomerGroup).
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
	// Set this field if this Price is only valid for the referenced `ProductDistribution` [Channel](ctp:api:type:Channel).
	Channel *ChannelResourceIdentifier `json:"channel,omitempty"`
	// Set this field if this Price is only valid from the specified date and time. Must be at least 1 ms earlier than `validUntil`.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than `validFrom`. Prices that are no longer valid are not automatically removed, but they can be [removed](ctp:api:type:ProductRemovePriceAction) if necessary.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Set this field to add a DiscountedPrice from an **external service**.
	//
	// Otherwise, Composable Commerce sets this field automatically if at least one [ProductDiscount](ctp:api:type:ProductDiscount) applies.
	// The DiscountedPrice must reference a ProductDiscount with:
	//
	// * The `isActive` flag set to `true`.
	// * A [ProductDiscountValue](ctp:api:type:ProductDiscountValueExternal) of type `external`.
	// * A `predicate` that matches the [ProductVariant](ctp:api:type:ProductVariant) the Price is referenced from.
	Discounted *DiscountedPriceDraft `json:"discounted,omitempty"`
	// Set this field to specify different Prices for certain [LineItem](ctp:api:type:LineItem) quantities.
	//
	// If `discounted` is set, the tiered Price is ignored for a Product Variant.
	Tiers []PriceTierDraft `json:"tiers"`
	// Custom Fields for the Price.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * The draft representation for prices to be embedded into [ProductVariantDrafts](ctp:api:type:ProductVariantDraft) when the [ProductPriceMode](ctp:api:type:ProductPriceModeEnum) is `Embedded`. For the `Standalone` ProductPriceMode use StandalonePriceDraft(ctp:api:type:StandalonePriceDraft).

func (PriceDraft) MarshalJSON ¶ 

func (obj PriceDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PriceFunction ¶ 

type PriceFunction struct {
	// Currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
	CurrencyCode string `json:"currencyCode"`
	// To calculate a Price based on the score, use `+`, `-`, `*` and parentheses. The score is inserted with `x`. The function returns the cent amount.
	//
	// For example, to charge $1.99 for a score of `1`, $3.99 for a score of `2`, \$5.99 for a score of `3` and onwards, the function is: `(200 * x) - 1)`. To charge $4.50, $6.00, and \$7.50 for express shipping, the function is: `(150 * x) + 300`.
	Function string `json:"function"`
}

type PriceTier ¶ 

type PriceTier struct {
	// Minimum quantity this Price tier is valid for.
	//
	// The minimum quantity is always greater than or equal to 2. The base Price is interpreted as valid for a minimum quantity equal to 1.
	// A [Price](ctp:api:type:Price) or [StandalonePrice](ctp:api:type:StandalonePrice) cannot contain more than one tier with the same `minimumQuantity`.
	MinimumQuantity int `json:"minimumQuantity"`
	// Money value that applies when the `minimumQuantity` is greater than or equal to the [LineItem](ctp:api:type:LineItem) `quantity`.
	//
	// The `currencyCode` of a Price tier is always the same as the `currencyCode` in the `value` of the related Price.
	Value TypedMoney `json:"value"`
}

* * A Price tier is selected instead of the default Price when a certain quantity of the ProductVariant(ctp:api:type:ProductVariant) is [added to a Cart](/projects/carts#add-lineitem) and ordered. * _For example: the Price can be lower if more than 10 items are ordered._ * If no Price tier is found for the Order quantity, the base Price is used. * A Price tier is applied for the entire quantity of a Product Variant put as LineItem(/projects/carts#lineitem) in a Cart as soon as the minimum quantity for the Price tier is reached. * The Price tier is applied per Line Item of the Product Variant. If, for example, the same Product Variant appears in the same Cart as several Line Items, (what can be achieved by different values of a Custom Field on the Line Items) for each Line Item the minimum quantity must be reached to get the Price tier. *

func (*PriceTier) UnmarshalJSON ¶ 

func (obj *PriceTier) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type PriceTierDraft ¶ 

type PriceTierDraft struct {
	// Minimum quantity this Price tier is valid for.
	//
	// The minimum quantity is always greater than or equal to 2. The base Price is interpreted as valid for a minimum quantity equal to 1.
	// A [Price](ctp:api:type:Price) or [StandalonePrice](ctp:api:type:StandalonePrice) cannot contain more than one tier with the same `minimumQuantity`.
	// In the case one of the constraint is not met an [InvalidField](ctp:api:type:InvalidFieldError) is returned.
	MinimumQuantity int `json:"minimumQuantity"`
	// Money value that applies when the `minimumQuantity` is greater than or equal to the [LineItem](ctp:api:type:LineItem) `quantity`.
	//
	// The `currencyCode` of a Price tier must be the same as the `currencyCode` in the `value` of the related Price.
	Value Money `json:"value"`
}

* * Specifies a Price tier that applies when the minimum quantity for the LineItem(ctp:api:type:LineItem) of a ProductVariant with the related Price is reached in a Cart. *

type Product ¶ 

type Product struct {
	// Unique identifier of the Product.
	ID string `json:"id"`
	// Current version of the Product.
	Version int `json:"version"`
	// Date and time (UTC) the Product was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Product was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the Product.
	//
	// This is different from the `key` of a [ProductVariant](ctp:api:type:ProductVariant).
	Key *string `json:"key,omitempty"`
	// The Product Type defining the Attributes of the Product. Cannot be changed.
	ProductType ProductTypeReference `json:"productType"`
	// Contains the current and the staged representation of the product information.
	MasterData ProductCatalogData `json:"masterData"`
	// The [TaxCategory](ctp:api:type:TaxCategory) of the Product.
	TaxCategory *TaxCategoryReference `json:"taxCategory,omitempty"`
	// [State](ctp:api:type:State) of the Product.
	State *StateReference `json:"state,omitempty"`
	// Review statistics of the Product.
	ReviewRatingStatistics *ReviewRatingStatistics `json:"reviewRatingStatistics,omitempty"`
	// Type of Price to be used when looking up a price for the Product.
	PriceMode *ProductPriceModeEnum `json:"priceMode,omitempty"`
}

* * An abstract sellable good with a set of Attributes defined by a Product Type. * Products themselves are not sellable. Instead, they act as a parent structure for Product Variants. * Each Product must have at least one Product Variant, which is called the Master Variant. * A single Product representation contains the _current_ and the _staged_ representation of its product data. *

type ProductAddAssetAction ¶ 

type ProductAddAssetAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged `assets` are updated. If `false`, both the current and staged `assets` are updated.
	Staged *bool `json:"staged,omitempty"`
	// Value to append.
	Asset AssetDraft `json:"asset"`
	// Position in `assets` where the Asset should be put. When specified, the value must be between `0` and the total number of Assets minus `1`.
	Position *int `json:"position,omitempty"`
}

* * Either `variantId` or `sku` is required. *

func (ProductAddAssetAction) MarshalJSON ¶ 

func (obj ProductAddAssetAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductAddExternalImageAction ¶ 

type ProductAddExternalImageAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// Value to add to `images`.
	Image Image `json:"image"`
	// If `true`, only the staged `images` is updated. If `false`, both the current and staged `images` is updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Either `variantId` or `sku` is required. Produces the [ProductImageAdded](/projects/messages#product-image-added) Message. *

func (ProductAddExternalImageAction) MarshalJSON ¶ 

func (obj ProductAddExternalImageAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductAddPriceAction ¶ 

type ProductAddPriceAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// Embedded Price to add to the Product Variant.
	Price PriceDraft `json:"price"`
	// If `true`, only the staged `prices` is updated. If `false`, both the current and staged `prices` are updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Adds the given Price to the `prices` array of the ProductVariant(ctp:api:type:ProductVariant). * Either `variantId` or `sku` is required. *

func (ProductAddPriceAction) MarshalJSON ¶ 

func (obj ProductAddPriceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductAddToCategoryAction ¶ 

type ProductAddToCategoryAction struct {
	// The Category to add.
	Category CategoryResourceIdentifier `json:"category"`
	// A string representing a number between 0 and 1. Must start with `0.` and cannot end with `0`. If empty, any existing value will be removed.
	OrderHint *string `json:"orderHint,omitempty"`
	// If `true`, only the staged `categories` and `categoryOrderHints` are updated. If `false`, both the current and staged `categories` and `categoryOrderHints` are updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Produces the [ProductAddedToCategory](/projects/messages#product-added-to-category) Message.

func (ProductAddToCategoryAction) MarshalJSON ¶ 

func (obj ProductAddToCategoryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductAddVariantAction ¶ 

type ProductAddVariantAction struct {
	// Value to set. Must be unique.
	Sku *string `json:"sku,omitempty"`
	// Value to set. Must be unique.
	Key *string `json:"key,omitempty"`
	// Embedded Prices for the Product Variant.
	Prices []PriceDraft `json:"prices"`
	// Images for the Product Variant.
	Images []Image `json:"images"`
	// Attributes for the Product Variant.
	Attributes []Attribute `json:"attributes"`
	// If `true` the new Product Variant is only staged. If `false` the new Product Variant is both current and staged.
	Staged *bool `json:"staged,omitempty"`
	// Media assets for the Product Variant.
	Assets []AssetDraft `json:"assets"`
}

func (ProductAddVariantAction) MarshalJSON ¶ 

func (obj ProductAddVariantAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductAddedToCategoryMessage ¶ 

type ProductAddedToCategoryMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Category](ctp:api:type:Category) the [Product](ctp:api:type:Product) was added to.
	Category CategoryReference `json:"category"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Add to Category](ctp:api:type:ProductAddToCategoryAction) update action. *

func (ProductAddedToCategoryMessage) MarshalJSON ¶ 

func (obj ProductAddedToCategoryMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductAddedToCategoryMessage) UnmarshalJSON ¶ 

func (obj *ProductAddedToCategoryMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductAddedToCategoryMessagePayload ¶ 

type ProductAddedToCategoryMessagePayload struct {
	// [Category](ctp:api:type:Category) the [Product](ctp:api:type:Product) was added to.
	Category CategoryReference `json:"category"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Add to Category](ctp:api:type:ProductAddToCategoryAction) update action. *

func (ProductAddedToCategoryMessagePayload) MarshalJSON ¶ 

func (obj ProductAddedToCategoryMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductAssignmentMissingError ¶ added in v1.2.0 

type ProductAssignmentMissingError struct {
	// For Product Selection of mode Individual, the message is:
	// `"A Product Variant Selection can only be set for a Product that has previously been added to the Product Selection."`
	// For Product Selection of mode IndividualExclusion, the message is:
	// `"A Variant Exclusion can only be set for a Product that has previously been added to the Product Selection of type Individual Exclusion."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// [Reference](ctp:api:type:Reference) to the [Product](ctp:api:type:Product) for which the error was returned.
	Product ProductReference `json:"product"`
}

* * Returned when a Product is not assigned to the Product Selection. * The error is returned as a failed response either to the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) or to the [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action. *

func (*ProductAssignmentMissingError) DecodeStruct ¶ added in v1.2.0 

func (obj *ProductAssignmentMissingError) DecodeStruct(src map[string]interface{}) error

func (ProductAssignmentMissingError) Error ¶ added in v1.2.0 

func (obj ProductAssignmentMissingError) Error() string

func (ProductAssignmentMissingError) MarshalJSON ¶ added in v1.2.0 

func (obj ProductAssignmentMissingError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductAssignmentMissingError) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ProductAssignmentMissingError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductCatalogData ¶ 

type ProductCatalogData struct {
	// `true` if the Product is published.
	Published bool `json:"published"`
	// Current (published) data of the Product.
	Current ProductData `json:"current"`
	// Staged (unpublished) data of the Product.
	Staged ProductData `json:"staged"`
	// `true` if the `staged` data is different from the `current` data.
	HasStagedChanges bool `json:"hasStagedChanges"`
}

* * Contains the `current` and `staged` ProductData(ctp:api:type:ProductData). *

type ProductChangeAssetNameAction ¶ 

type ProductChangeAssetNameAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged Asset is updated. If `false`, both the current and staged Asset is updated.
	Staged *bool `json:"staged,omitempty"`
	// The `id` of the Asset to update.
	AssetId *string `json:"assetId,omitempty"`
	// The `key` of the Asset to update.
	AssetKey *string `json:"assetKey,omitempty"`
	// New value to set. Must not be empty.
	Name LocalizedString `json:"name"`
}

* * Either `variantId` or `sku` is required. The Asset to update must be specified using either `assetId` or `assetKey`. *

func (ProductChangeAssetNameAction) MarshalJSON ¶ 

func (obj ProductChangeAssetNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductChangeAssetOrderAction ¶ 

type ProductChangeAssetOrderAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged `assets` is updated. If `false`, both the current and staged `assets` are updated.
	Staged *bool `json:"staged,omitempty"`
	// All existing Asset `id`s of the ProductVariant in the desired new order.
	AssetOrder []string `json:"assetOrder"`
}

* * Either `variantId` or `sku` is required. *

func (ProductChangeAssetOrderAction) MarshalJSON ¶ 

func (obj ProductChangeAssetOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductChangeMasterVariantAction ¶ 

type ProductChangeMasterVariantAction struct {
	// The `id` of the ProductVariant to become the Master Variant.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to become the Master Variant.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged Master Variant is changed. If `false`, both the current and staged Master Variant are changed.
	Staged *bool `json:"staged,omitempty"`
}

* * Assigns the specified Product Variant to the `masterVariant` and removes the same from `variants` at the same time. The current Master Variant becomes part of the `variants` array. * Either `variantId` or `sku` is required. *

func (ProductChangeMasterVariantAction) MarshalJSON ¶ 

func (obj ProductChangeMasterVariantAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductChangeNameAction ¶ 

type ProductChangeNameAction struct {
	// Value to set. Must not be empty.
	Name LocalizedString `json:"name"`
	// If `true`, only the staged `name` is updated. If `false`, both the current and staged `name` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductChangeNameAction) MarshalJSON ¶ 

func (obj ProductChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductChangePriceAction ¶ 

type ProductChangePriceAction struct {
	// The `id` of the Embedded Price to update.
	PriceId string `json:"priceId"`
	// Value to set.
	Price PriceDraft `json:"price"`
	// If `true`, only the staged Embedded Price is updated. If `false`, both the current and staged Embedded Price are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductChangePriceAction) MarshalJSON ¶ 

func (obj ProductChangePriceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductChangeSlugAction ¶ 

type ProductChangeSlugAction struct {
	// Value to set. Must not be empty. A Product can have the same slug for different [Locales](ctp:api:type:Locale), but it must be unique across the [Project](ctp:api:type:Project). Must match the pattern `^[A-Za-z0-9_-]{2,256}+$`.
	Slug LocalizedString `json:"slug"`
	// If `true`, only the staged `slug` is updated. If `false`, both the current and staged `slug` are updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Produces the [ProductSlugChanged](ctp:api:type:ProductSlugChangedMessage) Message.

func (ProductChangeSlugAction) MarshalJSON ¶ 

func (obj ProductChangeSlugAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductCreatedMessage ¶ 

type ProductCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The staged [Product Projection](ctp:api:type:ProductProjection) of the [Product](ctp:api:type:Product) at the time of creation.
	ProductProjection ProductProjection `json:"productProjection"`
}

* * Generated after a successful [Create Product](ctp:api:endpoint:/{projectKey}/products:POST) request. *

func (ProductCreatedMessage) MarshalJSON ¶ 

func (obj ProductCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductCreatedMessage) UnmarshalJSON ¶ 

func (obj *ProductCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductCreatedMessagePayload ¶ 

type ProductCreatedMessagePayload struct {
	// The staged [Product Projection](ctp:api:type:ProductProjection) of the [Product](ctp:api:type:Product) at the time of creation.
	ProductProjection ProductProjection `json:"productProjection"`
}

* * Generated after a successful [Create Product](ctp:api:endpoint:/{projectKey}/products:POST) request. *

func (ProductCreatedMessagePayload) MarshalJSON ¶ 

func (obj ProductCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductData ¶ 

type ProductData struct {
	// Name of the Product.
	Name LocalizedString `json:"name"`
	// [Categories](ctp:api:type:Category) assigned to the Product.
	Categories []CategoryReference `json:"categories"`
	// Numerical values to allow ordering of Products within a specified Category.
	CategoryOrderHints *CategoryOrderHints `json:"categoryOrderHints,omitempty"`
	// Description of the Product.
	Description *LocalizedString `json:"description,omitempty"`
	// User-defined identifier used in a deep-link URL for the Product.
	// Must be unique across a Project, but can be the same for Products in different [Locales](ctp:api:type:Locale).
	// Matches the pattern `[a-zA-Z0-9_\\-]{2,256}`.
	Slug LocalizedString `json:"slug"`
	// Title of the Product displayed in search results.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// Description of the Product displayed in search results below the meta title.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// Keywords that give additional information about the Product to search engines.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// The Master Variant of the Product.
	MasterVariant ProductVariant `json:"masterVariant"`
	// Additional Product Variants.
	Variants []ProductVariant `json:"variants"`
	// Used by [Product Suggestions](ctp:api:type:ProductSuggestions), but is also considered for a full text search.
	SearchKeywords SearchKeywords `json:"searchKeywords"`
}

* * Contains all the data of a Product and its Product Variants. *

type ProductDeletedMessage ¶ 

type ProductDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// List of image URLs that were removed during the [Delete Product](ctp:api:type:Product) request.
	RemovedImageUrls []string `json:"removedImageUrls"`
	// Current [Product Projection](ctp:api:type:ProductProjection) of the deleted [Product](ctp:api:type:Product).
	CurrentProjection *ProductProjection `json:"currentProjection,omitempty"`
}

* * Generated after a successful [Delete Product](/../api/projects/products#delete-product) request. *

func (ProductDeletedMessage) MarshalJSON ¶ 

func (obj ProductDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductDeletedMessage) UnmarshalJSON ¶ 

func (obj *ProductDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductDeletedMessagePayload ¶ 

type ProductDeletedMessagePayload struct {
	// List of image URLs that were removed during the [Delete Product](ctp:api:type:Product) request.
	RemovedImageUrls []string `json:"removedImageUrls"`
	// Current [Product Projection](ctp:api:type:ProductProjection) of the deleted [Product](ctp:api:type:Product).
	CurrentProjection *ProductProjection `json:"currentProjection,omitempty"`
}

* * Generated after a successful [Delete Product](/../api/projects/products#delete-product) request. *

func (ProductDeletedMessagePayload) MarshalJSON ¶ 

func (obj ProductDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscount ¶ 

type ProductDiscount struct {
	// Unique identifier of the ProductDiscount.
	ID string `json:"id"`
	// Current version of the ProductDiscount.
	Version int `json:"version"`
	// Date and time (UTC) the ProductDiscount was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the ProductDiscount was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Name of the ProductDiscount.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier of the ProductDiscount.
	Key *string `json:"key,omitempty"`
	// Description of the ProductDiscount.
	Description *LocalizedString `json:"description,omitempty"`
	// Type of Discount and its corresponding value.
	Value ProductDiscountValue `json:"value"`
	// Valid [ProductDiscount predicate](/../api/projects/predicates#productdiscount-predicates).
	Predicate string `json:"predicate"`
	// Unique decimal value between 0 and 1 (stored as String literal) defining the order of Product Discounts to apply in case more than one is applicable and active.
	// A Product Discount with a higher value is prioritized.
	SortOrder string `json:"sortOrder"`
	// If `true` the Product Discount is applied to Products matching the `predicate`.
	IsActive bool `json:"isActive"`
	// References of all the resources that are addressed in the `predicate`.
	References []Reference `json:"references"`
	// Date and time (UTC) from which the Discount is effective.
	// Take [Eventual Consistency](/../api/general-concepts#eventual-consistency) into account for calculated discount values.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Discount is effective.
	// Take [Eventual Consistency](/../api/general-concepts#eventual-consistency) into account for calculated undiscounted values.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

func (*ProductDiscount) UnmarshalJSON ¶ 

func (obj *ProductDiscount) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductDiscountChangeIsActiveAction ¶ 

type ProductDiscountChangeIsActiveAction struct {
	// New value to set.
	// If set to `true`, the Discount will be applied to Product Prices.
	IsActive bool `json:"isActive"`
}

func (ProductDiscountChangeIsActiveAction) MarshalJSON ¶ 

func (obj ProductDiscountChangeIsActiveAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountChangeNameAction ¶ 

type ProductDiscountChangeNameAction struct {
	// New value to set. Must not be empty.
	Name LocalizedString `json:"name"`
}

func (ProductDiscountChangeNameAction) MarshalJSON ¶ 

func (obj ProductDiscountChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountChangePredicateAction ¶ 

type ProductDiscountChangePredicateAction struct {
	// New value to set. Must be a valid [ProductDiscount predicate](/../api/projects/predicates#productdiscount-predicates).
	Predicate string `json:"predicate"`
}

func (ProductDiscountChangePredicateAction) MarshalJSON ¶ 

func (obj ProductDiscountChangePredicateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountChangeSortOrderAction ¶ 

type ProductDiscountChangeSortOrderAction struct {
	// New value to set.
	// Must not be empty.
	// The string value must be a number between `0` and `1`.
	// A Discount with a higher sortOrder is prioritized.
	SortOrder string `json:"sortOrder"`
}

func (ProductDiscountChangeSortOrderAction) MarshalJSON ¶ 

func (obj ProductDiscountChangeSortOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountChangeValueAction ¶ 

type ProductDiscountChangeValueAction struct {
	// New value to set. Must not be empty.
	Value ProductDiscountValueDraft `json:"value"`
}

func (ProductDiscountChangeValueAction) MarshalJSON ¶ 

func (obj ProductDiscountChangeValueAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductDiscountChangeValueAction) UnmarshalJSON ¶ 

func (obj *ProductDiscountChangeValueAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductDiscountDraft ¶ 

type ProductDiscountDraft struct {
	// Name of the ProductDiscount.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier for the ProductDiscount.
	Key *string `json:"key,omitempty"`
	// Description of the ProductDiscount.
	Description *LocalizedString `json:"description,omitempty"`
	// Type of Discount and its corresponding value.
	Value ProductDiscountValueDraft `json:"value"`
	// Valid [ProductDiscount predicate](/../api/projects/predicates#productdiscount-predicates).
	Predicate string `json:"predicate"`
	// Decimal value between 0 and 1 (passed as String literal) that defines the order of ProductDiscounts to apply in case more than one is applicable and active. A ProductDiscount with a higher `sortOrder` is prioritized.
	// The value must be **unique** among all ProductDiscounts in the [Project](ctp:api:type:Project).
	SortOrder string `json:"sortOrder"`
	// Set to `true` to activate the ProductDiscount, set to `false` to deactivate it (even though the `predicate` matches).
	IsActive bool `json:"isActive"`
	// Date and time (UTC) from which the Discount is effective.
	// Take [Eventual Consistency](/../api/general-concepts#eventual-consistency) into account for calculated discount values.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time (UTC) until which the Discount is effective.
	// Take [Eventual Consistency](/../api/general-concepts#eventual-consistency) into account for calculated undiscounted values.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

func (*ProductDiscountDraft) UnmarshalJSON ¶ 

func (obj *ProductDiscountDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductDiscountMatchQuery ¶ 

type ProductDiscountMatchQuery struct {
	// ID of the specified Product.
	ProductId string `json:"productId"`
	// ID of the specified Product Variant.
	VariantId int `json:"variantId"`
	// Controls which [projected representation](/../api/projects/productProjections#current--staged) is applied for the query.
	// Set to `true` for the `staged` Product Projection of the specified Product Variant, set to `false` for the `current` one.
	Staged bool `json:"staged"`
	// Specified Price of the specified Product Variant.
	Price QueryPrice `json:"price"`
}

type ProductDiscountPagedQueryResponse ¶ 

type ProductDiscountPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [ProductDiscounts](ctp:api:type:ProductDiscount) matching the query.
	Results []ProductDiscount `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of ProductDiscount(ctp:api:type:ProductDiscount). *

type ProductDiscountReference ¶ 

type ProductDiscountReference struct {
	// Unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount).
	ID string `json:"id"`
	// Contains the representation of the expanded ProductDiscount. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for ProductDiscounts.
	Obj *ProductDiscount `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a ProductDiscount(ctp:api:type:ProductDiscount). *

func (ProductDiscountReference) MarshalJSON ¶ 

func (obj ProductDiscountReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountResourceIdentifier ¶ 

type ProductDiscountResourceIdentifier struct {
	// Unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a ProductDiscount(ctp:api:type:ProductDiscount). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (ProductDiscountResourceIdentifier) MarshalJSON ¶ 

func (obj ProductDiscountResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountSetDescriptionAction ¶ 

type ProductDiscountSetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (ProductDiscountSetDescriptionAction) MarshalJSON ¶ 

func (obj ProductDiscountSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountSetKeyAction ¶ 

type ProductDiscountSetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (ProductDiscountSetKeyAction) MarshalJSON ¶ 

func (obj ProductDiscountSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountSetValidFromAction ¶ 

type ProductDiscountSetValidFromAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	// Take [Eventual Consistency](/../api/general-concepts#eventual-consistency) into account for calculated discount values.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
}

func (ProductDiscountSetValidFromAction) MarshalJSON ¶ 

func (obj ProductDiscountSetValidFromAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountSetValidFromAndUntilAction ¶ 

type ProductDiscountSetValidFromAndUntilAction struct {
	// Value to set.
	// Take [Eventual Consistency](/../api/general-concepts#eventual-consistency) into account for calculated undiscounted values.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Value to set.
	// Take [Eventual Consistency](/../api/general-concepts#eventual-consistency) into account for calculated undiscounted values.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

func (ProductDiscountSetValidFromAndUntilAction) MarshalJSON ¶ 

func (obj ProductDiscountSetValidFromAndUntilAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountSetValidUntilAction ¶ 

type ProductDiscountSetValidUntilAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	// Take [Eventual Consistency](/../api/general-concepts#eventual-consistency) into account for calculated undiscounted values.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

func (ProductDiscountSetValidUntilAction) MarshalJSON ¶ 

func (obj ProductDiscountSetValidUntilAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountUpdate ¶ 

type ProductDiscountUpdate struct {
	// Expected version of the ProductDiscount on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the ProductDiscount.
	Actions []ProductDiscountUpdateAction `json:"actions"`
}

func (*ProductDiscountUpdate) UnmarshalJSON ¶ 

func (obj *ProductDiscountUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductDiscountUpdateAction ¶ 

type ProductDiscountUpdateAction interface{}

type ProductDiscountValue ¶ 

type ProductDiscountValue interface{}

type ProductDiscountValueAbsolute ¶ 

type ProductDiscountValueAbsolute struct {
	// Money values in different currencies. An absolute [ProductDiscount](ctp:api:type:ProductDiscount) will only match a price if this array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be decreased by 10€ and the matching $ price will be decreased by 15\$.
	Money []CentPrecisionMoney `json:"money"`
}

* * Discounts the Product's Price by a fixed amount, defined by the `money` field.

func (ProductDiscountValueAbsolute) MarshalJSON ¶ 

func (obj ProductDiscountValueAbsolute) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountValueAbsoluteDraft ¶ 

type ProductDiscountValueAbsoluteDraft struct {
	// Money values in different currencies.
	// An absolute Product Discount will match a price only if the array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be decreased by 10€ and the matching $ price will be decreased by 15$. If the array has multiple values of the same currency, the API returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	//
	// If the array is empty, the discount does not apply.
	Money []Money `json:"money"`
}

* * Discounts the Product Price by a fixed amount, defined by the `money` field. *

func (ProductDiscountValueAbsoluteDraft) MarshalJSON ¶ 

func (obj ProductDiscountValueAbsoluteDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountValueDraft ¶ 

type ProductDiscountValueDraft interface{}

type ProductDiscountValueExternal ¶ 

type ProductDiscountValueExternal struct {
}

* * Discounts the Product Price by allowing the client to explicitly [set a discounted value](ctp:api:type:ProductSetDiscountedPriceAction). * Used when setting discounts using an external service. *

func (ProductDiscountValueExternal) MarshalJSON ¶ 

func (obj ProductDiscountValueExternal) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountValueExternalDraft ¶ 

type ProductDiscountValueExternalDraft struct {
}

* * Discounts the Product Price by allowing the client to explicitly [set a discounted value](ctp:api:type:ProductSetDiscountedPriceAction). * Use this when setting discounts using an external service. *

func (ProductDiscountValueExternalDraft) MarshalJSON ¶ 

func (obj ProductDiscountValueExternalDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountValueRelative ¶ 

type ProductDiscountValueRelative struct {
	// Fraction (per ten thousand) the price is reduced by. For example, `1000` will result in a 10% price reduction.
	Permyriad int `json:"permyriad"`
}

* * Discounts the product price by a percentage, defined by the `permyriad` field.

func (ProductDiscountValueRelative) MarshalJSON ¶ 

func (obj ProductDiscountValueRelative) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDiscountValueRelativeDraft ¶ 

type ProductDiscountValueRelativeDraft struct {
	// Fraction (per ten thousand) the price is reduced by. For example, `1000` will result in a 10% price reduction.
	Permyriad int `json:"permyriad"`
}

* * Discounts the Product Price by a percentage, defined by the `permyriad` field. *

func (ProductDiscountValueRelativeDraft) MarshalJSON ¶ 

func (obj ProductDiscountValueRelativeDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductDraft ¶ 

type ProductDraft struct {
	// The Product Type defining the Attributes for the Product. Cannot be changed later.
	ProductType ProductTypeResourceIdentifier `json:"productType"`
	// Name of the Product.
	Name LocalizedString `json:"name"`
	// User-defined identifier used in a deep-link URL for the Product.
	// It must be unique across a Project, but a Product can have the same slug in different [Locales](ctp:api:type:Locale).
	// It must match the pattern `[a-zA-Z0-9_\\-]{2,256}`.
	Slug LocalizedString `json:"slug"`
	// User-defined unique identifier for the Product.
	Key *string `json:"key,omitempty"`
	// Description of the Product.
	Description *LocalizedString `json:"description,omitempty"`
	// Categories assigned to the Product.
	Categories []CategoryResourceIdentifier `json:"categories"`
	// Numerical values to allow ordering of Products within a specified Category.
	CategoryOrderHints *CategoryOrderHints `json:"categoryOrderHints,omitempty"`
	// Title of the Product displayed in search results.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// Description of the Product displayed in search results.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// Keywords that give additional information about the Product to search engines.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// The Product Variant to be the Master Variant for the Product. Required if `variants` are provided also.
	MasterVariant *ProductVariantDraft `json:"masterVariant,omitempty"`
	// The additional Product Variants for the Product.
	Variants []ProductVariantDraft `json:"variants"`
	// The Tax Category to be assigned to the Product.
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// Used by [Product Suggestions](ctp:api:type:ProductSuggestions), but is also considered for a [full text search](/projects/products-search#full-text-search).
	SearchKeywords *SearchKeywords `json:"searchKeywords,omitempty"`
	// State to be assigned to the Product.
	State *StateResourceIdentifier `json:"state,omitempty"`
	// If `true`, the Product is published immediately to the current projection.
	Publish *bool `json:"publish,omitempty"`
	// Specifies the type of prices used when looking up a price for the Product.
	PriceMode *ProductPriceModeEnum `json:"priceMode,omitempty"`
}

func (ProductDraft) MarshalJSON ¶ 

func (obj ProductDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductImageAddedMessage ¶ 

type ProductImageAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Product Variant](ctp:api:type:ProductVariant) to which the [Image](ctp:api:type:Image) was added.
	VariantId int `json:"variantId"`
	// [Image](ctp:api:type:Image) that was added.
	Image Image `json:"image"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Add External Image](ctp:api:type:ProductAddExternalImageAction) update action or after the successful [upload of an image](/../api/projects/products#upload-product-image). *

func (ProductImageAddedMessage) MarshalJSON ¶ 

func (obj ProductImageAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductImageAddedMessage) UnmarshalJSON ¶ 

func (obj *ProductImageAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductImageAddedMessagePayload ¶ 

type ProductImageAddedMessagePayload struct {
	// Unique identifier of the [Product Variant](ctp:api:type:ProductVariant) to which the [Image](ctp:api:type:Image) was added.
	VariantId int `json:"variantId"`
	// [Image](ctp:api:type:Image) that was added.
	Image Image `json:"image"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Add External Image](ctp:api:type:ProductAddExternalImageAction) update action or after the successful [upload of an image](/../api/projects/products#upload-product-image). *

func (ProductImageAddedMessagePayload) MarshalJSON ¶ 

func (obj ProductImageAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductLegacySetSkuAction ¶ 

type ProductLegacySetSkuAction struct {
	Sku       *string `json:"sku,omitempty"`
	VariantId int     `json:"variantId"`
}

func (ProductLegacySetSkuAction) MarshalJSON ¶ 

func (obj ProductLegacySetSkuAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductMoveImageToPositionAction ¶ 

type ProductMoveImageToPositionAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// The URL of the image to update.
	ImageUrl string `json:"imageUrl"`
	// Position in `images` where the image should be moved. Must be between `0` and the total number of images minus `1`.
	Position int `json:"position"`
	// If `true`, only the staged `images` is updated. If `false`, both the current and staged `images` is updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Either `variantId` or `sku` is required. *

func (ProductMoveImageToPositionAction) MarshalJSON ¶ 

func (obj ProductMoveImageToPositionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductPagedQueryResponse ¶ 

type ProductPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](ctp:api:type:QueryPredicate), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Products](ctp:api:type:Product) matching the query.
	Results []Product `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of Product(ctp:api:type:Product). *

type ProductPresentWithDifferentVariantSelectionError ¶ added in v1.2.0 

type ProductPresentWithDifferentVariantSelectionError struct {
	// `"Product is already present with the following different $variantSelections."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// [Reference](ctp:api:type:Reference) to the [Product](ctp:api:type:Product) for which the error was returned.
	Product ProductReference `json:"product"`
	// Existing Product Variant Selection or Exclusion for the [Product](/../api/projects/products) in the [Product Selection](/../api/projects/product-selections).
	ExistingVariantSelection ProductVariantSelection `json:"existingVariantSelection"`
}

* * Returned when a Product is already assigned to a [Product Selection](/../api/projects/product-selections), but the Product Selection has either a different [Product Variant Selection](ctp:api:type:ProductVariantSelection) or a different [Product Variant Exclusion](ctp:api:type:ProductVariantExclusion). * * The error is returned as a failed response either to the [Add Product](ctp:api:type:ProductSelectionAddProductAction) or to the [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action. *

func (*ProductPresentWithDifferentVariantSelectionError) DecodeStruct ¶ added in v1.2.0 

func (obj *ProductPresentWithDifferentVariantSelectionError) DecodeStruct(src map[string]interface{}) error

func (ProductPresentWithDifferentVariantSelectionError) Error ¶ added in v1.2.0 

func (obj ProductPresentWithDifferentVariantSelectionError) Error() string

func (ProductPresentWithDifferentVariantSelectionError) MarshalJSON ¶ added in v1.2.0 

func (obj ProductPresentWithDifferentVariantSelectionError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPresentWithDifferentVariantSelectionError) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ProductPresentWithDifferentVariantSelectionError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPriceAddedMessage ¶ added in v1.3.0 

type ProductPriceAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [ProductVariant](ctp:api:type:ProductVariant) for which the Price was added.
	VariantId int `json:"variantId"`
	// The [Embedded Price](/projects/products#embedded-price) that was added to the [ProductVariant](ctp:api:type:ProductVariant).
	Price Price `json:"price"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Add Price](ctp:api:type:ProductAddPriceAction) update action. *

func (ProductPriceAddedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPriceAddedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *ProductPriceAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPriceAddedMessagePayload ¶ added in v1.3.0 

type ProductPriceAddedMessagePayload struct {
	// Unique identifier of the [ProductVariant](ctp:api:type:ProductVariant) for which the Price was added.
	VariantId int `json:"variantId"`
	// The [Embedded Price](/projects/products#embedded-price) that was added to the [ProductVariant](ctp:api:type:ProductVariant).
	Price Price `json:"price"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Add Price](ctp:api:type:ProductAddPriceAction) update action. *

func (ProductPriceAddedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductPriceChangedMessage ¶ added in v1.3.0 

type ProductPriceChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [ProductVariant](ctp:api:type:ProductVariant) for which the Price was changed.
	VariantId int `json:"variantId"`
	// The current [Embedded Price](/projects/products#embedded-price) before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action.
	OldPrice Price `json:"oldPrice"`
	// The [Embedded Price](/projects/products#embedded-price) after the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action.
	NewPrice Price `json:"newPrice"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
	// The staged [Embedded Price](/projects/products#embedded-price) before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action.
	OldStagedPrice *Price `json:"oldStagedPrice,omitempty"`
}

* * Generated after a successful [Change Price](ctp:api:type:ProductChangePriceAction) update action. *

func (ProductPriceChangedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPriceChangedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *ProductPriceChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPriceChangedMessagePayload ¶ added in v1.3.0 

type ProductPriceChangedMessagePayload struct {
	// Unique identifier of the [ProductVariant](ctp:api:type:ProductVariant) for which the Price was changed.
	VariantId int `json:"variantId"`
	// The current [Embedded Price](/projects/products#embedded-price) before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action.
	OldPrice Price `json:"oldPrice"`
	// The [Embedded Price](/projects/products#embedded-price) after the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action.
	NewPrice Price `json:"newPrice"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
	// The staged [Embedded Price](/projects/products#embedded-price) before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action.
	OldStagedPrice *Price `json:"oldStagedPrice,omitempty"`
}

* * Generated after a successful [Change Price](ctp:api:type:ProductChangePriceAction) update action. *

func (ProductPriceChangedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductPriceDiscountsSetMessage ¶ 

type ProductPriceDiscountsSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Array containing details about the [Embedded Prices](ctp:api:type:Price) that were updated.
	UpdatedPrices []ProductPriceDiscountsSetUpdatedPrice `json:"updatedPrices"`
}

* * Generated after a Price is updated due to a [Product Discount](ctp:api:type:ProductDiscount). *

func (ProductPriceDiscountsSetMessage) MarshalJSON ¶ 

func (obj ProductPriceDiscountsSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPriceDiscountsSetMessage) UnmarshalJSON ¶ 

func (obj *ProductPriceDiscountsSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPriceDiscountsSetMessagePayload ¶ 

type ProductPriceDiscountsSetMessagePayload struct {
	// Array containing details about the [Embedded Prices](ctp:api:type:Price) that were updated.
	UpdatedPrices []ProductPriceDiscountsSetUpdatedPrice `json:"updatedPrices"`
}

* * Generated after a Price is updated due to a [Product Discount](ctp:api:type:ProductDiscount). *

func (ProductPriceDiscountsSetMessagePayload) MarshalJSON ¶ 

func (obj ProductPriceDiscountsSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductPriceDiscountsSetUpdatedPrice ¶ 

type ProductPriceDiscountsSetUpdatedPrice struct {
	// Unique identifier of the [ProductVariant](ctp:api:type:ProductVariant) for which the Discount was set.
	VariantId int `json:"variantId"`
	// Key of the [ProductVariant](ctp:api:type:ProductVariant) for which Discount was set.
	VariantKey *string `json:"variantKey,omitempty"`
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant) for which Discount was set.
	Sku *string `json:"sku,omitempty"`
	// Unique identifier of the [Price](ctp:api:type:Price).
	PriceId string `json:"priceId"`
	// Discounted Price for the [ProductVariant](ctp:api:type:ProductVariant) for which Discount was set.
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
	// Whether the update was only applied to the staged [ProductProjection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Details about a [Embedded Price](/projects/products#embedded-price) that was updated due to a Discount. Specific to [Product Price Discounts Set](ctp:api:type:ProductPriceDiscountsSetMessage) Message. *

type ProductPriceExternalDiscountSetMessage ¶ 

type ProductPriceExternalDiscountSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Product Variant](ctp:api:type:ProductVariant) for which the Discount was set.
	VariantId int `json:"variantId"`
	// Key of the [Product Variant](ctp:api:type:ProductVariant) for which the Discount was set.
	VariantKey *string `json:"variantKey,omitempty"`
	// SKU of the [Product Variant](ctp:api:type:ProductVariant) for which Discount was set.
	Sku *string `json:"sku,omitempty"`
	// Unique identifier of the [Price](ctp:api:type:Price).
	PriceId string `json:"priceId"`
	// Discounted Price for the [Product Variant](ctp:api:type:ProductVariant) for which Discount was set.
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Set Discounted Price](ctp:api:type:ProductSetDiscountedPriceAction) update action. *

func (ProductPriceExternalDiscountSetMessage) MarshalJSON ¶ 

func (obj ProductPriceExternalDiscountSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPriceExternalDiscountSetMessage) UnmarshalJSON ¶ 

func (obj *ProductPriceExternalDiscountSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPriceExternalDiscountSetMessagePayload ¶ 

type ProductPriceExternalDiscountSetMessagePayload struct {
	// Unique identifier of the [Product Variant](ctp:api:type:ProductVariant) for which the Discount was set.
	VariantId int `json:"variantId"`
	// Key of the [Product Variant](ctp:api:type:ProductVariant) for which the Discount was set.
	VariantKey *string `json:"variantKey,omitempty"`
	// SKU of the [Product Variant](ctp:api:type:ProductVariant) for which Discount was set.
	Sku *string `json:"sku,omitempty"`
	// Unique identifier of the [Price](ctp:api:type:Price).
	PriceId string `json:"priceId"`
	// Discounted Price for the [Product Variant](ctp:api:type:ProductVariant) for which Discount was set.
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Set Discounted Price](ctp:api:type:ProductSetDiscountedPriceAction) update action. *

func (ProductPriceExternalDiscountSetMessagePayload) MarshalJSON ¶ 

func (obj ProductPriceExternalDiscountSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductPriceKeySetMessage ¶ added in v1.3.0 

type ProductPriceKeySetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	VariantId                       int                      `json:"variantId"`
	// Unique identifier of the [Price](ctp:api:type:Price).
	PriceId *string `json:"priceId,omitempty"`
	// `key` value of the [Price](ctp:api:type:Price) before the [Set Price Key](ctp:api:type:ProductSetPriceKeyAction) update action.
	OldKey *string `json:"oldKey,omitempty"`
	// `key` value of the [Price](ctp:api:type:Price) after the [Set Price Key](ctp:api:type:ProductSetPriceKeyAction) update action.
	Key *string `json:"key,omitempty"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Set Price Key](ctp:api:type:ProductSetPriceKeyAction) update action. *

func (ProductPriceKeySetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceKeySetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPriceKeySetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *ProductPriceKeySetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPriceKeySetMessagePayload ¶ added in v1.3.0 

type ProductPriceKeySetMessagePayload struct {
	VariantId int `json:"variantId"`
	// Unique identifier of the [Price](ctp:api:type:Price).
	PriceId *string `json:"priceId,omitempty"`
	// `key` value of the [Price](ctp:api:type:Price) before the [Set Price Key](ctp:api:type:ProductSetPriceKeyAction) update action.
	OldKey *string `json:"oldKey,omitempty"`
	// `key` value of the [Price](ctp:api:type:Price) after the [Set Price Key](ctp:api:type:ProductSetPriceKeyAction) update action.
	Key *string `json:"key,omitempty"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Set Price Key](ctp:api:type:ProductSetPriceKeyAction) update action. *

func (ProductPriceKeySetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceKeySetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductPriceModeEnum ¶ 

type ProductPriceModeEnum string

* * This mode determines the type of Prices used for [Product Price Selection](ctp:api:type:ProductPriceSelection) and for [LineItem Price selection](ctp:api:type:LineItemPriceSelection). * 

const (
	ProductPriceModeEnumEmbedded   ProductPriceModeEnum = "Embedded"
	ProductPriceModeEnumStandalone ProductPriceModeEnum = "Standalone"
)

type ProductPriceModeSetMessage ¶ added in v1.3.0 

type ProductPriceModeSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [PriceMode](ctp:api:type:ProductPriceModeEnum) that was set.
	To ProductPriceModeEnum `json:"to"`
}

* * Generated after a successful [Set PriceMode](ctp:api:type:ProductSetPriceModeAction) update action. *

func (ProductPriceModeSetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceModeSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPriceModeSetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *ProductPriceModeSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPriceModeSetMessagePayload ¶ added in v1.3.0 

type ProductPriceModeSetMessagePayload struct {
	// The [PriceMode](ctp:api:type:ProductPriceModeEnum) that was set.
	To ProductPriceModeEnum `json:"to"`
}

* * Generated after a successful [Set PriceMode](ctp:api:type:ProductSetPriceModeAction) update action. *

func (ProductPriceModeSetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceModeSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductPriceRemovedMessage ¶ added in v1.3.0 

type ProductPriceRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [ProductVariant](ctp:api:type:ProductVariant) for which the Price was removed.
	VariantId int `json:"variantId"`
	// The [Embedded Price](/projects/products#embedded-price) that was removed from the [ProductVariant](ctp:api:type:ProductVariant).
	Price Price `json:"price"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Remove Price](ctp:api:type:ProductRemovePriceAction) update action. *

func (ProductPriceRemovedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPriceRemovedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *ProductPriceRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPriceRemovedMessagePayload ¶ added in v1.3.0 

type ProductPriceRemovedMessagePayload struct {
	// Unique identifier of the [ProductVariant](ctp:api:type:ProductVariant) for which the Price was removed.
	VariantId int `json:"variantId"`
	// The [Embedded Price](/projects/products#embedded-price) that was removed from the [ProductVariant](ctp:api:type:ProductVariant).
	Price Price `json:"price"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Remove Price](ctp:api:type:ProductRemovePriceAction) update action. *

func (ProductPriceRemovedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPriceRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductPricesSetMessage ¶ added in v1.3.0 

type ProductPricesSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [ProductVariant](ctp:api:type:ProductVariant) for which the Price was set.
	VariantId int `json:"variantId"`
	// The [Embedded Prices](ctp:api:type:Price) that were set on the [ProductVariant](ctp:api:type:ProductVariant).
	Prices []Price `json:"prices"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Set Prices](ctp:api:type:ProductSetPricesAction) update action. *

func (ProductPricesSetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPricesSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPricesSetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *ProductPricesSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPricesSetMessagePayload ¶ added in v1.3.0 

type ProductPricesSetMessagePayload struct {
	// Unique identifier of the [ProductVariant](ctp:api:type:ProductVariant) for which the Price was set.
	VariantId int `json:"variantId"`
	// The [Embedded Prices](ctp:api:type:Price) that were set on the [ProductVariant](ctp:api:type:ProductVariant).
	Prices []Price `json:"prices"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Set Prices](ctp:api:type:ProductSetPricesAction) update action. *

func (ProductPricesSetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj ProductPricesSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductProjection ¶ 

type ProductProjection struct {
	// Unique identifier of the [Product](ctp:api:type:Product).
	ID string `json:"id"`
	// Current version of the [Product](ctp:api:type:Product).
	Version int `json:"version"`
	// Date and time (UTC) the ProductProjection was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the ProductProjection was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-defined unique identifier of the [Product](ctp:api:type:Product).
	Key *string `json:"key,omitempty"`
	// The [ProductType](ctp:api:type:ProductType) defining the Attributes of the [Product](ctp:api:type:Product).
	ProductType ProductTypeReference `json:"productType"`
	// Name of the [Product](ctp:api:type:Product).
	Name LocalizedString `json:"name"`
	// Description of the [Product](ctp:api:type:Product).
	Description *LocalizedString `json:"description,omitempty"`
	// User-defined identifier used in a deep-link URL for the [Product](ctp:api:type:Product).
	// Must be unique across a Project, but can be the same for Products in different locales.
	// Matches the pattern `[a-zA-Z0-9_\-]{2,256}`.
	// For [good performance](/../api/predicates/query#performance-considerations), indexes are provided for the first 15 `languages` set in the [Project](ctp:api:type:Project).
	Slug LocalizedString `json:"slug"`
	// [Categories](ctp:api:type:Category) assigned to the [Product](ctp:api:type:Product).
	Categories []CategoryReference `json:"categories"`
	// Order of [Product](ctp:api:type:Product) in [Categories](ctp:api:type:Category).
	CategoryOrderHints *CategoryOrderHints `json:"categoryOrderHints,omitempty"`
	// Title of the [Product](ctp:api:type:Product) displayed in search results.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// Description of the [Product](ctp:api:type:Product) displayed in search results below the meta title.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// Keywords that give additional information about the [Product](ctp:api:type:Product) to search engines.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// Used by [Product Suggestions](/../api/projects/products-suggestions), but is also considered for a [full text search](ctp:api:type:FullTextSearch).
	SearchKeywords *SearchKeywords `json:"searchKeywords,omitempty"`
	// `true` if the staged data is different from the current data.
	HasStagedChanges *bool `json:"hasStagedChanges,omitempty"`
	// `true` if the [Product](ctp:api:type:Product) is [published](ctp:api:type:CurrentStaged).
	Published *bool `json:"published,omitempty"`
	// The Master Variant of the [Product](ctp:api:type:Product).
	MasterVariant ProductVariant `json:"masterVariant"`
	// Additional Product Variants.
	Variants []ProductVariant `json:"variants"`
	// The [TaxCategory](ctp:api:type:TaxCategory) of the [Product](ctp:api:type:Product).
	TaxCategory *TaxCategoryReference `json:"taxCategory,omitempty"`
	// [State](ctp:api:type:State) of the [Product](ctp:api:type:Product).
	State *StateReference `json:"state,omitempty"`
	// Review statistics of the [Product](ctp:api:type:Product).
	ReviewRatingStatistics *ReviewRatingStatistics `json:"reviewRatingStatistics,omitempty"`
	// Indicates whether the Prices of the Product Projection are [embedded](ctp:api:type:Price) or [standalone](ctp:api:type:StandalonePrice). [Projecting Prices](#prices) only works with `Embedded`, there is currently no support for `Standalone`.
	PriceMode *ProductPriceModeEnum `json:"priceMode,omitempty"`
}

type ProductProjectionPagedQueryResponse ¶ 

type ProductProjectionPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// [ProductProjections](ctp:api:type:ProductProjection) matching the query.
	Results []ProductProjection `json:"results"`
}

type ProductProjectionPagedSearchResponse ¶ 

type ProductProjectionPagedSearchResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int  `json:"limit"`
	Count int  `json:"count"`
	Total *int `json:"total,omitempty"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset  int                 `json:"offset"`
	Results []ProductProjection `json:"results"`
	Facets  FacetResults        `json:"facets"`
}

type ProductPublishAction ¶ 

type ProductPublishAction struct {
	// `All` or `Prices`
	Scope *ProductPublishScope `json:"scope,omitempty"`
}

* * Publishes product data from the Product's staged projection to its current projection. * Produces the [ProductPublished](ctp:api:type:ProductPublishedMessage) Message.

func (ProductPublishAction) MarshalJSON ¶ 

func (obj ProductPublishAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductPublishScope ¶ 

type ProductPublishScope string

* * The scope controls which part of the product information is published. 

const (
	ProductPublishScopeAll    ProductPublishScope = "All"
	ProductPublishScopePrices ProductPublishScope = "Prices"
)

type ProductPublishedMessage ¶ 

type ProductPublishedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// List of image URLs which were removed during the [Publish](ctp:api:type:ProductPublishAction) update action.
	RemovedImageUrls []string `json:"removedImageUrls"`
	// Current [Product Projection](ctp:api:type:ProductProjection) of the [Product](ctp:api:type:Product) at the time of creation.
	ProductProjection ProductProjection `json:"productProjection"`
	// [Publishing Scope](ctp:api:type:ProductPublishScope) that was used during the [Publish](ctp:api:type:ProductPublishAction) update action.
	Scope ProductPublishScope `json:"scope"`
}

* * Generated after a successful [Publish](ctp:api:type:ProductPublishAction) update action. *

func (ProductPublishedMessage) MarshalJSON ¶ 

func (obj ProductPublishedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductPublishedMessage) UnmarshalJSON ¶ 

func (obj *ProductPublishedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductPublishedMessagePayload ¶ 

type ProductPublishedMessagePayload struct {
	// List of image URLs which were removed during the [Publish](ctp:api:type:ProductPublishAction) update action.
	RemovedImageUrls []string `json:"removedImageUrls"`
	// Current [Product Projection](ctp:api:type:ProductProjection) of the [Product](ctp:api:type:Product) at the time of creation.
	ProductProjection ProductProjection `json:"productProjection"`
	// [Publishing Scope](ctp:api:type:ProductPublishScope) that was used during the [Publish](ctp:api:type:ProductPublishAction) update action.
	Scope ProductPublishScope `json:"scope"`
}

* * Generated after a successful [Publish](ctp:api:type:ProductPublishAction) update action. *

func (ProductPublishedMessagePayload) MarshalJSON ¶ 

func (obj ProductPublishedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductReference ¶ 

type ProductReference struct {
	// Unique identifier of the referenced [Product](ctp:api:type:Product).
	ID string `json:"id"`
	// Contains the representation of the expanded Product. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Products.
	Obj *Product `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Product(ctp:api:type:Product). *

func (ProductReference) MarshalJSON ¶ 

func (obj ProductReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductRemoveAssetAction ¶ 

type ProductRemoveAssetAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged Asset is removed. If `false`, both the current and staged Asset is removed.
	Staged *bool `json:"staged,omitempty"`
	// The `id` of the Asset to remove.
	AssetId *string `json:"assetId,omitempty"`
	// The `key` of the Asset to remove.
	AssetKey *string `json:"assetKey,omitempty"`
}

* * Either `variantId` or `sku` is required. The Asset to remove must be specified using either `assetId` or `assetKey`. *

func (ProductRemoveAssetAction) MarshalJSON ¶ 

func (obj ProductRemoveAssetAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductRemoveFromCategoryAction ¶ 

type ProductRemoveFromCategoryAction struct {
	// The Category to remove.
	Category CategoryResourceIdentifier `json:"category"`
	// If `true`, only the staged `categories` and `categoryOrderHints` are removed. If `false`, both the current and staged `categories` and `categoryOrderHints` are removed.
	Staged *bool `json:"staged,omitempty"`
}

* * Produces the [ProductRemovedFromCategory](ctp:api:type:ProductRemovedFromCategoryMessage) Message.

func (ProductRemoveFromCategoryAction) MarshalJSON ¶ 

func (obj ProductRemoveFromCategoryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductRemoveImageAction ¶ 

type ProductRemoveImageAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// The URL of the image to remove.
	ImageUrl string `json:"imageUrl"`
	// If `true`, only the staged image is removed. If `false`, both the current and staged image is removed.
	Staged *bool `json:"staged,omitempty"`
}

* * Removes a Product image and deletes it from the Content Delivery Network (external images are not deleted). Deletion from the CDN is not instant, which means the image file itself will stay available for some time after the deletion. Either `variantId` or `sku` is required. *

func (ProductRemoveImageAction) MarshalJSON ¶ 

func (obj ProductRemoveImageAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductRemovePriceAction ¶ 

type ProductRemovePriceAction struct {
	// The `id` of the Embedded Price to remove.
	PriceId string `json:"priceId"`
	// The `sku` of the ProductVariant the provided Price should be removed from.
	// Either 'variantId' or 'sku' is required" when `priceId` is not provided.
	// This field is now deprecated, use 'priceId' instead.
	Sku *string `json:"sku,omitempty"`
	// The `id` of the ProductVariant the provided Price should be removed from.
	// Either 'variantId' or 'sku' is required" when `priceId` is not provided.
	// This field is now deprecated, use 'priceId' instead.
	VariantId *int `json:"variantId,omitempty"`
	// The Price identical to the one to be removed from the ProductVariant.
	// This field is now deprecated, use 'priceId' instead.
	Price *PriceDraft `json:"price,omitempty"`
	// If `true`, only the staged Embedded Price is removed. If `false`, both the current and staged Embedded Price are removed.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductRemovePriceAction) MarshalJSON ¶ 

func (obj ProductRemovePriceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductRemoveVariantAction ¶ 

type ProductRemoveVariantAction struct {
	// The `id` of the ProductVariant to remove.
	ID *int `json:"id,omitempty"`
	// The `sku` of the ProductVariant to remove.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged ProductVariant is removed. If `false`, both the current and staged ProductVariant is removed.
	Staged *bool `json:"staged,omitempty"`
}

* * Either `id` or `sku` is required. * Produces the [ProductVariantDeleted](ctp:api:type:ProductVariantDeletedMessage) Message. * If the Product Variant to remove is part of a ProductSelectionAssignment(ctp:api:type:ProductSelectionAssignment) * its SKU will be automatically removed from the respective ProductVariantSelection(ctp:api:type:ProductVariantSelection). *

func (ProductRemoveVariantAction) MarshalJSON ¶ 

func (obj ProductRemoveVariantAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductRemovedFromCategoryMessage ¶ 

type ProductRemovedFromCategoryMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Category](ctp:api:type:Category) the [Product](ctp:api:type:Product) was removed from.
	Category CategoryReference `json:"category"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Remove from Category](ctp:api:type:ProductRemoveFromCategoryAction) update action. *

func (ProductRemovedFromCategoryMessage) MarshalJSON ¶ 

func (obj ProductRemovedFromCategoryMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductRemovedFromCategoryMessage) UnmarshalJSON ¶ 

func (obj *ProductRemovedFromCategoryMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductRemovedFromCategoryMessagePayload ¶ 

type ProductRemovedFromCategoryMessagePayload struct {
	// [Category](ctp:api:type:Category) the [Product](ctp:api:type:Product) was removed from.
	Category CategoryReference `json:"category"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Remove from Category](ctp:api:type:ProductRemoveFromCategoryAction) update action. *

func (ProductRemovedFromCategoryMessagePayload) MarshalJSON ¶ 

func (obj ProductRemovedFromCategoryMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductResourceIdentifier ¶ 

type ProductResourceIdentifier struct {
	// Unique identifier of the referenced [Product](ctp:api:type:Product). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [Product](ctp:api:type:Product). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a Product(ctp:api:type:Product). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (ProductResourceIdentifier) MarshalJSON ¶ 

func (obj ProductResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductRevertStagedChangesAction ¶ 

type ProductRevertStagedChangesAction struct {
}

* * Reverts the staged version of a Product to the current version. Produces the [ProductRevertedStagedChanges](ctp:api:type:ProductRevertedStagedChangesMessage) Message. *

func (ProductRevertStagedChangesAction) MarshalJSON ¶ 

func (obj ProductRevertStagedChangesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductRevertStagedVariantChangesAction ¶ 

type ProductRevertStagedVariantChangesAction struct {
	// The `id` of the ProductVariant to revert.
	VariantId int `json:"variantId"`
}

* * Reverts the staged version of a ProductVariant to the current version. *

func (ProductRevertStagedVariantChangesAction) MarshalJSON ¶ 

func (obj ProductRevertStagedVariantChangesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductRevertedStagedChangesMessage ¶ 

type ProductRevertedStagedChangesMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// List of image URLs that were removed during the [Revert Staged Changes](ctp:api:type:ProductRevertStagedChangesAction) update action.
	RemovedImageUrls []string `json:"removedImageUrls"`
}

* * Generated after a successful [Revert Staged Changes](ctp:api:type:ProductRevertStagedChangesAction) update action. *

func (ProductRevertedStagedChangesMessage) MarshalJSON ¶ 

func (obj ProductRevertedStagedChangesMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductRevertedStagedChangesMessage) UnmarshalJSON ¶ 

func (obj *ProductRevertedStagedChangesMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductRevertedStagedChangesMessagePayload ¶ 

type ProductRevertedStagedChangesMessagePayload struct {
	// List of image URLs that were removed during the [Revert Staged Changes](ctp:api:type:ProductRevertStagedChangesAction) update action.
	RemovedImageUrls []string `json:"removedImageUrls"`
}

* * Generated after a successful [Revert Staged Changes](ctp:api:type:ProductRevertStagedChangesAction) update action. *

func (ProductRevertedStagedChangesMessagePayload) MarshalJSON ¶ 

func (obj ProductRevertedStagedChangesMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelection ¶ 

type ProductSelection struct {
	// Unique identifier of the ProductSelection.
	ID string `json:"id"`
	// Current version of the ProductSelection.
	Version int `json:"version"`
	// Date and time (UTC) the ProductSelection was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the ProductSelection was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources updated after 1/02/2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1/02/2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the ProductSelection.
	Key *string `json:"key,omitempty"`
	// Name of the ProductSelection.
	Name LocalizedString `json:"name"`
	// Number of Products that are currently assigned to this ProductSelection.
	ProductCount int `json:"productCount"`
	// Specifies in which way the Products are assigned to the ProductSelection.
	// Currently, the only way of doing this is to specify each Product individually, either by [including or excluding](ctp:api:type:ProductSelectionMode) them explicitly.
	Type *ProductSelectionTypeEnum `json:"type,omitempty"`
	// Specifies in which way the Products are assigned to the ProductSelection.
	// Currently, the only way of doing this is to specify each Product individually, either by [including or excluding](ctp:api:type:ProductSelectionMode) them explicitly.
	Mode ProductSelectionMode `json:"mode"`
	// Custom Fields of the ProductSelection.
	Custom *CustomFields `json:"custom,omitempty"`
}

type ProductSelectionAddProductAction ¶ 

type ProductSelectionAddProductAction struct {
	// ResourceIdentifier of the Product
	Product ProductResourceIdentifier `json:"product"`
	// Defines which Variants of the Product will be included in the Product Selection.
	// If not supplied all Variants are deemed to be included.
	VariantSelection ProductVariantSelection `json:"variantSelection,omitempty"`
}

* * Adds a Product to the Product Selection. * * If the specified Product is already assigned to the Product Selection, but the existing Product Selection has a different Product Variant Selection, a [ProductPresentWithDifferentVariantSelection](ctp:api:type:ProductPresentWithDifferentVariantSelectionError) error is returned. *

func (ProductSelectionAddProductAction) MarshalJSON ¶ 

func (obj ProductSelectionAddProductAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionAddProductAction) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ProductSelectionAddProductAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionAssignment ¶ 

type ProductSelectionAssignment struct {
	// Reference to a Product that is assigned to the ProductSelection.
	Product ProductReference `json:"product"`
	// Reference to the Product Selection that this assignment is part of.
	ProductSelection ProductSelectionReference `json:"productSelection"`
	// Define which Variants of the added Product will be included in the Product Selection.
	//
	// This field is only available for assignments to a Product Selection with `Individual` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
	// The list of SKUs will be updated automatically on any change of those performed on the respective Product itself.
	VariantSelection ProductVariantSelection `json:"variantSelection,omitempty"`
	// Defines which Variants of the Product will be excluded from the Product Selection.
	//
	// This field is only available for assignments to a Product Selection with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
	// The list of SKUs will be updated automatically on any change of those performed on the respective Product itself.
	VariantExclusion *ProductVariantExclusion `json:"variantExclusion,omitempty"`
}

* * * Given the mode of Product Selection, this assignment refers to, it may contain: * * - `variantSelection` field for a Product Selection with `Individual` ProductSelectionMode(ctp:api:type:ProductSelectionMode). * - `variantExclusion` field for a Product Selection with `IndividualExclusion` ProductSelectionMode(ctp:api:type:ProductSelectionMode).

func (*ProductSelectionAssignment) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ProductSelectionAssignment) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionChangeNameAction ¶ 

type ProductSelectionChangeNameAction struct {
	// The new name to be set for the ProductSelection.
	Name LocalizedString `json:"name"`
}

func (ProductSelectionChangeNameAction) MarshalJSON ¶ 

func (obj ProductSelectionChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionCreatedMessage ¶ 

type ProductSelectionCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Product Selection](ctp:api:type:ProductSelection) that was created.
	ProductSelection ProductSelection `json:"productSelection"`
}

* * Generated after a successful [Create Product Selection](ctp:api:endpoint:/{projectKey}/product-selections:POST) request. *

func (ProductSelectionCreatedMessage) MarshalJSON ¶ 

func (obj ProductSelectionCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionCreatedMessage) UnmarshalJSON ¶ 

func (obj *ProductSelectionCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionCreatedMessagePayload ¶ 

type ProductSelectionCreatedMessagePayload struct {
	// [Product Selection](ctp:api:type:ProductSelection) that was created.
	ProductSelection ProductSelection `json:"productSelection"`
}

* * Generated after a successful [Create Product Selection](ctp:api:endpoint:/{projectKey}/product-selections:POST) request. *

func (ProductSelectionCreatedMessagePayload) MarshalJSON ¶ 

func (obj ProductSelectionCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionDeletedMessage ¶ 

type ProductSelectionDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete Product Selection](/../api/projects/product-selections#delete-productselection) request. *

func (ProductSelectionDeletedMessage) MarshalJSON ¶ 

func (obj ProductSelectionDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionDeletedMessage) UnmarshalJSON ¶ 

func (obj *ProductSelectionDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionDeletedMessagePayload ¶ 

type ProductSelectionDeletedMessagePayload struct {
}

* * Generated after a successful [Delete Product Selection](/../api/projects/product-selections#delete-productselection) request. *

func (ProductSelectionDeletedMessagePayload) MarshalJSON ¶ 

func (obj ProductSelectionDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionDraft ¶ 

type ProductSelectionDraft struct {
	// User-defined unique identifier for the ProductSelection.
	Key *string `json:"key,omitempty"`
	// Name of the ProductSelection. Not checked for uniqueness, but distinct names are recommended.
	Name LocalizedString `json:"name"`
	// Custom Fields of this ProductSelection.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Type of the Product Selection.
	Type *ProductSelectionTypeEnum `json:"type,omitempty"`
	// Mode of the Product Selection.
	Mode *ProductSelectionMode `json:"mode,omitempty"`
}

type ProductSelectionExcludeProductAction ¶ added in v1.3.0 

type ProductSelectionExcludeProductAction struct {
	// ResourceIdentifier of the Product
	Product ProductResourceIdentifier `json:"product"`
	// Defines which Variants of the Product will be excluded from the Product Selection.
	// If not supplied all Variants are deemed to be excluded.
	VariantExclusion *ProductVariantExclusion `json:"variantExclusion,omitempty"`
}

* * Excludes a Product from a Product Selection with `IndividualExclusion` ProductSelectionMode(ctp:api:type:ProductSelectionMode). * * If the specified Product is already assigned to the Product Selection, but the existing Product Selection has a different Product Variant Exclusion, a [ProductPresentWithDifferentVariantSelection](ctp:api:type:ProductPresentWithDifferentVariantSelectionError) error is returned. *

func (ProductSelectionExcludeProductAction) MarshalJSON ¶ added in v1.3.0 

func (obj ProductSelectionExcludeProductAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionMode ¶ added in v1.3.0 

type ProductSelectionMode string

* * Product Selections can have the following modes: * 

const (
	ProductSelectionModeIndividual          ProductSelectionMode = "Individual"
	ProductSelectionModeIndividualExclusion ProductSelectionMode = "IndividualExclusion"
)

type ProductSelectionPagedQueryResponse ¶ 

type ProductSelectionPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/general-concepts#strong-consistency).
	// Unlike other endpoints, the Product Selection endpoint does not return this field by default.
	// To get `total`, pass the query parameter `withTotal` set to `true`.
	// When the results are filtered with a [Query Predicate](/predicates/query), `total` is subject to a [limit](/limits#queries).
	Total *int `json:"total,omitempty"`
	// [ProductSelections](ctp:api:type:ProductSelection) matching the query.
	Results []ProductSelection `json:"results"`
}

* * [PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of ProductSelection(ctp:api:type:ProductSelection). *

type ProductSelectionProductAddedMessage ¶ 

type ProductSelectionProductAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Product](ctp:api:type:Product) that was added to the [Product Selection](ctp:api:type:ProductSelection).
	Product ProductReference `json:"product"`
	// Product Variant Selection after the [Add Product](ctp:api:type:ProductSelectionAddProductAction) update action.
	VariantSelection ProductVariantSelection `json:"variantSelection"`
}

* * Generated after a successful [Add Product](ctp:api:type:ProductSelectionAddProductAction) update action. *

func (ProductSelectionProductAddedMessage) MarshalJSON ¶ 

func (obj ProductSelectionProductAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionProductAddedMessage) UnmarshalJSON ¶ 

func (obj *ProductSelectionProductAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionProductAddedMessagePayload ¶ 

type ProductSelectionProductAddedMessagePayload struct {
	// [Product](ctp:api:type:Product) that was added to the [Product Selection](ctp:api:type:ProductSelection).
	Product ProductReference `json:"product"`
	// Product Variant Selection after the [Add Product](ctp:api:type:ProductSelectionAddProductAction) update action.
	VariantSelection ProductVariantSelection `json:"variantSelection"`
}

* * Generated after a successful [Add Product](ctp:api:type:ProductSelectionAddProductAction) update action. *

func (ProductSelectionProductAddedMessagePayload) MarshalJSON ¶ 

func (obj ProductSelectionProductAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionProductAddedMessagePayload) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ProductSelectionProductAddedMessagePayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionProductExcludedMessage ¶ added in v1.3.0 

type ProductSelectionProductExcludedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Product](ctp:api:type:Product) that was excluded from the [Product Selection](ctp:api:type:ProductSelection).
	Product ProductReference `json:"product"`
	// Product Variant Exclusion after the [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action.
	VariantExclusion ProductVariantExclusion `json:"variantExclusion"`
}

* * Generated after a successful [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action. *

func (ProductSelectionProductExcludedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj ProductSelectionProductExcludedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionProductExcludedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *ProductSelectionProductExcludedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionProductExcludedMessagePayload ¶ added in v1.3.0 

type ProductSelectionProductExcludedMessagePayload struct {
	// [Product](ctp:api:type:Product) that was excluded from the [Product Selection](ctp:api:type:ProductSelection).
	Product ProductReference `json:"product"`
	// Product Variant Exclusion after the [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action.
	VariantExclusion ProductVariantExclusion `json:"variantExclusion"`
}

* * Generated after a successful [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action. *

func (ProductSelectionProductExcludedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj ProductSelectionProductExcludedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionProductPagedQueryResponse ¶ 

type ProductSelectionProductPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/general-concepts#strong-consistency).
	// Unlike other endpoints, the Product Selection endpoint does not return this field by default.
	// To get `total`, pass the query parameter `withTotal` set to `true`.
	// When the results are filtered with a [Query Predicate](/predicates/query), `total` is subject to a [limit](/limits#queries).
	Total *int `json:"total,omitempty"`
	// References to Products that are assigned to the ProductSelection.
	Results []AssignedProductReference `json:"results"`
}

* * [PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of AssignedProductReference(ctp:api:type:AssignedProductReference). *

type ProductSelectionProductRemovedMessage ¶ 

type ProductSelectionProductRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Product](ctp:api:type:Product) that was removed from the Product Selection.
	Product ProductReference `json:"product"`
}

* * Generated after a successful [Remove Product](ctp:api:type:ProductSelectionRemoveProductAction) update action. *

func (ProductSelectionProductRemovedMessage) MarshalJSON ¶ 

func (obj ProductSelectionProductRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionProductRemovedMessage) UnmarshalJSON ¶ 

func (obj *ProductSelectionProductRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionProductRemovedMessagePayload ¶ 

type ProductSelectionProductRemovedMessagePayload struct {
	// [Product](ctp:api:type:Product) that was removed from the Product Selection.
	Product ProductReference `json:"product"`
}

* * Generated after a successful [Remove Product](ctp:api:type:ProductSelectionRemoveProductAction) update action. *

func (ProductSelectionProductRemovedMessagePayload) MarshalJSON ¶ 

func (obj ProductSelectionProductRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionReference ¶ 

type ProductSelectionReference struct {
	// Unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection).
	ID string `json:"id"`
	// Contains the representation of the expanded ProductSelection. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for ProductSelections.
	Obj *ProductSelection `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a ProductSelection(ctp:api:type:ProductSelection). *

func (ProductSelectionReference) MarshalJSON ¶ 

func (obj ProductSelectionReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionRemoveProductAction ¶ 

type ProductSelectionRemoveProductAction struct {
	// ResourceIdentifier of the Product
	Product ProductResourceIdentifier `json:"product"`
}

func (ProductSelectionRemoveProductAction) MarshalJSON ¶ 

func (obj ProductSelectionRemoveProductAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionResourceIdentifier ¶ 

type ProductSelectionResourceIdentifier struct {
	// Unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a ProductSelection(ctp:api:type:ProductSelection). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (ProductSelectionResourceIdentifier) MarshalJSON ¶ 

func (obj ProductSelectionResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionSetCustomFieldAction ¶ 

type ProductSelectionSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (ProductSelectionSetCustomFieldAction) MarshalJSON ¶ 

func (obj ProductSelectionSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionSetCustomTypeAction ¶ 

type ProductSelectionSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the ProductSelection with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the ProductSelection.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ProductSelection.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ProductSelectionSetCustomTypeAction) MarshalJSON ¶ 

func (obj ProductSelectionSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionSetKeyAction ¶ 

type ProductSelectionSetKeyAction struct {
	// If `key` is absent or `null`, the existing key, if any, will be removed.
	Key *string `json:"key,omitempty"`
}

func (ProductSelectionSetKeyAction) MarshalJSON ¶ 

func (obj ProductSelectionSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionSetVariantExclusionAction ¶ added in v1.3.0 

type ProductSelectionSetVariantExclusionAction struct {
	// ResourceIdentifier of the Product
	Product ProductResourceIdentifier `json:"product"`
	// Determines which Variants of the previously excluded Product are to be included in the Product Selection with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
	// Leave it empty to unset an existing Variant Exclusion.
	VariantExclusion *ProductVariantExclusion `json:"variantExclusion,omitempty"`
}

* * Updates the Product Variant Exclusion of an existing [Product Selection Assignment](ctp:api:type:ProductSelectionAssignment). * A ProductVariantExclusion(ctp:api:type:ProductVariantExclusion) can only be set if the Product(ctp:api:type:Product) has already been excluded from the [Product Selection](ctp:api:type:ProductSelection) with `IndividualExclusion` ProductSelectionMode(ctp:api:type:ProductSelectionMode). * * If the specified Product is not assigned to the Product Selection, a [ProductAssignmentMissing](ctp:api:type:ProductAssignmentMissingError) error is returned. *

func (ProductSelectionSetVariantExclusionAction) MarshalJSON ¶ added in v1.3.0 

func (obj ProductSelectionSetVariantExclusionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionSetVariantSelectionAction ¶ added in v1.2.0 

type ProductSelectionSetVariantSelectionAction struct {
	// ResourceIdentifier of the Product
	Product ProductResourceIdentifier `json:"product"`
	// Determines which Variants of the previously added Product are to be included in, or excluded from, the Product Selection.
	// Leave it empty to unset an existing Variant Selection.
	VariantSelection ProductVariantSelection `json:"variantSelection,omitempty"`
}

* * Updates the Product Variant Selection of an existing [Product Selection Assignment](ctp:api:type:ProductSelectionAssignment). * A ProductVariantSelection(ctp:api:type:ProductVariantSelection) can only be set if the Product(ctp:api:type:Product) has already been included in the Product Selection with `Individual` ProductSelectionMode(ctp:api:type:ProductSelectionMode). * * If the specified Product is not assigned to the Product Selection, a [ProductAssignmentMissing](ctp:api:type:ProductAssignmentMissingError) error is returned. *

func (ProductSelectionSetVariantSelectionAction) MarshalJSON ¶ added in v1.2.0 

func (obj ProductSelectionSetVariantSelectionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionSetVariantSelectionAction) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ProductSelectionSetVariantSelectionAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionSetting ¶ 

type ProductSelectionSetting struct {
	// Reference to a ProductSelection.
	ProductSelection ProductSelectionReference `json:"productSelection"`
	// If `true`, all Products assigned to this Product Selection are part of the Store's assortment.
	Active bool `json:"active"`
}

type ProductSelectionSettingDraft ¶ 

type ProductSelectionSettingDraft struct {
	// Resource Identifier of a ProductSelection.
	ProductSelection ProductSelectionResourceIdentifier `json:"productSelection"`
	// Set to `true` if all Products assigned to the Product Selection should become part of the Store's assortment.
	Active *bool `json:"active,omitempty"`
}

type ProductSelectionType ¶ 

type ProductSelectionType interface{}

type ProductSelectionTypeEnum ¶ 

type ProductSelectionTypeEnum string

* * The following types of Product Selections are supported: * 

const (
	ProductSelectionTypeEnumIndividual          ProductSelectionTypeEnum = "individual"
	ProductSelectionTypeEnumIndividualExclusion ProductSelectionTypeEnum = "individualExclusion"
)

type ProductSelectionUpdate ¶ 

type ProductSelectionUpdate struct {
	Version int                            `json:"version"`
	Actions []ProductSelectionUpdateAction `json:"actions"`
}

func (*ProductSelectionUpdate) UnmarshalJSON ¶ 

func (obj *ProductSelectionUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionUpdateAction ¶ 

type ProductSelectionUpdateAction interface{}

type ProductSelectionVariantExclusionChangedMessage ¶ added in v1.3.0 

type ProductSelectionVariantExclusionChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Product](ctp:api:type:Product) for which the Product Variant Exclusion changed.
	Product ProductReference `json:"product"`
	// Product Variant Exclusion before the [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action.
	OldVariantExclusion ProductVariantExclusion `json:"oldVariantExclusion"`
	// Product Variant Exclusion after the [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action.
	NewVariantExclusion ProductVariantExclusion `json:"newVariantExclusion"`
}

* * Generated after a successful [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action. *

func (ProductSelectionVariantExclusionChangedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj ProductSelectionVariantExclusionChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionVariantExclusionChangedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *ProductSelectionVariantExclusionChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionVariantExclusionChangedMessagePayload ¶ added in v1.3.0 

type ProductSelectionVariantExclusionChangedMessagePayload struct {
	// [Product](ctp:api:type:Product) for which the Product Variant Exclusion changed.
	Product ProductReference `json:"product"`
	// Product Variant Exclusion before the [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action.
	OldVariantExclusion ProductVariantExclusion `json:"oldVariantExclusion"`
	// Product Variant Exclusion after the [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action.
	NewVariantExclusion ProductVariantExclusion `json:"newVariantExclusion"`
}

* * Generated after a successful [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action. *

func (ProductSelectionVariantExclusionChangedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj ProductSelectionVariantExclusionChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionVariantSelectionChangedMessage ¶ added in v1.2.0 

type ProductSelectionVariantSelectionChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Product](ctp:api:type:Product) for which the Product Variant Selection changed.
	Product ProductReference `json:"product"`
	// Product Variant Selection before the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action.
	OldVariantSelection ProductVariantSelection `json:"oldVariantSelection"`
	// Product Variant Selection after the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action.
	NewVariantSelection ProductVariantSelection `json:"newVariantSelection"`
}

* * Generated after a successful [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action. *

func (ProductSelectionVariantSelectionChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj ProductSelectionVariantSelectionChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionVariantSelectionChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ProductSelectionVariantSelectionChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSelectionVariantSelectionChangedMessagePayload ¶ added in v1.2.0 

type ProductSelectionVariantSelectionChangedMessagePayload struct {
	// [Product](ctp:api:type:Product) for which the Product Variant Selection changed.
	Product ProductReference `json:"product"`
	// Product Variant Selection before the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action.
	OldVariantSelection ProductVariantSelection `json:"oldVariantSelection"`
	// Product Variant Selection after the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action.
	NewVariantSelection ProductVariantSelection `json:"newVariantSelection"`
}

* * Generated after a successful [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action. *

func (ProductSelectionVariantSelectionChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj ProductSelectionVariantSelectionChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSelectionVariantSelectionChangedMessagePayload) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ProductSelectionVariantSelectionChangedMessagePayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSetAssetCustomFieldAction ¶ 

type ProductSetAssetCustomFieldAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged Asset is updated. If `false`, both the current and staged Asset is updated.
	Staged *bool `json:"staged,omitempty"`
	// The `id` of the Asset to update.
	AssetId *string `json:"assetId,omitempty"`
	// The `key` of the Asset to update.
	AssetKey *string `json:"assetKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

* * Either `variantId` or `sku` is required. The Asset(ctp:api:type:Asset) to update must be specified using either `assetId` or `assetKey`. *

func (ProductSetAssetCustomFieldAction) MarshalJSON ¶ 

func (obj ProductSetAssetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetAssetCustomTypeAction ¶ 

type ProductSetAssetCustomTypeAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged Asset is updated. If `false`, both the current and staged Asset is updated.
	Staged *bool `json:"staged,omitempty"`
	// The `id` of the Asset to update.
	AssetId *string `json:"assetId,omitempty"`
	// The `key` of the Asset to update.
	AssetKey *string `json:"assetKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Asset with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Asset.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Asset.
	Fields *FieldContainer `json:"fields,omitempty"`
}

* * Either `variantId` or `sku` is required. The Asset(ctp:api:type:Asset) to update must be specified using either `assetId` or `assetKey`. *

func (ProductSetAssetCustomTypeAction) MarshalJSON ¶ 

func (obj ProductSetAssetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetAssetDescriptionAction ¶ 

type ProductSetAssetDescriptionAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged Asset is updated. If `false`, both the current and staged Asset is updated.
	Staged *bool `json:"staged,omitempty"`
	// The `id` of the Asset to update.
	AssetId *string `json:"assetId,omitempty"`
	// The `key` of the Asset to update.
	AssetKey *string `json:"assetKey,omitempty"`
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

* * Either `variantId` or `sku` is required. The Asset(ctp:api:type:Asset) to update must be specified using either `assetId` or `assetKey`. *

func (ProductSetAssetDescriptionAction) MarshalJSON ¶ 

func (obj ProductSetAssetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetAssetKeyAction ¶ 

type ProductSetAssetKeyAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged Asset is updated. If `false`, both the current and staged Asset is updated.
	Staged *bool `json:"staged,omitempty"`
	// The `id` of the Asset to update.
	AssetId string `json:"assetId"`
	// Value to set. If empty, any existing value will be removed.
	AssetKey *string `json:"assetKey,omitempty"`
}

* * Either `variantId` or `sku` is required. *

func (ProductSetAssetKeyAction) MarshalJSON ¶ 

func (obj ProductSetAssetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetAssetSourcesAction ¶ 

type ProductSetAssetSourcesAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged Asset is updated. If `false` both the current and staged Asset is updated.
	Staged *bool `json:"staged,omitempty"`
	// The `id` of the Asset to update.
	AssetId *string `json:"assetId,omitempty"`
	// The `key` of the Asset to update.
	AssetKey *string `json:"assetKey,omitempty"`
	// Value to set.
	Sources []AssetSource `json:"sources"`
}

* * Either `variantId` or `sku` is required. The Asset(ctp:api:type:Asset) to update must be specified using either `assetId` or `assetKey`. *

func (ProductSetAssetSourcesAction) MarshalJSON ¶ 

func (obj ProductSetAssetSourcesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetAssetTagsAction ¶ 

type ProductSetAssetTagsAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged Asset is updated. If `false`, both the current and staged Asset is updated.
	Staged *bool `json:"staged,omitempty"`
	// The `id` of the Asset to update.
	AssetId *string `json:"assetId,omitempty"`
	// The `key` of the Asset to update.
	AssetKey *string `json:"assetKey,omitempty"`
	// Keywords for categorizing and organizing Assets.
	Tags []string `json:"tags"`
}

* * Either `variantId` or `sku` is required. The Asset to update must be specified using either `assetId` or `assetKey`. *

func (ProductSetAssetTagsAction) MarshalJSON ¶ 

func (obj ProductSetAssetTagsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetAttributeAction ¶ 

type ProductSetAttributeAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// The name of the Attribute to set.
	Name string `json:"name"`
	// Value to set for the Attribute. If empty, any existing value will be removed.
	//
	// The [AttributeType](ctp:api:type:AttributeType) determines the format of the Attribute `value` to be provided:
	//
	// - For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType),
	//   use the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects,
	//   or the complete objects as `value`.
	// - For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), use the [LocalizedString](ctp:api:type:LocalizedString) object as `value`.
	// - For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, use the [Money](ctp:api:type:Money) object as `value`.
	// - For [Set Type](ctp:api:type:AttributeSetType) Attributes, use the entire `set` object  as `value`.
	// - For [Nested Type](ctp:api:type:AttributeNestedType) Attributes, use the list of values of all Attributes of the nested Product as `value`.
	// - For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, use the [Reference](ctp:api:type:Reference) object as `value`.
	Value interface{} `json:"value,omitempty"`
	// If `true`, only the staged Attribute is set. If `false`, both current and staged Attribute is set.
	Staged *bool `json:"staged,omitempty"`
}

* * Either `variantId` or `sku` is required. *

func (ProductSetAttributeAction) MarshalJSON ¶ 

func (obj ProductSetAttributeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetAttributeInAllVariantsAction ¶ 

type ProductSetAttributeInAllVariantsAction struct {
	// The name of the Attribute to set.
	Name string `json:"name"`
	// Value to set for the Attributes. If empty, any existing value will be removed.
	//
	// The [AttributeType](ctp:api:type:AttributeType) determines the format of the Attribute `value` to be provided:
	//
	// - For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType),
	//   use the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects,
	//   or the complete objects as `value`.
	// - For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), use the [LocalizedString](ctp:api:type:LocalizedString) object as `value`.
	// - For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, use the [Money](ctp:api:type:Money) object as `value`.
	// - For [Set Type](ctp:api:type:AttributeSetType) Attributes, use the entire `set` object  as `value`.
	// - For [Nested Type](ctp:api:type:AttributeNestedType) Attributes, use the list of values of all Attributes of the nested Product as `value`.
	// - For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, use the [Reference](ctp:api:type:Reference) object as `value`.
	Value interface{} `json:"value,omitempty"`
	// If `true`, only the staged Attributes are set. If `false`, both the current and staged Attributes are set.
	Staged *bool `json:"staged,omitempty"`
}

* * Adds, removes, or changes a Product Attribute in all Product Variants at the same time. * This action is useful for setting values for Attributes with the [Constraint](ctp:api:type:AttributeConstraintEnum) `SameForAll`.

func (ProductSetAttributeInAllVariantsAction) MarshalJSON ¶ 

func (obj ProductSetAttributeInAllVariantsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetCategoryOrderHintAction ¶ 

type ProductSetCategoryOrderHintAction struct {
	// The `id` of the Category to add the `orderHint`.
	CategoryId string `json:"categoryId"`
	// A string representing a number between 0 and 1. Must start with `0.` and cannot end with `0`. If empty, any existing value will be removed.
	OrderHint *string `json:"orderHint,omitempty"`
	// If `true`, only the staged `categoryOrderHints` is updated. If `false`, both the current and staged `categoryOrderHints` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductSetCategoryOrderHintAction) MarshalJSON ¶ 

func (obj ProductSetCategoryOrderHintAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetDescriptionAction ¶ 

type ProductSetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
	// If `true`, only the staged `description` is updated. If `false`, both the current and staged `description` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductSetDescriptionAction) MarshalJSON ¶ 

func (obj ProductSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetDiscountedPriceAction ¶ 

type ProductSetDiscountedPriceAction struct {
	// The `id` of the [Price](ctp:api:type:Price) to set the Discount.
	PriceId string `json:"priceId"`
	// If `true`, only the staged Embedded Price is updated. If `false`, both the current and staged Embedded Price are updated.
	Staged *bool `json:"staged,omitempty"`
	// Value to set. If empty, any existing value will be removed.
	// The referenced [ProductDiscount](ctp:api:type:ProductDiscount) must have the Type `external`, be active, and its predicate must match the referenced Price.
	Discounted *DiscountedPriceDraft `json:"discounted,omitempty"`
}

* * Produces the [ProductPriceExternalDiscountSet](ctp:api:type:ProductPriceExternalDiscountSetMessage) Message. *

func (ProductSetDiscountedPriceAction) MarshalJSON ¶ 

func (obj ProductSetDiscountedPriceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetImageLabelAction ¶ 

type ProductSetImageLabelAction struct {
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The URL of the image to set the label.
	ImageUrl string `json:"imageUrl"`
	// Value to set. If empty, any existing value will be removed.
	Label *string `json:"label,omitempty"`
	// If `true`, only the staged image is updated. If `false`, both the current and staged image is updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Either `variantId` or `sku` is required. *

func (ProductSetImageLabelAction) MarshalJSON ¶ 

func (obj ProductSetImageLabelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetKeyAction ¶ 

type ProductSetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (ProductSetKeyAction) MarshalJSON ¶ 

func (obj ProductSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetMetaDescriptionAction ¶ 

type ProductSetMetaDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// If `true`, only the staged `metaDescription` is updated. If `false`, both the current and staged `metaDescription` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductSetMetaDescriptionAction) MarshalJSON ¶ 

func (obj ProductSetMetaDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetMetaKeywordsAction ¶ 

type ProductSetMetaKeywordsAction struct {
	// Value to set. If empty, any existing value will be removed.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// If `true`, only the staged `metaKeywords` is updated. If `false`, both the current and staged `metaKeywords` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductSetMetaKeywordsAction) MarshalJSON ¶ 

func (obj ProductSetMetaKeywordsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetMetaTitleAction ¶ 

type ProductSetMetaTitleAction struct {
	// Value to set. If empty, any existing value will be removed.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// If `true`, only the staged `metaTitle` is updated. If `false`, both the current and staged `metaTitle` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductSetMetaTitleAction) MarshalJSON ¶ 

func (obj ProductSetMetaTitleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetPriceKeyAction ¶ added in v1.3.0 

type ProductSetPriceKeyAction struct {
	// The `id` of the [Price](ctp:api:type:Price) to set the key.
	PriceId string `json:"priceId"`
	// If `true`, only the staged [Embedded Price](/projects/products#embedded-price) is updated. If `false`, both the current and staged Embedded Price are updated.
	Staged *bool `json:"staged,omitempty"`
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

* * Sets the key of an [Embedded Price](/projects/products#embedded-price). Produces the [ProductPriceKeySet](ctp:api:type:ProductPriceKeySetMessage) Message. *

func (ProductSetPriceKeyAction) MarshalJSON ¶ added in v1.3.0 

func (obj ProductSetPriceKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetPriceModeAction ¶ 

type ProductSetPriceModeAction struct {
	// Specifies which type of Prices should be used when looking up a price for the Product.
	PriceMode *ProductPriceModeEnum `json:"priceMode,omitempty"`
}

* * Controls whether the Prices of a Product Variant are embedded into the Product or standalone. *

func (ProductSetPriceModeAction) MarshalJSON ¶ 

func (obj ProductSetPriceModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetPricesAction ¶ 

type ProductSetPricesAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// The Embedded Prices to set.
	// Each Price must have its unique Price scope (with same currency, country, Customer Group, Channel, `validFrom` and `validUntil`).
	Prices []PriceDraft `json:"prices"`
	// If `true`, only the staged ProductVariant is updated. If `false`, both the current and staged ProductVariant are updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Either `variantId` or `sku` is required. *

func (ProductSetPricesAction) MarshalJSON ¶ 

func (obj ProductSetPricesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetProductPriceCustomFieldAction ¶ 

type ProductSetProductPriceCustomFieldAction struct {
	// The `id` of the Embedded Price to update.
	PriceId string `json:"priceId"`
	// If `true`, only the staged Embedded Price Custom Field is updated. If `false`, both the current and staged Embedded Price Custom Field are updated.
	Staged *bool `json:"staged,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (ProductSetProductPriceCustomFieldAction) MarshalJSON ¶ 

func (obj ProductSetProductPriceCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetProductPriceCustomTypeAction ¶ 

type ProductSetProductPriceCustomTypeAction struct {
	// The `id` of the Embedded Price to update.
	PriceId string `json:"priceId"`
	// If `true`, only the staged Embedded Price is updated. If `false`, both the current and staged Embedded Price is updated.
	Staged *bool `json:"staged,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Price with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Embedded Price.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Embedded Price.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ProductSetProductPriceCustomTypeAction) MarshalJSON ¶ 

func (obj ProductSetProductPriceCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetProductVariantKeyAction ¶ 

type ProductSetProductVariantKeyAction struct {
	// The `id` of the ProductVariant to update.
	VariantId *int `json:"variantId,omitempty"`
	// The `sku` of the ProductVariant to update.
	Sku *string `json:"sku,omitempty"`
	// Value to set. Must be unique. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
	// If `true`, only the staged `key` is set. If `false`, both the current and staged `key` are set.
	Staged *bool `json:"staged,omitempty"`
}

* * Either `variantId` or `sku` is required. *

func (ProductSetProductVariantKeyAction) MarshalJSON ¶ 

func (obj ProductSetProductVariantKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetSearchKeywordsAction ¶ 

type ProductSetSearchKeywordsAction struct {
	// Value to set.
	SearchKeywords SearchKeywords `json:"searchKeywords"`
	// If `true`, only the staged `searchKeywords` is updated. If `false`, both the current and staged `searchKeywords` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductSetSearchKeywordsAction) MarshalJSON ¶ 

func (obj ProductSetSearchKeywordsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetSkuAction ¶ 

type ProductSetSkuAction struct {
	// The `id` of the ProductVariant to update.
	VariantId int `json:"variantId"`
	// Value to set. Must be unique. If empty, any existing value will be removed.
	Sku *string `json:"sku,omitempty"`
	// If `true`, only the staged `sku` is updated. If `false`, both the current and staged `sku` are updated.
	Staged *bool `json:"staged,omitempty"`
}

* * SKU cannot be changed or removed if it is associated with an InventoryEntry(ctp:api:type:InventoryEntry). * If the SKU to set or unset is part of a ProductSelectionAssignment(ctp:api:type:ProductSelectionAssignment) * it will be automatically added or removed from the respective ProductVariantSelection(ctp:api:type:ProductVariantSelection). *

func (ProductSetSkuAction) MarshalJSON ¶ 

func (obj ProductSetSkuAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSetTaxCategoryAction ¶ 

type ProductSetTaxCategoryAction struct {
	// The Tax Category to set. If empty, any existing value will be removed.
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
}

* * Cannot be staged. Published Products are immediately updated. *

func (ProductSetTaxCategoryAction) MarshalJSON ¶ 

func (obj ProductSetTaxCategoryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSlugChangedMessage ¶ 

type ProductSlugChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The slug of the [Product](ctp:api:type:Product) after the [Change Slug](ctp:api:type:ProductChangeSlugAction) update action.
	Slug LocalizedString `json:"slug"`
	// The slug of the [Product](ctp:api:type:Product) before the [Change Slug](ctp:api:type:ProductChangeSlugAction) update action.
	OldSlug *LocalizedString `json:"oldSlug,omitempty"`
}

* * Generated after a successful [Change Slug](ctp:api:type:ProductChangeSlugAction) update action. *

func (ProductSlugChangedMessage) MarshalJSON ¶ 

func (obj ProductSlugChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductSlugChangedMessage) UnmarshalJSON ¶ 

func (obj *ProductSlugChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductSlugChangedMessagePayload ¶ 

type ProductSlugChangedMessagePayload struct {
	// The slug of the [Product](ctp:api:type:Product) after the [Change Slug](ctp:api:type:ProductChangeSlugAction) update action.
	Slug LocalizedString `json:"slug"`
	// The slug of the [Product](ctp:api:type:Product) before the [Change Slug](ctp:api:type:ProductChangeSlugAction) update action.
	OldSlug *LocalizedString `json:"oldSlug,omitempty"`
}

* * Generated after a successful [Change Slug](ctp:api:type:ProductChangeSlugAction) update action. *

func (ProductSlugChangedMessagePayload) MarshalJSON ¶ 

func (obj ProductSlugChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductStateTransitionMessage ¶ 

type ProductStateTransitionMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Product [State](ctp:api:type:State) after the [Transition State](ctp:api:type:ProductTransitionStateAction) update action.
	State StateReference `json:"state"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:ProductTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:ProductTransitionStateAction) update action. *

func (ProductStateTransitionMessage) MarshalJSON ¶ 

func (obj ProductStateTransitionMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductStateTransitionMessage) UnmarshalJSON ¶ 

func (obj *ProductStateTransitionMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductStateTransitionMessagePayload ¶ 

type ProductStateTransitionMessagePayload struct {
	// Product [State](ctp:api:type:State) after the [Transition State](ctp:api:type:ProductTransitionStateAction) update action.
	State StateReference `json:"state"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:ProductTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:ProductTransitionStateAction) update action. *

func (ProductStateTransitionMessagePayload) MarshalJSON ¶ 

func (obj ProductStateTransitionMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoring ¶ added in v1.5.1 

type ProductTailoring struct {
	// Unique identifier of the ProductTailoring.
	ID string `json:"id"`
	// Current version of the ProductTailoring.
	Version int `json:"version"`
	// Date and time (UTC) the ProductTailoring was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the ProductTailoring was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the ProductTailoring.
	Key *string `json:"key,omitempty"`
	// The Store to which the ProductTailoring belongs.
	Store StoreKeyReference `json:"store"`
	// Reference to the Product the ProductTailoring belongs to.
	Product ProductReference `json:"product"`
	// `true` if the ProductTailoring is published.
	Published bool `json:"published"`
	// Current (published) data of the ProductTailoring.
	Current ProductTailoringData `json:"current"`
	// Staged (unpublished) data of the ProductTailoring.
	Staged ProductTailoringData `json:"staged"`
	// `true` if the `staged` data is different from the `current` data.
	HasStagedChanges bool `json:"hasStagedChanges"`
}

* * A single ProductTailoring representation contains the _current_ and the _staged_ representation of its product data tailored per Store. *

type ProductTailoringCreatedMessage ¶ added in v1.5.1 

type ProductTailoringCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// User-defined unique identifier of the Product Tailoring.
	Key *string `json:"key,omitempty"`
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
	// The description of the [Product Tailoring](ctp:api:type:ProductTailoring) at the time of creation.
	Description *LocalizedString `json:"description,omitempty"`
	// The name of the [Product Tailoring](ctp:api:type:ProductTailoring) at the time of creation.
	Name *LocalizedString `json:"name,omitempty"`
	// The slug of the [Product Tailoring](ctp:api:type:ProductTailoring) at the time of creation.
	Slug *LocalizedString `json:"slug,omitempty"`
	// `true` if the ProductTailoring is published.
	Published bool `json:"published"`
}

* * Generated after a successful [Create Product Tailoring](/../api/projects/product-tailoring#create-producttailoring) or * [Create Product Tailoring in Store](/../api/projects/product-tailoring#create-producttailoring-in-store) request. *

func (ProductTailoringCreatedMessage) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductTailoringCreatedMessage) UnmarshalJSON ¶ added in v1.5.1 

func (obj *ProductTailoringCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductTailoringCreatedMessagePayload ¶ added in v1.5.1 

type ProductTailoringCreatedMessagePayload struct {
	// User-defined unique identifier of the Product Tailoring.
	Key *string `json:"key,omitempty"`
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
	// The description of the [Product Tailoring](ctp:api:type:ProductTailoring) at the time of creation.
	Description *LocalizedString `json:"description,omitempty"`
	// The name of the [Product Tailoring](ctp:api:type:ProductTailoring) at the time of creation.
	Name *LocalizedString `json:"name,omitempty"`
	// The slug of the [Product Tailoring](ctp:api:type:ProductTailoring) at the time of creation.
	Slug *LocalizedString `json:"slug,omitempty"`
	// `true` if the ProductTailoring is published.
	Published bool `json:"published"`
}

* * Generated after a successful [Create Product Tailoring](/../api/projects/product-tailoring#create-producttailoring) or * [Create Product Tailoring in Store](/../api/projects/product-tailoring#create-producttailoring-in-store) request. *

func (ProductTailoringCreatedMessagePayload) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringData ¶ added in v1.5.1 

type ProductTailoringData struct {
	// Tailored name of the Product.
	Name *LocalizedString `json:"name,omitempty"`
	// Tailored description of the Product.
	Description *LocalizedString `json:"description,omitempty"`
	// Tailored title of the Product used by external search engines for improved search engine performance.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// Tailored description of the Product used by external search engines for improved search engine performance.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// Tailored keywords related to the Product used by external search engines for improved search engine performance.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// User-defined identifier used in a deep-link URL for the ProductTailoring.
	// Matches the pattern `[a-zA-Z0-9_\\-]{2,256}`.
	Slug *LocalizedString `json:"slug,omitempty"`
}

* * Contains all the tailored data of a Product. *

type ProductTailoringDeletedMessage ¶ added in v1.5.1 

type ProductTailoringDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
}

* * Generated after a successful [Delete Product Tailoring](/../api/projects/product-tailoring#delete-producttailoring) or * [Delete ProductTailoring assigned to Product in Store](/../api/projects/product-tailoring#delete-producttailoring-assigned-to-product-in-store) request. *

func (ProductTailoringDeletedMessage) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductTailoringDeletedMessage) UnmarshalJSON ¶ added in v1.5.1 

func (obj *ProductTailoringDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductTailoringDeletedMessagePayload ¶ added in v1.5.1 

type ProductTailoringDeletedMessagePayload struct {
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
}

* * Generated after a successful [Delete Product Tailoring](/../api/projects/product-tailoring#delete-producttailoring) or * [Delete ProductTailoring assigned to Product in Store](/../api/projects/product-tailoring#delete-producttailoring-assigned-to-product-in-store) request. *

func (ProductTailoringDeletedMessagePayload) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringDescriptionSetMessage ¶ added in v1.5.1 

type ProductTailoringDescriptionSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
	// The description of the [Product Tailoring](ctp:api:type:ProductTailoring) after the [Set Description](ctp:api:type:ProductTailoringSetDescriptionAction) update action.
	Description *LocalizedString `json:"description,omitempty"`
	// The description of the [ProductTailoring](ctp:api:type:ProductTailoring) before the [Set Description](ctp:api:type:ProductTailoringSetDescriptionAction) update action.
	OldDescription *LocalizedString `json:"oldDescription,omitempty"`
}

* * Generated after a successful Product Tailoring [Set Description](ctp:api:type:ProductTailoringSetDescriptionAction) update action. *

func (ProductTailoringDescriptionSetMessage) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringDescriptionSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductTailoringDescriptionSetMessage) UnmarshalJSON ¶ added in v1.5.1 

func (obj *ProductTailoringDescriptionSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductTailoringDescriptionSetMessagePayload ¶ added in v1.5.1 

type ProductTailoringDescriptionSetMessagePayload struct {
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
	// The description of the [Product Tailoring](ctp:api:type:ProductTailoring) after the [Set Description](ctp:api:type:ProductTailoringSetDescriptionAction) update action.
	Description *LocalizedString `json:"description,omitempty"`
	// The description of the [ProductTailoring](ctp:api:type:ProductTailoring) before the [Set Description](ctp:api:type:ProductTailoringSetDescriptionAction) update action.
	OldDescription *LocalizedString `json:"oldDescription,omitempty"`
}

* * Generated after a successful Product Tailoring [Set Description](ctp:api:type:ProductTailoringSetDescriptionAction) update action. *

func (ProductTailoringDescriptionSetMessagePayload) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringDescriptionSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringDraft ¶ added in v1.5.1 

type ProductTailoringDraft struct {
	// User-defined unique identifier of the ProductTailoring.
	Key *string `json:"key,omitempty"`
	// The Store to which the ProductTailoring belongs.
	Store StoreResourceIdentifier `json:"store"`
	// ResourceIdentifier of the Product the ProductTailoring belongs to.
	Product ProductResourceIdentifier `json:"product"`
	// Tailored name of the Product.
	Name *LocalizedString `json:"name,omitempty"`
	// Tailored description of the Product.
	Description *LocalizedString `json:"description,omitempty"`
	// Tailored title of the Product used by external search engines for improved search engine performance.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// Tailored description of the Product used by external search engines for improved search engine performance.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// Tailored keywords related to the Product used by external search engines for improved search engine performance.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// User-defined identifier used in a deep-link URL for the ProductTailoring.
	// Matches the pattern `[a-zA-Z0-9_\\-]{2,256}`.
	Slug *LocalizedString `json:"slug,omitempty"`
	// If `true`, the ProductTailoring is published immediately.
	Publish *bool `json:"publish,omitempty"`
}

* * Contains all the tailored data of a Product. *

type ProductTailoringInStoreDraft ¶ added in v1.5.1 

type ProductTailoringInStoreDraft struct {
	// User-defined unique identifier of the ProductTailoring.
	Key *string `json:"key,omitempty"`
	// ResourceIdentifier of the Product the ProductTailoring belongs to.
	Product ProductResourceIdentifier `json:"product"`
	// Tailored name of the Product.
	Name *LocalizedString `json:"name,omitempty"`
	// Tailored description of the Product.
	Description *LocalizedString `json:"description,omitempty"`
	// Tailored title of the Product used by external search engines for improved search engine performance.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// Tailored description of the Product used by external search engines for improved search engine performance.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// Tailored keywords related to the Product used by external search engines for improved search engine performance.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// User-defined identifier used in a deep-link URL for the ProductTailoring.
	// Matches the pattern `[a-zA-Z0-9_\\-]{2,256}`.
	Slug *LocalizedString `json:"slug,omitempty"`
	// If `true`, the ProductTailoring is published immediately.
	Publish *bool `json:"publish,omitempty"`
}

* * Contains all the tailored data of a Product for a specific Store. *

type ProductTailoringNameSetMessage ¶ added in v1.5.1 

type ProductTailoringNameSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
	// The name of the [Product Tailoring](ctp:api:type:ProductTailoring) after the [Set Name](ctp:api:type:ProductTailoringSetNameAction) update action.
	Name *LocalizedString `json:"name,omitempty"`
	// The name of the [ProductTailoring](ctp:api:type:ProductTailoring) before the [Set Name](ctp:api:type:ProductTailoringSetNameAction) update action.
	OldName *LocalizedString `json:"oldName,omitempty"`
}

* * Generated after a successful Product Tailoring [Set Name](ctp:api:type:ProductTailoringSetNameAction) update action. *

func (ProductTailoringNameSetMessage) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringNameSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductTailoringNameSetMessage) UnmarshalJSON ¶ added in v1.5.1 

func (obj *ProductTailoringNameSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductTailoringNameSetMessagePayload ¶ added in v1.5.1 

type ProductTailoringNameSetMessagePayload struct {
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
	// The name of the [Product Tailoring](ctp:api:type:ProductTailoring) after the [Set Name](ctp:api:type:ProductTailoringSetNameAction) update action.
	Name *LocalizedString `json:"name,omitempty"`
	// The name of the [ProductTailoring](ctp:api:type:ProductTailoring) before the [Set Name](ctp:api:type:ProductTailoringSetNameAction) update action.
	OldName *LocalizedString `json:"oldName,omitempty"`
}

* * Generated after a successful Product Tailoring [Set Name](ctp:api:type:ProductTailoringSetNameAction) update action. *

func (ProductTailoringNameSetMessagePayload) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringNameSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringPagedQueryResponse ¶ added in v1.5.1 

type ProductTailoringPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [ProductTailoring](ctp:api:type:ProductTailoring) list matching the query.
	Results []ProductTailoring `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of ProductTailoring(ctp:api:type:ProductTailoring). *

type ProductTailoringPublishAction ¶ added in v1.5.1 

type ProductTailoringPublishAction struct {
}

* * Publishes the `staged` data of the ProductTailoring to `current`. Sets `hasStagedChanges` to `false`. * Generates the [ProductTailoringPublished](ctp:api:type:ProductTailoringPublishedMessage) Message. *

func (ProductTailoringPublishAction) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringPublishAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringPublishedMessage ¶ added in v1.5.1 

type ProductTailoringPublishedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
}

* * Generated after a successful [Product Tailoring Publish](ctp:api:type:ProductTailoringPublishAction) update action. *

func (ProductTailoringPublishedMessage) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringPublishedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductTailoringPublishedMessage) UnmarshalJSON ¶ added in v1.5.1 

func (obj *ProductTailoringPublishedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductTailoringPublishedMessagePayload ¶ added in v1.5.1 

type ProductTailoringPublishedMessagePayload struct {
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
}

* * Generated after a successful [Product Tailoring Publish](ctp:api:type:ProductTailoringPublishAction) update action. *

func (ProductTailoringPublishedMessagePayload) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringPublishedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringReference ¶ added in v1.5.1 

type ProductTailoringReference struct {
	// Unique identifier of the referenced [ProductTailoring](ctp:api:type:ProductTailoring).
	ID string `json:"id"`
	// Contains the representation of the expanded ProductTailoring. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for ProductTailoring.
	Obj *ProductTailoring `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a ProductTailoring(ctp:api:type:ProductTailoring). *

func (ProductTailoringReference) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringResourceIdentifier ¶ added in v1.5.1 

type ProductTailoringResourceIdentifier struct {
	// Unique identifier of the referenced [ProductTailoring](ctp:api:type:ProductTailoring). Either `id` or `key` is required.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [ProductTailoring](ctp:api:type:ProductTailoring). Either `id` or `key` is required.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a ProductTailoring(ctp:api:type:ProductTailoring). *

func (ProductTailoringResourceIdentifier) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringSetDescriptionAction ¶ added in v1.5.1 

type ProductTailoringSetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
	// If `true`, only the staged `description` is updated. If `false`, both the current and staged `description` are updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Generates the [ProductTailoringDescriptionSet](ctp:api:type:ProductTailoringDescriptionSetMessage) Message. *

func (ProductTailoringSetDescriptionAction) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringSetMetaAttributesAction ¶ added in v1.5.1 

type ProductTailoringSetMetaAttributesAction struct {
	// Value to set. If empty, any existing value will be removed.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// Value to set. If empty, any existing value will be removed.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// Value to set. If empty, any existing value will be removed.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// If `true`, only the staged attributes are updated. If `false`, both the current and staged attributes are updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Updates all meta attributes at the same time.

func (ProductTailoringSetMetaAttributesAction) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringSetMetaAttributesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringSetMetaDescriptionAction ¶ added in v1.5.1 

type ProductTailoringSetMetaDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	MetaDescription *LocalizedString `json:"metaDescription,omitempty"`
	// If `true`, only the staged `metaDescription` is updated. If `false`, both the current and staged `metaDescription` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductTailoringSetMetaDescriptionAction) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringSetMetaDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringSetMetaKeywordsAction ¶ added in v1.5.1 

type ProductTailoringSetMetaKeywordsAction struct {
	// Value to set. If empty, any existing value will be removed.
	MetaKeywords *LocalizedString `json:"metaKeywords,omitempty"`
	// If `true`, only the staged `metaKeywords` is updated. If `false`, both the current and staged `metaKeywords` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductTailoringSetMetaKeywordsAction) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringSetMetaKeywordsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringSetMetaTitleAction ¶ added in v1.5.1 

type ProductTailoringSetMetaTitleAction struct {
	// Value to set. If empty, any existing value will be removed.
	MetaTitle *LocalizedString `json:"metaTitle,omitempty"`
	// If `true`, only the staged `metaTitle` is updated. If `false`, both the current and staged `metaTitle` are updated.
	Staged *bool `json:"staged,omitempty"`
}

func (ProductTailoringSetMetaTitleAction) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringSetMetaTitleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringSetNameAction ¶ added in v1.5.1 

type ProductTailoringSetNameAction struct {
	// Value to set. If empty, any existing value will be removed.
	Name *LocalizedString `json:"name,omitempty"`
	// If `true`, only the staged `name` is updated. If `false`, both the current and staged `name` are updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Generates the [ProductTailoringNameSet](ctp:api:type:ProductTailoringNameSetMessage) Message. *

func (ProductTailoringSetNameAction) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringSetNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringSetSlugAction ¶ added in v1.5.1 

type ProductTailoringSetSlugAction struct {
	// Value to set. If empty, any existing value will be removed.
	Slug *LocalizedString `json:"slug,omitempty"`
	// If `true`, only the staged `slug` is updated. If `false`, both the current and staged `slug` are updated.
	Staged *bool `json:"staged,omitempty"`
}

* * Generates the [ProductTailoringSlugSet](ctp:api:type:ProductTailoringSlugSetMessage) Message. *

func (ProductTailoringSetSlugAction) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringSetSlugAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringSlugSetMessage ¶ added in v1.5.1 

type ProductTailoringSlugSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
	// The slug of the [Product Tailoring](ctp:api:type:ProductTailoring) after the [Set Slug](ctp:api:type:ProductTailoringSetSlugAction) update action.
	Slug *LocalizedString `json:"slug,omitempty"`
	// The slug of the [ProductTailoring](ctp:api:type:ProductTailoring) before the [Set Slug](ctp:api:type:ProductTailoringSetSlugAction) update action.
	OldSlug *LocalizedString `json:"oldSlug,omitempty"`
}

* * Generated after a successful Product Tailoring [Set Slug](ctp:api:type:ProductTailoringSetSlugAction) update action. *

func (ProductTailoringSlugSetMessage) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringSlugSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductTailoringSlugSetMessage) UnmarshalJSON ¶ added in v1.5.1 

func (obj *ProductTailoringSlugSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductTailoringSlugSetMessagePayload ¶ added in v1.5.1 

type ProductTailoringSlugSetMessagePayload struct {
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
	// The slug of the [Product Tailoring](ctp:api:type:ProductTailoring) after the [Set Slug](ctp:api:type:ProductTailoringSetSlugAction) update action.
	Slug *LocalizedString `json:"slug,omitempty"`
	// The slug of the [ProductTailoring](ctp:api:type:ProductTailoring) before the [Set Slug](ctp:api:type:ProductTailoringSetSlugAction) update action.
	OldSlug *LocalizedString `json:"oldSlug,omitempty"`
}

* * Generated after a successful Product Tailoring [Set Slug](ctp:api:type:ProductTailoringSetSlugAction) update action. *

func (ProductTailoringSlugSetMessagePayload) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringSlugSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringUnpublishAction ¶ added in v1.5.1 

type ProductTailoringUnpublishAction struct {
}

* * Unpublishes the `current` data of the ProductTailoring. Sets the `published` field to `false`. * Generates the [ProductTailoringUnpublished](ctp:api:type:ProductTailoringUnpublishedMessage) Message. *

func (ProductTailoringUnpublishAction) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringUnpublishAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringUnpublishedMessage ¶ added in v1.5.1 

type ProductTailoringUnpublishedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
}

* * Generated after a successful [Product Tailoring Unpublish](ctp:api:type:ProductTailoringUnpublishAction) update action. *

func (ProductTailoringUnpublishedMessage) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringUnpublishedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductTailoringUnpublishedMessage) UnmarshalJSON ¶ added in v1.5.1 

func (obj *ProductTailoringUnpublishedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductTailoringUnpublishedMessagePayload ¶ added in v1.5.1 

type ProductTailoringUnpublishedMessagePayload struct {
	// The Store to which the Product Tailoring belongs.
	Store StoreKeyReference `json:"store"`
	// User-defined unique identifier of the Product this Product Tailoring belongs to.
	ProductKey *string `json:"productKey,omitempty"`
	// Reference to the Product the Product Tailoring belongs to.
	Product ProductReference `json:"product"`
}

* * Generated after a successful [Product Tailoring Unpublish](ctp:api:type:ProductTailoringUnpublishAction) update action. *

func (ProductTailoringUnpublishedMessagePayload) MarshalJSON ¶ added in v1.5.1 

func (obj ProductTailoringUnpublishedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTailoringUpdate ¶ added in v1.5.1 

type ProductTailoringUpdate struct {
	// Expected version of the ProductTailoring on which the changes apply.
	// If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) is returned.
	Version int `json:"version"`
	// Update actions to be performed on the ProductTailoring.
	Actions []ProductTailoringUpdateAction `json:"actions"`
}

func (*ProductTailoringUpdate) UnmarshalJSON ¶ added in v1.5.1 

func (obj *ProductTailoringUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductTailoringUpdateAction ¶ added in v1.5.1 

type ProductTailoringUpdateAction interface{}

type ProductTransitionStateAction ¶ 

type ProductTransitionStateAction struct {
	// The State to transition to. If there is no existing State, this must be an initial State.
	State *StateResourceIdentifier `json:"state,omitempty"`
	// If `true`, validations are disabled.
	Force *bool `json:"force,omitempty"`
}

* * If the existing State(ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State. If `transitions` is not set, no validation is performed. Produces the [ProductStateTransition](ctp:api:type:ProductStateTransitionMessage) Message. *

func (ProductTransitionStateAction) MarshalJSON ¶ 

func (obj ProductTransitionStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductType ¶ 

type ProductType struct {
	// Unique identifier of the ProductType.
	ID string `json:"id"`
	// Current version of the ProductType.
	Version int `json:"version"`
	// Date and time (UTC) the ProductType was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the ProductType was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the ProductType.
	Key *string `json:"key,omitempty"`
	// Name of the ProductType.
	Name string `json:"name"`
	// Description of the ProductType.
	Description string `json:"description"`
	// Attributes specified for the ProductType.
	Attributes []AttributeDefinition `json:"attributes"`
}

func (ProductType) MarshalJSON ¶ 

func (obj ProductType) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeAddAttributeDefinitionAction ¶ 

type ProductTypeAddAttributeDefinitionAction struct {
	// Value to append to `attributes`.
	Attribute AttributeDefinitionDraft `json:"attribute"`
}

func (ProductTypeAddAttributeDefinitionAction) MarshalJSON ¶ 

func (obj ProductTypeAddAttributeDefinitionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeAddLocalizedEnumValueAction ¶ 

type ProductTypeAddLocalizedEnumValueAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// Value to append to the array.
	Value AttributeLocalizedEnumValue `json:"value"`
}

* * Adds a localizable enum to the values of AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType). It can update an AttributeLocalizedEnumType AttributeDefinition or an AttributeSetType(ctp:api:type:AttributeSetType) of AttributeLocalizedEnumType AttributeDefinition. *

func (ProductTypeAddLocalizedEnumValueAction) MarshalJSON ¶ 

func (obj ProductTypeAddLocalizedEnumValueAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeAddPlainEnumValueAction ¶ 

type ProductTypeAddPlainEnumValueAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// Value to append to the array.
	Value AttributePlainEnumValue `json:"value"`
}

* * Adds an enum to the values of AttributeEnumType(ctp:api:type:AttributeEnumType) AttributeDefinition, or AttributeSetType(ctp:api:type:AttributeSetType) of AttributeEnumType AttributeDefinition. *

func (ProductTypeAddPlainEnumValueAction) MarshalJSON ¶ 

func (obj ProductTypeAddPlainEnumValueAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeAttributeConstraintAction ¶ 

type ProductTypeChangeAttributeConstraintAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// `None`
	NewValue AttributeConstraintEnumDraft `json:"newValue"`
}

* * Updates the `attributeConstraint` of an AttributeDefinition(ctp:api:type:AttributeDefinition). For now only following changes are supported: `SameForAll` to `None` and `Unique` to `None`. *

func (ProductTypeChangeAttributeConstraintAction) MarshalJSON ¶ 

func (obj ProductTypeChangeAttributeConstraintAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeAttributeNameAction ¶ 

type ProductTypeChangeAttributeNameAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// New user-defined name of the Attribute that is unique with the [Project](ctp:api:type:Project).
	//
	// When using the same `name` for an Attribute in two or more ProductTypes, all fields of the AttributeDefinition of this Attribute must be the same across the ProductTypes. If not, an [AttributeDefinitionAlreadyExists](ctp:api:type:AttributeDefinitionAlreadyExistsError) error is returned.
	// An exception to this are the values of an `enum` or `lenum` type and sets thereof.
	NewAttributeName string `json:"newAttributeName"`
}

* * Renames an AttributeDefinition and also renames all corresponding Attributes on all [Products](/projects/products) with this ProductType. The renaming of the Attributes is [eventually consistent](/general-concepts#eventual-consistency). * * If the AttributeDefinition name to be changed does not exist, an [AttributeNameDoesNotExist](ctp:api:type:AttributeNameDoesNotExistError) error is returned. *

func (ProductTypeChangeAttributeNameAction) MarshalJSON ¶ 

func (obj ProductTypeChangeAttributeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeAttributeOrderAction ¶ 

type ProductTypeChangeAttributeOrderAction struct {
	Attributes []AttributeDefinition `json:"attributes"`
}

func (ProductTypeChangeAttributeOrderAction) MarshalJSON ¶ 

func (obj ProductTypeChangeAttributeOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeAttributeOrderByNameAction ¶ 

type ProductTypeChangeAttributeOrderByNameAction struct {
	// Names of Attributes to reorder. This array must include all Attributes currently present on a ProductType in a different order.
	AttributeNames []string `json:"attributeNames"`
}

func (ProductTypeChangeAttributeOrderByNameAction) MarshalJSON ¶ 

func (obj ProductTypeChangeAttributeOrderByNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeDescriptionAction ¶ 

type ProductTypeChangeDescriptionAction struct {
	// New value to set.
	Description string `json:"description"`
}

func (ProductTypeChangeDescriptionAction) MarshalJSON ¶ 

func (obj ProductTypeChangeDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeEnumKeyAction ¶ 

type ProductTypeChangeEnumKeyAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// Existing key to be changed.
	Key string `json:"key"`
	// New key to be set.
	NewKey string `json:"newKey"`
}

* * Updates the key of a single enum `value` in an AttributeEnumType(ctp:api:type:AttributeEnumType) AttributeDefinition, AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) AttributeDefinition, AttributeSetType(ctp:api:type:AttributeSetType) of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition. * * If the AttributeDefinition does not contain an enum with the referenced key, a [EnumKeyDoesNotExist](ctp:api:type:EnumKeyDoesNotExistError) error is returned. * * All Products will be updated to the new key in an [eventually consistent](/general-concepts#eventual-consistency) way. *

func (ProductTypeChangeEnumKeyAction) MarshalJSON ¶ 

func (obj ProductTypeChangeEnumKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeInputHintAction ¶ 

type ProductTypeChangeInputHintAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// `SingleLine` or `MultiLine`
	NewValue TextInputHint `json:"newValue"`
}

* * Updates the `inputHint` of an AttributeDefinition(ctp:api:type:AttributeDefinition). *

func (ProductTypeChangeInputHintAction) MarshalJSON ¶ 

func (obj ProductTypeChangeInputHintAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeIsSearchableAction ¶ 

type ProductTypeChangeIsSearchableAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// Determines whether the Attribute's values can be used in full-text search queries, filters, and facets. See [AttributeDefinition](ctp:api:type:AttributeDefinition) for details.
	IsSearchable bool `json:"isSearchable"`
}

* * Following this update the Products are reindexed asynchronously to reflect this change on the search endpoint. When enabling search on an existing Attribute type definition, the constraint regarding the maximum size of a searchable Attribute will not be enforced. Instead, Product AttributeDefinitions exceeding this limit will be treated as not searchable and will not be available for full-text search. *

func (ProductTypeChangeIsSearchableAction) MarshalJSON ¶ 

func (obj ProductTypeChangeIsSearchableAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeLabelAction ¶ 

type ProductTypeChangeLabelAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// New value to set. Must not be empty.
	Label LocalizedString `json:"label"`
}

func (ProductTypeChangeLabelAction) MarshalJSON ¶ 

func (obj ProductTypeChangeLabelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeLocalizedEnumValueLabelAction ¶ 

type ProductTypeChangeLocalizedEnumValueLabelAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// New value to set. Must be different from the existing value.
	NewValue AttributeLocalizedEnumValue `json:"newValue"`
}

* * Updates the label of a single enum `value` in an AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) AttributeDefinition, or AttributeSetType(ctp:api:type:AttributeSetType) of AttributeLocalizedEnumType AttributeDefinition. * * All Products will be updated to the new label in an [eventually consistent](/general-concepts#eventual-consistency) way. *

func (ProductTypeChangeLocalizedEnumValueLabelAction) MarshalJSON ¶ 

func (obj ProductTypeChangeLocalizedEnumValueLabelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeLocalizedEnumValueOrderAction ¶ 

type ProductTypeChangeLocalizedEnumValueOrderAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// Values must be equal to the values of the Attribute enum values (except for the order). If not, an [EnumValuesMustMatch](ctp:api:type:EnumValuesMustMatchError) error is returned.
	Values []AttributeLocalizedEnumValue `json:"values"`
}

* * Updates the order of localized enum `values` in an AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType) AttributeDefinition. It can update an AttributeLocalizedEnumType AttributeDefinition or an AttributeSetType(ctp:api:type:AttributeSetType) of AttributeLocalizedEnumType AttributeDefinition. *

func (ProductTypeChangeLocalizedEnumValueOrderAction) MarshalJSON ¶ 

func (obj ProductTypeChangeLocalizedEnumValueOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangeNameAction ¶ 

type ProductTypeChangeNameAction struct {
	// New value to set.
	Name string `json:"name"`
}

func (ProductTypeChangeNameAction) MarshalJSON ¶ 

func (obj ProductTypeChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangePlainEnumValueLabelAction ¶ 

type ProductTypeChangePlainEnumValueLabelAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// New value to set. Must be different from the existing value.
	NewValue AttributePlainEnumValue `json:"newValue"`
}

* * Updates the label of a single enum `value` in an AttributeEnumType(ctp:api:type:AttributeEnumType) AttributeDefinition, or AttributeSetType(ctp:api:type:AttributeSetType) of AttributeEnumType AttributeDefinition. * * All Products will be updated to the new label in an [eventually consistent](/general-concepts#eventual-consistency) way. *

func (ProductTypeChangePlainEnumValueLabelAction) MarshalJSON ¶ 

func (obj ProductTypeChangePlainEnumValueLabelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeChangePlainEnumValueOrderAction ¶ 

type ProductTypeChangePlainEnumValueOrderAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// Values must be equal to the values of the Attribute enum values (except for the order). If not, an [EnumValuesMustMatch](ctp:api:type:EnumValuesMustMatchError) error is returned.
	Values []AttributePlainEnumValue `json:"values"`
}

* * Updates the order of enum `values` in an AttributeEnumType(ctp:api:type:AttributeEnumType) AttributeDefinition. It can update an AttributeEnumType AttributeDefinition or an AttributeSetType(ctp:api:type:AttributeSetType) of AttributeEnumType AttributeDefinition. *

func (ProductTypeChangePlainEnumValueOrderAction) MarshalJSON ¶ 

func (obj ProductTypeChangePlainEnumValueOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeDraft ¶ 

type ProductTypeDraft struct {
	// User-defined unique identifier for the ProductType.
	Key *string `json:"key,omitempty"`
	// Name of the ProductType.
	Name string `json:"name"`
	// Description of the ProductType.
	Description string `json:"description"`
	// Attributes to specify for the ProductType. Products of this ProductType have these Attributes available on their [ProductVariants](ctp:api:type:ProductVariant).
	Attributes []AttributeDefinitionDraft `json:"attributes"`
}

func (ProductTypeDraft) MarshalJSON ¶ 

func (obj ProductTypeDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypePagedQueryResponse ¶ 

type ProductTypePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [ProductTypes](ctp:api:type:ProductType) matching the query.
	Results []ProductType `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of ProductType(ctp:api:type:ProductType). *

type ProductTypeReference ¶ 

type ProductTypeReference struct {
	// Unique identifier of the referenced [ProductType](ctp:api:type:ProductType).
	ID string `json:"id"`
	// Contains the representation of the expanded ProductType. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for ProductTypes.
	Obj *ProductType `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a ProductType(ctp:api:type:ProductType). *

func (ProductTypeReference) MarshalJSON ¶ 

func (obj ProductTypeReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeRemoveAttributeDefinitionAction ¶ 

type ProductTypeRemoveAttributeDefinitionAction struct {
	// Name of the Attribute to remove.
	Name string `json:"name"`
}

* * Removes an AttributeDefinition and also deletes all corresponding Attributes on all [Products](/projects/products) with this ProductType. The removal of the Attributes is [eventually consistent](/general-concepts#eventual-consistency). * * The `CombinationUnique` constraint is not checked when an Attribute is removed, and uniqueness violations may occur when you remove an Attribute with a `CombinationUnique` constraint. *

func (ProductTypeRemoveAttributeDefinitionAction) MarshalJSON ¶ 

func (obj ProductTypeRemoveAttributeDefinitionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeRemoveEnumValuesAction ¶ 

type ProductTypeRemoveEnumValuesAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// Keys of [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) to remove.
	Keys []string `json:"keys"`
}

* * Removes enum values from an AttributeDefinition of AttributeEnumType(ctp:api:type:AttributeEnumType), AttributeLocalizedEnumType(ctp:api:type:AttributeLocalizedEnumType), AttributeSetType(ctp:api:type:AttributeSetType) of AttributeEnumType, or AttributeSetType of AttributeLocalizedEnumType. * * If the Attribute is **not** required, the Attributes of all Products using those enum keys will also be removed in an [eventually consistent](/general-concepts#eventual-consistency) way. If the Attribute is required, the operation returns an [EnumValueIsUsed](ctp:api:type:EnumValueIsUsedError) error. *

func (ProductTypeRemoveEnumValuesAction) MarshalJSON ¶ 

func (obj ProductTypeRemoveEnumValuesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeResourceIdentifier ¶ 

type ProductTypeResourceIdentifier struct {
	// Unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a ProductType(ctp:api:type:ProductType). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (ProductTypeResourceIdentifier) MarshalJSON ¶ 

func (obj ProductTypeResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeSetInputTipAction ¶ 

type ProductTypeSetInputTipAction struct {
	// Name of the AttributeDefinition to update.
	AttributeName string `json:"attributeName"`
	// Value to set. If empty, any existing value will be removed.
	InputTip *LocalizedString `json:"inputTip,omitempty"`
}

func (ProductTypeSetInputTipAction) MarshalJSON ¶ 

func (obj ProductTypeSetInputTipAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeSetKeyAction ¶ 

type ProductTypeSetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (ProductTypeSetKeyAction) MarshalJSON ¶ 

func (obj ProductTypeSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductTypeUpdate ¶ 

type ProductTypeUpdate struct {
	// Expected version of the ProductType on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the ProductType.
	Actions []ProductTypeUpdateAction `json:"actions"`
}

func (*ProductTypeUpdate) UnmarshalJSON ¶ 

func (obj *ProductTypeUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductTypeUpdateAction ¶ 

type ProductTypeUpdateAction interface{}

type ProductUnpublishAction ¶ 

type ProductUnpublishAction struct {
}

* * Removes the current [projection](/../api/projects/productProjections#current--staged) of the Product. The staged projection is unaffected. To retrieve unpublished Products, the `staged` parameter must be set to `false` when [querying](ctp:api:endpoint:/{projectKey}/product-projections:GET)/[searching](/projects/products-search#product-projection-search) Product Projections. Produces the [ProductUnpublished](ctp:api:type:ProductUnpublishedMessage) Message. * * Unpublished Products cannot be added to a Cart. However, if a Cart contains Line Items for Products that were added before the Product was unpublished, the Cart is unaffected and can still be used to create an Order. To prevent this, in addition to unpublishing the Product you should remove the Prices from the Product using [Remove Price](ctp:api:type:ProductRemovePriceAction) for Embedded Prices or [Delete StandalonePrice](/projects/standalone-prices#delete-standaloneprice) for Standalone Prices. *

func (ProductUnpublishAction) MarshalJSON ¶ 

func (obj ProductUnpublishAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductUnpublishedMessage ¶ 

type ProductUnpublishedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Unpublish Product](ctp:api:type:ProductUnpublishAction) update action. *

func (ProductUnpublishedMessage) MarshalJSON ¶ 

func (obj ProductUnpublishedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductUnpublishedMessage) UnmarshalJSON ¶ 

func (obj *ProductUnpublishedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductUnpublishedMessagePayload ¶ 

type ProductUnpublishedMessagePayload struct {
}

* * Generated after a successful [Unpublish Product](ctp:api:type:ProductUnpublishAction) update action. *

func (ProductUnpublishedMessagePayload) MarshalJSON ¶ 

func (obj ProductUnpublishedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductUpdate ¶ 

type ProductUpdate struct {
	// Expected version of the Product on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Product.
	Actions []ProductUpdateAction `json:"actions"`
}

func (*ProductUpdate) UnmarshalJSON ¶ 

func (obj *ProductUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductUpdateAction ¶ 

type ProductUpdateAction interface{}

type ProductVariant ¶ 

type ProductVariant struct {
	// A unique, sequential identifier of the Product Variant within the Product.
	ID int `json:"id"`
	// User-defined unique SKU of the Product Variant.
	Sku *string `json:"sku,omitempty"`
	// User-defined unique identifier of the ProductVariant.
	//
	// This is different from [Product](ctp:api:type:Product) `key`.
	Key *string `json:"key,omitempty"`
	// The Embedded Prices of the Product Variant.
	// Cannot contain two Prices of the same Price scope (with same currency, country, Customer Group, Channel, `validFrom` and `validUntil`).
	Prices []Price `json:"prices"`
	// Attributes of the Product Variant.
	Attributes []Attribute `json:"attributes"`
	// Only available when [Price selection](#price-selection) is used.
	// Cannot be used in a [Query Predicate](ctp:api:type:QueryPredicate).
	Price *Price `json:"price,omitempty"`
	// Images of the Product Variant.
	Images []Image `json:"images"`
	// Media assets of the Product Variant.
	Assets []Asset `json:"assets"`
	// Set if the Product Variant is tracked by [Inventory](ctp:api:type:InventoryEntry).
	// Can be used as an optimization to reduce calls to the Inventory service.
	// May not contain the latest Inventory State (it is [eventually consistent](/general-concepts#eventual-consistency)).
	Availability *ProductVariantAvailability `json:"availability,omitempty"`
	// `true` if the Product Variant matches the search query.
	// Only available in response to a [Product Projection Search](ctp:api:type:ProductProjectionSearch) request.
	IsMatchingVariant *bool `json:"isMatchingVariant,omitempty"`
	// Only available in response to a [Product Projection Search](ctp:api:type:ProductProjectionSearch) request
	// with [price selection](ctp:api:type:ProductPriceSelection).
	// Can be used to sort, [filter](ctp:api:type:ProductProjectionSearchFilterScopedPrice), and facet.
	ScopedPrice *ScopedPrice `json:"scopedPrice,omitempty"`
	// Only available in response to a [Product Projection Search](ctp:api:type:ProductProjectionSearchFilterScopedPrice) request
	// with [price selection](ctp:api:type:ProductPriceSelection).
	ScopedPriceDiscounted *bool `json:"scopedPriceDiscounted,omitempty"`
}

* * A concrete sellable good for which inventory can be tracked. Product Variants are generally mapped to specific SKUs. *

func (ProductVariant) MarshalJSON ¶ 

func (obj ProductVariant) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductVariantAddedMessage ¶ 

type ProductVariantAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Product Variant](ctp:api:type:ProductVariant) that was added.
	Variant ProductVariant `json:"variant"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Add ProductVariant](ctp:api:type:ProductAddVariantAction) update action. *

func (ProductVariantAddedMessage) MarshalJSON ¶ 

func (obj ProductVariantAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductVariantAddedMessage) UnmarshalJSON ¶ 

func (obj *ProductVariantAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductVariantAddedMessagePayload ¶ 

type ProductVariantAddedMessagePayload struct {
	// Unique identifier of the [Product Variant](ctp:api:type:ProductVariant) that was added.
	Variant ProductVariant `json:"variant"`
	// Whether the update was only applied to the staged [Product Projection](ctp:api:type:ProductProjection).
	Staged bool `json:"staged"`
}

* * Generated after a successful [Add ProductVariant](ctp:api:type:ProductAddVariantAction) update action. *

func (ProductVariantAddedMessagePayload) MarshalJSON ¶ 

func (obj ProductVariantAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductVariantAvailability ¶ 

type ProductVariantAvailability struct {
	// For each [InventoryEntry](ctp:api:type:InventoryEntry) with a supply Channel, an entry is added to `channels`.
	Channels *ProductVariantChannelAvailabilityMap `json:"channels,omitempty"`
	// Indicates whether a Product Variant is in stock.
	IsOnStock bool `json:"isOnStock"`
	// Number of days to restock a Product Variant once it is out of stock.
	RestockableInDays *int `json:"restockableInDays,omitempty"`
	// Number of items of the Product Variant that are in stock.
	AvailableQuantity *int `json:"availableQuantity,omitempty"`
	// Unique identifier of the [InventoryEntry](ctp:api:type:InventoryEntry).
	ID *string `json:"id,omitempty"`
	// Current version of the [InventoryEntry](ctp:api:type:InventoryEntry).
	Version *int `json:"version,omitempty"`
}

* * The InventoryEntry(ctp:api:type:InventoryEntry) information of the Product Variant. If there is a supply Channel(ctp:api:type:Channel) for the InventoryEntry, then `channels` is returned. If not, then `isOnStock`, `restockableInDays`, and `quantityOnStock` are returned. *

type ProductVariantChannelAvailability ¶ 

type ProductVariantChannelAvailability struct {
	// Indicates whether a Product Variant is in stock in a specified [Channel](ctp:api:type:Channel).
	IsOnStock *bool `json:"isOnStock,omitempty"`
	// Number of days to restock a Product Variant once it is out of stock in a specified [Channel](ctp:api:type:Channel).
	RestockableInDays *int `json:"restockableInDays,omitempty"`
	// Number of items of this Product Variant that are in stock in a specified [Channel](ctp:api:type:Channel).
	AvailableQuantity *int `json:"availableQuantity,omitempty"`
	// Unique identifier of the [InventoryEntry](ctp:api:type:InventoryEntry).
	ID string `json:"id"`
	// Current version of the [InventoryEntry](ctp:api:type:InventoryEntry).
	Version int `json:"version"`
}

type ProductVariantChannelAvailabilityMap ¶ 

type ProductVariantChannelAvailabilityMap map[string]ProductVariantChannelAvailability

* * JSON object where the key is a supply Channel(ctp:api:type:Channel) `id` and the value is the ProductVariantChannelAvailability(ctp:api:type:ProductVariantChannelAvailability) of the InventoryEntry(ctp:api:type:InventoryEntry). *

type ProductVariantDeletedMessage ¶ 

type ProductVariantDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Unique identifier of the [Product Variant](ctp:api:type:ProductVariant) that was added.
	Variant *ProductVariant `json:"variant,omitempty"`
	// List of image URLs that were removed with the [Remove Product Variant](ctp:api:type:ProductRemoveVariantAction) update action.
	RemovedImageUrls []string `json:"removedImageUrls"`
}

* * Generated after a successful [Remove ProductVariant](ctp:api:type:ProductRemoveVariantAction) update action. *

func (ProductVariantDeletedMessage) MarshalJSON ¶ 

func (obj ProductVariantDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProductVariantDeletedMessage) UnmarshalJSON ¶ 

func (obj *ProductVariantDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProductVariantDeletedMessagePayload ¶ 

type ProductVariantDeletedMessagePayload struct {
	// Unique identifier of the [Product Variant](ctp:api:type:ProductVariant) that was added.
	Variant *ProductVariant `json:"variant,omitempty"`
	// List of image URLs that were removed with the [Remove Product Variant](ctp:api:type:ProductRemoveVariantAction) update action.
	RemovedImageUrls []string `json:"removedImageUrls"`
}

* * Generated after a successful [Remove ProductVariant](ctp:api:type:ProductRemoveVariantAction) update action. *

func (ProductVariantDeletedMessagePayload) MarshalJSON ¶ 

func (obj ProductVariantDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductVariantDraft ¶ 

type ProductVariantDraft struct {
	// User-defined unique SKU of the Product Variant.
	Sku *string `json:"sku,omitempty"`
	// User-defined unique identifier for the ProductVariant.
	Key *string `json:"key,omitempty"`
	// The Embedded Prices for the Product Variant.
	// Each Price must have its unique Price scope (with same currency, country, Customer Group, Channel, `validFrom` and `validUntil`).
	Prices []PriceDraft `json:"prices"`
	// Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinition).
	Attributes []Attribute `json:"attributes"`
	// Images for the Product Variant.
	Images []Image `json:"images"`
	// Media assets for the Product Variant.
	Assets []AssetDraft `json:"assets"`
}

* * Creates a Product Variant when included in the `masterVariant` and `variants` fields of the ProductDraft(ctp:api:type:ProductDraft). *

func (ProductVariantDraft) MarshalJSON ¶ 

func (obj ProductVariantDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductVariantExclusion ¶ added in v1.3.0 

type ProductVariantExclusion struct {
	// Non-empty array of SKUs representing Product Variants to be included in the Product Selection with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
	Skus []string `json:"skus"`
}

* * Only Product Variants with the explicitly listed SKUs are part of a Product Selection with `IndividualExclusion` ProductSelectionMode(ctp:api:type:ProductSelectionMode). *

type ProductVariantImportDraft ¶ 

type ProductVariantImportDraft struct {
	// The `id` of the [ProductVariant](ctp:api:type:ProductVariant). Required if you do not set a value for `sku`.
	// If set, you must specify a `productId` in the [LineItemImportDraft](ctp:api:type:LineItemImportDraft) also.
	ID *int `json:"id,omitempty"`
	// The `sku` of the [ProductVariant](ctp:api:type:ProductVariant). Required if you do not set a value for `id`.
	Sku *string `json:"sku,omitempty"`
	// The [Prices](ctp:api:type:Price) of the Product Variant if you want to override the `prices` property in the referenced [ProductVariant](ctp:api:type:ProductVariant).
	// If not set, the `prices` from the referenced [ProductVariant](ctp:api:type:ProductVariant) are used in the resulting Order.
	// If set, each Price must have its unique price scope (same `value.currencyCode`, `country`, `customerGroup`, `channel`, `validFrom` and `validUntil`).
	Prices []PriceDraft `json:"prices"`
	// The [Attributes](ctp:api:type:Attribute) of the Product Variant if you want to override the `attributes` property in the referenced [ProductVariant](ctp:api:type:ProductVariant).
	// If not set, the `attributes` from the referenced [ProductVariant](ctp:api:type:ProductVariant) are copied to the resulting Order.
	Attributes []Attribute `json:"attributes"`
	// The [Images](ctp:api:type:Image) of the Product Variant if you want to override the `images` property in the referenced [ProductVariant](ctp:api:type:ProductVariant).
	// If not set, the `images` from the referenced [ProductVariant](ctp:api:type:ProductVariant) are copied to the resulting Order.
	Images []Image `json:"images"`
}

* * Contains the Product Variant to be used in the LineItemImportDraft(ctp:api:type:LineItemImportDraft). *

func (ProductVariantImportDraft) MarshalJSON ¶ 

func (obj ProductVariantImportDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductVariantSelection ¶ added in v1.2.0 

type ProductVariantSelection interface{}

* * Polymorphic base type for Product Variant Selections. The actual type is determined by the `type` field. *

type ProductVariantSelectionExclusion ¶ added in v1.2.0 

type ProductVariantSelectionExclusion struct {
	// Non-empty array of SKUs representing Product Variants to be excluded from the Product Selection.
	Skus []string `json:"skus"`
}

* * All Product Variants except the explicitly stated SKUs are part of the Product Selection. *

func (ProductVariantSelectionExclusion) MarshalJSON ¶ added in v1.2.0 

func (obj ProductVariantSelectionExclusion) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductVariantSelectionIncludeAllExcept ¶ added in v1.3.0 

type ProductVariantSelectionIncludeAllExcept struct {
	// Non-empty array of SKUs representing Product Variants to be excluded from the Product Selection.
	Skus []string `json:"skus"`
}

* * All Product Variants except the explicitly stated SKUs are part of the Product Selection. *

func (ProductVariantSelectionIncludeAllExcept) MarshalJSON ¶ added in v1.3.0 

func (obj ProductVariantSelectionIncludeAllExcept) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductVariantSelectionIncludeOnly ¶ added in v1.3.0 

type ProductVariantSelectionIncludeOnly struct {
	// Non-empty array of SKUs representing Product Variants to be included into the Product Selection.
	Skus []string `json:"skus"`
}

* * Only Product Variants with explicitly stated SKUs are part of the Product Selection. *

func (ProductVariantSelectionIncludeOnly) MarshalJSON ¶ added in v1.3.0 

func (obj ProductVariantSelectionIncludeOnly) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductVariantSelectionInclusion ¶ added in v1.2.0 

type ProductVariantSelectionInclusion struct {
	// Non-empty array of SKUs representing Product Variants to be included into the Product Selection.
	Skus []string `json:"skus"`
}

* * Only Product Variants with explicitly stated SKUs are part of the Product Selection. *

func (ProductVariantSelectionInclusion) MarshalJSON ¶ added in v1.2.0 

func (obj ProductVariantSelectionInclusion) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductVariantSelectionTypeEnum ¶ added in v1.2.0 

type ProductVariantSelectionTypeEnum string
const (
	ProductVariantSelectionTypeEnumInclusion        ProductVariantSelectionTypeEnum = "inclusion"
	ProductVariantSelectionTypeEnumExclusion        ProductVariantSelectionTypeEnum = "exclusion"
	ProductVariantSelectionTypeEnumIncludeOnly      ProductVariantSelectionTypeEnum = "includeOnly"
	ProductVariantSelectionTypeEnumIncludeAllExcept ProductVariantSelectionTypeEnum = "includeAllExcept"
)

type ProductsInStorePagedQueryResponse ¶ 

type ProductsInStorePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/general-concepts#strong-consistency).
	// Unlike other endpoints, the Product Selection endpoint does not return this field by default.
	// To get `total`, pass the query parameter `withTotal` set to `true`.
	// When the results are filtered with a [Query Predicate](/predicates/query), `total` is subject to a [limit](/limits#queries).
	Total *int `json:"total,omitempty"`
	// ProductSelectionAssignments matching the query.
	Results []ProductSelectionAssignment `json:"results"`
}

* * [PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of ProductSelectionAssignment(ctp:api:type:ProductSelectionAssignment). *

type Project ¶ 

type Project struct {
	// Current version of the Project.
	Version int `json:"version"`
	// User-defined unique identifier of the Project.
	Key string `json:"key"`
	// Name of the Project.
	Name string `json:"name"`
	// Country code of the geographic location.
	Countries []string `json:"countries"`
	// Currency code of the country. A Project must have at least one currency.
	Currencies []string `json:"currencies"`
	// Language of the country. A Project must have at least one language.
	Languages []string `json:"languages"`
	// Date and time (UTC) the Project was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date in YYYY-MM format specifying when the trial period for the Project ends. Only present on Projects in trial period.
	TrialUntil *string `json:"trialUntil,omitempty"`
	// Holds the configuration for the [Messages Query](/../api/projects/messages) feature.
	Messages MessagesConfiguration `json:"messages"`
	// Holds the configuration for the [Carts](/../api/projects/carts) feature.
	Carts CartsConfiguration `json:"carts"`
	// Holds the configuration for the [Shopping Lists](/../api/projects/shoppingLists) feature. This field may not be present on Projects created before January 2020.
	ShoppingLists *ShoppingListsConfiguration `json:"shoppingLists,omitempty"`
	// Holds the configuration for the [tiered shipping rates](ctp:api:type:ShippingRatePriceTier) feature.
	ShippingRateInputType ShippingRateInputType `json:"shippingRateInputType,omitempty"`
	// Represents a RFC 7662 compliant [OAuth 2.0 Token Introspection](https://datatracker.ietf.org/doc/html/rfc7662) endpoint.
	ExternalOAuth *ExternalOAuth `json:"externalOAuth,omitempty"`
	// Controls indexing of resources to be provided on high performance read-only search endpoints.
	SearchIndexing *SearchIndexingConfiguration `json:"searchIndexing,omitempty"`
	// Holds configuration specific to [Business Units](ctp:api:type:BusinessUnit).
	BusinessUnits *BusinessUnitConfiguration `json:"businessUnits,omitempty"`
}

func (*Project) UnmarshalJSON ¶ 

func (obj *Project) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProjectChangeBusinessUnitStatusOnCreationAction ¶ added in v1.2.0 

type ProjectChangeBusinessUnitStatusOnCreationAction struct {
	// Status for Business Units created using the [My Business Unit endpoint](ctp:api:endpoint:/{projectKey}/me/business-units:POST).
	Status BusinessUnitConfigurationStatus `json:"status"`
}

func (ProjectChangeBusinessUnitStatusOnCreationAction) MarshalJSON ¶ added in v1.2.0 

func (obj ProjectChangeBusinessUnitStatusOnCreationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeCartsConfigurationAction ¶ 

type ProjectChangeCartsConfigurationAction struct {
	// Configuration for the [Carts](/../api/projects/carts) feature.
	CartsConfiguration CartsConfiguration `json:"cartsConfiguration"`
}

func (ProjectChangeCartsConfigurationAction) MarshalJSON ¶ 

func (obj ProjectChangeCartsConfigurationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeCountriesAction ¶ 

type ProjectChangeCountriesAction struct {
	// New value to set. Must not be empty.
	Countries []string `json:"countries"`
}

func (ProjectChangeCountriesAction) MarshalJSON ¶ 

func (obj ProjectChangeCountriesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeCountryTaxRateFallbackEnabledAction ¶ 

type ProjectChangeCountryTaxRateFallbackEnabledAction struct {
	// When `true`, country _- no state_ Tax Rate is used as fallback. See [CartsConfiguration](ctp:api:type:CartsConfiguration).
	CountryTaxRateFallbackEnabled bool `json:"countryTaxRateFallbackEnabled"`
}

func (ProjectChangeCountryTaxRateFallbackEnabledAction) MarshalJSON ¶ 

func (obj ProjectChangeCountryTaxRateFallbackEnabledAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeCurrenciesAction ¶ 

type ProjectChangeCurrenciesAction struct {
	// New value to set. Must not be empty.
	Currencies []string `json:"currencies"`
}

func (ProjectChangeCurrenciesAction) MarshalJSON ¶ 

func (obj ProjectChangeCurrenciesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeLanguagesAction ¶ 

type ProjectChangeLanguagesAction struct {
	// New value to set. Must not be empty.
	Languages []string `json:"languages"`
}

* * Removing a language used by a Store(ctp:api:type:Store) returns a [LanguageUsedInStores](ctp:api:type:LanguageUsedInStoresError) error. *

func (ProjectChangeLanguagesAction) MarshalJSON ¶ 

func (obj ProjectChangeLanguagesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeMessagesConfigurationAction ¶ 

type ProjectChangeMessagesConfigurationAction struct {
	// Configuration for the [Messages Query](/../api/projects/messages) feature.
	MessagesConfiguration MessagesConfigurationDraft `json:"messagesConfiguration"`
}

func (ProjectChangeMessagesConfigurationAction) MarshalJSON ¶ 

func (obj ProjectChangeMessagesConfigurationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeMessagesEnabledAction ¶ 

type ProjectChangeMessagesEnabledAction struct {
	MessagesEnabled bool `json:"messagesEnabled"`
}

func (ProjectChangeMessagesEnabledAction) MarshalJSON ¶ 

func (obj ProjectChangeMessagesEnabledAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeNameAction ¶ 

type ProjectChangeNameAction struct {
	// New value to set. Must not be empty.
	Name string `json:"name"`
}

func (ProjectChangeNameAction) MarshalJSON ¶ 

func (obj ProjectChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeOrderSearchStatusAction ¶ 

type ProjectChangeOrderSearchStatusAction struct {
	// Activates or deactivates the [Order Search](/../api/projects/order-search) feature. Activation will trigger building a search index for the Orders in the Project.
	Status OrderSearchStatus `json:"status"`
}

func (ProjectChangeOrderSearchStatusAction) MarshalJSON ¶ 

func (obj ProjectChangeOrderSearchStatusAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeProductSearchIndexingEnabledAction ¶ 

type ProjectChangeProductSearchIndexingEnabledAction struct {
	// - If `false`, the indexing of [Product](ctp:api:type:Product) information will stop and the [Product Projection Search](/../api/projects/products-search) as well as the [Product Suggestions](/../api/projects/products-suggestions) endpoint will not be available anymore for this Project. The Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be changed to `"Deactivated"`.
	// - If `true`, the indexing of [Product](ctp:api:type:Product) information will start and the [Product Projection Search](/../api/projects/products-search) as well as the [Product Suggestions](/../api/projects/products-suggestions) endpoint will become available soon after for this Project. Proportional to the amount of information being indexed, the Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be shown as `"Indexing"` during this time. As soon as the indexing has finished, the configuration status will be changed to `"Activated"` making the aforementioned endpoints fully available for this Project.
	Enabled bool `json:"enabled"`
}

func (ProjectChangeProductSearchIndexingEnabledAction) MarshalJSON ¶ 

func (obj ProjectChangeProductSearchIndexingEnabledAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectChangeShoppingListsConfigurationAction ¶ 

type ProjectChangeShoppingListsConfigurationAction struct {
	// Configuration for the [Shopping Lists](/../api/projects/shoppingLists) feature.
	ShoppingListsConfiguration ShoppingListsConfiguration `json:"shoppingListsConfiguration"`
}

func (ProjectChangeShoppingListsConfigurationAction) MarshalJSON ¶ 

func (obj ProjectChangeShoppingListsConfigurationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectNotConfiguredForLanguagesError ¶ 

type ProjectNotConfiguredForLanguagesError struct {
	// `"The project is not configured for given languages."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Languages configured for the Store.
	Languages []string `json:"languages"`
}

* * Returned when the languages set for a Store are not supported by the Project. * * The error is returned as a failed response to the [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action. *

func (*ProjectNotConfiguredForLanguagesError) DecodeStruct ¶ added in v1.1.0 

func (obj *ProjectNotConfiguredForLanguagesError) DecodeStruct(src map[string]interface{}) error

func (ProjectNotConfiguredForLanguagesError) Error ¶ 

func (obj ProjectNotConfiguredForLanguagesError) Error() string

func (ProjectNotConfiguredForLanguagesError) MarshalJSON ¶ 

func (obj ProjectNotConfiguredForLanguagesError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProjectNotConfiguredForLanguagesError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ProjectNotConfiguredForLanguagesError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProjectSetBusinessUnitAssociateRoleOnCreationAction ¶ added in v1.3.0 

type ProjectSetBusinessUnitAssociateRoleOnCreationAction struct {
	// Default [Associate Role](ctp:api:type:AssociateRole) assigned to the Associate creating a Business Unit using the [My Business Unit endpoint](ctp:api:endpoint:/{projectKey}/me/business-units:POST).
	AssociateRole AssociateRoleResourceIdentifier `json:"associateRole"`
}

func (ProjectSetBusinessUnitAssociateRoleOnCreationAction) MarshalJSON ¶ added in v1.3.0 

func (obj ProjectSetBusinessUnitAssociateRoleOnCreationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectSetExternalOAuthAction ¶ 

type ProjectSetExternalOAuthAction struct {
	// Value to set. If empty, any existing value will be removed.
	ExternalOAuth *ExternalOAuth `json:"externalOAuth,omitempty"`
}

func (ProjectSetExternalOAuthAction) MarshalJSON ¶ 

func (obj ProjectSetExternalOAuthAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProjectSetShippingRateInputTypeAction ¶ 

type ProjectSetShippingRateInputTypeAction struct {
	// Value to set. If empty, any existing value will be removed.
	ShippingRateInputType ShippingRateInputType `json:"shippingRateInputType,omitempty"`
}

func (ProjectSetShippingRateInputTypeAction) MarshalJSON ¶ 

func (obj ProjectSetShippingRateInputTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ProjectSetShippingRateInputTypeAction) UnmarshalJSON ¶ 

func (obj *ProjectSetShippingRateInputTypeAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProjectUpdate ¶ 

type ProjectUpdate struct {
	// Expected version of the Project on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Project.
	Actions []ProjectUpdateAction `json:"actions"`
}

func (*ProjectUpdate) UnmarshalJSON ¶ 

func (obj *ProjectUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ProjectUpdateAction ¶ 

type ProjectUpdateAction interface{}

type QueryComplexityLimitExceededError ¶ 

type QueryComplexityLimitExceededError struct {
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

func (*QueryComplexityLimitExceededError) DecodeStruct ¶ added in v1.1.0 

func (obj *QueryComplexityLimitExceededError) DecodeStruct(src map[string]interface{}) error

func (QueryComplexityLimitExceededError) Error ¶ 

func (obj QueryComplexityLimitExceededError) Error() string

func (QueryComplexityLimitExceededError) MarshalJSON ¶ 

func (obj QueryComplexityLimitExceededError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QueryComplexityLimitExceededError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *QueryComplexityLimitExceededError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QueryPrice ¶ 

type QueryPrice struct {
	// Unique identifier of the given Price.
	ID *string `json:"id,omitempty"`
	// Money value of the given Price.
	Value Money `json:"value"`
	// Country for which the given Price is valid.
	Country *string `json:"country,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) for which the given Price is valid.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// `ProductDistribution` [Channel](ctp:api:type:Channel) for which the given Price is valid.
	Channel *ChannelReference `json:"channel,omitempty"`
	// Date from which the given Price is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date until which the given Price is valid.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// [DiscountedPrice](ctp:api:type:DiscountedPrice) you specify for the given Price.
	Discounted *DiscountedPriceDraft `json:"discounted,omitempty"`
	// Custom Fields for the Price.
	Custom *CustomFields `json:"custom,omitempty"`
	// Price tier applied when the minimum quantity for the [LineItem](ctp:api:type:LineItem) of a ProductVariant with the related Price is reached in a Cart.
	//
	// If `discounted` is specified, the tiered Price is ignored for a Product Variant.
	Tiers []PriceTierDraft `json:"tiers"`
}

func (QueryPrice) MarshalJSON ¶ 

func (obj QueryPrice) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QueryTimedOutError ¶ 

type QueryTimedOutError struct {
	// `"The query timed out. If your query constantly times out, please check that it follows the performance best practices (see https://docs.commercetools.com/api/predicates/query#performance-considerations)."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the query times out. * * If a query constantly times out, please check if it follows the [performance best practices](/../api/predicates/query#performance-considerations). *

func (*QueryTimedOutError) DecodeStruct ¶ added in v1.1.0 

func (obj *QueryTimedOutError) DecodeStruct(src map[string]interface{}) error

func (QueryTimedOutError) Error ¶ 

func (obj QueryTimedOutError) Error() string

func (QueryTimedOutError) MarshalJSON ¶ 

func (obj QueryTimedOutError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QueryTimedOutError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *QueryTimedOutError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type Quote ¶ added in v1.2.0 

type Quote struct {
	// Unique identifier of the Quote.
	ID string `json:"id"`
	// Current version of the Quote.
	Version int `json:"version"`
	// Date and time (UTC) the Quote was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Quote was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-defined unique identifier of the Quote.
	Key *string `json:"key,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Quote Request related to the Quote.
	QuoteRequest QuoteRequestReference `json:"quoteRequest"`
	// Staged Quote related to the Quote.
	StagedQuote StagedQuoteReference `json:"stagedQuote"`
	// The [Buyer](/../api/quotes-overview#buyer) who owns the Quote.
	Customer *CustomerReference `json:"customer,omitempty"`
	// Set automatically when `customer` is set and the Customer is a member of a Customer Group.
	// Not updated if Customer is changed after Quote creation.
	// Used for Product Variant price selection.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// Expiration date for the Quote.
	ValidTo *time.Time `json:"validTo,omitempty"`
	// Message from the [Seller](/../api/quotes-overview#seller) included in the offer.
	SellerComment *string `json:"sellerComment,omitempty"`
	// Message from the [Buyer](/../api/quotes-overview#buyer) included in the [renegotiation request](ctp:api:type:QuoteRequestQuoteRenegotiationAction).
	BuyerComment *string `json:"buyerComment,omitempty"`
	// The Store to which the [Buyer](/../api/quotes-overview#buyer) belongs.
	Store *StoreKeyReference `json:"store,omitempty"`
	// The Line Items for which the Quote is requested.
	LineItems []LineItem `json:"lineItems"`
	// The Custom Line Items for which the Quote is requested.
	CustomLineItems []CustomLineItem `json:"customLineItems"`
	// Sum of all `totalPrice` fields of the `lineItems` and `customLineItems`, as well as the `price` field of `shippingInfo` (if it exists).
	// `totalPrice` may or may not include the taxes: it depends on the taxRate.includedInPrice property of each price.
	TotalPrice TypedMoney `json:"totalPrice"`
	// Not set until the shipping address is set.
	// Will be set automatically in the `Platform` TaxMode.
	// For the `External` tax mode it will be set  as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set.
	TaxedPrice *TaxedPrice `json:"taxedPrice,omitempty"`
	// Used to determine the eligible [ShippingMethods](ctp:api:type:ShippingMethod)
	// and rates as well as the tax rate of the Line Items.
	ShippingAddress *Address `json:"shippingAddress,omitempty"`
	// Address used for invoicing.
	BillingAddress *Address `json:"billingAddress,omitempty"`
	// Inventory mode of the Cart referenced in the [QuoteRequestDraft](ctp:api:type:QuoteRequestDraft).
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Tax mode of the Cart referenced in the [QuoteRequestDraft](ctp:api:type:QuoteRequestDraft).
	TaxMode TaxMode `json:"taxMode"`
	// When calculating taxes for `taxedPrice`, the selected mode is used for rounding.
	TaxRoundingMode RoundingMode `json:"taxRoundingMode"`
	// When calculating taxes for `taxedPrice`, the selected mode is used for calculating the price with `LineItemLevel` (horizontally) or `UnitPriceLevel` (vertically) calculation mode.
	TaxCalculationMode TaxCalculationMode `json:"taxCalculationMode"`
	// Used for Product Variant price selection.
	Country *string `json:"country,omitempty"`
	// Set automatically once the [ShippingMethod](ctp:api:type:ShippingMethod) is set.
	ShippingInfo *ShippingInfo `json:"shippingInfo,omitempty"`
	// Log of payment transactions related to the Quote.
	PaymentInfo *PaymentInfo `json:"paymentInfo,omitempty"`
	// Used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	ShippingRateInput ShippingRateInput `json:"shippingRateInput,omitempty"`
	// Contains addresses for carts with multiple shipping addresses.
	// Line items reference these addresses under their `shippingDetails`.
	// The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate.
	// Only the cart's `shippingAddress` is used for this.
	ItemShippingAddresses []Address `json:"itemShippingAddresses"`
	// Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
	DirectDiscounts []DirectDiscount `json:"directDiscounts"`
	// Custom Fields on the Quote.
	Custom *CustomFields `json:"custom,omitempty"`
	// Predefined states tracking the status of the Quote.
	QuoteState QuoteState `json:"quoteState"`
	// [State](ctp:api:type:State) of the Quote.
	// This reference can point to a State in a custom workflow.
	State *StateReference `json:"state,omitempty"`
	// The Purchase Order Number is typically set by the [Buyer](/quotes-overview#buyer) on a [QuoteRequest](ctp:api:type:QuoteRequest) to
	// track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
	// The [BusinessUnit](ctp:api:type:BusinessUnit) for the Quote.
	BusinessUnit *BusinessUnitKeyReference `json:"businessUnit,omitempty"`
}

func (Quote) MarshalJSON ¶ added in v1.2.0 

func (obj Quote) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*Quote) UnmarshalJSON ¶ added in v1.2.0 

func (obj *Quote) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteChangeCustomerAction ¶ added in v1.3.0 

type QuoteChangeCustomerAction struct {
	// New Customer to own the Quote.
	Customer CustomerResourceIdentifier `json:"customer"`
}

* * Changes the owner of a Quote to a different Customer. * Customer Group is not updated. * This update action produces the [Quote Customer Changed](ctp:api:type:QuoteCustomerChangedMessage) Message. *

func (QuoteChangeCustomerAction) MarshalJSON ¶ added in v1.3.0 

func (obj QuoteChangeCustomerAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteChangeQuoteStateAction ¶ added in v1.2.0 

type QuoteChangeQuoteStateAction struct {
	// New state to be set for the Quote.
	QuoteState QuoteState `json:"quoteState"`
}

func (QuoteChangeQuoteStateAction) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteChangeQuoteStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteCreatedMessage ¶ added in v1.2.0 

type QuoteCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Quote](/../api/projects/quotes) that was created.
	Quote Quote `json:"quote"`
}

* * Generated after a successful [Create Quote](ctp:api:endpoint:/{projectKey}/quotes:POST) request. *

func (QuoteCreatedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteCreatedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteCreatedMessagePayload ¶ added in v1.2.0 

type QuoteCreatedMessagePayload struct {
	// [Quote](/../api/projects/quotes) that was created.
	Quote Quote `json:"quote"`
}

* * Generated after a successful [Create Quote](ctp:api:endpoint:/{projectKey}/quotes:POST) request. *

func (QuoteCreatedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteCustomerChangedMessage ¶ added in v1.3.0 

type QuoteCustomerChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Buyer](/../api/quotes-overview#buyer) who now owns the Quote.
	Customer CustomerReference `json:"customer"`
	// The previous [Buyer](/../api/quotes-overview#buyer).
	PreviousCustomer CustomerReference `json:"previousCustomer"`
}

* * Generated after a successful [Change Customer](ctp:api:type:QuoteChangeCustomerAction) update action. *

func (QuoteCustomerChangedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj QuoteCustomerChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteCustomerChangedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *QuoteCustomerChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteCustomerChangedMessagePayload ¶ added in v1.3.0 

type QuoteCustomerChangedMessagePayload struct {
	// The [Buyer](/../api/quotes-overview#buyer) who now owns the Quote.
	Customer CustomerReference `json:"customer"`
	// The previous [Buyer](/../api/quotes-overview#buyer).
	PreviousCustomer CustomerReference `json:"previousCustomer"`
}

* * Generated after a successful [Change Customer](ctp:api:type:QuoteChangeCustomerAction) update action. *

func (QuoteCustomerChangedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj QuoteCustomerChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteDeletedMessage ¶ added in v1.2.0 

type QuoteDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete Quote](/../api/projects/quotes#delete-quote) request. *

func (QuoteDeletedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteDeletedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteDeletedMessagePayload ¶ added in v1.2.0 

type QuoteDeletedMessagePayload struct {
}

* * Generated after a successful [Delete Quote](/../api/projects/quotes#delete-quote) request. *

func (QuoteDeletedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteDraft ¶ added in v1.2.0 

type QuoteDraft struct {
	// User-defined unique identifier for the Quote.
	Key *string `json:"key,omitempty"`
	// StagedQuote from which the Quote is created.
	StagedQuote StagedQuoteResourceIdentifier `json:"stagedQuote"`
	// Current version of the StagedQuote.
	StagedQuoteVersion int `json:"stagedQuoteVersion"`
	// If `true`, the `stagedQuoteState` of the referenced [StagedQuote](/../api/projects/staged-quotes#stagedquote) will be set to `Sent`.
	StagedQuoteStateToSent *bool `json:"stagedQuoteStateToSent,omitempty"`
	// [State](ctp:api:type:State) of the Quote.
	// This reference can point to a State in a custom workflow.
	State *StateReference `json:"state,omitempty"`
	// [Custom Fields](/../api/projects/custom-fields) to be added to the Quote.
	//
	// - If specified, the Custom Fields are merged with the Custom Fields on the referenced [StagedQuote](/../api/projects/staged-quotes#stagedquote) and added to the Quote.
	// - If empty, the Custom Fields on the referenced [StagedQuote](/../api/projects/staged-quotes#stagedquote) are added to the Quote automatically.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

type QuotePagedQueryResponse ¶ added in v1.2.0 

type QuotePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Quotes matching the query.
	Results []Quote `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of Quote(ctp:api:type:Quote). *

type QuoteReference ¶ added in v1.2.0 

type QuoteReference struct {
	// Unique ID of the referenced resource.
	ID string `json:"id"`
	// Contains the representation of the expanded Quote.
	// Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Quote.
	Obj *Quote `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Quote(ctp:api:type:Quote). *

func (QuoteReference) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRenegotiationRequestedMessage ¶ added in v1.4.0 

type QuoteRenegotiationRequestedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Message from the [Buyer](/api/quotes-overview#buyer) regarding the Quote renegotiation request.
	BuyerComment *string `json:"buyerComment,omitempty"`
}

* * Generated after a successful [Request Quote Renegotiation](ctp:api:type:QuoteRequestQuoteRenegotiationAction) update action. *

func (QuoteRenegotiationRequestedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj QuoteRenegotiationRequestedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteRenegotiationRequestedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *QuoteRenegotiationRequestedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteRenegotiationRequestedMessagePayload ¶ added in v1.4.0 

type QuoteRenegotiationRequestedMessagePayload struct {
	// Message from the [Buyer](/api/quotes-overview#buyer) regarding the Quote renegotiation request.
	BuyerComment *string `json:"buyerComment,omitempty"`
}

* * Generated after a successful [Request Quote Renegotiation](ctp:api:type:QuoteRequestQuoteRenegotiationAction) update action. *

func (QuoteRenegotiationRequestedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj QuoteRenegotiationRequestedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequest ¶ added in v1.2.0 

type QuoteRequest struct {
	// Unique identifier of the QuoteRequest.
	ID string `json:"id"`
	// Current version of the QuoteRequest.
	Version int `json:"version"`
	// Date and time (UTC) the QuoteRequest was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the QuoteRequest was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-defined unique identifier of the QuoteRequest.
	Key *string `json:"key,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Indicates the current state of the Quote Request in the negotiation process.
	QuoteRequestState QuoteRequestState `json:"quoteRequestState"`
	// Message from the Buyer included in the Quote Request.
	Comment *string `json:"comment,omitempty"`
	// The [Buyer](/../api/quotes-overview#buyer) who owns the request.
	Customer CustomerReference `json:"customer"`
	// Set automatically when `customer` is set and the Customer is a member of a Customer Group.
	// Not updated if Customer is changed after Quote Request creation.
	// Used for Product Variant price selection.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// The Store to which the [Buyer](/../api/quotes-overview#buyer) belongs.
	Store *StoreKeyReference `json:"store,omitempty"`
	// The Line Items for which a Quote is requested.
	LineItems []LineItem `json:"lineItems"`
	// The Custom Line Items for which a Quote is requested.
	CustomLineItems []CustomLineItem `json:"customLineItems"`
	// Sum of all `totalPrice` fields of the `lineItems` and `customLineItems`, as well as the `price` field of `shippingInfo` (if it exists).
	// `totalPrice` may or may not include the taxes: it depends on the taxRate.includedInPrice property of each price.
	TotalPrice TypedMoney `json:"totalPrice"`
	// Not set until the shipping address is set.
	// Will be set automatically in the `Platform` TaxMode.
	// For the `External` tax mode it will be set  as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set.
	TaxedPrice *TaxedPrice `json:"taxedPrice,omitempty"`
	// Used to determine the eligible [ShippingMethods](ctp:api:type:ShippingMethod)
	// and rates as well as the tax rate of the Line Items.
	ShippingAddress *Address `json:"shippingAddress,omitempty"`
	// Address used for invoicing.
	BillingAddress *Address `json:"billingAddress,omitempty"`
	// Inventory mode of the Cart referenced in the [QuoteRequestDraft](ctp:api:type:QuoteRequestDraft).
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Tax mode of the Cart referenced in the [QuoteRequestDraft](ctp:api:type:QuoteRequestDraft).
	TaxMode TaxMode `json:"taxMode"`
	// When calculating taxes for `taxedPrice`, the selected mode is used for rounding.
	TaxRoundingMode RoundingMode `json:"taxRoundingMode"`
	// When calculating taxes for `taxedPrice`, the selected mode is used for calculating the price with `LineItemLevel` (horizontally) or `UnitPriceLevel` (vertically) calculation mode.
	TaxCalculationMode TaxCalculationMode `json:"taxCalculationMode"`
	// Used for Product Variant price selection.
	Country *string `json:"country,omitempty"`
	// Set automatically once the [ShippingMethod](ctp:api:type:ShippingMethod) is set.
	ShippingInfo *ShippingInfo `json:"shippingInfo,omitempty"`
	// Log of payment transactions related to the Quote.
	PaymentInfo *PaymentInfo `json:"paymentInfo,omitempty"`
	// Used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	ShippingRateInput ShippingRateInput `json:"shippingRateInput,omitempty"`
	// Contains addresses for carts with multiple shipping addresses.
	// Line items reference these addresses under their `shippingDetails`.
	// The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate.
	// Only the cart's `shippingAddress` is used for this.
	ItemShippingAddresses []Address `json:"itemShippingAddresses"`
	// Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
	DirectDiscounts []DirectDiscount `json:"directDiscounts"`
	// Custom Fields of the Quote Request.
	Custom *CustomFields `json:"custom,omitempty"`
	// [State](ctp:api:type:State) of the Quote Request.
	// This reference can point to a State in a custom workflow.
	State *StateReference `json:"state,omitempty"`
	// Identifier for a purchase order, usually in a B2B context.
	// The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer).
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
	// The [Cart](ctp:api:type:Cart) from which a Quote is requested.
	Cart *CartReference `json:"cart,omitempty"`
	// The [BusinessUnit](ctp:api:type:BusinessUnit) for the Quote Request.
	BusinessUnit *BusinessUnitKeyReference `json:"businessUnit,omitempty"`
}

func (QuoteRequest) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequest) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteRequest) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteRequestChangeCustomerAction ¶ added in v1.3.0 

type QuoteRequestChangeCustomerAction struct {
	// New Customer to own the Quote Request.
	Customer CustomerResourceIdentifier `json:"customer"`
}

* * Changes the owner of a Quote Request to a different Customer. * Customer Group is not updated. * This update action produces the [Quote Request Customer Changed](ctp:api:type:QuoteRequestCustomerChangedMessage) Message. *

func (QuoteRequestChangeCustomerAction) MarshalJSON ¶ added in v1.3.0 

func (obj QuoteRequestChangeCustomerAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestChangeQuoteRequestStateAction ¶ added in v1.2.0 

type QuoteRequestChangeQuoteRequestStateAction struct {
	// New state to be set for the Quote Request.
	QuoteRequestState QuoteRequestState `json:"quoteRequestState"`
}

* * Transitions the Quote Request to a different state. * A Buyer is only allowed to cancel a Quote Request when it is in `Submitted` state. *

func (QuoteRequestChangeQuoteRequestStateAction) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestChangeQuoteRequestStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestCreatedMessage ¶ added in v1.2.0 

type QuoteRequestCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Quote Request](/../api/projects/quote-requests) that was created.
	QuoteRequest QuoteRequest `json:"quoteRequest"`
}

* * Generated after a successful [Create QuoteRequest](ctp:api:endpoint:/{projectKey}/quote-requests:POST) request. *

func (QuoteRequestCreatedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteRequestCreatedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteRequestCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteRequestCreatedMessagePayload ¶ added in v1.2.0 

type QuoteRequestCreatedMessagePayload struct {
	// [Quote Request](/../api/projects/quote-requests) that was created.
	QuoteRequest QuoteRequest `json:"quoteRequest"`
}

* * Generated after a successful [Create QuoteRequest](ctp:api:endpoint:/{projectKey}/quote-requests:POST) request. *

func (QuoteRequestCreatedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestCustomerChangedMessage ¶ added in v1.3.0 

type QuoteRequestCustomerChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Buyer](/../api/quotes-overview#buyer) who now owns the Quote Request.
	Customer CustomerReference `json:"customer"`
	// The previous [Buyer](/../api/quotes-overview#buyer).
	PreviousCustomer CustomerReference `json:"previousCustomer"`
}

* * Generated after a successful [Change Customer](ctp:api:type:QuoteRequestChangeCustomerAction) update action. *

func (QuoteRequestCustomerChangedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj QuoteRequestCustomerChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteRequestCustomerChangedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *QuoteRequestCustomerChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteRequestCustomerChangedMessagePayload ¶ added in v1.3.0 

type QuoteRequestCustomerChangedMessagePayload struct {
	// The [Buyer](/../api/quotes-overview#buyer) who now owns the Quote Request.
	Customer CustomerReference `json:"customer"`
	// The previous [Buyer](/../api/quotes-overview#buyer).
	PreviousCustomer CustomerReference `json:"previousCustomer"`
}

* * Generated after a successful [Change Customer](ctp:api:type:QuoteRequestChangeCustomerAction) update action. *

func (QuoteRequestCustomerChangedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj QuoteRequestCustomerChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestDeletedMessage ¶ added in v1.2.0 

type QuoteRequestDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete QuoteRequest](/../api/projects/quote-requests#delete-quoterequest) request. *

func (QuoteRequestDeletedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteRequestDeletedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteRequestDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteRequestDeletedMessagePayload ¶ added in v1.2.0 

type QuoteRequestDeletedMessagePayload struct {
}

* * Generated after a successful [Delete QuoteRequest](/../api/projects/quote-requests#delete-quoterequest) request. *

func (QuoteRequestDeletedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestDraft ¶ added in v1.2.0 

type QuoteRequestDraft struct {
	// Cart for which a Quote is requested.
	// Anonymous Carts, Carts with [Discount Codes](ctp:api:type:DiscountCode), or Carts with a `Multiple` [ShippingMode](ctp:api:type:ShippingMode) are not supported.
	Cart CartResourceIdentifier `json:"cart"`
	// Current version of the referenced Cart.
	CartVersion int `json:"cartVersion"`
	// User-defined unique identifier for the QuoteRequest.
	Key *string `json:"key,omitempty"`
	// Message from the Buyer included in the Quote Request.
	Comment *string `json:"comment,omitempty"`
	// Custom Fields to be added to the Quote Request.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// [State](ctp:api:type:State) of the Quote Request.
	// This reference can point to a State in a custom workflow.
	State *StateReference `json:"state,omitempty"`
	// Identifier for a purchase order, usually in a B2B context.
	// The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer).
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
}

type QuoteRequestPagedQueryResponse ¶ added in v1.2.0 

type QuoteRequestPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Quote Requests matching the query.
	Results []QuoteRequest `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of QuoteRequest(ctp:api:type:QuoteRequest). *

type QuoteRequestQuoteRenegotiationAction ¶ added in v1.2.0 

type QuoteRequestQuoteRenegotiationAction struct {
	// Message from the [Buyer](/api/quotes-overview#buyer) regarding the Quote renegotiation request.
	BuyerComment *string `json:"buyerComment,omitempty"`
}

* * Represents the Buyer requesting renegotiation for a Quote. Valid for Quotes in a `Pending` [state](ctp:api:type:QuoteState). *

func (QuoteRequestQuoteRenegotiationAction) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestQuoteRenegotiationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestReference ¶ added in v1.2.0 

type QuoteRequestReference struct {
	// Unique ID of the referenced resource.
	ID string `json:"id"`
	// Contains the representation of the expanded QuoteRequest.
	// Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for QuoteRequest.
	Obj *QuoteRequest `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a QuoteRequest(ctp:api:type:QuoteRequest). *

func (QuoteRequestReference) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestResourceIdentifier ¶ added in v1.2.0 

type QuoteRequestResourceIdentifier struct {
	// Unique identifier of the referenced resource. Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced resource. Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a QuoteRequest(ctp:api:type:QuoteRequest). *

func (QuoteRequestResourceIdentifier) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestSetCustomFieldAction ¶ added in v1.2.0 

type QuoteRequestSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (QuoteRequestSetCustomFieldAction) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestSetCustomTypeAction ¶ added in v1.2.0 

type QuoteRequestSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the QuoteRequest with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the QuoteRequest.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the QuoteRequest.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (QuoteRequestSetCustomTypeAction) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestState ¶ added in v1.2.0 

type QuoteRequestState string

* * Predefined states tracking the status of the Quote Request in the negotiation process. * 

const (
	QuoteRequestStateSubmitted QuoteRequestState = "Submitted"
	QuoteRequestStateAccepted  QuoteRequestState = "Accepted"
	QuoteRequestStateClosed    QuoteRequestState = "Closed"
	QuoteRequestStateRejected  QuoteRequestState = "Rejected"
	QuoteRequestStateCancelled QuoteRequestState = "Cancelled"
)

type QuoteRequestStateChangedMessage ¶ added in v1.2.0 

type QuoteRequestStateChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// State of the Quote Request after the [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action.
	QuoteRequestState QuoteRequestState `json:"quoteRequestState"`
	// State of the Quote Request before the [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action.
	OldQuoteRequestState QuoteRequestState `json:"oldQuoteRequestState"`
}

* * Generated after a successful [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action. *

func (QuoteRequestStateChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestStateChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteRequestStateChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteRequestStateChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteRequestStateChangedMessagePayload ¶ added in v1.2.0 

type QuoteRequestStateChangedMessagePayload struct {
	// State of the Quote Request after the [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action.
	QuoteRequestState QuoteRequestState `json:"quoteRequestState"`
	// State of the Quote Request before the [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action.
	OldQuoteRequestState QuoteRequestState `json:"oldQuoteRequestState"`
}

* * Generated after a successful [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action. *

func (QuoteRequestStateChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestStateChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestStateTransitionMessage ¶ added in v1.2.0 

type QuoteRequestStateTransitionMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) after the [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action.
	State StateReference `json:"state"`
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) before the [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action. *

func (QuoteRequestStateTransitionMessage) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestStateTransitionMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteRequestStateTransitionMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteRequestStateTransitionMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteRequestStateTransitionMessagePayload ¶ added in v1.2.0 

type QuoteRequestStateTransitionMessagePayload struct {
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) after the [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action.
	State StateReference `json:"state"`
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) before the [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action. *

func (QuoteRequestStateTransitionMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestStateTransitionMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestTransitionStateAction ¶ added in v1.2.0 

type QuoteRequestTransitionStateAction struct {
	// Value to set.
	// If there is no State yet, this must be an initial State.
	State StateResourceIdentifier `json:"state"`
	// Switch validations on or off.
	Force *bool `json:"force,omitempty"`
}

* * If the existing State(ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State. If `transitions` is not set, no validation is performed. This update action produces the [Quote Request State Transition](ctp:api:type:QuoteRequestStateTransitionMessage) Message. *

func (QuoteRequestTransitionStateAction) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteRequestTransitionStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestUpdate ¶ added in v1.2.0 

type QuoteRequestUpdate struct {
	// Expected version of the [QuoteRequest](ctp:api:type:QuoteRequest) to which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the [QuoteRequest](ctp:api:type:QuoteRequest).
	Actions []QuoteRequestUpdateAction `json:"actions"`
}

func (*QuoteRequestUpdate) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteRequestUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteRequestUpdateAction ¶ added in v1.2.0 

type QuoteRequestUpdateAction interface{}

type QuoteResourceIdentifier ¶ added in v1.2.0 

type QuoteResourceIdentifier struct {
	// Unique identifier of the referenced resource. Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced resource. Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a Quote(ctp:api:type:Quote). *

func (QuoteResourceIdentifier) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteSetCustomFieldAction ¶ added in v1.2.0 

type QuoteSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (QuoteSetCustomFieldAction) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteSetCustomTypeAction ¶ added in v1.2.0 

type QuoteSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Quote with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Quote.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Quote.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (QuoteSetCustomTypeAction) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteState ¶ added in v1.2.0 

type QuoteState string

* * Predefined states tracking the status of the Quote. * 

const (
	QuoteStatePending                  QuoteState = "Pending"
	QuoteStateDeclined                 QuoteState = "Declined"
	QuoteStateDeclinedForRenegotiation QuoteState = "DeclinedForRenegotiation"
	QuoteStateRenegotiationAddressed   QuoteState = "RenegotiationAddressed"
	QuoteStateAccepted                 QuoteState = "Accepted"
	QuoteStateWithdrawn                QuoteState = "Withdrawn"
)

type QuoteStateChangedMessage ¶ added in v1.2.0 

type QuoteStateChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// State of the Quote after the [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action.
	QuoteState QuoteState `json:"quoteState"`
	// State of the Quote before the [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action.
	OldQuoteState QuoteState `json:"oldQuoteState"`
}

* * Generated after a successful [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action. *

func (QuoteStateChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteStateChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteStateChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteStateChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteStateChangedMessagePayload ¶ added in v1.2.0 

type QuoteStateChangedMessagePayload struct {
	// State of the Quote after the [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action.
	QuoteState QuoteState `json:"quoteState"`
	// State of the Quote before the [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action.
	OldQuoteState QuoteState `json:"oldQuoteState"`
}

* * Generated after a successful [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action. *

func (QuoteStateChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteStateChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteStateTransitionMessage ¶ added in v1.2.0 

type QuoteStateTransitionMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) after the [Transition State](ctp:api:type:QuoteTransitionStateAction) update action.
	State StateReference `json:"state"`
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) before the [Transition State](ctp:api:type:QuoteTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:QuoteTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:QuoteTransitionStateAction) update action. *

func (QuoteStateTransitionMessage) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteStateTransitionMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*QuoteStateTransitionMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteStateTransitionMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteStateTransitionMessagePayload ¶ added in v1.2.0 

type QuoteStateTransitionMessagePayload struct {
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) after the [Transition State](ctp:api:type:QuoteTransitionStateAction) update action.
	State StateReference `json:"state"`
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) before the [Transition State](ctp:api:type:QuoteTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:QuoteTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:QuoteTransitionStateAction) update action. *

func (QuoteStateTransitionMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteStateTransitionMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteTransitionStateAction ¶ added in v1.2.0 

type QuoteTransitionStateAction struct {
	// Value to set.
	// If there is no State yet, this must be an initial State.
	State StateResourceIdentifier `json:"state"`
	// Switch validations on or off.
	Force *bool `json:"force,omitempty"`
}

* * If the existing State(ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State. If `transitions` is not set, no validation is performed. This update action produces the [Quote State Transition](ctp:api:type:QuoteStateTransitionMessage) Message. *

func (QuoteTransitionStateAction) MarshalJSON ¶ added in v1.2.0 

func (obj QuoteTransitionStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteUpdate ¶ added in v1.2.0 

type QuoteUpdate struct {
	// Expected version of the [Quote](ctp:api:type:Quote) to which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the [Quote](ctp:api:type:Quote).
	Actions []QuoteUpdateAction `json:"actions"`
}

func (*QuoteUpdate) UnmarshalJSON ¶ added in v1.2.0 

func (obj *QuoteUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type QuoteUpdateAction ¶ added in v1.2.0 

type QuoteUpdateAction interface{}

type RangeFacetResult ¶ 

type RangeFacetResult struct {
	Ranges []FacetRange `json:"ranges"`
}

func (RangeFacetResult) MarshalJSON ¶ 

func (obj RangeFacetResult) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Reference ¶ 

type Reference interface{}

* * A Reference represents a loose reference to another resource in the same Project identified by its `id`. The `typeId` indicates the type of the referenced resource. Each resource type has its corresponding Reference type, like ChannelReference(ctp:api:type:ChannelReference). A referenced resource can be embedded through [Reference Expansion](/general-concepts#reference-expansion). The expanded reference is the value of an additional `obj` field then. *

type ReferenceExistsError ¶ 

type ReferenceExistsError struct {
	// `"Can not delete a $resource while it is referenced by at least one $referencedBy."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Type of referenced resource.
	ReferencedBy *ReferenceTypeId `json:"referencedBy,omitempty"`
}

* * Returned when a resource cannot be deleted because it is being referenced by another resource. *

func (*ReferenceExistsError) DecodeStruct ¶ added in v1.1.0 

func (obj *ReferenceExistsError) DecodeStruct(src map[string]interface{}) error

func (ReferenceExistsError) Error ¶ 

func (obj ReferenceExistsError) Error() string

func (ReferenceExistsError) MarshalJSON ¶ 

func (obj ReferenceExistsError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ReferenceExistsError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ReferenceExistsError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReferenceTypeId ¶ 

type ReferenceTypeId string

* * Type of resource the value should reference. Supported resource type identifiers are: * 

const (
	ReferenceTypeIdApprovalFlow          ReferenceTypeId = "approval-flow"
	ReferenceTypeIdApprovalRule          ReferenceTypeId = "approval-rule"
	ReferenceTypeIdAssociateRole         ReferenceTypeId = "associate-role"
	ReferenceTypeIdAttributeGroup        ReferenceTypeId = "attribute-group"
	ReferenceTypeIdBusinessUnit          ReferenceTypeId = "business-unit"
	ReferenceTypeIdCart                  ReferenceTypeId = "cart"
	ReferenceTypeIdCartDiscount          ReferenceTypeId = "cart-discount"
	ReferenceTypeIdCategory              ReferenceTypeId = "category"
	ReferenceTypeIdChannel               ReferenceTypeId = "channel"
	ReferenceTypeIdCustomer              ReferenceTypeId = "customer"
	ReferenceTypeIdCustomerEmailToken    ReferenceTypeId = "customer-email-token"
	ReferenceTypeIdCustomerGroup         ReferenceTypeId = "customer-group"
	ReferenceTypeIdCustomerPasswordToken ReferenceTypeId = "customer-password-token"
	ReferenceTypeIdDirectDiscount        ReferenceTypeId = "direct-discount"
	ReferenceTypeIdDiscountCode          ReferenceTypeId = "discount-code"
	ReferenceTypeIdExtension             ReferenceTypeId = "extension"
	ReferenceTypeIdInventoryEntry        ReferenceTypeId = "inventory-entry"
	ReferenceTypeIdKeyValueDocument      ReferenceTypeId = "key-value-document"
	ReferenceTypeIdOrder                 ReferenceTypeId = "order"
	ReferenceTypeIdOrderEdit             ReferenceTypeId = "order-edit"
	ReferenceTypeIdPayment               ReferenceTypeId = "payment"
	ReferenceTypeIdProduct               ReferenceTypeId = "product"
	ReferenceTypeIdProductDiscount       ReferenceTypeId = "product-discount"
	ReferenceTypeIdProductPrice          ReferenceTypeId = "product-price"
	ReferenceTypeIdProductSelection      ReferenceTypeId = "product-selection"
	ReferenceTypeIdProductTailoring      ReferenceTypeId = "product-tailoring"
	ReferenceTypeIdProductType           ReferenceTypeId = "product-type"
	ReferenceTypeIdQuote                 ReferenceTypeId = "quote"
	ReferenceTypeIdQuoteRequest          ReferenceTypeId = "quote-request"
	ReferenceTypeIdReview                ReferenceTypeId = "review"
	ReferenceTypeIdShippingMethod        ReferenceTypeId = "shipping-method"
	ReferenceTypeIdShoppingList          ReferenceTypeId = "shopping-list"
	ReferenceTypeIdStagedQuote           ReferenceTypeId = "staged-quote"
	ReferenceTypeIdStandalonePrice       ReferenceTypeId = "standalone-price"
	ReferenceTypeIdState                 ReferenceTypeId = "state"
	ReferenceTypeIdStore                 ReferenceTypeId = "store"
	ReferenceTypeIdSubscription          ReferenceTypeId = "subscription"
	ReferenceTypeIdTaxCategory           ReferenceTypeId = "tax-category"
	ReferenceTypeIdType                  ReferenceTypeId = "type"
	ReferenceTypeIdZone                  ReferenceTypeId = "zone"
)

type ReferencedResourceNotFoundError ¶ 

type ReferencedResourceNotFoundError struct {
	// `"The referenced object of type $typeId $predicate was not found. It either doesn't exist, or it can't be accessed from this endpoint (e.g., if the endpoint filters by store or customer account)."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Type of referenced resource.
	TypeId ReferenceTypeId `json:"typeId"`
	// Unique identifier of the referenced resource, if known.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced resource, if known.
	Key *string `json:"key,omitempty"`
}

* * Returned when a resource referenced by a Reference(ctp:api:type:Reference) or a ResourceIdentifier(ctp:api:type:ResourceIdentifier) could not be found. *

func (*ReferencedResourceNotFoundError) DecodeStruct ¶ added in v1.1.0 

func (obj *ReferencedResourceNotFoundError) DecodeStruct(src map[string]interface{}) error

func (ReferencedResourceNotFoundError) Error ¶ 

func (obj ReferencedResourceNotFoundError) Error() string

func (ReferencedResourceNotFoundError) MarshalJSON ¶ 

func (obj ReferencedResourceNotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ReferencedResourceNotFoundError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ReferencedResourceNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReplicaCartDraft ¶ 

type ReplicaCartDraft struct {
	// [Reference](ctp:api:type:Reference) to a [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order) that is replicated.
	Reference interface{} `json:"reference"`
	// User-defined unique identifier for the Cart.
	Key *string `json:"key,omitempty"`
}

* * Used for [replicating an existing Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST) or Order. *

type ReplicaMyCartDraft ¶ 

type ReplicaMyCartDraft struct {
	// [Reference](ctp:api:type:Reference) to a [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order) that is replicated.
	Reference interface{} `json:"reference"`
}

type RequiredFieldError ¶ 

type RequiredFieldError struct {
	// `"A value is required for field $field."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Name of the field missing the value.
	Field string `json:"field"`
}

* * Returned when a value is not defined for a required field. *

func (*RequiredFieldError) DecodeStruct ¶ added in v1.1.0 

func (obj *RequiredFieldError) DecodeStruct(src map[string]interface{}) error

func (RequiredFieldError) Error ¶ 

func (obj RequiredFieldError) Error() string

func (RequiredFieldError) MarshalJSON ¶ 

func (obj RequiredFieldError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*RequiredFieldError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *RequiredFieldError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ResourceCreatedDeliveryPayload ¶ 

type ResourceCreatedDeliveryPayload struct {
	// `key` of the [Project](ctp:api:type:Project).
	// Useful in message processing if the Destination receives events from multiple Projects.
	ProjectKey string `json:"projectKey"`
	// Reference to the resource that triggered the message.
	Resource Reference `json:"resource"`
	// User-defined unique identifiers of the resource.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Last seen version of the resource.
	Version int `json:"version"`
	// Date and time (UTC) the resource was last modified.
	ModifiedAt time.Time `json:"modifiedAt"`
}

* * This payload is sent for a ChangeSubscription(ctp:api:type:ChangeSubscription) when a resource is created. *

func (ResourceCreatedDeliveryPayload) MarshalJSON ¶ 

func (obj ResourceCreatedDeliveryPayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ResourceCreatedDeliveryPayload) UnmarshalJSON ¶ 

func (obj *ResourceCreatedDeliveryPayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ResourceDeletedDeliveryPayload ¶ 

type ResourceDeletedDeliveryPayload struct {
	// `key` of the [Project](ctp:api:type:Project).
	// Useful in message processing if the Destination receives events from multiple Projects.
	ProjectKey string `json:"projectKey"`
	// Reference to the resource that triggered the message.
	Resource Reference `json:"resource"`
	// User-defined unique identifiers of the resource.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Last seen version of the resource.
	Version int `json:"version"`
	// Date and time (UTC) the resource was last deleted.
	ModifiedAt time.Time `json:"modifiedAt"`
	// `true` if the `dataErasure` [parameter](/../api/gdpr#data-erasure-of-personal-data) on the `DELETE` request was set to `true`.
	DataErasure *bool `json:"dataErasure,omitempty"`
}

* * This payload is sent for a ChangeSubscription(ctp:api:type:ChangeSubscription) when a resource is deleted. *

func (ResourceDeletedDeliveryPayload) MarshalJSON ¶ 

func (obj ResourceDeletedDeliveryPayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ResourceDeletedDeliveryPayload) UnmarshalJSON ¶ 

func (obj *ResourceDeletedDeliveryPayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ResourceIdentifier ¶ 

type ResourceIdentifier interface{}

* * Draft type to create a Reference(ctp:api:type:Reference) or a KeyReference(ctp:api:type:KeyReference) to a resource. Provide either the `id` or (wherever supported) the `key` of the resource to reference, but depending on the API endpoint the response returns either a Reference or a KeyReference. For example, the field `parent` of a CategoryDraft(ctp:api:type:CategoryDraft) takes a ResourceIdentifier for its value while the value of the corresponding field of a Category(ctp:api:type:Category) is a Reference. * * Each resource type has its corresponding ResourceIdentifier, like ChannelResourceIdentifier(ctp:api:type:ChannelResourceIdentifier). *

type ResourceNotFoundError ¶ 

type ResourceNotFoundError struct {
	// `"The Resource with ID $resourceId was not found."`
	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 ¶ added in v1.1.0 

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 ¶ added in v1.1.0 

func (obj *ResourceNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ResourceSizeLimitExceededError ¶ 

type ResourceSizeLimitExceededError struct {
	// `"The resource size exceeds the maximal allowed size of 16 MB."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the resource exceeds the maximum allowed size of 16 MB. *

func (*ResourceSizeLimitExceededError) DecodeStruct ¶ added in v1.1.0 

func (obj *ResourceSizeLimitExceededError) DecodeStruct(src map[string]interface{}) error

func (ResourceSizeLimitExceededError) Error ¶ 

func (obj ResourceSizeLimitExceededError) Error() string

func (ResourceSizeLimitExceededError) MarshalJSON ¶ 

func (obj ResourceSizeLimitExceededError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ResourceSizeLimitExceededError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ResourceSizeLimitExceededError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ResourceTypeId ¶ 

type ResourceTypeId string

* * IDs indicating the [customizable resources and data types](/../api/projects/types#list-of-customizable-data-types). * 

const (
	ResourceTypeIdAddress                     ResourceTypeId = "address"
	ResourceTypeIdAsset                       ResourceTypeId = "asset"
	ResourceTypeIdApprovalFlow                ResourceTypeId = "approval-flow"
	ResourceTypeIdAssociateRole               ResourceTypeId = "associate-role"
	ResourceTypeIdBusinessUnit                ResourceTypeId = "business-unit"
	ResourceTypeIdCartDiscount                ResourceTypeId = "cart-discount"
	ResourceTypeIdCategory                    ResourceTypeId = "category"
	ResourceTypeIdChannel                     ResourceTypeId = "channel"
	ResourceTypeIdCustomer                    ResourceTypeId = "customer"
	ResourceTypeIdCustomerGroup               ResourceTypeId = "customer-group"
	ResourceTypeIdCustomLineItem              ResourceTypeId = "custom-line-item"
	ResourceTypeIdDiscountCode                ResourceTypeId = "discount-code"
	ResourceTypeIdInventoryEntry              ResourceTypeId = "inventory-entry"
	ResourceTypeIdLineItem                    ResourceTypeId = "line-item"
	ResourceTypeIdOrder                       ResourceTypeId = "order"
	ResourceTypeIdOrderEdit                   ResourceTypeId = "order-edit"
	ResourceTypeIdOrderDelivery               ResourceTypeId = "order-delivery"
	ResourceTypeIdOrderParcel                 ResourceTypeId = "order-parcel"
	ResourceTypeIdOrderReturnItem             ResourceTypeId = "order-return-item"
	ResourceTypeIdPayment                     ResourceTypeId = "payment"
	ResourceTypeIdPaymentInterfaceInteraction ResourceTypeId = "payment-interface-interaction"
	ResourceTypeIdProductPrice                ResourceTypeId = "product-price"
	ResourceTypeIdProductSelection            ResourceTypeId = "product-selection"
	ResourceTypeIdQuote                       ResourceTypeId = "quote"
	ResourceTypeIdReview                      ResourceTypeId = "review"
	ResourceTypeIdShipping                    ResourceTypeId = "shipping"
	ResourceTypeIdShippingMethod              ResourceTypeId = "shipping-method"
	ResourceTypeIdShoppingList                ResourceTypeId = "shopping-list"
	ResourceTypeIdShoppingListTextLineItem    ResourceTypeId = "shopping-list-text-line-item"
	ResourceTypeIdStandalonePrice             ResourceTypeId = "standalone-price"
	ResourceTypeIdStore                       ResourceTypeId = "store"
	ResourceTypeIdTransaction                 ResourceTypeId = "transaction"
)

type ResourceUpdatedDeliveryPayload ¶ 

type ResourceUpdatedDeliveryPayload struct {
	// `key` of the [Project](ctp:api:type:Project).
	// Useful in message processing if the Destination receives events from multiple Projects.
	ProjectKey string `json:"projectKey"`
	// Reference to the resource that triggered the message.
	Resource Reference `json:"resource"`
	// User-defined unique identifiers of the resource.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Last seen version of the resource.
	Version int `json:"version"`
	// Version of the resource before the update.
	OldVersion int `json:"oldVersion"`
	// Date and time (UTC) the resource was last updated.
	ModifiedAt time.Time `json:"modifiedAt"`
}

* * This payload is sent for a ChangeSubscription(ctp:api:type:ChangeSubscription) when a resource is updated. This includes updates by a background process, like a change in product availability. *

func (ResourceUpdatedDeliveryPayload) MarshalJSON ¶ 

func (obj ResourceUpdatedDeliveryPayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ResourceUpdatedDeliveryPayload) UnmarshalJSON ¶ 

func (obj *ResourceUpdatedDeliveryPayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReturnInfo ¶ 

type ReturnInfo struct {
	// Information on the Line Items or Custom Line Items returned.
	Items []ReturnItem `json:"items"`
	// User-defined identifier to track the return.
	ReturnTrackingId *string `json:"returnTrackingId,omitempty"`
	// Date and time (UTC) the return is initiated.
	ReturnDate *time.Time `json:"returnDate,omitempty"`
}

* * Stores information about returns connected to an Order. *

func (*ReturnInfo) UnmarshalJSON ¶ 

func (obj *ReturnInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReturnInfoAddedMessage ¶ added in v1.2.0 

type ReturnInfoAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [ReturnInfo](ctp:api:type:ReturnInfo) that was added to the [Order](ctp:api:type:Order).
	ReturnInfo ReturnInfo `json:"returnInfo"`
}

* * Generated after a successful [Add ReturnInfo](ctp:api:type:OrderAddReturnInfoAction) update action. *

func (ReturnInfoAddedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj ReturnInfoAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ReturnInfoAddedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ReturnInfoAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReturnInfoAddedMessagePayload ¶ added in v1.2.0 

type ReturnInfoAddedMessagePayload struct {
	// The [ReturnInfo](ctp:api:type:ReturnInfo) that was added to the [Order](ctp:api:type:Order).
	ReturnInfo ReturnInfo `json:"returnInfo"`
}

* * Generated after a successful [Add ReturnInfo](ctp:api:type:OrderAddReturnInfoAction) update action. *

func (ReturnInfoAddedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj ReturnInfoAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReturnInfoDraft ¶ 

type ReturnInfoDraft struct {
	// Information on the Line Items or Custom Line Items returned.
	Items []ReturnItemDraft `json:"items"`
	// User-defined identifier for tracking the return.
	ReturnTrackingId *string `json:"returnTrackingId,omitempty"`
	// Date and time (UTC) the return is initiated.
	ReturnDate *time.Time `json:"returnDate,omitempty"`
}

type ReturnInfoSetMessage ¶ added in v1.2.0 

type ReturnInfoSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [ReturnInfo](ctp:api:type:ReturnInfo) that was set on the [Order](ctp:api:type:Order) or [Order Edit](ctp:api:type:OrderEdit).
	ReturnInfo []ReturnInfo `json:"returnInfo"`
}

* * Generated after a successful [Set ReturnInfo](ctp:api:type:OrderSetReturnInfoAction) update action on [Orders](ctp:api:type:Order) and [Order Edits](ctp:api:type:OrderEdit). *

func (ReturnInfoSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj ReturnInfoSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ReturnInfoSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ReturnInfoSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReturnInfoSetMessagePayload ¶ added in v1.2.0 

type ReturnInfoSetMessagePayload struct {
	// The [ReturnInfo](ctp:api:type:ReturnInfo) that was set on the [Order](ctp:api:type:Order) or [Order Edit](ctp:api:type:OrderEdit).
	ReturnInfo []ReturnInfo `json:"returnInfo"`
}

* * Generated after a successful [Set ReturnInfo](ctp:api:type:OrderSetReturnInfoAction) update action on [Orders](ctp:api:type:Order) and [Order Edits](ctp:api:type:OrderEdit). *

func (ReturnInfoSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj ReturnInfoSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReturnItem ¶ 

type ReturnItem interface{}

type ReturnItemDraft ¶ 

type ReturnItemDraft struct {
	// User-defined unique identifier of the Return Item.
	Key *string `json:"key,omitempty"`
	// Number of Line Items or Custom Line Items to return.
	Quantity int `json:"quantity"`
	// `id` of the [LineItem](ctp:api:type:LineItem) to return.
	//
	//  Required if Line Items are returned, to create a [LineItemReturnItem](ctp:api:type:LineItemReturnItem).
	LineItemId *string `json:"lineItemId,omitempty"`
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to return.
	//
	//  Required if Custom Line Items are returned, to create a [CustomLineItemReturnItem](ctp:api:type:CustomLineItemReturnItem).
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// User-defined description for the return.
	Comment *string `json:"comment,omitempty"`
	// Shipment status of the item to be returned.
	// Can either be `Advised` or `Returned` only.
	ShipmentState ReturnShipmentState `json:"shipmentState"`
	// Custom Fields for the Return Item.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

type ReturnPaymentState ¶ 

type ReturnPaymentState string
const (
	ReturnPaymentStateNonRefundable ReturnPaymentState = "NonRefundable"
	ReturnPaymentStateInitial       ReturnPaymentState = "Initial"
	ReturnPaymentStateRefunded      ReturnPaymentState = "Refunded"
	ReturnPaymentStateNotRefunded   ReturnPaymentState = "NotRefunded"
)

type ReturnShipmentState ¶ 

type ReturnShipmentState string
const (
	ReturnShipmentStateAdvised     ReturnShipmentState = "Advised"
	ReturnShipmentStateReturned    ReturnShipmentState = "Returned"
	ReturnShipmentStateBackInStock ReturnShipmentState = "BackInStock"
	ReturnShipmentStateUnusable    ReturnShipmentState = "Unusable"
)

type Review ¶ 

type Review struct {
	// Unique identifier of the Review.
	ID string `json:"id"`
	// Current version of the Review.
	Version int `json:"version"`
	// Date and time (UTC) the Review was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Review was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the Review.
	Key *string `json:"key,omitempty"`
	// Must be unique among Reviews. For example, if this value is set to Customer `id` + Product `id`, only one Review per Customer and per Product is allowed.
	UniquenessValue *string `json:"uniquenessValue,omitempty"`
	// Language in which the content of the Review is written.
	Locale *string `json:"locale,omitempty"`
	// Name of the author.
	AuthorName *string `json:"authorName,omitempty"`
	// Title of the Review.
	Title *string `json:"title,omitempty"`
	// Content of the Review.
	Text *string `json:"text,omitempty"`
	// Identifies the target of the Review. Can be a [Product](ctp:api:type:Product) or a [Channel](ctp:api:type:Channel), specified as [ProductReference](ctp:api:type:ProductReference) or [ChannelReference](ctp:api:type:ChannelReference), respectively.
	Target interface{} `json:"target,omitempty"`
	// Indicates if this Review is taken into account in the ratings statistics of the target.
	// A Review is per default used in the statistics, unless the Review is in a state that does not have the [role](ctp:api:type:StateRoleEnum) `ReviewIncludedInStatistics`.
	// If the role of a [State](ctp:api:type:State) is modified after the calculation of this field, the calculation is not updated.
	IncludedInStatistics bool `json:"includedInStatistics"`
	// Rating of the Product or Channel.
	Rating *int `json:"rating,omitempty"`
	// State of the Review. Used for approval processes, see [Review approval process](/../tutorials/review-ratings#review-approval-process) for details.
	State *StateReference `json:"state,omitempty"`
	// Customer who created the Review.
	Customer *CustomerReference `json:"customer,omitempty"`
	// Custom Fields of the Review.
	Custom *CustomFields `json:"custom,omitempty"`
}

type ReviewCreatedMessage ¶ 

type ReviewCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Review](ctp:api:type:Review) that was created.
	Review Review `json:"review"`
}

* * Generated after a successful [Create Review](ctp:api:endpoint:/{projectKey}/reviews:POST) request. *

func (ReviewCreatedMessage) MarshalJSON ¶ 

func (obj ReviewCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ReviewCreatedMessage) UnmarshalJSON ¶ 

func (obj *ReviewCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReviewCreatedMessagePayload ¶ 

type ReviewCreatedMessagePayload struct {
	// [Review](ctp:api:type:Review) that was created.
	Review Review `json:"review"`
}

* * Generated after a successful [Create Review](ctp:api:endpoint:/{projectKey}/reviews:POST) request. *

func (ReviewCreatedMessagePayload) MarshalJSON ¶ 

func (obj ReviewCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewDraft ¶ 

type ReviewDraft struct {
	// User-defined unique identifier for the Review.
	Key *string `json:"key,omitempty"`
	// If set, this value must be unique among Reviews.
	// For example, if you want to have only one Review per Customer and per Product, you can set the value to Customer `id` + Product `id`.
	UniquenessValue *string `json:"uniquenessValue,omitempty"`
	// Language in which the content of the Review is written.
	Locale *string `json:"locale,omitempty"`
	// Name of the author.
	AuthorName *string `json:"authorName,omitempty"`
	// Title of the Review.
	Title *string `json:"title,omitempty"`
	// Content of the Review.
	Text *string `json:"text,omitempty"`
	// Identifies the target of the Review. Can be a [Product](ctp:api:type:Product) or a [Channel](ctp:api:type:Channel), specified as [ProductResourceIdentifier](ctp:api:type:ProductResourceIdentifier) or [ChannelResourceIdentifier](ctp:api:type:ChannelResourceIdentifier), respectively.
	Target interface{} `json:"target,omitempty"`
	// State of the Review. Used for approval processes, see [Review approval process](/../tutorials/review-ratings#review-approval-process) for details.
	State *StateResourceIdentifier `json:"state,omitempty"`
	// Rating of the targeted Product or Channel.
	// This rating can represent the number of stars, a percentage, or a like (+1)/dislike (-1).
	// A rating is used in the ratings statistics of the targeted object, unless the Review is in a State that does not have the role `ReviewIncludedInStatistics`.
	Rating *int `json:"rating,omitempty"`
	// Customer who created the Review.
	Customer *CustomerResourceIdentifier `json:"customer,omitempty"`
	// Custom Fields for the Review.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * When creating a new Review, at least one of `title`, `text` or `rating` should be set. *

type ReviewPagedQueryResponse ¶ 

type ReviewPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// [Reviews](ctp:api:type:Review) matching the query.
	Results []Review `json:"results"`
}

type ReviewRatingSetMessage ¶ 

type ReviewRatingSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `rating` of the [Review](ctp:api:type:Review) before the [Set Rating](ctp:api:type:ReviewSetRatingAction) update action.
	OldRating *float64 `json:"oldRating,omitempty"`
	// The `rating` of the [Review](ctp:api:type:Review) after the [Set Rating](ctp:api:type:ReviewSetRatingAction) update action.
	NewRating *float64 `json:"newRating,omitempty"`
	// Whether the [Review](ctp:api:type:Review) was taken into account in the ratings statistics of the target.
	IncludedInStatistics bool `json:"includedInStatistics"`
	// [Reference](ctp:api:type:Reference) to the resource that the [Review](ctp:api:type:Review) belongs to.
	Target Reference `json:"target,omitempty"`
}

* * Generated after a successful [Set Rating](ctp:api:type:ReviewSetRatingAction) update action. *

func (ReviewRatingSetMessage) MarshalJSON ¶ 

func (obj ReviewRatingSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ReviewRatingSetMessage) UnmarshalJSON ¶ 

func (obj *ReviewRatingSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReviewRatingSetMessagePayload ¶ 

type ReviewRatingSetMessagePayload struct {
	// The `rating` of the [Review](ctp:api:type:Review) before the [Set Rating](ctp:api:type:ReviewSetRatingAction) update action.
	OldRating *float64 `json:"oldRating,omitempty"`
	// The `rating` of the [Review](ctp:api:type:Review) after the [Set Rating](ctp:api:type:ReviewSetRatingAction) update action.
	NewRating *float64 `json:"newRating,omitempty"`
	// Whether the [Review](ctp:api:type:Review) was taken into account in the ratings statistics of the target.
	IncludedInStatistics bool `json:"includedInStatistics"`
	// [Reference](ctp:api:type:Reference) to the resource that the [Review](ctp:api:type:Review) belongs to.
	Target Reference `json:"target,omitempty"`
}

* * Generated after a successful [Set Rating](ctp:api:type:ReviewSetRatingAction) update action. *

func (ReviewRatingSetMessagePayload) MarshalJSON ¶ 

func (obj ReviewRatingSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ReviewRatingSetMessagePayload) UnmarshalJSON ¶ 

func (obj *ReviewRatingSetMessagePayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReviewRatingStatistics ¶ 

type ReviewRatingStatistics struct {
	// Average rating of one target
	// This number is rounded with 5 decimals.
	AverageRating float64 `json:"averageRating"`
	// Highest rating of one target
	HighestRating float64 `json:"highestRating"`
	// Lowest rating of one target
	LowestRating float64 `json:"lowestRating"`
	// Number of ratings taken into account
	Count int `json:"count"`
	// Full distribution of the ratings.
	// The keys are the different ratings and the values are the count of reviews having this rating.
	// Only the used ratings appear in this object.
	RatingsDistribution interface{} `json:"ratingsDistribution"`
}

type ReviewReference ¶ 

type ReviewReference struct {
	// Unique identifier of the referenced [Review](ctp:api:type:Review).
	ID string `json:"id"`
	// Contains the representation of the expanded Review. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Reviews.
	Obj *Review `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Review(ctp:api:type:Review). *

func (ReviewReference) MarshalJSON ¶ 

func (obj ReviewReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewResourceIdentifier ¶ 

type ReviewResourceIdentifier struct {
	// Unique identifier of the referenced [Review](ctp:api:type:Review). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [Review](ctp:api:type:Review). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a Review(ctp:api:type:Review). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (ReviewResourceIdentifier) MarshalJSON ¶ 

func (obj ReviewResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetAuthorNameAction ¶ 

type ReviewSetAuthorNameAction struct {
	// Value to set. If empty, any existing value will be removed.
	AuthorName *string `json:"authorName,omitempty"`
}

func (ReviewSetAuthorNameAction) MarshalJSON ¶ 

func (obj ReviewSetAuthorNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetCustomFieldAction ¶ 

type ReviewSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (ReviewSetCustomFieldAction) MarshalJSON ¶ 

func (obj ReviewSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetCustomTypeAction ¶ 

type ReviewSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Review with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Review.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Review.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ReviewSetCustomTypeAction) MarshalJSON ¶ 

func (obj ReviewSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetCustomerAction ¶ 

type ReviewSetCustomerAction struct {
	// Value to set. If empty, any existing value will be removed.
	Customer *CustomerResourceIdentifier `json:"customer,omitempty"`
}

func (ReviewSetCustomerAction) MarshalJSON ¶ 

func (obj ReviewSetCustomerAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetKeyAction ¶ 

type ReviewSetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (ReviewSetKeyAction) MarshalJSON ¶ 

func (obj ReviewSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetLocaleAction ¶ 

type ReviewSetLocaleAction struct {
	// Value to set. If empty, any existing value will be removed.
	Locale *string `json:"locale,omitempty"`
}

func (ReviewSetLocaleAction) MarshalJSON ¶ 

func (obj ReviewSetLocaleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetRatingAction ¶ 

type ReviewSetRatingAction struct {
	// Value to set. If empty, any existing value will be removed.
	Rating *int `json:"rating,omitempty"`
}

* * This update action produces the [ReviewRatingSet](ctp:api:type:ReviewRatingSetMessage) Message. *

func (ReviewSetRatingAction) MarshalJSON ¶ 

func (obj ReviewSetRatingAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetTargetAction ¶ 

type ReviewSetTargetAction struct {
	// Value to set, specified as [ProductResourceIdentifier](ctp:api:type:ProductResourceIdentifier) or [ChannelResourceIdentifier](ctp:api:type:ChannelResourceIdentifier), respectively. If empty, any existing value will be removed.
	Target interface{} `json:"target"`
}

func (ReviewSetTargetAction) MarshalJSON ¶ 

func (obj ReviewSetTargetAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetTextAction ¶ 

type ReviewSetTextAction struct {
	// Value to set. If empty, any existing value will be removed.
	Text *string `json:"text,omitempty"`
}

func (ReviewSetTextAction) MarshalJSON ¶ 

func (obj ReviewSetTextAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewSetTitleAction ¶ 

type ReviewSetTitleAction struct {
	// Value to set. If empty, any existing value will be removed.
	Title *string `json:"title,omitempty"`
}

func (ReviewSetTitleAction) MarshalJSON ¶ 

func (obj ReviewSetTitleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewStateTransitionMessage ¶ 

type ReviewStateTransitionMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [State](ctp:api:type:State) of the [Review](ctp:api:type:Review) before the [Transition State](ctp:api:type:ReviewTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// [State](ctp:api:type:State) of the [Review](ctp:api:type:Review) after the [Transition State](ctp:api:type:ReviewTransitionStateAction) update action.
	NewState StateReference `json:"newState"`
	// Whether the old [Review](ctp:api:type:Review) was taken into account in the rating statistics of the target before the state transition.
	OldIncludedInStatistics bool `json:"oldIncludedInStatistics"`
	// Whether the new [Review](ctp:api:type:Review) was taken into account in the rating statistics of the target after the state transition.
	NewIncludedInStatistics bool `json:"newIncludedInStatistics"`
	// [Reference](ctp:api:type:Reference) to the resource that the [Review](ctp:api:type:Review) belongs to.
	Target Reference `json:"target,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:ReviewTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:ReviewTransitionStateAction) update action. *

func (ReviewStateTransitionMessage) MarshalJSON ¶ 

func (obj ReviewStateTransitionMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ReviewStateTransitionMessage) UnmarshalJSON ¶ 

func (obj *ReviewStateTransitionMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReviewStateTransitionMessagePayload ¶ 

type ReviewStateTransitionMessagePayload struct {
	// [State](ctp:api:type:State) of the [Review](ctp:api:type:Review) before the [Transition State](ctp:api:type:ReviewTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// [State](ctp:api:type:State) of the [Review](ctp:api:type:Review) after the [Transition State](ctp:api:type:ReviewTransitionStateAction) update action.
	NewState StateReference `json:"newState"`
	// Whether the old [Review](ctp:api:type:Review) was taken into account in the rating statistics of the target before the state transition.
	OldIncludedInStatistics bool `json:"oldIncludedInStatistics"`
	// Whether the new [Review](ctp:api:type:Review) was taken into account in the rating statistics of the target after the state transition.
	NewIncludedInStatistics bool `json:"newIncludedInStatistics"`
	// [Reference](ctp:api:type:Reference) to the resource that the [Review](ctp:api:type:Review) belongs to.
	Target Reference `json:"target,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:ReviewTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:ReviewTransitionStateAction) update action. *

func (ReviewStateTransitionMessagePayload) MarshalJSON ¶ 

func (obj ReviewStateTransitionMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ReviewStateTransitionMessagePayload) UnmarshalJSON ¶ 

func (obj *ReviewStateTransitionMessagePayload) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReviewTransitionStateAction ¶ 

type ReviewTransitionStateAction struct {
	// Value to set. If there is no State yet, the new State must be an initial State. If the existing State has `transitions` set, there must be a direct transition to the new State. If `transitions` is not set, no validation is performed. If the new State does not have the [role](ctp:api:type:StateRoleEnum) `ReviewIncludedInStatistics`, the Review is not taken into account in the ratings statistics of the target.
	State StateResourceIdentifier `json:"state"`
	// Switch validations on or off.
	Force *bool `json:"force,omitempty"`
}

* * Transition to a new State. This update action produces the [Review State Transition](ctp:api:type:ReviewStateTransitionMessage) Message. *

func (ReviewTransitionStateAction) MarshalJSON ¶ 

func (obj ReviewTransitionStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewUpdate ¶ 

type ReviewUpdate struct {
	// The expected version of the review on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.
	Version int `json:"version"`
	// The list of update actions to be performed on the review.
	Actions []ReviewUpdateAction `json:"actions"`
}

func (*ReviewUpdate) UnmarshalJSON ¶ 

func (obj *ReviewUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ReviewUpdateAction ¶ 

type ReviewUpdateAction interface{}

type RoundingMode ¶ 

type RoundingMode string

* * Determines how monetary values are rounded. * 

const (
	RoundingModeHalfEven RoundingMode = "HalfEven"
	RoundingModeHalfUp   RoundingMode = "HalfUp"
	RoundingModeHalfDown RoundingMode = "HalfDown"
)

type RuleApprover ¶ added in v1.4.0 

type RuleApprover struct {
	// The Associate Role that is allowed to approve at a given stage in the approval process.
	AssociateRole AssociateRoleKeyReference `json:"associateRole"`
}

type RuleApproverDraft ¶ added in v1.4.0 

type RuleApproverDraft struct {
	// Any Associate with this Role can approve.
	AssociateRole AssociateRoleResourceIdentifier `json:"associateRole"`
}

type RuleRequester ¶ added in v1.4.0 

type RuleRequester struct {
	// The [Associate Role](ctp:api:type:AssociateRole) that an [Associate](ctp:api:type) must hold for the Approval Rule to apply to the Orders they create.
	AssociateRole AssociateRoleKeyReference `json:"associateRole"`
}

type RuleRequesterDraft ¶ added in v1.4.0 

type RuleRequesterDraft struct {
	// The [Associate Role](ctp:api:type:AssociateRole) that an [Associate](ctp:api:type) must hold for the Approval Rule to apply to the Orders they create.
	AssociateRole AssociateRoleResourceIdentifier `json:"associateRole"`
}

type ScopedPrice ¶ 

type ScopedPrice struct {
	// Platform-generated unique identifier of the Price.
	ID string `json:"id"`
	// Original value of the Price.
	Value TypedMoney `json:"value"`
	// If available, either the original price `value` or `discounted` value.
	CurrentValue TypedMoney `json:"currentValue"`
	// Country code of the geographic location.
	Country *string `json:"country,omitempty"`
	// Reference to a CustomerGroup.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// Reference to a Channel.
	Channel *ChannelReference `json:"channel,omitempty"`
	// Date and time from which the Price is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date and time until which the Price is valid.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Is set when a matching [ProductDiscount](ctp:api:type:ProductDiscount) exists. If set, the [Cart](ctp:api:type:Cart) uses the discounted value for the [Cart Price calculation](ctp:api:type:CartAddLineItemAction).
	//
	// When a [relative Product Discount](ctp:api:type:ProductDiscountValueRelative) is applied and the fractional part of the discounted Price is 0.5, the discounted Price is [rounded half down](https://en.wikipedia.org/wiki/Rounding#Round_half_down) in favor of the Customer.
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
	// Custom Fields for the Price.
	Custom *CustomFields `json:"custom,omitempty"`
}

* * Scoped Price is contained in a ProductVariant(ctp:api:type:ProductVariant) which is returned in response to a * [Product Projection Search](ctp:api:type:ProductProjectionSearchFilterScopedPrice) request when [Scoped Price Search](ctp:api:type:ScopedPriceSearch) is used. *

func (*ScopedPrice) UnmarshalJSON ¶ 

func (obj *ScopedPrice) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ScoreShippingRateInput ¶ 

type ScoreShippingRateInput struct {
	// Abstract value for categorizing a Cart.
	Score int `json:"score"`
}

func (ScoreShippingRateInput) MarshalJSON ¶ 

func (obj ScoreShippingRateInput) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ScoreShippingRateInputDraft ¶ 

type ScoreShippingRateInputDraft struct {
	// Abstract value for categorizing a Cart.
	Score int `json:"score"`
}

func (ScoreShippingRateInputDraft) MarshalJSON ¶ 

func (obj ScoreShippingRateInputDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SearchDeactivatedError ¶ 

type SearchDeactivatedError struct {
	// `"The endpoint is deactivated for this project. Please enable it via the Project endpoint, via the Merchant Center in the Project settings, or reach out to Support to enable it."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the indexing of Product information is deactivated in a Project. * * To activate indexing, call [Change Product Search Indexing Enabled](ctp:api:type:ProjectChangeProductSearchIndexingEnabledAction) and set `enabled` to `true`. *

func (*SearchDeactivatedError) DecodeStruct ¶ added in v1.1.0 

func (obj *SearchDeactivatedError) DecodeStruct(src map[string]interface{}) error

func (SearchDeactivatedError) Error ¶ 

func (obj SearchDeactivatedError) Error() string

func (SearchDeactivatedError) MarshalJSON ¶ 

func (obj SearchDeactivatedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*SearchDeactivatedError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *SearchDeactivatedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SearchExecutionFailureError ¶ 

type SearchExecutionFailureError struct {
	// `"Something went wrong during the search query execution. In most case this happens due to usage of non-existing fields and custom product attributes. Please verify all filters and facets in your search query and make sure that all paths are correct."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a search query could not be completed due to an unexpected failure. *

func (*SearchExecutionFailureError) DecodeStruct ¶ added in v1.1.0 

func (obj *SearchExecutionFailureError) DecodeStruct(src map[string]interface{}) error

func (SearchExecutionFailureError) Error ¶ 

func (obj SearchExecutionFailureError) Error() string

func (SearchExecutionFailureError) MarshalJSON ¶ 

func (obj SearchExecutionFailureError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*SearchExecutionFailureError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *SearchExecutionFailureError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SearchFacetPathNotFoundError ¶ 

type SearchFacetPathNotFoundError struct {
	// `"Facet path $path not found."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a search facet path could not be found. *

func (*SearchFacetPathNotFoundError) DecodeStruct ¶ added in v1.1.0 

func (obj *SearchFacetPathNotFoundError) DecodeStruct(src map[string]interface{}) error

func (SearchFacetPathNotFoundError) Error ¶ 

func (obj SearchFacetPathNotFoundError) Error() string

func (SearchFacetPathNotFoundError) MarshalJSON ¶ 

func (obj SearchFacetPathNotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*SearchFacetPathNotFoundError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *SearchFacetPathNotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SearchIndexingConfiguration ¶ 

type SearchIndexingConfiguration struct {
	// Configuration for the [Product Projection Search](/../api/projects/products-search) and [Product Suggestions](/../api/projects/products-suggestions) endpoints.
	Products *SearchIndexingConfigurationValues `json:"products,omitempty"`
	// Configuration for the [Order Search](/../api/projects/order-search) feature.
	Orders *SearchIndexingConfigurationValues `json:"orders,omitempty"`
}

* * Controls indexing of resources to be provided on high performance read-only search endpoints. *

type SearchIndexingConfigurationStatus ¶ 

type SearchIndexingConfigurationStatus string

* * Status of resource indexing. 

const (
	SearchIndexingConfigurationStatusActivated   SearchIndexingConfigurationStatus = "Activated"
	SearchIndexingConfigurationStatusDeactivated SearchIndexingConfigurationStatus = "Deactivated"
	SearchIndexingConfigurationStatusIndexing    SearchIndexingConfigurationStatus = "Indexing"
)

type SearchIndexingConfigurationValues ¶ 

type SearchIndexingConfigurationValues struct {
	// Current status of resource indexing. Present on Projects from 1 February 2019.
	Status *SearchIndexingConfigurationStatus `json:"status,omitempty"`
	// Date and time (UTC) the Project was last updated. Only present on Projects last modified after 1 February 2019.
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
}

type SearchIndexingInProgressError ¶ 

type SearchIndexingInProgressError struct {
	// `"The indexing is currently in progress. Please wait until the status is "Activated" to execute search requests."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the indexing of Product information is still in progress for Projects that have indexing activated. *

func (*SearchIndexingInProgressError) DecodeStruct ¶ added in v1.1.0 

func (obj *SearchIndexingInProgressError) DecodeStruct(src map[string]interface{}) error

func (SearchIndexingInProgressError) Error ¶ 

func (obj SearchIndexingInProgressError) Error() string

func (SearchIndexingInProgressError) MarshalJSON ¶ 

func (obj SearchIndexingInProgressError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*SearchIndexingInProgressError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *SearchIndexingInProgressError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SearchKeyword ¶ 

type SearchKeyword struct {
	// Text to return in the result of a [suggest query](ctp:api:type:ProductSuggestionsSuggestQuery).
	Text string `json:"text"`
	// If no tokenizer is defined, the `text` is used as a single token.
	SuggestTokenizer SuggestTokenizer `json:"suggestTokenizer,omitempty"`
}

func (*SearchKeyword) UnmarshalJSON ¶ 

func (obj *SearchKeyword) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SearchKeywords ¶ 

type SearchKeywords map[string][]SearchKeyword

* * Search keywords are JSON objects primarily used by [Product Suggestions](ctp:api:type:ProductSuggestions), but are also considered for a full text search. The keys are of type [Locale](ctp:api:type:Locale), and the values are an array of SearchKeyword(ctp:api:type:SearchKeyword). *

type SelectionMode ¶ 

type SelectionMode string

* * Defines which matching items are to be discounted. * 

const (
	SelectionModeCheapest      SelectionMode = "Cheapest"
	SelectionModeMostExpensive SelectionMode = "MostExpensive"
)

type SemanticErrorError ¶ 

type SemanticErrorError struct {
	// Plain text description of the error concerning the predicate. For example, `"Invalid country code $countryCode provided for the field $fieldDefinition."`.
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a [Discount predicate](/../api/predicates/predicate-operators) or [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions) is not semantically correct. *

func (*SemanticErrorError) DecodeStruct ¶ added in v1.1.0 

func (obj *SemanticErrorError) DecodeStruct(src map[string]interface{}) error

func (SemanticErrorError) Error ¶ 

func (obj SemanticErrorError) Error() string

func (SemanticErrorError) MarshalJSON ¶ 

func (obj SemanticErrorError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*SemanticErrorError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *SemanticErrorError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SetUserAgentTransport ¶ added in v1.0.1 

type SetUserAgentTransport struct {
	T http.RoundTripper
	// contains filtered or unexported fields
}

func (*SetUserAgentTransport) RoundTrip ¶ added in v1.0.1 

func (sat *SetUserAgentTransport) RoundTrip(req *http.Request) (*http.Response, error)

type ShipmentState ¶ 

type ShipmentState string

* * Indicates the shipment status of the Order. * 

const (
	ShipmentStateShipped   ShipmentState = "Shipped"
	ShipmentStateDelivered ShipmentState = "Delivered"
	ShipmentStateReady     ShipmentState = "Ready"
	ShipmentStatePending   ShipmentState = "Pending"
	ShipmentStateDelayed   ShipmentState = "Delayed"
	ShipmentStatePartial   ShipmentState = "Partial"
	ShipmentStateBackorder ShipmentState = "Backorder"
)

type Shipping ¶ added in v1.2.0 

type Shipping struct {
	// User-defined unique identifier of the Shipping in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey string `json:"shippingKey"`
	// Automatically set when the [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).
	ShippingInfo ShippingInfo `json:"shippingInfo"`
	// Determines the shipping rates and Tax Rates of associated Line Items.
	ShippingAddress Address `json:"shippingAddress"`
	// Used as an input to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it is [ClassificationShippingRateInput](ctp:api:type:ClassificationShippingRateInput).
	// - If `CartScore`, it is [ScoreShippingRateInput](ctp:api:type:ScoreShippingRateInput).
	// - If `CartValue`, it cannot be used.
	ShippingRateInput ShippingRateInput `json:"shippingRateInput,omitempty"`
	// Custom Fields of Shipping with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingCustomFields *CustomFields `json:"shippingCustomFields,omitempty"`
}

func (*Shipping) UnmarshalJSON ¶ added in v1.2.0 

func (obj *Shipping) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ShippingDraft ¶ added in v1.2.0 

type ShippingDraft struct {
	// User-defined unique identifier for the Shipping in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	Key string `json:"key"`
	// Shipping Methods added to the Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingMethod *ShippingMethodReference `json:"shippingMethod,omitempty"`
	// Determines the shipping rate and Tax Rate of the associated Line Items.
	ShippingAddress BaseAddress `json:"shippingAddress"`
	// Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it must be [ClassificationShippingRateInputDraft](ctp:api:type:ClassificationShippingRateInputDraft).
	// - If `CartScore`, it must be [ScoreShippingRateInputDraft](ctp:api:type:ScoreShippingRateInputDraft).
	// - If `CartValue`, it cannot be set.
	ShippingRateInput ShippingRateInputDraft `json:"shippingRateInput,omitempty"`
	// Tax Rate used for taxing a shipping expense if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Deliveries to be shipped with the Shipping Method.
	Deliveries []DeliveryDraft `json:"deliveries"`
	// Custom Fields for Shipping.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * Wraps all shipping-related information (such as address, rate, deliveries) per Shipping Method for Carts with multiple Shipping Methods. *

func (ShippingDraft) MarshalJSON ¶ added in v1.3.0 

func (obj ShippingDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ShippingDraft) UnmarshalJSON ¶ added in v1.2.0 

func (obj *ShippingDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ShippingInfo ¶ 

type ShippingInfo struct {
	// Name of the Shipping Method.
	ShippingMethodName string `json:"shippingMethodName"`
	// Determined based on the [ShippingRate](ctp:api:type:ShippingRate) and its tiered prices, and either the sum of [LineItem](ctp:api:type:LineItem) prices or the `shippingRateInput` field.
	Price CentPrecisionMoney `json:"price"`
	// Used to determine the price.
	ShippingRate ShippingRate `json:"shippingRate"`
	// Automatically set after the `taxRate` is set.
	TaxedPrice *TaxedItemPrice `json:"taxedPrice,omitempty"`
	// Automatically set in the `Platform` [TaxMode](ctp:api:type:TaxMode) after the [shipping address is set](ctp:api:type:CartSetShippingAddressAction).
	//
	// For the `External` [TaxMode](ctp:api:type:TaxMode) the Tax Rate must be set explicitly with the [ExternalTaxRateDraft](ctp:api:type:ExternalTaxRateDraft).
	TaxRate *TaxRate `json:"taxRate,omitempty"`
	// Used to select a Tax Rate when a Cart has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	TaxCategory *TaxCategoryReference `json:"taxCategory,omitempty"`
	// Not set if a custom Shipping Method is used.
	ShippingMethod *ShippingMethodReference `json:"shippingMethod,omitempty"`
	// Information on how items are delivered to customers.
	Deliveries []Delivery `json:"deliveries"`
	// Discounted price of the Shipping Method.
	DiscountedPrice *DiscountedLineItemPrice `json:"discountedPrice,omitempty"`
	// Indicates whether the [ShippingMethod](ctp:api:type:ShippingMethod) referenced in this ShippingInfo is allowed for the Cart.
	ShippingMethodState ShippingMethodState `json:"shippingMethodState"`
}

func (ShippingInfo) MarshalJSON ¶ 

func (obj ShippingInfo) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingInfoImportDraft ¶ 

type ShippingInfoImportDraft struct {
	// Name of the Shipping Method.
	ShippingMethodName string `json:"shippingMethodName"`
	// The base price for the Shipping Method.
	Price Money `json:"price"`
	// Shipping rate information for the Order.
	ShippingRate ShippingRateDraft `json:"shippingRate"`
	// Include a Tax Rate for the Shipping Method.
	TaxRate *TaxRate `json:"taxRate,omitempty"`
	// Include a value to associate a Tax Category with the shipping information.
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// Include a value to associate a Shipping Method with the Order.
	ShippingMethod *ShippingMethodResourceIdentifier `json:"shippingMethod,omitempty"`
	// Information on how items are to be delivered to customers.
	Deliveries []DeliveryDraft `json:"deliveries"`
	// Discounted Price of the Shipping Method.
	DiscountedPrice *DiscountedLineItemPriceDraft `json:"discountedPrice,omitempty"`
	// Indicates if the [ShippingMethod](ctp:api:type:ShippingMethod) referenced is allowed for the Order or not.
	ShippingMethodState *ShippingMethodState `json:"shippingMethodState,omitempty"`
}

* * Becomes the `shippingInfo` of the imported Order. *

func (ShippingInfoImportDraft) MarshalJSON ¶ 

func (obj ShippingInfoImportDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethod ¶ 

type ShippingMethod struct {
	// Unique identifier of the ShippingMethod.
	ID string `json:"id"`
	// Current version of the ShippingMethod.
	Version int `json:"version"`
	// Date and time (UTC) the ShippingMethod was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the ShippingMethod was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the ShippingMethod.
	Key *string `json:"key,omitempty"`
	// Unique name of the ShippingMethod within a [Project](ctp:api:type:Project).
	Name string `json:"name"`
	// Localized name of the ShippingMethod.
	LocalizedName *LocalizedString `json:"localizedName,omitempty"`
	// Description of the ShippingMethod.
	Description *string `json:"description,omitempty"`
	// Localized description of the ShippingMethod.
	LocalizedDescription *LocalizedString `json:"localizedDescription,omitempty"`
	// [TaxCategory](ctp:api:type:TaxCategory) of all ZoneRates of the ShippingMethod.
	TaxCategory TaxCategoryReference `json:"taxCategory"`
	// Defines [ShippingRates](ctp:api:type:ShippingRate) (prices) for specific Zones.
	ZoneRates []ZoneRate `json:"zoneRates"`
	// If `true` this ShippingMethod is the [Project](ctp:api:type:Project)'s default ShippingMethod.
	IsDefault bool `json:"isDefault"`
	// Valid [Cart predicate](/projects/predicates#cart-predicates) to select a ShippingMethod for a Cart.
	Predicate *string `json:"predicate,omitempty"`
	// Custom Fields of the ShippingMethod.
	Custom *CustomFields `json:"custom,omitempty"`
}

type ShippingMethodAddShippingRateAction ¶ 

type ShippingMethodAddShippingRateAction struct {
	// [Zone](ctp:api:type:Zone) to which the ShippingRate should be added.
	Zone ZoneResourceIdentifier `json:"zone"`
	// Value to add to `shippingRates`.
	ShippingRate ShippingRateDraft `json:"shippingRate"`
}

func (ShippingMethodAddShippingRateAction) MarshalJSON ¶ 

func (obj ShippingMethodAddShippingRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodAddZoneAction ¶ 

type ShippingMethodAddZoneAction struct {
	// Value to add to `zoneRates`.
	Zone ZoneResourceIdentifier `json:"zone"`
}

func (ShippingMethodAddZoneAction) MarshalJSON ¶ 

func (obj ShippingMethodAddZoneAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodChangeIsDefaultAction ¶ 

type ShippingMethodChangeIsDefaultAction struct {
	// Value to set. Only one ShippingMethod can be default in a [Project](ctp:api:type:Project).
	IsDefault bool `json:"isDefault"`
}

func (ShippingMethodChangeIsDefaultAction) MarshalJSON ¶ 

func (obj ShippingMethodChangeIsDefaultAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodChangeNameAction ¶ 

type ShippingMethodChangeNameAction struct {
	// Unique value to set within a [Project](ctp:api:type:Project). Must not be empty.
	Name string `json:"name"`
}

func (ShippingMethodChangeNameAction) MarshalJSON ¶ 

func (obj ShippingMethodChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodChangeTaxCategoryAction ¶ 

type ShippingMethodChangeTaxCategoryAction struct {
	// Value to set.
	TaxCategory TaxCategoryResourceIdentifier `json:"taxCategory"`
}

func (ShippingMethodChangeTaxCategoryAction) MarshalJSON ¶ 

func (obj ShippingMethodChangeTaxCategoryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodDoesNotMatchCartError ¶ 

type ShippingMethodDoesNotMatchCartError struct {
	// `"The predicate does not match the cart."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when the Cart contains a ShippingMethod(ctp:api:type:ShippingMethod) that is not allowed for the Cart(ctp:api:type:Cart). In this case, the ShippingMethodState(ctp:api:type:ShippingMethodState) value is `DoesNotMatchCart`. * * The error is returned as a failed response to the [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) or [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. *

func (*ShippingMethodDoesNotMatchCartError) DecodeStruct ¶ added in v1.1.0 

func (obj *ShippingMethodDoesNotMatchCartError) DecodeStruct(src map[string]interface{}) error

func (ShippingMethodDoesNotMatchCartError) Error ¶ 

func (obj ShippingMethodDoesNotMatchCartError) Error() string

func (ShippingMethodDoesNotMatchCartError) MarshalJSON ¶ 

func (obj ShippingMethodDoesNotMatchCartError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ShippingMethodDoesNotMatchCartError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *ShippingMethodDoesNotMatchCartError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ShippingMethodDraft ¶ 

type ShippingMethodDraft struct {
	// User-defined unique identifier for the ShippingMethod.
	Key *string `json:"key,omitempty"`
	// Unique name for the ShippingMethod within a [Project](ctp:api:type:Project).
	Name string `json:"name"`
	// Localized name of the ShippingMethod.
	LocalizedName *LocalizedString `json:"localizedName,omitempty"`
	// Description of the ShippingMethod.
	Description *string `json:"description,omitempty"`
	// Localized description of the ShippingMethod.
	LocalizedDescription *LocalizedString `json:"localizedDescription,omitempty"`
	// [TaxCategory](ctp:api:type:TaxCategory) for all ZoneRates of the ShippingMethod.
	TaxCategory TaxCategoryResourceIdentifier `json:"taxCategory"`
	// Defines [ShippingRates](ctp:api:type:ShippingRate) (prices) for specific zones.
	ZoneRates []ZoneRateDraft `json:"zoneRates"`
	// If `true` the ShippingMethod will be the [Project](ctp:api:type:Project)'s default ShippingMethod.
	IsDefault bool `json:"isDefault"`
	// Valid [Cart predicate](/projects/predicates#cart-predicates) to select a ShippingMethod for a Cart.
	Predicate *string `json:"predicate,omitempty"`
	// Custom Fields for the ShippingMethod.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

type ShippingMethodPagedQueryResponse ¶ 

type ShippingMethodPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit *int `json:"limit,omitempty"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset *int `json:"offset,omitempty"`
	// [Shipping Methods](ctp:api:type:ShippingMethod) matching the query.
	Results []ShippingMethod `json:"results"`
}

* * [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of ShippingMethod(ctp:api:type:ShippingMethod). *

type ShippingMethodReference ¶ 

type ShippingMethodReference struct {
	// Unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod).
	ID string `json:"id"`
	// Contains the representation of the expanded ShippingMethod. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for ShippingMethods.
	Obj *ShippingMethod `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a ShippingMethod(ctp:api:type:ShippingMethod). *

func (ShippingMethodReference) MarshalJSON ¶ 

func (obj ShippingMethodReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodRemoveShippingRateAction ¶ 

type ShippingMethodRemoveShippingRateAction struct {
	// [Zone](ctp:api:type:Zone) from which the ShippingRate should be removed.
	Zone ZoneResourceIdentifier `json:"zone"`
	// Value to remove from `shippingRates`.
	ShippingRate ShippingRateDraft `json:"shippingRate"`
}

func (ShippingMethodRemoveShippingRateAction) MarshalJSON ¶ 

func (obj ShippingMethodRemoveShippingRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodRemoveZoneAction ¶ 

type ShippingMethodRemoveZoneAction struct {
	// Value to remove from `zoneRates`.
	Zone ZoneResourceIdentifier `json:"zone"`
}

func (ShippingMethodRemoveZoneAction) MarshalJSON ¶ 

func (obj ShippingMethodRemoveZoneAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodResourceIdentifier ¶ 

type ShippingMethodResourceIdentifier struct {
	// Unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a ShippingMethod(ctp:api:type:ShippingMethod). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (ShippingMethodResourceIdentifier) MarshalJSON ¶ 

func (obj ShippingMethodResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodSetCustomFieldAction ¶ 

type ShippingMethodSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

* * This action sets, overwrites, or removes any existing [Custom Field](/projects/custom-fields) for an existing ShippingMethod. *

func (ShippingMethodSetCustomFieldAction) MarshalJSON ¶ 

func (obj ShippingMethodSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodSetCustomTypeAction ¶ 

type ShippingMethodSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the ShippingMethod with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the ShippingMethod.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ShippingMethod.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ShippingMethodSetCustomTypeAction) MarshalJSON ¶ 

func (obj ShippingMethodSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodSetDescriptionAction ¶ 

type ShippingMethodSetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *string `json:"description,omitempty"`
}

func (ShippingMethodSetDescriptionAction) MarshalJSON ¶ 

func (obj ShippingMethodSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodSetKeyAction ¶ 

type ShippingMethodSetKeyAction struct {
	// If `key` is absent or `null`, the existing key, if any, will be removed.
	Key *string `json:"key,omitempty"`
}

func (ShippingMethodSetKeyAction) MarshalJSON ¶ 

func (obj ShippingMethodSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodSetLocalizedDescriptionAction ¶ 

type ShippingMethodSetLocalizedDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	LocalizedDescription *LocalizedString `json:"localizedDescription,omitempty"`
}

func (ShippingMethodSetLocalizedDescriptionAction) MarshalJSON ¶ 

func (obj ShippingMethodSetLocalizedDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodSetLocalizedNameAction ¶ 

type ShippingMethodSetLocalizedNameAction struct {
	// Value to set. If empty, any existing value will be removed.
	LocalizedName *LocalizedString `json:"localizedName,omitempty"`
}

func (ShippingMethodSetLocalizedNameAction) MarshalJSON ¶ 

func (obj ShippingMethodSetLocalizedNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodSetPredicateAction ¶ 

type ShippingMethodSetPredicateAction struct {
	// A valid [Cart predicate](/projects/predicates#cart-predicates). If `predicate` is absent or `null`, it is removed if it exists.
	Predicate *string `json:"predicate,omitempty"`
}

func (ShippingMethodSetPredicateAction) MarshalJSON ¶ 

func (obj ShippingMethodSetPredicateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShippingMethodState ¶ 

type ShippingMethodState string

* * Determines whether a ShippingMethod(ctp:api:type:ShippingMethod) is allowed for a Cart. * 

const (
	ShippingMethodStateDoesNotMatchCart ShippingMethodState = "DoesNotMatchCart"
	ShippingMethodStateMatchesCart      ShippingMethodState = "MatchesCart"
)

type ShippingMethodUpdate ¶ 

type ShippingMethodUpdate struct {
	// Expected version of the ShippingMethod on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the [ShippingMethod](/projects/shippingMethods#shippingmethod).
	Actions []ShippingMethodUpdateAction `json:"actions"`
}

func (*ShippingMethodUpdate) UnmarshalJSON ¶ 

func (obj *ShippingMethodUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ShippingMethodUpdateAction ¶ 

type ShippingMethodUpdateAction interface{}

type ShippingMode ¶ added in v1.2.0 

type ShippingMode string
const (
	ShippingModeSingle   ShippingMode = "Single"
	ShippingModeMultiple ShippingMode = "Multiple"
)

type ShippingRate ¶ 

type ShippingRate struct {
	// Currency amount of the ShippingRate.
	Price TypedMoney `json:"price"`
	// [Free shipping](/../api/shipping-delivery-overview#free-shipping) is applied if the sum of the (Custom) Line Item Prices reaches the specified value.
	FreeAbove TypedMoney `json:"freeAbove,omitempty"`
	// `true` if the ShippingRate matches given [Cart](ctp:api:type:Cart) or [Location](ctp:api:type:Location).
	// Only appears in response to requests for [Get ShippingMethods for a Cart](ctp:api:endpoint:/{projectKey}/shipping-methods/matching-cart:GET) or
	// [Get ShippingMethods for a Location](ctp:api:endpoint:/{projectKey}/shipping-methods/matching-location:GET).
	IsMatching *bool `json:"isMatching,omitempty"`
	// Price tiers for the ShippingRate.
	Tiers []ShippingRatePriceTier `json:"tiers"`
}

func (*ShippingRate) UnmarshalJSON ¶ 

func (obj *ShippingRate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ShippingRateDraft ¶ 

type ShippingRateDraft struct {
	// Money value of the ShippingRate.
	Price Money `json:"price"`
	// [Free shipping](/../api/shipping-delivery-overview#free-shipping) is applied if the sum of the (Custom) Line Item Prices reaches the specified value.
	FreeAbove *Money `json:"freeAbove,omitempty"`
	// Price tiers for the ShippingRate.
	Tiers []ShippingRatePriceTier `json:"tiers"`
}

func (ShippingRateDraft) MarshalJSON ¶ 

func (obj ShippingRateDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ShippingRateDraft) UnmarshalJSON ¶ 

func (obj *ShippingRateDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ShippingRateInput ¶ 

type ShippingRateInput interface{}

type ShippingRateInputDraft ¶ 

type ShippingRateInputDraft interface{}

* * Generic type holding specifc ShippingRateInputDraft types.

type ShippingRateInputType ¶ 

type ShippingRateInputType interface{}

type ShippingRatePriceTier ¶ 

type ShippingRatePriceTier interface{}

type ShippingRateTierType ¶ 

type ShippingRateTierType string
const (
	ShippingRateTierTypeCartValue          ShippingRateTierType = "CartValue"
	ShippingRateTierTypeCartClassification ShippingRateTierType = "CartClassification"
	ShippingRateTierTypeCartScore          ShippingRateTierType = "CartScore"
)

type ShoppingList ¶ 

type ShoppingList struct {
	// Unique identifier of the ShoppingList.
	ID string `json:"id"`
	// Current version of the ShoppingList.
	Version int `json:"version"`
	// Date and time (UTC) the ShoppingList was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the ShoppingList was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Name of the ShoppingList.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier of the ShoppingList.
	Key *string `json:"key,omitempty"`
	// Reference to a [Customer](ctp:api:type:Customer) associated with the ShoppingList.
	Customer *CustomerReference `json:"customer,omitempty"`
	// Human-readable identifiers usually used as deep-link URL to the related ShoppingList.
	// Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages.
	// The slug must match the pattern `[a-zA-Z0-9_-]{2,256}`. For [good performance](/predicates/query#performance-considerations), indexes are provided for the first 15 `languages` set on the [Project](ctp:api:type:Project).
	Slug *LocalizedString `json:"slug,omitempty"`
	// Description of the ShoppingList.
	Description *LocalizedString `json:"description,omitempty"`
	// Line Items (containing Products) of the ShoppingList.
	LineItems []ShoppingListLineItem `json:"lineItems"`
	// Line Items (containing text values) of the ShoppingList.
	TextLineItems []TextLineItem `json:"textLineItems"`
	// Number of days after which the ShoppingList will be automatically deleted if it has not been modified.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
	// Identifies ShoppingLists belonging to an [anonymous session](ctp:api:type:AnonymousSession).
	AnonymousId *string `json:"anonymousId,omitempty"`
	// Store to which the ShoppingList is assigned.
	Store *StoreKeyReference `json:"store,omitempty"`
	// Custom Fields defined for the ShoppingList.
	Custom *CustomFields `json:"custom,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
}

type ShoppingListAddLineItemAction ¶ 

type ShoppingListAddLineItemAction struct {
	// User-defined identifier of the ShoppingListLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
	Key *string `json:"key,omitempty"`
	// `sku` of the [ProductVariant](ctp:api:type:ProductVariant).
	Sku *string `json:"sku,omitempty"`
	// Unique identifier of a [Product](ctp:api:type:Product).
	ProductId *string `json:"productId,omitempty"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant). If not set, the ShoppingListLineItem refers to the Master Variant.
	VariantId *int `json:"variantId,omitempty"`
	// Number of Products in the ShoppingListLineItem.
	Quantity *int `json:"quantity,omitempty"`
	// Date and time the TextLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Custom Fields defined for the ShoppingListLineItem.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * The ProductVariant(ctp:api:type:ProductVariant) to be included in the ShoppingListLineItem must be specified using the `productID` and `variantID`, or by the `sku`. * If the ShoppingList already contains a ShoppingListLineItem for the same Product Variant with the same Custom Fields, then only the quantity of the existing ShoppingListLineItem is increased. * A ShoppingListLineItem with an empty `variantId` is not considered the same as a ShoppingListLineItem with a `variantId` currently referring to the Master Variant. *

func (ShoppingListAddLineItemAction) MarshalJSON ¶ 

func (obj ShoppingListAddLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListAddTextLineItemAction ¶ 

type ShoppingListAddTextLineItemAction struct {
	// Name of the TextLineItem.
	Name LocalizedString `json:"name"`
	// User-defined identifier of the TextLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
	Key *string `json:"key,omitempty"`
	// Description of the TextLineItem.
	Description *LocalizedString `json:"description,omitempty"`
	// Number of entries in the TextLineItem.
	Quantity *int `json:"quantity,omitempty"`
	// Date and time the TextLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Custom Fields defined for the TextLineItem.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (ShoppingListAddTextLineItemAction) MarshalJSON ¶ 

func (obj ShoppingListAddTextLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListChangeLineItemQuantityAction ¶ 

type ShoppingListChangeLineItemQuantityAction struct {
	// The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// The `key` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// New value to set. If `0`, the ShoppingListLineItem is removed from the ShoppingList.
	Quantity int `json:"quantity"`
}

func (ShoppingListChangeLineItemQuantityAction) MarshalJSON ¶ 

func (obj ShoppingListChangeLineItemQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListChangeLineItemsOrderAction ¶ 

type ShoppingListChangeLineItemsOrderAction struct {
	// All existing ShoppingListLineItem `id`s in the desired new order.
	LineItemOrder []string `json:"lineItemOrder"`
}

func (ShoppingListChangeLineItemsOrderAction) MarshalJSON ¶ 

func (obj ShoppingListChangeLineItemsOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListChangeNameAction ¶ 

type ShoppingListChangeNameAction struct {
	// New value to set. Must not be empty.
	Name LocalizedString `json:"name"`
}

func (ShoppingListChangeNameAction) MarshalJSON ¶ 

func (obj ShoppingListChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListChangeTextLineItemNameAction ¶ 

type ShoppingListChangeTextLineItemNameAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// New value to set. Must not be empty.
	Name LocalizedString `json:"name"`
}

func (ShoppingListChangeTextLineItemNameAction) MarshalJSON ¶ 

func (obj ShoppingListChangeTextLineItemNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListChangeTextLineItemQuantityAction ¶ 

type ShoppingListChangeTextLineItemQuantityAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// New value to set. If `0`, the TextLineItem is removed from the ShoppingList.
	Quantity int `json:"quantity"`
}

func (ShoppingListChangeTextLineItemQuantityAction) MarshalJSON ¶ 

func (obj ShoppingListChangeTextLineItemQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListChangeTextLineItemsOrderAction ¶ 

type ShoppingListChangeTextLineItemsOrderAction struct {
	// Must contain all existing [TextLineItem](ctp:api:type:TextLineItem) `id`s in the desired new order.
	TextLineItemOrder []string `json:"textLineItemOrder"`
}

func (ShoppingListChangeTextLineItemsOrderAction) MarshalJSON ¶ 

func (obj ShoppingListChangeTextLineItemsOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListDraft ¶ 

type ShoppingListDraft struct {
	// Name of the ShoppingList.
	Name LocalizedString `json:"name"`
	// Human-readable identifiers usually used as deep-link URL to the related ShoppingList.
	// Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages.
	// The slug must match the pattern `[a-zA-Z0-9_-]{2,256}`.
	Slug *LocalizedString `json:"slug,omitempty"`
	// The [Customer](ctp:api:type:Customer) the ShoppingList should be associated to.
	Customer *CustomerResourceIdentifier `json:"customer,omitempty"`
	// User-defined unique identifier for the ShoppingList.
	Key *string `json:"key,omitempty"`
	// Description of the ShoppingList.
	Description *LocalizedString `json:"description,omitempty"`
	// Identifies ShoppingLists belonging to an [anonymous session](ctp:api:type:AnonymousSession).
	AnonymousId *string `json:"anonymousId,omitempty"`
	// Number of days after which the ShoppingList will be automatically deleted if it has not been modified. If not set, the [default value](ctp:api:type:ShoppingListsConfiguration) configured in the [Project](ctp:api:type:Project) is used.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
	// Line Items (containing Products) to add to the ShoppingList.
	LineItems []ShoppingListLineItemDraft `json:"lineItems"`
	// Line Items (containing text values) to add to the ShoppingList.
	TextLineItems []TextLineItemDraft `json:"textLineItems"`
	// Assigns the new ShoppingList to the [Store](ctp:api:type:Store).
	Store *StoreResourceIdentifier `json:"store,omitempty"`
	// Custom Fields defined for the ShoppingList.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (ShoppingListDraft) MarshalJSON ¶ 

func (obj ShoppingListDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListLineItem ¶ 

type ShoppingListLineItem struct {
	// Date and time (UTC) the ShoppingListLineItem was added to the ShoppingList.
	AddedAt time.Time `json:"addedAt"`
	// Custom Fields of the ShoppingListLineItem.
	Custom *CustomFields `json:"custom,omitempty"`
	// If the Product or Product Variant is deleted, `deactivatedAt` is the date and time (UTC) of deletion.
	//
	// This data is updated in an [eventual consistent manner](/general-concepts#eventual-consistency) when the Product Variant cannot be ordered anymore.
	DeactivatedAt *time.Time `json:"deactivatedAt,omitempty"`
	// Unique identifier of the ShoppingListLineItem.
	ID string `json:"id"`
	// User-defined identifier of the ShoppingListLineItem. It is unique per [ShoppingList](ctp:api:type:ShoppingList).
	Key *string `json:"key,omitempty"`
	// Name of the Product.
	//
	// This data is updated in an [eventual consistent manner](/general-concepts#eventual-consistency) when the Product's name changes.
	Name LocalizedString `json:"name"`
	// Unique identifier of a [Product](ctp:api:type:Product).
	ProductId string `json:"productId"`
	// The Product Type defining the Attributes of the [Product](ctp:api:type:Product).
	ProductType ProductTypeReference `json:"productType"`
	// Number of Products in the ShoppingListLineItem.
	Quantity int `json:"quantity"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant) the ShoppingListLineItem refers to. If not set, the ShoppingListLineItem refers to the Master Variant.
	VariantId *int `json:"variantId,omitempty"`
	// Data of the [ProductVariant](ctp:api:type:ProductVariant).
	//
	// Returned when expanded using `expand=lineItems[*].variant`. You cannot expand only a single element of the array.
	Variant *ProductVariant `json:"variant,omitempty"`
	// Slug of the current [ProductData](ctp:api:type:ProductData).
	//
	// Returned when expanded using `expand=lineItems[*].productSlug`. You cannot expand only a single element of the array.
	ProductSlug *LocalizedString `json:"productSlug,omitempty"`
}

* * ShoppingListLineItems are Line Items that contain references to [ProductVariants](ctp:api:type:ProductVariant) in a Product(ctp:api:type:Product). * * In addition to standard [Reference Expansion](/general-concepts#reference-expansion), a ShoppingListLineItem offers expansion on `productSlug` and `variant`, defined with the query parameter `expand`. *

type ShoppingListLineItemDraft ¶ 

type ShoppingListLineItemDraft struct {
	// User-defined identifier of the ShoppingListLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
	Key *string `json:"key,omitempty"`
	// Unique identifier of a [Product](ctp:api:type:Product).
	ProductId *string `json:"productId,omitempty"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant). If not set, the ShoppingListLineItem refers to the Master Variant.
	VariantId *int `json:"variantId,omitempty"`
	// `sku` of the [ProductVariant](ctp:api:type:ProductVariant).
	Sku *string `json:"sku,omitempty"`
	// Date and time the ShoppingListLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Custom Fields of the ShoppingListLineItem.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Number of Products in the ShoppingListLineItem.
	Quantity *int `json:"quantity,omitempty"`
}

* * The ProductVariant(ctp:api:type:ProductVariant) to be included in the ShoppingListLineItem must be specified using the `productID` and `variantID`, or by the `sku`. *

type ShoppingListPagedQueryResponse ¶ 

type ShoppingListPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// [ShoppingLists](ctp:api:type:ShoppingList) matching the query.
	Results []ShoppingList `json:"results"`
}

type ShoppingListReference ¶ 

type ShoppingListReference struct {
	// Unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList).
	ID string `json:"id"`
	// Contains the representation of the expanded ShoppingList. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for ShoppingLists.
	Obj *ShoppingList `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a ShoppingList(ctp:api:type:ShoppingList). *

func (ShoppingListReference) MarshalJSON ¶ 

func (obj ShoppingListReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListRemoveLineItemAction ¶ 

type ShoppingListRemoveLineItemAction struct {
	// The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// The `key` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Amount to remove from the `quantity` of the ShoppingListLineItem. If not set, the ShoppingListLineItem is removed from the ShoppingList. If this value matches or exceeds the current `quantity` of the ShoppingListLineItem, the ShoppingListLineItem is removed from the ShoppingList.
	Quantity *int `json:"quantity,omitempty"`
}

func (ShoppingListRemoveLineItemAction) MarshalJSON ¶ 

func (obj ShoppingListRemoveLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListRemoveTextLineItemAction ¶ 

type ShoppingListRemoveTextLineItemAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// Amount to remove from the `quantity` of the TextLineItem. If not set, the TextLineItem is removed from the ShoppingList. If this value matches or exceeds the current `quantity` of the TextLineItem, the TextLineItem is removed from the ShoppingList.
	Quantity *int `json:"quantity,omitempty"`
}

func (ShoppingListRemoveTextLineItemAction) MarshalJSON ¶ 

func (obj ShoppingListRemoveTextLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListResourceIdentifier ¶ 

type ShoppingListResourceIdentifier struct {
	// Unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a ShoppingList(ctp:api:type:ShoppingList). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (ShoppingListResourceIdentifier) MarshalJSON ¶ 

func (obj ShoppingListResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetAnonymousIdAction ¶ 

type ShoppingListSetAnonymousIdAction struct {
	// Value to set. If empty, any existing value will be removed.
	AnonymousId *string `json:"anonymousId,omitempty"`
}

func (ShoppingListSetAnonymousIdAction) MarshalJSON ¶ 

func (obj ShoppingListSetAnonymousIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetCustomFieldAction ¶ 

type ShoppingListSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (ShoppingListSetCustomFieldAction) MarshalJSON ¶ 

func (obj ShoppingListSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetCustomTypeAction ¶ 

type ShoppingListSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the ShoppingList with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the ShoppingList.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ShoppingList.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ShoppingListSetCustomTypeAction) MarshalJSON ¶ 

func (obj ShoppingListSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetCustomerAction ¶ 

type ShoppingListSetCustomerAction struct {
	// The [Customer](ctp:api:type:Customer) the ShoppingList should be associated to. If empty, any existing value will be removed.
	Customer *CustomerResourceIdentifier `json:"customer,omitempty"`
}

func (ShoppingListSetCustomerAction) MarshalJSON ¶ 

func (obj ShoppingListSetCustomerAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetDeleteDaysAfterLastModificationAction ¶ 

type ShoppingListSetDeleteDaysAfterLastModificationAction struct {
	// Value to set. If empty, any existing value will be removed.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
}

func (ShoppingListSetDeleteDaysAfterLastModificationAction) MarshalJSON ¶ 

func (obj ShoppingListSetDeleteDaysAfterLastModificationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetDescriptionAction ¶ 

type ShoppingListSetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (ShoppingListSetDescriptionAction) MarshalJSON ¶ 

func (obj ShoppingListSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetKeyAction ¶ 

type ShoppingListSetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (ShoppingListSetKeyAction) MarshalJSON ¶ 

func (obj ShoppingListSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetLineItemCustomFieldAction ¶ 

type ShoppingListSetLineItemCustomFieldAction struct {
	// The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// The `key` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (ShoppingListSetLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj ShoppingListSetLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetLineItemCustomTypeAction ¶ 

type ShoppingListSetLineItemCustomTypeAction struct {
	// The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// The `key` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the ShoppingListLineItem with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the ShoppingListLineItem.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ShoppingListLineItem.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ShoppingListSetLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj ShoppingListSetLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetSlugAction ¶ 

type ShoppingListSetSlugAction struct {
	// Value to set. If empty, any existing value will be removed. Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages. Must match the pattern `^[A-Za-z0-9_-]{2,256}+$`
	Slug *LocalizedString `json:"slug,omitempty"`
}

func (ShoppingListSetSlugAction) MarshalJSON ¶ 

func (obj ShoppingListSetSlugAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetStoreAction ¶ 

type ShoppingListSetStoreAction struct {
	// The [Store](ctp:api:type:Store) the ShoppingList should be assigned to. If empty, any existing value will be removed.
	Store *StoreResourceIdentifier `json:"store,omitempty"`
}

func (ShoppingListSetStoreAction) MarshalJSON ¶ 

func (obj ShoppingListSetStoreAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetTextLineItemCustomFieldAction ¶ 

type ShoppingListSetTextLineItemCustomFieldAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (ShoppingListSetTextLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj ShoppingListSetTextLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetTextLineItemCustomTypeAction ¶ 

type ShoppingListSetTextLineItemCustomTypeAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the TextLineItem with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the TextLineItem.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the TextLineItem.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (ShoppingListSetTextLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj ShoppingListSetTextLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListSetTextLineItemDescriptionAction ¶ 

type ShoppingListSetTextLineItemDescriptionAction struct {
	// The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemId *string `json:"textLineItemId,omitempty"`
	// The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	TextLineItemKey *string `json:"textLineItemKey,omitempty"`
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (ShoppingListSetTextLineItemDescriptionAction) MarshalJSON ¶ 

func (obj ShoppingListSetTextLineItemDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListStoreSetMessagePayload ¶ 

type ShoppingListStoreSetMessagePayload struct {
	// [Reference](ctp:api:type:Reference) to a [Store](ctp:api:type:Store) by its key.
	Store StoreKeyReference `json:"store"`
}

func (ShoppingListStoreSetMessagePayload) MarshalJSON ¶ 

func (obj ShoppingListStoreSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShoppingListUpdate ¶ 

type ShoppingListUpdate struct {
	// Expected version of the ShoppingList on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// List of update actions to be performed on the ShoppingList.
	Actions []ShoppingListUpdateAction `json:"actions"`
}

func (*ShoppingListUpdate) UnmarshalJSON ¶ 

func (obj *ShoppingListUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ShoppingListUpdateAction ¶ 

type ShoppingListUpdateAction interface{}

type ShoppingListsConfiguration ¶ 

type ShoppingListsConfiguration struct {
	// Default value for the `deleteDaysAfterLastModification` parameter of the [ShoppingListDraft](ctp:api:type:ShoppingListDraft).
	// This field may not be present on Projects created before January 2020.
	DeleteDaysAfterLastModification *int `json:"deleteDaysAfterLastModification,omitempty"`
}

type SnsDestination ¶ 

type SnsDestination struct {
	// Only present if `authenticationMode` is set to `Credentials`.
	AccessKey *string `json:"accessKey,omitempty"`
	// Only present if `authenticationMode` is set to `Credentials`.
	AccessSecret *string `json:"accessSecret,omitempty"`
	// Amazon Resource Name (ARN) of the topic.
	TopicArn string `json:"topicArn"`
	// Defines the method of authentication for the SNS topic.
	AuthenticationMode *AwsAuthenticationMode `json:"authenticationMode,omitempty"`
}

* * [AWS SNS](https://aws.amazon.com/sns/) can be used to push messages to AWS Lambda, HTTP endpoints (webhooks), or fan-out messages to SQS queues. The SQS queue must be a [Standard](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/standard-queues.html) queue type. * * We recommend setting `authenticationMode` to `IAM`, to avoid unnecessary key management. For IAM authentication and before creating the Subscription, give permissions to the following user account: `arn:aws-cn:iam::417094354346:user/subscriptions` if the Project is hosted in the China (AWS, Ningxia) Region; `arn:aws:iam::362576667341:user/subscriptions` for all other [Regions](/../api/general-concepts#regions). Otherwise, a test message will not be sent. * * If you prefer to use `Credentials` for authentication, we recommend [creating an IAM user](https://docs.aws.amazon.com/sns/latest/dg/sns-setting-up.html#create-iam-user) with an `accessKey` and `accessSecret` pair specifically for each Subscription. * * The IAM user should only have the `sns:Publish` permission on this topic. *

func (SnsDestination) MarshalJSON ¶ 

func (obj SnsDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SqsDestination ¶ 

type SqsDestination struct {
	// Only present if `authenticationMode` is set to `Credentials`.
	AccessKey *string `json:"accessKey,omitempty"`
	// Only present if `authenticationMode` is set to `Credentials`.
	AccessSecret *string `json:"accessSecret,omitempty"`
	// URL of the Amazon SQS queue.
	QueueUrl string `json:"queueUrl"`
	// [AWS Region](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) the message queue is located in.
	Region string `json:"region"`
	// Defines the method of authentication for the SQS queue.
	AuthenticationMode *AwsAuthenticationMode `json:"authenticationMode,omitempty"`
}

* * [AWS SQS](https://aws.amazon.com/sqs/) is a pull-queue on AWS. * The queue must be a [Standard](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/standard-queues.html) queue type with a `MaximumMessageSize` of `256 KB`. * * We recommend setting `authenticationMode` to `IAM`, to avoid unnecessary key management. For IAM authentication and before creating the Subscription, give permissions to the following user account: `arn:aws-cn:iam::417094354346:user/subscriptions` if the Project is hosted in the China (AWS, Ningxia) Region; `arn:aws:iam::362576667341:user/subscriptions` for all other [Regions](/../api/general-concepts#regions). Otherwise, a test message will not be sent. * * If you prefer to use `Credentials` for authentication, we recommend [creating an IAM user](https://docs.aws.amazon.com/sns/latest/dg/sns-setting-up.html#create-iam-user) with an `accessKey` and `accessSecret` pair specifically for each Subscription. * * The IAM user should only have the `sqs:SendMessage` permission on this queue. *

func (SqsDestination) MarshalJSON ¶ 

func (obj SqsDestination) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StackingMode ¶ 

type StackingMode string

* * Describes how the Cart Discount interacts with other Discounts. * 

const (
	StackingModeStacking              StackingMode = "Stacking"
	StackingModeStopAfterThisDiscount StackingMode = "StopAfterThisDiscount"
)

type StagedOrder ¶ 

type StagedOrder struct {
	// Unique identifier of the Order.
	ID string `json:"id"`
	// Current version of the Order.
	Version int `json:"version"`
	// Date and time (UTC) the Order was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Order was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-defined identifier of the Order that is unique across a Project.
	OrderNumber *string `json:"orderNumber,omitempty"`
	// User-defined identifier of a purchase Order.
	//
	// It is typically set by the [Buyer](ctp:api:type:Buyer) and can be used with [Quotes](/quotes-overview) to track the purchase Order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
	// `id` of the [Customer](ctp:api:type:Customer) that the Order belongs to.
	CustomerId *string `json:"customerId,omitempty"`
	// Email address of the Customer that the Order belongs to.
	CustomerEmail *string `json:"customerEmail,omitempty"`
	// [Reference](ctp:api:type:Reference) to the Customer Group of the Customer that the Order belongs to.
	// Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// [Anonymous session](ctp:api:type:AnonymousSession) associated with the Order.
	AnonymousId *string `json:"anonymousId,omitempty"`
	// [Reference](ctp:api:type:Reference) to a Business Unit the Order belongs to.
	BusinessUnit *BusinessUnitKeyReference `json:"businessUnit,omitempty"`
	// [Reference](ctp:api:type:Reference) to a Store the Order belongs to.
	Store *StoreKeyReference `json:"store,omitempty"`
	// [Line Items](ctp:api:type:LineItems) that are part of the Order.
	LineItems []LineItem `json:"lineItems"`
	// [Custom Line Items](ctp:api:type:CustomLineItems) that are part of the Order.
	CustomLineItems []CustomLineItem `json:"customLineItems"`
	// Sum of the `totalPrice` field of all [LineItems](ctp:api:type:LineItem) and [CustomLineItems](ctp:api:type:CustomLineItem), and if available, the `price` field of [ShippingInfo](ctp:api:type:ShippingInfo).
	// If a discount applies on `totalPrice`, this field holds the discounted value.
	//
	// Taxes are included if [TaxRate](ctp:api:type:TaxRate) `includedInPrice` is `true` for each price.
	TotalPrice TypedMoney `json:"totalPrice"`
	// - For `Platform` [TaxMode](ctp:api:type:TaxMode), it is automatically set when a [shipping address is set](ctp:api:type:OrderSetShippingAddressAction).
	// - For `External` [TaxMode](ctp:api:type:TaxMode), it is automatically set when `shippingAddress` and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
	//
	// If a discount applies on `totalPrice`, this field holds the discounted values.
	TaxedPrice *TaxedPrice `json:"taxedPrice,omitempty"`
	// Sum of the `taxedPrice` field of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods.
	TaxedShippingPrice *TaxedPrice `json:"taxedShippingPrice,omitempty"`
	// Discounts that apply on the total price of the Order.
	DiscountOnTotalPrice *DiscountOnTotalPrice `json:"discountOnTotalPrice,omitempty"`
	// Indicates how Tax Rates are set.
	TaxMode *TaxMode `json:"taxMode,omitempty"`
	// Indicates how monetary values are rounded when calculating taxes for `taxedPrice`.
	TaxRoundingMode *RoundingMode `json:"taxRoundingMode,omitempty"`
	// Indicates how taxes are calculated when calculating taxes for `taxedPrice`.
	TaxCalculationMode *TaxCalculationMode `json:"taxCalculationMode,omitempty"`
	// Indicates how stock quantities are tracked for Line Items in the Order.
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Billing address associated with the Order.
	BillingAddress *Address `json:"billingAddress,omitempty"`
	// Shipping address associated with the Order.
	// Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
	ShippingAddress *Address `json:"shippingAddress,omitempty"`
	// Indicates whether there can be one or multiple Shipping Methods.
	ShippingMode ShippingMode `json:"shippingMode"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) for `Single` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Shipping-related information for `Single` [ShippingMode](ctp:api:type:ShippingMode).
	// Automatically set when a [Shipping Method is set](ctp:api:type:StagedOrderSetShippingMethodAction).
	ShippingInfo *ShippingInfo `json:"shippingInfo,omitempty"`
	// Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it is [ClassificationShippingRateInput](ctp:api:type:ClassificationShippingRateInput).
	// - If `CartScore`, it is [ScoreShippingRateInput](ctp:api:type:ScoreShippingRateInput).
	// - If `CartValue`, it cannot be used.
	ShippingRateInput ShippingRateInput `json:"shippingRateInput,omitempty"`
	// Custom Fields of the Shipping Method for `Single` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingCustomFields *CustomFields `json:"shippingCustomFields,omitempty"`
	// Shipping-related information for `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	// Updated automatically each time a new [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).
	Shipping []Shipping `json:"shipping"`
	// Additional shipping addresses of the Order as specified by [LineItems](ctp:api:type:LineItem) using the `shippingDetails` field.
	// Eligible Shipping Methods or applicable Tax Rates are determined by the address in `shippingAddress`, and not `itemShippingAddresses`.
	ItemShippingAddresses []Address `json:"itemShippingAddresses"`
	// Discount Codes added to the Order.
	// An Order that has `directDiscounts` cannot have `discountCodes`.
	DiscountCodes []DiscountCodeInfo `json:"discountCodes"`
	// Direct Discounts added to the Order.
	// An Order that has `discountCodes` cannot have `directDiscounts`.
	DirectDiscounts []DirectDiscount `json:"directDiscounts"`
	// Automatically set when a Line Item with `GiftLineItem` [LineItemMode](ctp:api:type:LineItemMode) is [removed](ctp:api:type:StagedOrderRemoveLineItemAction) from the Order.
	RefusedGifts []CartDiscountReference `json:"refusedGifts"`
	// Payment information related to the Order.
	PaymentInfo *PaymentInfo `json:"paymentInfo,omitempty"`
	// Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	Country *string `json:"country,omitempty"`
	// Languages of the Order.
	// Can only contain languages supported by the [Project](ctp:api:type:Project).
	Locale *string `json:"locale,omitempty"`
	// Indicates the origin of the Cart from which the Order was created.
	Origin CartOrigin `json:"origin"`
	// [Reference](ctp:api:type:Reference) to the Cart for an [Order created from Cart](ctp:api:endpoint:/{projectKey}/orders:POST).
	// The referenced Cart will have the `Ordered` [CartState](ctp:api:type:CartState).
	Cart *CartReference `json:"cart,omitempty"`
	// [Reference](ctp:api:type:Reference) to the Quote for an [Order created from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST).
	Quote *QuoteReference `json:"quote,omitempty"`
	// Current status of the Order.
	OrderState OrderState `json:"orderState"`
	// Shipment status of the Order.
	ShipmentState *ShipmentState `json:"shipmentState,omitempty"`
	// Payment status of the Order.
	PaymentState *PaymentState `json:"paymentState,omitempty"`
	// [State](ctp:api:type:State) of the Order.
	// This reference can point to a State in a custom workflow.
	State *StateReference `json:"state,omitempty"`
	// Contains synchronization activity information of the Order (like export or import).
	// Can only be set with [Update SyncInfo](ctp:api:type:OrderUpdateSyncInfoAction) update action.
	SyncInfo []SyncInfo `json:"syncInfo"`
	// Contains information regarding the returns associated with the Order.
	ReturnInfo []ReturnInfo `json:"returnInfo"`
	// Internal-only field.
	LastMessageSequenceNumber *int `json:"lastMessageSequenceNumber,omitempty"`
	// Custom Fields of the Order.
	Custom *CustomFields `json:"custom,omitempty"`
	// User-defined date and time (UTC) of the Order.
	// Present only on an Order created using [Order Import](ctp:api:endpoint:/{projectKey}/orders/import:POST).
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
}

func (StagedOrder) MarshalJSON ¶ 

func (obj StagedOrder) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StagedOrder) UnmarshalJSON ¶ 

func (obj *StagedOrder) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedOrderAddCustomLineItemAction ¶ 

type StagedOrderAddCustomLineItemAction struct {
	// Money value of the Custom Line Item. The value can be negative.
	Money Money `json:"money"`
	// Name of the Custom Line Item.
	Name LocalizedString `json:"name"`
	// User-defined unique identifier of the Custom Line Item.
	Key *string `json:"key,omitempty"`
	// Number of Custom Line Items to add to the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// User-defined identifier used in a deep-link URL for the Custom Line Item. It must match the pattern `[a-zA-Z0-9_-]{2,256}`.
	Slug string `json:"slug"`
	// Used to select a Tax Rate when a Cart has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	// If [TaxMode](ctp:api:type:TaxMode) is `Platform`, this field must not be empty.
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// An external Tax Rate can be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Container for Custom Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// - If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget)
	// are applied to the Custom Line Item.
	// - If `External`, Cart Discounts are not considered on the Custom Line Item.
	PriceMode *CustomLineItemPriceMode `json:"priceMode,omitempty"`
	// Custom Fields for the Custom Line Item.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * If the Cart already contains a CustomLineItem(ctp:api:type:CustomLineItem) with the same `slug`, `name`, `money`, `taxCategory`, `state`, * and Custom Fields, then only the quantity of the existing Custom Line Item is increased. * If CustomLineItem(ctp:api:type:CustomLineItem) `shippingDetails` are set, they are merged with the `targets` that already exist on the * ItemShippingDetails(ctp:api:type:ItemShippingDetails) of the Custom Line Item. * In case of overlapping address keys the ItemShippingTarget(ctp:api:type:ItemShippingTarget) `quantity` is summed up. * * If the Cart already contains a Custom Line Item with the same slug that is otherwise not identical, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned. * * If the Tax Rate is not set, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. *

func (StagedOrderAddCustomLineItemAction) MarshalJSON ¶ 

func (obj StagedOrderAddCustomLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderAddDeliveryAction ¶ 

type StagedOrderAddDeliveryAction struct {
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod), required for `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Items to be included in the Delivery.
	Items []DeliveryItem `json:"items"`
	// Address the `parcels` should be delivered to.
	Address *BaseAddress `json:"address,omitempty"`
	// Parcels of the Delivery.
	//
	// If provided, this update action also produces the [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message.
	Parcels []ParcelDraft `json:"parcels"`
	// Custom Fields for the Delivery.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * A Delivery(ctp:api:type:Delivery) can only be added to an Order(ctp:api:type:Order) if * its `shippingInfo` (for `shippingMode` = `Single`), or its `shipping` (for `shippingMode` = `Multiple`) exists. * * Produces the [Delivery Added](ctp:api:type:DeliveryAddedMessage) Message. *

func (StagedOrderAddDeliveryAction) MarshalJSON ¶ 

func (obj StagedOrderAddDeliveryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderAddDiscountCodeAction ¶ 

type StagedOrderAddDiscountCodeAction struct {
	// `code` of a [DiscountCode](ctp:api:type:DiscountCode).
	Code string `json:"code"`
}

* * Adds a DiscountCode(ctp:api:type:DiscountCode) to the Cart to activate the related [Cart Discounts](/../api/projects/cartDiscounts). * Adding a Discount Code is only possible if no DirectDiscount(ctp:api:type:DirectDiscount) has been applied to the Order. * * The maximum number of Discount Codes in a Cart is restricted by a [limit](/../api/limits#carts). * * Specific Error Code: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) *

func (StagedOrderAddDiscountCodeAction) MarshalJSON ¶ 

func (obj StagedOrderAddDiscountCodeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderAddItemShippingAddressAction ¶ 

type StagedOrderAddItemShippingAddressAction struct {
	// Address to append to `itemShippingAddresses`.
	// The new Address must have a `key` that is unique across this Order.
	Address BaseAddress `json:"address"`
}

* * Adds an address to an Order when shipping to multiple addresses is desired. *

func (StagedOrderAddItemShippingAddressAction) MarshalJSON ¶ 

func (obj StagedOrderAddItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderAddLineItemAction ¶ 

type StagedOrderAddLineItemAction struct {
	// User-defined unique identifier of the LineItem.
	Key *string `json:"key,omitempty"`
	// `id` of the published [Product](ctp:api:type:Product).
	//
	// Either the `productId` and `variantId`, or `sku` must be provided.
	ProductId *string `json:"productId,omitempty"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant) in the Product.
	// If not provided, the Master Variant is used.
	//
	// Either the `productId` and `variantId`, or `sku` must be provided.
	VariantId *int `json:"variantId,omitempty"`
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant).
	//
	// Either the `productId` and `variantId`, or `sku` must be provided.
	Sku *string `json:"sku,omitempty"`
	// Quantity of the Product Variant to add to the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// Date and time (UTC) the Product Variant is added to the Cart.
	// If not set, it defaults to the current date and time.
	//
	// Optional for backwards compatibility reasons.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Used to [select](/../api/carts-orders-overview#line-item-price-selection) a Product Price.
	// The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	// If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set, the Channel must match one of the Store's distribution channels.
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
	// Used to identify [Inventory entries](/../api/projects/inventory) that must be reserved.
	// The Channel must have the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` value, and the `priceMode` to `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalPrice *Money `json:"externalPrice,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` and `totalPrice` values, and the `priceMode` to `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
	// External Tax Rate for the Line Item, if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// Inventory mode specific to the Line Item only, and valid for the entire `quantity` of the Line Item.
	// Set only if the inventory mode should be different from the `inventoryMode` specified on the [Cart](ctp:api:type:Cart).
	InventoryMode *InventoryMode `json:"inventoryMode,omitempty"`
	// Container for Line Item-specific addresses.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
	// Custom Fields for the Line Item.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * If the Cart contains a LineItem(ctp:api:type:LineItem) for a Product Variant with the same LineItemMode(ctp:api:type:LineItemMode), [Custom Fields](/../api/projects/custom-fields), supply and distribution channel, then only the quantity of the existing Line Item is increased. * If LineItem(ctp:api:type:LineItem) `shippingDetails` is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. * A new Line Item is added when the `externalPrice` or `externalTotalPrice` is set in this update action. * The LineItem(ctp:api:type:LineItem) price is set as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). * * If the Tax Rate is not set, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. * * If the Line Items do not have a Price according to the Product(ctp:api:type:Product) `priceMode` value for a selected currency and/or country, Customer Group, or Channel, a [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) error is returned. *

func (StagedOrderAddLineItemAction) MarshalJSON ¶ 

func (obj StagedOrderAddLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderAddParcelToDeliveryAction ¶ 

type StagedOrderAddParcelToDeliveryAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Value to set.
	Measurements *ParcelMeasurements `json:"measurements,omitempty"`
	// Value to set.
	TrackingData *TrackingData `json:"trackingData,omitempty"`
	// Value to set.
	Items []DeliveryItem `json:"items"`
	// Custom Fields for the Parcel.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

* * To add a Parcel, at least one Delivery(ctp:api:type:Delivery) must exist. * * Produces the [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message. *

func (StagedOrderAddParcelToDeliveryAction) MarshalJSON ¶ 

func (obj StagedOrderAddParcelToDeliveryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderAddPaymentAction ¶ 

type StagedOrderAddPaymentAction struct {
	// Payment to add to the [PaymentInfo](ctp:api:type:PaymentInfo).
	// Must not be assigned to another Order or active Cart already.
	Payment PaymentResourceIdentifier `json:"payment"`
}

func (StagedOrderAddPaymentAction) MarshalJSON ¶ 

func (obj StagedOrderAddPaymentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderAddReturnInfoAction ¶ 

type StagedOrderAddReturnInfoAction struct {
	// Value to set.
	ReturnTrackingId *string `json:"returnTrackingId,omitempty"`
	// Items to be returned.
	// Must not be empty.
	Items []ReturnItemDraft `json:"items"`
	// Value to set.
	// If not set, it defaults to the current date and time.
	ReturnDate *time.Time `json:"returnDate,omitempty"`
}

* * Produces the [Return Info Added](ctp:api:type:ReturnInfoAddedMessage) Message. *

func (StagedOrderAddReturnInfoAction) MarshalJSON ¶ 

func (obj StagedOrderAddReturnInfoAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderAddShoppingListAction ¶ 

type StagedOrderAddShoppingListAction struct {
	// Shopping List that contains the Line Items to be added.
	ShoppingList ShoppingListResourceIdentifier `json:"shoppingList"`
	// `distributionChannel` to set for all [LineItems](ctp:api:type:LineItem) that are added to the Cart.
	// The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
	// `supplyChannel` to set for all [LineItems](ctp:api:type:LineItem) that are added to the Cart.
	// The Channel must have the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel *ChannelResourceIdentifier `json:"supplyChannel,omitempty"`
}

* * Adds all [LineItems](ctp:api:type:LineItem) of a ShoppingList(ctp:api:type:ShoppingList) to the Cart. *

func (StagedOrderAddShoppingListAction) MarshalJSON ¶ 

func (obj StagedOrderAddShoppingListAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderChangeCustomLineItemMoneyAction ¶ 

type StagedOrderChangeCustomLineItemMoneyAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Value to set.
	// Must not be empty.
	// Can be a negative amount.
	Money Money `json:"money"`
}

func (StagedOrderChangeCustomLineItemMoneyAction) MarshalJSON ¶ 

func (obj StagedOrderChangeCustomLineItemMoneyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderChangeCustomLineItemQuantityAction ¶ 

type StagedOrderChangeCustomLineItemQuantityAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// New value to set.
	// If `0`, the Custom Line Item is removed from the Order.
	Quantity int `json:"quantity"`
}

* * When multiple shipping addresses are set for a Custom Line Item, use the [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update action to change the shipping details. Since it is not possible for the API to infer how the overall change in the Custom Line Item quantity should be distributed over the sub-quantities, the `shippingDetails` field is kept in its current state to avoid data loss. * * To change the Custom Line Item quantity and shipping details together, use this update action in combination with the [Set CustomLineItem ShippingDetails](ctp:api:type:StagedOrderSetCustomLineItemShippingDetailsAction) update action in a single Order update command. *

func (StagedOrderChangeCustomLineItemQuantityAction) MarshalJSON ¶ 

func (obj StagedOrderChangeCustomLineItemQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderChangeLineItemQuantityAction ¶ 

type StagedOrderChangeLineItemQuantityAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// New value to set.
	// If `0`, the LineItem is removed from the Order.
	Quantity int `json:"quantity"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` to the given value when changing the quantity of a Line Item with the `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	//
	// The [LineItem](ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	ExternalPrice *Money `json:"externalPrice,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` and `totalPrice` to the given value when changing the quantity of a Line Item with the `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
}

* * When multiple shipping addresses are set for a Line Item, use the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) and [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction) update action to change the shipping details. Since it is not possible for the API to infer how the overall change in the Line Item quantity should be distributed over the sub-quantities, the `shippingDetails` field is kept in its current state to avoid data loss. * * To change the Line Item quantity and shipping details together, use this update action in combination with the [Set LineItem ShippingDetails](ctp:api:type:StagedOrderSetLineItemShippingDetailsAction) update action in a single Order update command. * * The LineItem(ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). *

func (StagedOrderChangeLineItemQuantityAction) MarshalJSON ¶ 

func (obj StagedOrderChangeLineItemQuantityAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderChangeOrderStateAction ¶ 

type StagedOrderChangeOrderStateAction struct {
	// New status of the Order.
	OrderState OrderState `json:"orderState"`
}

* * Produces the [Order State Changed](ctp:api:type:OrderStateChangedMessage) Message. *

func (StagedOrderChangeOrderStateAction) MarshalJSON ¶ 

func (obj StagedOrderChangeOrderStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderChangePaymentStateAction ¶ 

type StagedOrderChangePaymentStateAction struct {
	// New payment status of the Order.
	PaymentState PaymentState `json:"paymentState"`
}

* * Produces the [Order Payment State Changed](ctp:api:type:OrderPaymentStateChangedMessage) Message. *

func (StagedOrderChangePaymentStateAction) MarshalJSON ¶ 

func (obj StagedOrderChangePaymentStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderChangeShipmentStateAction ¶ 

type StagedOrderChangeShipmentStateAction struct {
	// New shipment status of the Order.
	ShipmentState ShipmentState `json:"shipmentState"`
}

* * Produces the [Order Shipment State Changed](ctp:api:type:OrderShipmentStateChangedMessage) Message. *

func (StagedOrderChangeShipmentStateAction) MarshalJSON ¶ 

func (obj StagedOrderChangeShipmentStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderChangeTaxCalculationModeAction ¶ 

type StagedOrderChangeTaxCalculationModeAction struct {
	// New value to set.
	TaxCalculationMode TaxCalculationMode `json:"taxCalculationMode"`
}

* * Changing the tax calculation mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation). *

func (StagedOrderChangeTaxCalculationModeAction) MarshalJSON ¶ 

func (obj StagedOrderChangeTaxCalculationModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderChangeTaxModeAction ¶ 

type StagedOrderChangeTaxModeAction struct {
	// The new TaxMode.
	TaxMode TaxMode `json:"taxMode"`
}

* * - When `External` TaxMode(ctp:api:type:TaxMode) is changed to `Platform` or `Disabled`, all previously set external Tax Rates are removed. * - When set to `Platform`, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's `shippingAddress`. *

func (StagedOrderChangeTaxModeAction) MarshalJSON ¶ 

func (obj StagedOrderChangeTaxModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderChangeTaxRoundingModeAction ¶ 

type StagedOrderChangeTaxRoundingModeAction struct {
	// New value to set.
	TaxRoundingMode RoundingMode `json:"taxRoundingMode"`
}

* * Changing the tax rounding mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation). *

func (StagedOrderChangeTaxRoundingModeAction) MarshalJSON ¶ 

func (obj StagedOrderChangeTaxRoundingModeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderImportCustomLineItemStateAction ¶ 

type StagedOrderImportCustomLineItemStateAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// New status of the Custom Line Items.
	State []ItemState `json:"state"`
}

* * The import of States does not follow any predefined rules and should be only used if no transitions are defined. * The `quantity` of the [ItemStates](ctp:api:type:ItemState) must match the sum of all Custom Line Item states' quantities. *

func (StagedOrderImportCustomLineItemStateAction) MarshalJSON ¶ 

func (obj StagedOrderImportCustomLineItemStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderImportLineItemStateAction ¶ 

type StagedOrderImportLineItemStateAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// New status of the Line Items.
	State []ItemState `json:"state"`
}

* * The import of States does not follow any predefined rules and should be only used if no transitions are defined. * The `quantity` in the [ItemStates](ctp:api:type:ItemState) must match the sum of all Line Item states' quantities. *

func (StagedOrderImportLineItemStateAction) MarshalJSON ¶ 

func (obj StagedOrderImportLineItemStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderRemoveCustomLineItemAction ¶ 

type StagedOrderRemoveCustomLineItemAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
}

* * This update action does not support specifying a quantity, unlike the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. * * If `shippingDetails` must be partially removed, use the [Change CustomLineItem Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action. *

func (StagedOrderRemoveCustomLineItemAction) MarshalJSON ¶ 

func (obj StagedOrderRemoveCustomLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderRemoveDeliveryAction ¶ 

type StagedOrderRemoveDeliveryAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
}

* * Produces the [DeliveryRemoved](ctp:api:type:DeliveryRemovedMessage) Message. *

func (StagedOrderRemoveDeliveryAction) MarshalJSON ¶ 

func (obj StagedOrderRemoveDeliveryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderRemoveDiscountCodeAction ¶ 

type StagedOrderRemoveDiscountCodeAction struct {
	// Discount Code to remove from the Cart.
	DiscountCode DiscountCodeReference `json:"discountCode"`
}

func (StagedOrderRemoveDiscountCodeAction) MarshalJSON ¶ 

func (obj StagedOrderRemoveDiscountCodeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderRemoveItemShippingAddressAction ¶ 

type StagedOrderRemoveItemShippingAddressAction struct {
	// `key` of the Address to remove from `itemShippingAddresses`.
	AddressKey string `json:"addressKey"`
}

* * An address can only be removed if it is not referenced in any ItemShippingTarget(ctp:api:type:ItemShippingTarget) of the Cart. *

func (StagedOrderRemoveItemShippingAddressAction) MarshalJSON ¶ 

func (obj StagedOrderRemoveItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderRemoveLineItemAction ¶ 

type StagedOrderRemoveLineItemAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// New value to set.
	// If absent or `0`, the Line Item is removed from the Cart.
	Quantity *int `json:"quantity,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` to the given value when decreasing the quantity of a Line Item with the `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalPrice *Money `json:"externalPrice,omitempty"`
	// Sets the [LineItem](ctp:api:type:LineItem) `price` and `totalPrice` to the given value when decreasing the quantity of a Line Item with the `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
	// Container for Line Item-specific addresses to remove.
	ShippingDetailsToRemove *ItemShippingDetailsDraft `json:"shippingDetailsToRemove,omitempty"`
}

* * The LineItem(ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). *

func (StagedOrderRemoveLineItemAction) MarshalJSON ¶ 

func (obj StagedOrderRemoveLineItemAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderRemoveParcelFromDeliveryAction ¶ 

type StagedOrderRemoveParcelFromDeliveryAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
}

* * Produces the [ParcelRemovedFromDelivery](ctp:api:type:ParcelRemovedFromDeliveryMessage) Message. *

func (StagedOrderRemoveParcelFromDeliveryAction) MarshalJSON ¶ 

func (obj StagedOrderRemoveParcelFromDeliveryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderRemovePaymentAction ¶ 

type StagedOrderRemovePaymentAction struct {
	// Payment to remove from the [PaymentInfo](ctp:api:type:PaymentInfo).
	Payment PaymentResourceIdentifier `json:"payment"`
}

func (StagedOrderRemovePaymentAction) MarshalJSON ¶ 

func (obj StagedOrderRemovePaymentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetBillingAddressAction ¶ 

type StagedOrderSetBillingAddressAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Address *BaseAddress `json:"address,omitempty"`
}

* * This action updates the `billingAddress` on the Order, but it does not change the billing address on the referenced Cart(ctp:api:type:Cart) from which the Order is created. * * Produces the [Order Billing Address Set](ctp:api:type:OrderBillingAddressSetMessage) Message. *

func (StagedOrderSetBillingAddressAction) MarshalJSON ¶ 

func (obj StagedOrderSetBillingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetBillingAddressCustomFieldAction ¶ 

type StagedOrderSetBillingAddressCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetBillingAddressCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetBillingAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetBillingAddressCustomTypeAction ¶ 

type StagedOrderSetBillingAddressCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the `billingAddress` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `billingAddress`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `billingAddress`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetBillingAddressCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetBillingAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCountryAction ¶ 

type StagedOrderSetCountryAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	//
	// If the Cart is bound to a `store`, the provided value must be included in the [Store](ctp:api:type:Store)'s `countries`.
	// Otherwise a [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) error is returned.
	Country *string `json:"country,omitempty"`
}

* * Setting the country can lead to changes in the LineItem(ctp:api:type:LineItem) prices. *

func (StagedOrderSetCountryAction) MarshalJSON ¶ 

func (obj StagedOrderSetCountryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomFieldAction ¶ 

type StagedOrderSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomLineItemCustomFieldAction ¶ 

type StagedOrderSetCustomLineItemCustomFieldAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetCustomLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomLineItemCustomTypeAction ¶ 

type StagedOrderSetCustomLineItemCustomTypeAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Custom Line Item with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Custom Line Item.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Custom Line Item.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetCustomLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomLineItemShippingDetailsAction ¶ 

type StagedOrderSetCustomLineItemShippingDetailsAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
}

func (StagedOrderSetCustomLineItemShippingDetailsAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomLineItemShippingDetailsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomLineItemTaxAmountAction ¶ 

type StagedOrderSetCustomLineItemTaxAmountAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ExternalTaxAmount *ExternalTaxAmountDraft `json:"externalTaxAmount,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Custom Line Item.
	// This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Can be used if the Cart has the `ExternalAmount` TaxMode(ctp:api:type:TaxMode). *

func (StagedOrderSetCustomLineItemTaxAmountAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomLineItemTaxAmountAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomLineItemTaxRateAction ¶ 

type StagedOrderSetCustomLineItemTaxRateAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Value to set.
	// If empty, an existing value is removed.
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Custom Line Item.
	// This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Can be used if the Cart has the `External` TaxMode(ctp:api:type:TaxMode). *

func (StagedOrderSetCustomLineItemTaxRateAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomLineItemTaxRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomShippingMethodAction ¶ 

type StagedOrderSetCustomShippingMethodAction struct {
	// Name of the custom Shipping Method.
	ShippingMethodName string `json:"shippingMethodName"`
	// Determines the shipping price.
	ShippingRate ShippingRateDraft `json:"shippingRate"`
	// Tax Category used to determine the Tax Rate when the Cart has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// External Tax Rate for the `shippingRate` to be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
}

* * To set the Cart's custom Shipping Method (independent of the [ShippingMethods](ctp:api:type:ShippingMethod) managed through the [Shipping Methods API](/../api/projects/shippingMethods)) the Cart must have the `Single` ShippingMode(ctp:api:type:ShippingMode) and a `shippingAddress`. * * To unset a custom Shipping Method on a Cart, use the [Set ShippingMethod](ctp:api:type:StagedOrderSetShippingMethodAction) update action without the `shippingMethod` field instead. *

func (StagedOrderSetCustomShippingMethodAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomTypeAction ¶ 

type StagedOrderSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Order Edit with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Order Edit.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Order Edit.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomerEmailAction ¶ 

type StagedOrderSetCustomerEmailAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Email *string `json:"email,omitempty"`
}

* * This action updates the `customerEmail` on the Order, but it does not change the Customer email on the Cart(ctp:api:type:Cart) the Order has been created from. * * Produces the [Order Customer Email Set](ctp:api:type:OrderCustomerEmailSetMessage) Message. *

func (StagedOrderSetCustomerEmailAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomerEmailAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomerGroupAction ¶ 

type StagedOrderSetCustomerGroupAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
}

* * This update action can only be used if a Customer is not assigned to a Cart. If a Customer is already assigned, the Cart has the same Customer Group as the assigned Customer. * * Setting the Customer Group also updates the LineItem(ctp:api:type:LineItem) `prices` according to the Customer Group. *

func (StagedOrderSetCustomerGroupAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomerGroupAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetCustomerIdAction ¶ 

type StagedOrderSetCustomerIdAction struct {
	// `id` of an existing [Customer](ctp:api:type:Customer).
	// If empty, any existing value is removed.
	CustomerId *string `json:"customerId,omitempty"`
}

* * Setting the Order's `customerId` does not recalculate prices or discounts on the Order. * If the Customer belongs to a Customer Group, `customerGroup` on the Order(ctp:api:type:Order) is updated automatically. * * Produces the [OrderCustomerSet](ctp:api:type:OrderCustomerSetMessage) Message. *

func (StagedOrderSetCustomerIdAction) MarshalJSON ¶ 

func (obj StagedOrderSetCustomerIdAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetDeliveryAddressAction ¶ 

type StagedOrderSetDeliveryAddressAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Value to set.
	// If empty, any existing value will be removed.
	Address *BaseAddress `json:"address,omitempty"`
}

* * Produces the [DeliveryAddressSet](ctp:api:type:DeliveryAddressSetMessage) Message. *

func (StagedOrderSetDeliveryAddressAction) MarshalJSON ¶ 

func (obj StagedOrderSetDeliveryAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetDeliveryAddressCustomFieldAction ¶ 

type StagedOrderSetDeliveryAddressCustomFieldAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetDeliveryAddressCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetDeliveryAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetDeliveryAddressCustomTypeAction ¶ 

type StagedOrderSetDeliveryAddressCustomTypeAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the [Delivery](ctp:api:type:Delivery) `address` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the [Delivery](ctp:api:type:Delivery) `address`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the [Delivery](ctp:api:type:Delivery) `address`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetDeliveryAddressCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetDeliveryAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetDeliveryCustomFieldAction ¶ 

type StagedOrderSetDeliveryCustomFieldAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetDeliveryCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetDeliveryCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetDeliveryCustomTypeAction ¶ 

type StagedOrderSetDeliveryCustomTypeAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Delivery with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Delivery.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Delivery.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetDeliveryCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetDeliveryCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetDeliveryItemsAction ¶ 

type StagedOrderSetDeliveryItemsAction struct {
	// `id` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryId *string `json:"deliveryId,omitempty"`
	// `key` of an existing [Delivery](ctp:api:type:Delivery).
	//
	// Either `deliveryId` or `deliveryKey` must be provided.
	DeliveryKey *string `json:"deliveryKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	Items []DeliveryItem `json:"items"`
}

* * Produces the [Delivery Items Updated](ctp:api:type:DeliveryItemsUpdatedMessage) Message. *

func (StagedOrderSetDeliveryItemsAction) MarshalJSON ¶ 

func (obj StagedOrderSetDeliveryItemsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetDirectDiscountsAction ¶ added in v1.4.0 

type StagedOrderSetDirectDiscountsAction struct {
	// - If set, all existing Direct Discounts are replaced.
	//   The discounts apply in the order they are added to the list.
	// - If empty, all existing Direct Discounts are removed and all affected prices on the Order are recalculated.
	Discounts []DirectDiscountDraft `json:"discounts"`
}

* * Adds a DirectDiscount(ctp:api:type:DirectDiscount), but only if no DiscountCode(ctp:api:type:DiscountCode) has been added to the Order. * Either a Discount Code or a Direct Discount can exist on a Order at the same time. *

func (StagedOrderSetDirectDiscountsAction) MarshalJSON ¶ added in v1.4.0 

func (obj StagedOrderSetDirectDiscountsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetItemShippingAddressCustomFieldAction ¶ 

type StagedOrderSetItemShippingAddressCustomFieldAction struct {
	// `key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
	AddressKey string `json:"addressKey"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetItemShippingAddressCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetItemShippingAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetItemShippingAddressCustomTypeAction ¶ 

type StagedOrderSetItemShippingAddressCustomTypeAction struct {
	// `key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
	AddressKey string `json:"addressKey"`
	// Defines the [Type](ctp:api:type:Type) that extends the `itemShippingAddress` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `itemShippingAddress`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `itemShippingAddress`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetItemShippingAddressCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetItemShippingAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetLineItemCustomFieldAction ¶ 

type StagedOrderSetLineItemCustomFieldAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetLineItemCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetLineItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetLineItemCustomTypeAction ¶ 

type StagedOrderSetLineItemCustomTypeAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Line Item with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Line Item.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Line Item.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetLineItemCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetLineItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetLineItemDistributionChannelAction ¶ 

type StagedOrderSetLineItemDistributionChannelAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// - If present, a [Reference](ctp:api:type:Reference) to the Channel is set for the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	// - If not present, the current [Reference](ctp:api:type:Reference) to a distribution channel is removed from the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`.
	//   The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	DistributionChannel *ChannelResourceIdentifier `json:"distributionChannel,omitempty"`
}

* * Setting a distribution channel for a LineItem(ctp:api:type:LineItem) can lead to an updated `price` as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). * * Produces the [OrderLineItemDistributionChannelSet](ctp:api:type:OrderLineItemDistributionChannelSetMessage) Message. *

func (StagedOrderSetLineItemDistributionChannelAction) MarshalJSON ¶ 

func (obj StagedOrderSetLineItemDistributionChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetLineItemPriceAction ¶ 

type StagedOrderSetLineItemPriceAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If `externalPrice` is not given and the `priceMode` is `ExternalPrice`, the external price is unset and the `priceMode` is set to `Platform`.
	ExternalPrice *Money `json:"externalPrice,omitempty"`
}

* * Sets the LineItem(ctp:api:type:LineItem) `price` and changes the `priceMode` to `ExternalPrice` LineItemPriceMode(ctp:api:type:LineItemPriceMode). *

func (StagedOrderSetLineItemPriceAction) MarshalJSON ¶ 

func (obj StagedOrderSetLineItemPriceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetLineItemShippingDetailsAction ¶ 

type StagedOrderSetLineItemShippingDetailsAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If empty, the existing value is removed.
	ShippingDetails *ItemShippingDetailsDraft `json:"shippingDetails,omitempty"`
}

func (StagedOrderSetLineItemShippingDetailsAction) MarshalJSON ¶ 

func (obj StagedOrderSetLineItemShippingDetailsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetLineItemTaxAmountAction ¶ 

type StagedOrderSetLineItemTaxAmountAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If empty, any existing value will be removed.
	ExternalTaxAmount *ExternalTaxAmountDraft `json:"externalTaxAmount,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Line Item.
	// This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Can be used if the Cart has the `ExternalAmount` TaxMode(ctp:api:type:TaxMode). *

func (StagedOrderSetLineItemTaxAmountAction) MarshalJSON ¶ 

func (obj StagedOrderSetLineItemTaxAmountAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetLineItemTaxRateAction ¶ 

type StagedOrderSetLineItemTaxRateAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If empty, any existing value will be removed.
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Line Item.
	// This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
}

* * Can be used if the Cart has the `External` TaxMode(ctp:api:type:TaxMode). *

func (StagedOrderSetLineItemTaxRateAction) MarshalJSON ¶ 

func (obj StagedOrderSetLineItemTaxRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetLineItemTotalPriceAction ¶ 

type StagedOrderSetLineItemTotalPriceAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Value to set.
	// If `externalTotalPrice` is not given and the `priceMode` is `ExternalTotal`, the external price is unset and the `priceMode` is set to `Platform`.
	ExternalTotalPrice *ExternalLineItemTotalPrice `json:"externalTotalPrice,omitempty"`
}

* * Sets the LineItem(ctp:api:type:LineItem) `totalPrice` and `price`, and changes the `priceMode` to `ExternalTotal` LineItemPriceMode(ctp:api:type:LineItemPriceMode). *

func (StagedOrderSetLineItemTotalPriceAction) MarshalJSON ¶ 

func (obj StagedOrderSetLineItemTotalPriceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetLocaleAction ¶ 

type StagedOrderSetLocaleAction struct {
	// Value to set.
	// Must be one of the [Project](ctp:api:type:Project)'s languages.
	// If empty, any existing value is removed.
	Locale *string `json:"locale,omitempty"`
}

func (StagedOrderSetLocaleAction) MarshalJSON ¶ 

func (obj StagedOrderSetLocaleAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetOrderNumberAction ¶ 

type StagedOrderSetOrderNumberAction struct {
	// Value to set. Must be unique across a Project.
	// Once set, the value cannot be changed.
	OrderNumber *string `json:"orderNumber,omitempty"`
}

func (StagedOrderSetOrderNumberAction) MarshalJSON ¶ 

func (obj StagedOrderSetOrderNumberAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetOrderTotalTaxAction ¶ 

type StagedOrderSetOrderTotalTaxAction struct {
	// Total gross amount of the Order (totalNet + taxes).
	ExternalTotalGross Money `json:"externalTotalGross"`
	// Value to set.
	ExternalTaxPortions []TaxPortionDraft `json:"externalTaxPortions"`
}

* * Updates the total tax amount of the Order if it has the `ExternalAmount` TaxMode(ctp:api:type:TaxMode). *

func (StagedOrderSetOrderTotalTaxAction) MarshalJSON ¶ 

func (obj StagedOrderSetOrderTotalTaxAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetParcelCustomFieldAction ¶ 

type StagedOrderSetParcelCustomFieldAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetParcelCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetParcelCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetParcelCustomTypeAction ¶ 

type StagedOrderSetParcelCustomTypeAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Parcel with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Parcel.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Parcel.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetParcelCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetParcelCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetParcelItemsAction ¶ 

type StagedOrderSetParcelItemsAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Value to set.
	// If empty, any existing value will be removed.
	Items []DeliveryItem `json:"items"`
}

* * Produces the [ParcelItemsUpdated](ctp:api:type:ParcelItemsUpdatedMessage) Message. *

func (StagedOrderSetParcelItemsAction) MarshalJSON ¶ 

func (obj StagedOrderSetParcelItemsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetParcelMeasurementsAction ¶ 

type StagedOrderSetParcelMeasurementsAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Value to set.
	// If empty, any existing value will be removed.
	Measurements *ParcelMeasurements `json:"measurements,omitempty"`
}

* * Produces the [ParcelMeasurementsUpdated](ctp:api:type:ParcelMeasurementsUpdatedMessage) Message. *

func (StagedOrderSetParcelMeasurementsAction) MarshalJSON ¶ 

func (obj StagedOrderSetParcelMeasurementsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetParcelTrackingDataAction ¶ 

type StagedOrderSetParcelTrackingDataAction struct {
	// `id` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelId *string `json:"parcelId,omitempty"`
	// `key` of an existing [Parcel](ctp:api:type:Parcel).
	//
	// Either `parcelId` or `parcelKey` must be provided.
	ParcelKey *string `json:"parcelKey,omitempty"`
	// Value to set.
	// If empty, any existing value will be removed.
	TrackingData *TrackingData `json:"trackingData,omitempty"`
}

* * Produces the [ParcelTrackingDataUpdated](ctp:api:type:ParcelTrackingDataUpdatedMessage) Message. *

func (StagedOrderSetParcelTrackingDataAction) MarshalJSON ¶ 

func (obj StagedOrderSetParcelTrackingDataAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetPurchaseOrderNumberAction ¶ added in v1.3.0 

type StagedOrderSetPurchaseOrderNumberAction struct {
	// Value to set.
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
}

* * Produces the [PurchaseOrderNumberSet](ctp:api:type:OrderPurchaseOrderNumberSetMessage) Message. *

func (StagedOrderSetPurchaseOrderNumberAction) MarshalJSON ¶ added in v1.3.0 

func (obj StagedOrderSetPurchaseOrderNumberAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetReturnInfoAction ¶ 

type StagedOrderSetReturnInfoAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Items []ReturnInfoDraft `json:"items"`
}

* * Produces the [Return Info Set](ctp:api:type:ReturnInfoSetMessage) Message. *

func (StagedOrderSetReturnInfoAction) MarshalJSON ¶ 

func (obj StagedOrderSetReturnInfoAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetReturnItemCustomFieldAction ¶ 

type StagedOrderSetReturnItemCustomFieldAction struct {
	// `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemId *string `json:"returnItemId,omitempty"`
	// `key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemKey *string `json:"returnItemKey,omitempty"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetReturnItemCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetReturnItemCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetReturnItemCustomTypeAction ¶ 

type StagedOrderSetReturnItemCustomTypeAction struct {
	// `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemId *string `json:"returnItemId,omitempty"`
	// `key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemKey *string `json:"returnItemKey,omitempty"`
	// Defines the [Type](ctp:api:type:Type) that extends the Return Item with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Return Item.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Return Item.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetReturnItemCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetReturnItemCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetReturnPaymentStateAction ¶ 

type StagedOrderSetReturnPaymentStateAction struct {
	// `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemId *string `json:"returnItemId,omitempty"`
	// `key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemKey *string `json:"returnItemKey,omitempty"`
	// New Payment status of the [ReturnItem](ctp:api:type:ReturnItem).
	PaymentState ReturnPaymentState `json:"paymentState"`
}

* * To set a ReturnPaymentState(ctp:api:type:ReturnPaymentState), the Order(ctp:api:type:Order) `returnInfo` must have at least one ReturnItem(ctp:api:type:ReturnItem). *

func (StagedOrderSetReturnPaymentStateAction) MarshalJSON ¶ 

func (obj StagedOrderSetReturnPaymentStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetReturnShipmentStateAction ¶ 

type StagedOrderSetReturnShipmentStateAction struct {
	// `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemId *string `json:"returnItemId,omitempty"`
	// `key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
	ReturnItemKey *string `json:"returnItemKey,omitempty"`
	// New shipment state of the [ReturnItem](ctp:api:type:ReturnItem).
	ShipmentState ReturnShipmentState `json:"shipmentState"`
}

* * To set a `ReturnShipmentState`, the Order(ctp:api:type:Order) `returnInfo` must have at least one ReturnItem(ctp:api:type:ReturnItem). * * Produces the [Order Return Shipment State Changed](ctp:api:type:OrderReturnShipmentStateChangedMessage) Message. *

func (StagedOrderSetReturnShipmentStateAction) MarshalJSON ¶ 

func (obj StagedOrderSetReturnShipmentStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetShippingAddressAction ¶ 

type StagedOrderSetShippingAddressAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	Address *BaseAddress `json:"address,omitempty"`
}

* * This action updates the `shippingAddress` on the Order, but it does not change the shipping address on the referenced Cart(ctp:api:type:Cart) from which the Order is created. * Also, it does not recalculate the Cart as taxes may not fit to the shipping address anymore. * * Produces the [Order Shipping Address Set](ctp:api:type:OrderShippingAddressSetMessage) Message. *

func (StagedOrderSetShippingAddressAction) MarshalJSON ¶ 

func (obj StagedOrderSetShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetShippingAddressAndCustomShippingMethodAction ¶ 

type StagedOrderSetShippingAddressAndCustomShippingMethodAction struct {
	// Value to set for `shippingAddress`.
	Address BaseAddress `json:"address"`
	// Value to set.
	ShippingMethodName string `json:"shippingMethodName"`
	// Value to set.
	ShippingRate ShippingRateDraft `json:"shippingRate"`
	// Used to select a Tax Rate when the Order has the `Platform` [TaxMode](ctp:api:type:TaxMode).
	TaxCategory *TaxCategoryResourceIdentifier `json:"taxCategory,omitempty"`
	// An external Tax Rate can be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
}

* * Sets the shipping address and a custom Shipping Method together to prevent an inconsistent state. *

func (StagedOrderSetShippingAddressAndCustomShippingMethodAction) MarshalJSON ¶ 

func (obj StagedOrderSetShippingAddressAndCustomShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetShippingAddressAndShippingMethodAction ¶ 

type StagedOrderSetShippingAddressAndShippingMethodAction struct {
	// Value to set for `shippingAddress`.
	Address BaseAddress `json:"address"`
	// Value to set.
	ShippingMethod *ShippingMethodResourceIdentifier `json:"shippingMethod,omitempty"`
	// An external Tax Rate can be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
}

* * Sets the shipping address and Shipping Method together to prevent an inconsistent state. *

func (StagedOrderSetShippingAddressAndShippingMethodAction) MarshalJSON ¶ 

func (obj StagedOrderSetShippingAddressAndShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetShippingAddressCustomFieldAction ¶ 

type StagedOrderSetShippingAddressCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedOrderSetShippingAddressCustomFieldAction) MarshalJSON ¶ 

func (obj StagedOrderSetShippingAddressCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetShippingAddressCustomTypeAction ¶ 

type StagedOrderSetShippingAddressCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the `shippingAddress` with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the `shippingAddress`.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `shippingAddress`.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedOrderSetShippingAddressCustomTypeAction) MarshalJSON ¶ 

func (obj StagedOrderSetShippingAddressCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetShippingMethodAction ¶ 

type StagedOrderSetShippingMethodAction struct {
	// Value to set. If empty, any existing value will be removed.
	// If the referenced Shipping Method has a predicate that does not match the Cart, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
	ShippingMethod *ShippingMethodResourceIdentifier `json:"shippingMethod,omitempty"`
	// An external Tax Rate can be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
}

* * To set the Cart's Shipping Method, the Cart must have the `Single` ShippingMode(ctp:api:type:ShippingMode) and a `shippingAddress`. *

func (StagedOrderSetShippingMethodAction) MarshalJSON ¶ 

func (obj StagedOrderSetShippingMethodAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetShippingMethodTaxAmountAction ¶ 

type StagedOrderSetShippingMethodTaxAmountAction struct {
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) to update. This is required for Orders with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Value to set. If empty, any existing value will be removed.
	ExternalTaxAmount *ExternalTaxAmountDraft `json:"externalTaxAmount,omitempty"`
}

* * A Shipping Method tax amount can be set if the Cart has the `ExternalAmount` TaxMode(ctp:api:type:TaxMode). *

func (StagedOrderSetShippingMethodTaxAmountAction) MarshalJSON ¶ 

func (obj StagedOrderSetShippingMethodTaxAmountAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetShippingMethodTaxRateAction ¶ 

type StagedOrderSetShippingMethodTaxRateAction struct {
	// `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) to update. This is required for Orders with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
	ShippingKey *string `json:"shippingKey,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ExternalTaxRate *ExternalTaxRateDraft `json:"externalTaxRate,omitempty"`
}

* * A Shipping Method Tax Rate can be set if the Cart has the `External` TaxMode(ctp:api:type:TaxMode). *

func (StagedOrderSetShippingMethodTaxRateAction) MarshalJSON ¶ 

func (obj StagedOrderSetShippingMethodTaxRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderSetShippingRateInputAction ¶ 

type StagedOrderSetShippingRateInputAction struct {
	// The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
	//
	// - If `CartClassification`, it must be [ClassificationShippingRateInputDraft](ctp:api:type:ClassificationShippingRateInputDraft).
	// - If `CartScore`, it must be [ScoreShippingRateInputDraft](ctp:api:type:ScoreShippingRateInputDraft).
	// - If `CartValue`, it cannot be set.
	ShippingRateInput ShippingRateInputDraft `json:"shippingRateInput,omitempty"`
}

* * Input used to select a ShippingRatePriceTier(ctp:api:type:ShippingRatePriceTier). If no matching tier can be found, or the input is not set, the default price for the shipping rate is used. *

func (StagedOrderSetShippingRateInputAction) MarshalJSON ¶ 

func (obj StagedOrderSetShippingRateInputAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StagedOrderSetShippingRateInputAction) UnmarshalJSON ¶ 

func (obj *StagedOrderSetShippingRateInputAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedOrderSetStoreAction ¶ added in v1.4.0 

type StagedOrderSetStoreAction struct {
	// Value to set. If empty, any existing value will be removed.
	//
	// If `store` references the same Store the Order is currently assigned to or if you try to remove the value when no Store is currently assigned, a `400` error is returned.
	Store *StoreResourceIdentifier `json:"store,omitempty"`
}

* * Sets the Store(ctp:api:type:Store) the Order is assigned to. * It should be used to migrate Orders to a new Store. * No validations are performed (such as that the Customer is allowed to create Orders in the Store). * * Produces the [Order Store Set](ctp:api:type:OrderStoreSetMessage) Message. * Returns a `400` error if `store` references the same Store the Order is currently assigned to, including if you try to remove the value when no Store is currently assigned. *

func (StagedOrderSetStoreAction) MarshalJSON ¶ added in v1.4.0 

func (obj StagedOrderSetStoreAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderTransitionCustomLineItemStateAction ¶ 

type StagedOrderTransitionCustomLineItemStateAction struct {
	// `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemId *string `json:"customLineItemId,omitempty"`
	// `key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
	CustomLineItemKey *string `json:"customLineItemKey,omitempty"`
	// Number of Custom Line Items that should transition [State](ctp:api:type:State).
	Quantity int `json:"quantity"`
	// [State](ctp:api:type:State) the Custom Line Item should transition from.
	FromState StateResourceIdentifier `json:"fromState"`
	// [State](ctp:api:type:State) the Custom Line Item should transition to.
	ToState StateResourceIdentifier `json:"toState"`
	// Date and time (UTC) to perform the [State](ctp:api:type:State) transition.
	ActualTransitionDate *time.Time `json:"actualTransitionDate,omitempty"`
}

* * Produces the [Custom Line Item State Transition](ctp:api:type:CustomLineItemStateTransitionMessage) Message. *

func (StagedOrderTransitionCustomLineItemStateAction) MarshalJSON ¶ 

func (obj StagedOrderTransitionCustomLineItemStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderTransitionLineItemStateAction ¶ 

type StagedOrderTransitionLineItemStateAction struct {
	// `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemId *string `json:"lineItemId,omitempty"`
	// `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
	LineItemKey *string `json:"lineItemKey,omitempty"`
	// Number of Line Items that should transition [State](ctp:api:type:State).
	Quantity int `json:"quantity"`
	// [State](ctp:api:type:State) the Line Item should transition from.
	FromState StateResourceIdentifier `json:"fromState"`
	// [State](ctp:api:type:State) the Line Item should transition to.
	ToState StateResourceIdentifier `json:"toState"`
	// Date and time (UTC) to perform the [State](ctp:api:type:State) transition.
	ActualTransitionDate *time.Time `json:"actualTransitionDate,omitempty"`
}

* * Produces the [Line Item State Transition](ctp:api:type:LineItemStateTransitionMessage) Message. *

func (StagedOrderTransitionLineItemStateAction) MarshalJSON ¶ 

func (obj StagedOrderTransitionLineItemStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderTransitionStateAction ¶ 

type StagedOrderTransitionStateAction struct {
	// Value to set.
	// If there is no State yet, the new State must be an initial State.
	State StateResourceIdentifier `json:"state"`
	// Set to `true` to turn off validation.
	Force *bool `json:"force,omitempty"`
}

* * If the existing State(ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State. If `transitions` is not set, no validation is performed. * * This update action produces the [Order State Transition](ctp:api:type:OrderStateTransitionMessage) Message. *

func (StagedOrderTransitionStateAction) MarshalJSON ¶ 

func (obj StagedOrderTransitionStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderUpdateAction ¶ 

type StagedOrderUpdateAction interface{}

type StagedOrderUpdateItemShippingAddressAction ¶ 

type StagedOrderUpdateItemShippingAddressAction struct {
	// The new Address with the same `key` as the Address it will replace.
	Address BaseAddress `json:"address"`
}

* * Updates an address in `itemShippingAddresses` by keeping the Address `key`. *

func (StagedOrderUpdateItemShippingAddressAction) MarshalJSON ¶ 

func (obj StagedOrderUpdateItemShippingAddressAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedOrderUpdateSyncInfoAction ¶ 

type StagedOrderUpdateSyncInfoAction struct {
	// Set this to identify an external order instance, file, or other resource.
	ExternalId *string `json:"externalId,omitempty"`
	// The synchronization destination to set. Must not be empty.
	// The referenced Channel must have the [Channel Role](ctp:api:type:ChannelRoleEnum) `OrderExport` or `OrderImport`.
	// Otherwise this update action returns an [InvalidInput](ctp:api:type:InvalidInputError) error.
	Channel ChannelResourceIdentifier `json:"channel"`
	// If not set, it defaults to the current date and time.
	SyncedAt *time.Time `json:"syncedAt,omitempty"`
}

func (StagedOrderUpdateSyncInfoAction) MarshalJSON ¶ 

func (obj StagedOrderUpdateSyncInfoAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedPriceDraft ¶ added in v1.4.0 

type StagedPriceDraft struct {
	// Money value for the StagedPriceDraft.
	Value TypedMoneyDraft `json:"value"`
}

func (*StagedPriceDraft) UnmarshalJSON ¶ added in v1.4.0 

func (obj *StagedPriceDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedQuote ¶ added in v1.2.0 

type StagedQuote struct {
	// The unique ID of the StagedQuote.
	ID string `json:"id"`
	// Current version of the StagedQuote.
	Version int `json:"version"`
	// Date and time (UTC) the StagedQuote was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the StagedQuote was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// User-specific unique identifier of the staged quote.
	Key *string `json:"key,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Predefined states tracking the status of the Staged Quote.
	StagedQuoteState StagedQuoteState `json:"stagedQuoteState"`
	// The [Buyer](/../api/quotes-overview#buyer) who requested the Quote.
	Customer *CustomerReference `json:"customer,omitempty"`
	// Quote Request related to the Staged Quote.
	QuoteRequest QuoteRequestReference `json:"quoteRequest"`
	// [Cart](ctp:api:type:Cart) containing the offered items. May contain either [DirectDiscounts](ctp:api:type:DirectDiscount) or [CartDiscounts](ctp:api:type:CartDiscount).
	QuotationCart CartReference `json:"quotationCart"`
	// Expiration date for the Quote.
	ValidTo *time.Time `json:"validTo,omitempty"`
	// Message from the [Seller](/../api/quotes-overview#seller) included in the offer.
	SellerComment *string `json:"sellerComment,omitempty"`
	// Custom Fields of the Staged Quote.
	Custom *CustomFields `json:"custom,omitempty"`
	// [State](ctp:api:type:State) of the Staged Quote.
	// This reference can point to a State in a custom workflow.
	State *StateReference `json:"state,omitempty"`
	// The Purchase Order Number is typically set by the [Buyer](/quotes-overview#buyer) on a [QuoteRequest](ctp:api:type:QuoteRequest) to
	// track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
	PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty"`
	// The [BusinessUnit](ctp:api:type:BusinessUnit) for the Staged Quote.
	BusinessUnit *BusinessUnitKeyReference `json:"businessUnit,omitempty"`
}

type StagedQuoteChangeStagedQuoteStateAction ¶ added in v1.2.0 

type StagedQuoteChangeStagedQuoteStateAction struct {
	// New state to be set for the Staged Quote.
	StagedQuoteState StagedQuoteState `json:"stagedQuoteState"`
}

func (StagedQuoteChangeStagedQuoteStateAction) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteChangeStagedQuoteStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteCreatedMessage ¶ added in v1.2.0 

type StagedQuoteCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Staged Quote](/../api/projects/staged-quotes) that was created.
	StagedQuote StagedQuote `json:"stagedQuote"`
}

* * Generated after a successful [Create StagedQuote](ctp:api:endpoint:/{projectKey}/staged-quotes:POST) request. *

func (StagedQuoteCreatedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StagedQuoteCreatedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StagedQuoteCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedQuoteCreatedMessagePayload ¶ added in v1.2.0 

type StagedQuoteCreatedMessagePayload struct {
	// [Staged Quote](/../api/projects/staged-quotes) that was created.
	StagedQuote StagedQuote `json:"stagedQuote"`
}

* * Generated after a successful [Create StagedQuote](ctp:api:endpoint:/{projectKey}/staged-quotes:POST) request. *

func (StagedQuoteCreatedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteDeletedMessage ¶ added in v1.2.0 

type StagedQuoteDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete StagedQuote](/../api/projects/staged-quotes#delete-stagedquote) request. *

func (StagedQuoteDeletedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StagedQuoteDeletedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StagedQuoteDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedQuoteDeletedMessagePayload ¶ added in v1.2.0 

type StagedQuoteDeletedMessagePayload struct {
}

* * Generated after a successful [Delete StagedQuote](/../api/projects/staged-quotes#delete-stagedquote) request. *

func (StagedQuoteDeletedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteDraft ¶ added in v1.2.0 

type StagedQuoteDraft struct {
	// QuoteRequest from which the StagedQuote is created.
	QuoteRequest QuoteRequestResourceIdentifier `json:"quoteRequest"`
	// Current version of the QuoteRequest.
	QuoteRequestVersion int `json:"quoteRequestVersion"`
	// If `true`, the `quoteRequestState` of the referenced [QuoteRequest](ctp:api:type:QuoteRequest) will be set to `Accepted`.
	QuoteRequestStateToAccepted *bool `json:"quoteRequestStateToAccepted,omitempty"`
	// User-defined unique identifier for the StagedQuote.
	Key *string `json:"key,omitempty"`
	// [Custom Fields](/../api/projects/custom-fields) to be added to the StagedQuote.
	//
	// - If specified, the Custom Fields are merged with the Custom Fields on the referenced [QuoteRequest](ctp:api:type:QuoteRequest) and added to the StagedQuote.
	// - If empty, the Custom Fields on the referenced [QuoteRequest](ctp:api:type:QuoteRequest) are added to the StagedQuote automatically.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// [State](ctp:api:type:State) of the Staged Quote.
	// This reference can point to a State in a custom workflow.
	State *StateReference `json:"state,omitempty"`
}

type StagedQuotePagedQueryResponse ¶ added in v1.2.0 

type StagedQuotePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Staged Quotes matching the query.
	Results []StagedQuote `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of StagedQuote(ctp:api:type:StagedQuote). *

type StagedQuoteReference ¶ added in v1.2.0 

type StagedQuoteReference struct {
	// Unique ID of the referenced resource.
	ID string `json:"id"`
	// Contains the representation of the expanded StagedQuote.
	// Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for StagedQuote.
	Obj *StagedQuote `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a StagedQuote(ctp:api:type:StagedQuote). *

func (StagedQuoteReference) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteResourceIdentifier ¶ added in v1.2.0 

type StagedQuoteResourceIdentifier struct {
	// Unique identifier of the referenced resource. Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced resource. Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a StagedQuote(ctp:api:type:StagedQuote). *

func (StagedQuoteResourceIdentifier) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteSellerCommentSetMessage ¶ added in v1.2.0 

type StagedQuoteSellerCommentSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// `sellerComment` on the [StagedQuote](ctp:api:type:StagedQuote) after a successful [Set Seller Comment](ctp:api:type:StagedQuoteSetSellerCommentAction) update action.
	SellerComment string `json:"sellerComment"`
}

* * Generated after a successful [Set Seller Comment](ctp:api:type:StagedQuoteSetSellerCommentAction) update action. *

func (StagedQuoteSellerCommentSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteSellerCommentSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StagedQuoteSellerCommentSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StagedQuoteSellerCommentSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedQuoteSellerCommentSetMessagePayload ¶ added in v1.2.0 

type StagedQuoteSellerCommentSetMessagePayload struct {
	// `sellerComment` on the [StagedQuote](ctp:api:type:StagedQuote) after a successful [Set Seller Comment](ctp:api:type:StagedQuoteSetSellerCommentAction) update action.
	SellerComment string `json:"sellerComment"`
}

* * Generated after a successful [Set Seller Comment](ctp:api:type:StagedQuoteSetSellerCommentAction) update action. *

func (StagedQuoteSellerCommentSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteSellerCommentSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteSetCustomFieldAction ¶ added in v1.2.0 

type StagedQuoteSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StagedQuoteSetCustomFieldAction) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteSetCustomTypeAction ¶ added in v1.2.0 

type StagedQuoteSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the StagedQuote with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the StagedQuote.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the StagedQuote.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StagedQuoteSetCustomTypeAction) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteSetSellerCommentAction ¶ added in v1.2.0 

type StagedQuoteSetSellerCommentAction struct {
	// If `sellerComment` is absent or `null`, this field will be removed if it exists.
	SellerComment *string `json:"sellerComment,omitempty"`
}

func (StagedQuoteSetSellerCommentAction) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteSetSellerCommentAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteSetValidToAction ¶ added in v1.2.0 

type StagedQuoteSetValidToAction struct {
	// If `validTo` is absent or `null`, this field will be removed if it exists.
	ValidTo *time.Time `json:"validTo,omitempty"`
}

func (StagedQuoteSetValidToAction) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteSetValidToAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteState ¶ added in v1.2.0 

type StagedQuoteState string

* * Predefined states tracking the status of the Staged Quote. * 

const (
	StagedQuoteStateInProgress StagedQuoteState = "InProgress"
	StagedQuoteStateSent       StagedQuoteState = "Sent"
	StagedQuoteStateClosed     StagedQuoteState = "Closed"
)

type StagedQuoteStateChangedMessage ¶ added in v1.2.0 

type StagedQuoteStateChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// State of the Staged Quote after the [Change Staged Quote State](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action.
	StagedQuoteState StagedQuoteState `json:"stagedQuoteState"`
	// State of the Staged Quote before the [Change Staged Quote State](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action.
	OldStagedQuoteState StagedQuoteState `json:"oldStagedQuoteState"`
}

* * Generated after a successful [Change Staged Quote State](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action. *

func (StagedQuoteStateChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteStateChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StagedQuoteStateChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StagedQuoteStateChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedQuoteStateChangedMessagePayload ¶ added in v1.2.0 

type StagedQuoteStateChangedMessagePayload struct {
	// State of the Staged Quote after the [Change Staged Quote State](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action.
	StagedQuoteState StagedQuoteState `json:"stagedQuoteState"`
	// State of the Staged Quote before the [Change Staged Quote State](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action.
	OldStagedQuoteState StagedQuoteState `json:"oldStagedQuoteState"`
}

* * Generated after a successful [Change Staged Quote State](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action. *

func (StagedQuoteStateChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteStateChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteStateTransitionMessage ¶ added in v1.2.0 

type StagedQuoteStateTransitionMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) after the [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action.
	State StateReference `json:"state"`
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) before the [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action. *

func (StagedQuoteStateTransitionMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteStateTransitionMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StagedQuoteStateTransitionMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StagedQuoteStateTransitionMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedQuoteStateTransitionMessagePayload ¶ added in v1.2.0 

type StagedQuoteStateTransitionMessagePayload struct {
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) after the [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action.
	State StateReference `json:"state"`
	// [State](ctp:api:type:State) of the [Quote](ctp:api:type:Quote) before the [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action.
	OldState *StateReference `json:"oldState,omitempty"`
	// Whether [State](ctp:api:type:State) transition validations were turned off during the [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action.
	Force bool `json:"force"`
}

* * Generated after a successful [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action. *

func (StagedQuoteStateTransitionMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteStateTransitionMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteTransitionStateAction ¶ added in v1.2.0 

type StagedQuoteTransitionStateAction struct {
	// Value to set.
	// If there is no State yet, the new State must be an initial State.
	State StateResourceIdentifier `json:"state"`
	// Switch validations on or off.
	Force *bool `json:"force,omitempty"`
}

* * If the existing State(ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State. If `transitions` is not set, no validation is performed. This update action produces the [Staged Quote State Transition](ctp:api:type:StagedQuoteStateTransitionMessage) Message. *

func (StagedQuoteTransitionStateAction) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteTransitionStateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteUpdate ¶ added in v1.2.0 

type StagedQuoteUpdate struct {
	// Expected version of the [StagedQuote](ctp:api:type:StagedQuote) to which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the [StagedQuote](ctp:api:type:StagedQuote).
	Actions []StagedQuoteUpdateAction `json:"actions"`
}

func (*StagedQuoteUpdate) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StagedQuoteUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedQuoteUpdateAction ¶ added in v1.2.0 

type StagedQuoteUpdateAction interface{}

type StagedQuoteValidToSetMessage ¶ added in v1.2.0 

type StagedQuoteValidToSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Expiration date for the Staged Quote after the [Set Valid To](ctp:api:type:StagedQuoteSetValidToAction) update action.
	ValidTo time.Time `json:"validTo"`
}

* * Generated after a successful [Set Valid To](ctp:api:type:StagedQuoteSetValidToAction) update action. *

func (StagedQuoteValidToSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteValidToSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StagedQuoteValidToSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StagedQuoteValidToSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StagedQuoteValidToSetMessagePayload ¶ added in v1.2.0 

type StagedQuoteValidToSetMessagePayload struct {
	// Expiration date for the Staged Quote after the [Set Valid To](ctp:api:type:StagedQuoteSetValidToAction) update action.
	ValidTo time.Time `json:"validTo"`
}

* * Generated after a successful [Set Valid To](ctp:api:type:StagedQuoteSetValidToAction) update action. *

func (StagedQuoteValidToSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StagedQuoteValidToSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedStandalonePrice ¶ added in v1.2.0 

type StagedStandalonePrice struct {
	// Money value of the StagedStandalonePrice.
	Value TypedMoney `json:"value"`
	// Discounted price for the StagedStandalonePrice.
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
}

* * Staged changes on a Standalone Price. * To update the `value` property of a Staged Standalone Price, use the [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action. * To apply all staged changes to the Standalone Price, use the [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. *

func (*StagedStandalonePrice) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StagedStandalonePrice) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePrice ¶ 

type StandalonePrice struct {
	// Unique identifier of the StandalonePrice.
	ID string `json:"id"`
	// Current version of the StandalonePrice.
	Version int `json:"version"`
	// Date and time (UTC) the StandalonePrice was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the StandalonePrice was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the StandalonePrice.
	Key *string `json:"key,omitempty"`
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which this Price is associated.
	Sku string `json:"sku"`
	// Money value of this Price.
	Value TypedMoney `json:"value"`
	// Country for which this Price is valid.
	Country *string `json:"country,omitempty"`
	// [CustomerGroup](ctp:api:type:CustomerGroup) for which this Price is valid.
	CustomerGroup *CustomerGroupReference `json:"customerGroup,omitempty"`
	// Product distribution [Channel](ctp:api:type:Channel) for which this Price is valid.
	Channel *ChannelReference `json:"channel,omitempty"`
	// Date from which the Price is valid.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Date until the Price is valid. Standalone Prices that are no longer valid are not automatically deleted, but they can be [deleted](/../api/projects/standalone-prices#delete-standaloneprice) if necessary.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Price tiers if any are defined.
	//
	// If `discounted` is present, the tiered Price is ignored for a Product Variant.
	Tiers []PriceTier `json:"tiers"`
	// Set if a matching [ProductDiscount](ctp:api:type:ProductDiscount) exists. If set, the API uses the `discounted` value for the [LineItem Price selection](ctp:api:type:LineItemPriceSelection).
	// When a [relative discount](/../api/projects/productDiscounts#productdiscountvaluerelative) is applied and the fraction part of the `discounted` price is 0.5, the discounted price is rounded in favor of the customer with the [half down rounding](https://en.wikipedia.org/wiki/Rounding#Round_half_down).
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
	// Custom Fields for the StandalonePrice.
	Custom *CustomFields `json:"custom,omitempty"`
	// Staged changes of the StandalonePrice. Only present if the StandalonePrice has some changes staged.
	Staged *StagedStandalonePrice `json:"staged,omitempty"`
	// If set to `true`, the StandalonePrice is considered during [price selection](ctp:api:type:ProductPriceSelection).
	// If set to `false`, the StandalonePrice is not considered during [price selection](ctp:api:type:ProductPriceSelection).
	Active bool `json:"active"`
}

func (StandalonePrice) MarshalJSON ¶ 

func (obj StandalonePrice) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePrice) UnmarshalJSON ¶ 

func (obj *StandalonePrice) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceActiveChangedMessage ¶ added in v1.2.0 

type StandalonePriceActiveChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Value of the `active` field of the StandalonePrice after the [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action.
	Active bool `json:"active"`
	// Value of the `active` field of the StandalonePrice before the [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action.
	OldActive bool `json:"oldActive"`
}

* * Generated after a successful [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action. *

func (StandalonePriceActiveChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StandalonePriceActiveChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceActiveChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StandalonePriceActiveChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceActiveChangedMessagePayload ¶ added in v1.2.0 

type StandalonePriceActiveChangedMessagePayload struct {
	// Value of the `active` field of the StandalonePrice after the [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action.
	Active bool `json:"active"`
	// Value of the `active` field of the StandalonePrice before the [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action.
	OldActive bool `json:"oldActive"`
}

* * Generated after a successful [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action. *

func (StandalonePriceActiveChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StandalonePriceActiveChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceAddPriceTierAction ¶ added in v1.3.0 

type StandalonePriceAddPriceTierAction struct {
	// The [PriceTier](ctp:api:type:PriceTier) to be added to the `tiers` field of the [StandalonePrice](ctp:api:type:StandalonePrice).
	// The action returns an [InvalidField](ctp:api:type:InvalidFieldError) error in the following cases:
	//
	// * Trying to add a PriceTier with `minimumQuantity` < `2`.
	// * Trying to add a PriceTier with `minimumQuantity` that already exists for the StandalonePrice.
	Tier PriceTierDraft `json:"tier"`
}

* * Adding a PriceTier(ctp:api:type:PriceTier) to a StandalonePrice(ctp:api:type:StandalonePrice) produces the [Standalone Price Tier Added](ctp:api:type:StandalonePriceTierAddedMessage) Message. *

func (StandalonePriceAddPriceTierAction) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceAddPriceTierAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceApplyStagedChangesAction ¶ added in v1.2.0 

type StandalonePriceApplyStagedChangesAction struct {
}

* * Applies all staged changes to the StandalonePrice by overwriting all current values with the values in the StagedStandalonePrice(ctp:api:type:StagedStandalonePrice). After successfully applied, the StagedStandalonePrice(ctp:api:type:StagedStandalonePrice) will be removed from the StandalonePrice. An `applyStagedChanges` update action on a StandalonePrice that does not contain any staged changes will return a `400 Bad Request` error. Applying staged changes successfully will produce the [StandalonePriceStagedChangesApplied](ctp:api:type:StandalonePriceStagedChangesAppliedMessage) Message. *

func (StandalonePriceApplyStagedChangesAction) MarshalJSON ¶ added in v1.2.0 

func (obj StandalonePriceApplyStagedChangesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceChangeActiveAction ¶ added in v1.2.0 

type StandalonePriceChangeActiveAction struct {
	// New value to set for the `active` field of the [StandalonePrice](ctp:api:type:StandalonePrice).
	Active bool `json:"active"`
}

* * Updating the value of a StandalonePrice(ctp:api:type:StandalonePrice) produces the [StandalonePriceActiveChanged](ctp:api:type:StandalonePriceActiveChangedMessage) Message. *

func (StandalonePriceChangeActiveAction) MarshalJSON ¶ added in v1.2.0 

func (obj StandalonePriceChangeActiveAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceChangeValueAction ¶ 

type StandalonePriceChangeValueAction struct {
	// New value to set. Must not be empty.
	Value Money `json:"value"`
	// If set to `true` the update action applies to the [StagedStandalonePrice](ctp:api:type:StagedStandalonePrice). If set to `false`, the update action applies to the current [StandalonePrice](ctp:api:type:StandalonePrice).
	Staged *bool `json:"staged,omitempty"`
}

* * Updating the value of a StandalonePrice(ctp:api:type:StandalonePrice) produces the StandalonePriceValueChangedMessage(ctp:api:type:StandalonePriceValueChangedMessage). *

func (StandalonePriceChangeValueAction) MarshalJSON ¶ 

func (obj StandalonePriceChangeValueAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceCreatedMessage ¶ 

type StandalonePriceCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Standalone Price](ctp:api:type:StandalonePrice) that was created.
	StandalonePrice StandalonePrice `json:"standalonePrice"`
}

* * Generated after a successful [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request. *

func (StandalonePriceCreatedMessage) MarshalJSON ¶ 

func (obj StandalonePriceCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceCreatedMessage) UnmarshalJSON ¶ 

func (obj *StandalonePriceCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceCreatedMessagePayload ¶ 

type StandalonePriceCreatedMessagePayload struct {
	// [Standalone Price](ctp:api:type:StandalonePrice) that was created.
	StandalonePrice StandalonePrice `json:"standalonePrice"`
}

* * Generated after a successful [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request. *

func (StandalonePriceCreatedMessagePayload) MarshalJSON ¶ 

func (obj StandalonePriceCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceDeletedMessage ¶ 

type StandalonePriceDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the deleted Standalone Price was associated.
	Sku string `json:"sku"`
}

* * Generated after a successful [Delete StandalonePrice](/../api/projects/standalone-prices#delete-standaloneprice) request. *

func (StandalonePriceDeletedMessage) MarshalJSON ¶ 

func (obj StandalonePriceDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceDeletedMessage) UnmarshalJSON ¶ 

func (obj *StandalonePriceDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceDeletedMessagePayload ¶ 

type StandalonePriceDeletedMessagePayload struct {
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the deleted Standalone Price was associated.
	Sku string `json:"sku"`
}

* * Generated after a successful [Delete StandalonePrice](/../api/projects/standalone-prices#delete-standaloneprice) request. *

func (StandalonePriceDeletedMessagePayload) MarshalJSON ¶ 

func (obj StandalonePriceDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceDiscountSetMessage ¶ 

type StandalonePriceDiscountSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The new `discounted` value of the updated [StandalonePrice](ctp:api:type:StandalonePrice).
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
}

* * Generated after a [Product Discount](ctp:api:type:ProductDiscount) is successfully applied to a StandalonePrice. *

func (StandalonePriceDiscountSetMessage) MarshalJSON ¶ 

func (obj StandalonePriceDiscountSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceDiscountSetMessage) UnmarshalJSON ¶ 

func (obj *StandalonePriceDiscountSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceDiscountSetMessagePayload ¶ 

type StandalonePriceDiscountSetMessagePayload struct {
	// The new `discounted` value of the updated [StandalonePrice](ctp:api:type:StandalonePrice).
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
}

* * Generated after a [Product Discount](ctp:api:type:ProductDiscount) is successfully applied to a StandalonePrice. *

func (StandalonePriceDiscountSetMessagePayload) MarshalJSON ¶ 

func (obj StandalonePriceDiscountSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceDraft ¶ 

type StandalonePriceDraft struct {
	// User-defined unique identifier for the StandalonePrice.
	Key *string `json:"key,omitempty"`
	// Specifies to which [ProductVariant](ctp:api:type:ProductVariant) the API associates this Price.
	// It is not validated to exist in product variants.
	Sku string `json:"sku"`
	// Sets the money value of this Price.
	Value Money `json:"value"`
	// Sets the country for which this Price is valid.
	Country *string `json:"country,omitempty"`
	// Sets the [CustomerGroup](ctp:api:type:CustomerGroup) for which this Price is valid.
	CustomerGroup *CustomerGroupResourceIdentifier `json:"customerGroup,omitempty"`
	// Sets the product distribution [Channel](ctp:api:type:Channel) for which this Price is valid.
	Channel *ChannelResourceIdentifier `json:"channel,omitempty"`
	// Sets the date from which the Price is valid. Must be at least 1 ms earlier than `validUntil`.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Sets the date until the Price is valid. Must be at least 1 ms later than `validFrom`. Standalone Prices that are no longer valid are not automatically deleted, but they can be [deleted](/../api/projects/standalone-prices#delete-standaloneprice) if necessary.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Sets price tiers.
	//
	// If `discounted` is set, the tiered Price is ignored for a Product Variant.
	Tiers []PriceTierDraft `json:"tiers"`
	// Sets a discounted price for this Price that is different from the base price with `value`.
	Discounted *DiscountedPriceDraft `json:"discounted,omitempty"`
	// Custom Fields for the StandalonePrice.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Staged changes for the StandalonePrice.
	Staged *StagedPriceDraft `json:"staged,omitempty"`
	// Set to `false`, if the StandalonePrice should not be considered during [price selection](ctp:api:type:ProductPriceSelection).
	Active *bool `json:"active,omitempty"`
}

* * Standalone Prices are defined with a scope consisting of `currency` and optionally `country`, `customerGroup`, and `channel` and/or a validity period (`validFrom` and/or `validTo`). For more information see [price selection](/../api/projects/products#price-selection). * * Creating a Standalone Price for an SKU which has a Standalone Price with exactly the same price scope, or with overlapping validity periods within the same price scope returns the [DuplicateStandalonePriceScope](ctp:api:type:DuplicateStandalonePriceScopeError) and [OverlappingStandalonePriceValidity](ctp:api:type:OverlappingStandalonePriceValidityError) errors, respectively. A Price without validity period does not conflict with a Price defined for a time period.

func (StandalonePriceDraft) MarshalJSON ¶ 

func (obj StandalonePriceDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceExternalDiscountSetMessage ¶ added in v1.2.0 

type StandalonePriceExternalDiscountSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `discounted` value of the [StandalonePrice](ctp:api:type:StandalonePrice) after the [Set Discounted Price](ctp:api:type:StandalonePriceSetDiscountedPriceAction) update action.
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
}

* * Generated after a successful [Set Discounted Price](ctp:api:type:StandalonePriceSetDiscountedPriceAction) update action. *

func (StandalonePriceExternalDiscountSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StandalonePriceExternalDiscountSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceExternalDiscountSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StandalonePriceExternalDiscountSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceExternalDiscountSetMessagePayload ¶ added in v1.2.0 

type StandalonePriceExternalDiscountSetMessagePayload struct {
	// The `discounted` value of the [StandalonePrice](ctp:api:type:StandalonePrice) after the [Set Discounted Price](ctp:api:type:StandalonePriceSetDiscountedPriceAction) update action.
	Discounted *DiscountedPrice `json:"discounted,omitempty"`
}

* * Generated after a successful [Set Discounted Price](ctp:api:type:StandalonePriceSetDiscountedPriceAction) update action. *

func (StandalonePriceExternalDiscountSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StandalonePriceExternalDiscountSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceKeySetMessage ¶ added in v1.3.0 

type StandalonePriceKeySetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// `key` value of the [StandalonePrice](ctp:api:type:StandalonePrice) after the [Set Key](ctp:api:type:StandalonePriceSetKeyAction) update action.
	Key *string `json:"key,omitempty"`
	// `key` value of the [StandalonePrice](ctp:api:type:StandalonePrice) before the [Set Key](ctp:api:type:StandalonePriceSetKeyAction) update action.
	OldKey *string `json:"oldKey,omitempty"`
}

* * Generated after a successful [Set Key](ctp:api:type:StandalonePriceSetKeyAction) update action. *

func (StandalonePriceKeySetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceKeySetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceKeySetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *StandalonePriceKeySetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceKeySetMessagePayload ¶ added in v1.3.0 

type StandalonePriceKeySetMessagePayload struct {
	// `key` value of the [StandalonePrice](ctp:api:type:StandalonePrice) after the [Set Key](ctp:api:type:StandalonePriceSetKeyAction) update action.
	Key *string `json:"key,omitempty"`
	// `key` value of the [StandalonePrice](ctp:api:type:StandalonePrice) before the [Set Key](ctp:api:type:StandalonePriceSetKeyAction) update action.
	OldKey *string `json:"oldKey,omitempty"`
}

* * Generated after a successful [Set Key](ctp:api:type:StandalonePriceSetKeyAction) update action. *

func (StandalonePriceKeySetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceKeySetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePricePagedQueryResponse ¶ 

type StandalonePricePagedQueryResponse struct {
	// Number of requested results.
	Limit int `json:"limit"`
	// Offset supplied by the client or server default. It is the number of elements skipped, not a page number.
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [StandalonePrices](ctp:api:type:StandalonePrice) matching the query.
	Results []StandalonePrice `json:"results"`
}

type StandalonePriceReference ¶ 

type StandalonePriceReference struct {
	// Unique ID of the referenced resource.
	ID string `json:"id"`
	// Contains the representation of the expanded StandalonePrice. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for StandalonePrice.
	Obj *StandalonePrice `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a StandalonePrice(ctp:api:type:StandalonePrice). *

func (StandalonePriceReference) MarshalJSON ¶ 

func (obj StandalonePriceReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceRemovePriceTierAction ¶ added in v1.3.0 

type StandalonePriceRemovePriceTierAction struct {
	// The `minimumQuantity` of the [PriceTier](ctp:api:type:PriceTier) to be removed from the `tiers` field of the [StandalonePrice](ctp:api:type:StandalonePrice).
	TierMinimumQuantity int `json:"tierMinimumQuantity"`
}

* * Removing a PriceTier(ctp:api:type:PriceTier) from a StandalonePrice(ctp:api:type:StandalonePrice) produces the [Standalone Price Tier Removed](ctp:api:type:StandalonePriceTierRemovedMessage) Message. *

func (StandalonePriceRemovePriceTierAction) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceRemovePriceTierAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceRemoveStagedChangesAction ¶ added in v1.4.0 

type StandalonePriceRemoveStagedChangesAction struct {
}

* * Removes all staged changes from the StandalonePrice. * Removing staged changes successfully produces the [StandalonePriceStagedChangesRemoved](ctp:api:type:StandalonePriceStagedChangesRemovedMessage) Message. *

func (StandalonePriceRemoveStagedChangesAction) MarshalJSON ¶ added in v1.4.0 

func (obj StandalonePriceRemoveStagedChangesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceResourceIdentifier ¶ 

type StandalonePriceResourceIdentifier struct {
	// Unique identifier of the referenced resource. Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced resource. Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a StandalonePrice(ctp:api:type:StandalonePrice). *

func (StandalonePriceResourceIdentifier) MarshalJSON ¶ 

func (obj StandalonePriceResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceSetCustomFieldAction ¶ 

type StandalonePriceSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StandalonePriceSetCustomFieldAction) MarshalJSON ¶ 

func (obj StandalonePriceSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceSetCustomTypeAction ¶ 

type StandalonePriceSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the StandalonePrice with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the StandalonePrice.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the StandalonePrice.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StandalonePriceSetCustomTypeAction) MarshalJSON ¶ 

func (obj StandalonePriceSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceSetDiscountedPriceAction ¶ added in v1.2.0 

type StandalonePriceSetDiscountedPriceAction struct {
	// Value to set. If empty, any existing value will be removed.
	Discounted *DiscountedPriceDraft `json:"discounted,omitempty"`
}

* * Discounts a Standalone Price. The referenced ProductDiscount(ctp:api:type:ProductDiscount) in the discounted field must be of type external, active, and its predicate must match the referenced Price. Produces the [StandalonePriceExternalDiscountSet](ctp:api:type:StandalonePriceExternalDiscountSetMessage) Message. *

func (StandalonePriceSetDiscountedPriceAction) MarshalJSON ¶ added in v1.2.0 

func (obj StandalonePriceSetDiscountedPriceAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceSetKeyAction ¶ added in v1.3.0 

type StandalonePriceSetKeyAction struct {
	// Value to set. Must be unique. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

* * Sets the key on a Standalone Price. Produces the [StandalonePriceKeySet](ctp:api:type:StandalonePriceKeySetMessage) Message. *

func (StandalonePriceSetKeyAction) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceSetPriceTiersAction ¶ added in v1.3.0 

type StandalonePriceSetPriceTiersAction struct {
	// Value to set. If empty, any existing value will be removed.
	// The `minimumQuantity` of the PriceTiers must be unique and greater than `1`, otherwise an [InvalidField](ctp:api:type:InvalidFieldError) error is returned.
	Tiers []PriceTierDraft `json:"tiers"`
}

* * Sets all [PriceTiers](ctp:api:type:PriceTier) for a StandalonePrice(ctp:api:type:StandalonePrice) in one action, produces the [Standalone Price Tiers Set](ctp:api:type:StandalonePriceTiersSetMessage) Message. *

func (StandalonePriceSetPriceTiersAction) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceSetPriceTiersAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceSetValidFromAction ¶ added in v1.3.0 

type StandalonePriceSetValidFromAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
}

* * Updating the `validFrom` value generates the [StandalonePriceValidFromSet](ctp:api:type:StandalonePriceValidFromSetMessage) Message. * * As the validity dates are part of the price scope and are not allowed to overlap, this update might return the [DuplicateStandalonePriceScope](ctp:api:type:DuplicateStandalonePriceScopeError) and [OverlappingStandalonePriceValidity](ctp:api:type:OverlappingStandalonePriceValidityError) errors, respectively. A Price without validity period does not conflict with a Price defined for a time period. *

func (StandalonePriceSetValidFromAction) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceSetValidFromAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceSetValidFromAndUntilAction ¶ added in v1.3.0 

type StandalonePriceSetValidFromAndUntilAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Value to set.
	// If empty, any existing value is removed.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

* * Updating the `validFrom` and `validUntil` values generates the [StandalonePriceValidFromAndUntilSet](ctp:api:type:StandalonePriceValidFromAndUntilSetMessage) Message. * * As the validity dates are part of the price scope and are not allowed to overlap, this update might return the [DuplicateStandalonePriceScope](ctp:api:type:DuplicateStandalonePriceScopeError) and [OverlappingStandalonePriceValidity](ctp:api:type:OverlappingStandalonePriceValidityError) errors, respectively. A Price without validity period does not conflict with a Price defined for a time period. *

func (StandalonePriceSetValidFromAndUntilAction) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceSetValidFromAndUntilAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceSetValidUntilAction ¶ added in v1.3.0 

type StandalonePriceSetValidUntilAction struct {
	// Value to set.
	// If empty, any existing value is removed.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
}

* * Updating the `validUntil` value generates the [StandalonePriceValidUntilSet](ctp:api:type:StandalonePriceValidUntilSetMessage) Message. * * As the validity dates are part of the price scope and are not allowed to overlap, this update might return the [DuplicateStandalonePriceScope](ctp:api:type:DuplicateStandalonePriceScopeError) and [OverlappingStandalonePriceValidity](ctp:api:type:OverlappingStandalonePriceValidityError) errors, respectively. A Price without validity period does not conflict with a Price defined for a time period. *

func (StandalonePriceSetValidUntilAction) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceSetValidUntilAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceStagedChangesAppliedMessage ¶ added in v1.2.0 

type StandalonePriceStagedChangesAppliedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Applied changes of the [StandalonePrice](/../api/projects/standalone-prices) after the [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action.
	StagedChanges StagedStandalonePrice `json:"stagedChanges"`
}

* * Generated after a successful [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. *

func (StandalonePriceStagedChangesAppliedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StandalonePriceStagedChangesAppliedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceStagedChangesAppliedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StandalonePriceStagedChangesAppliedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceStagedChangesAppliedMessagePayload ¶ added in v1.2.0 

type StandalonePriceStagedChangesAppliedMessagePayload struct {
	// Applied changes of the [StandalonePrice](/../api/projects/standalone-prices) after the [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action.
	StagedChanges StagedStandalonePrice `json:"stagedChanges"`
}

* * Generated after a successful [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. *

func (StandalonePriceStagedChangesAppliedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StandalonePriceStagedChangesAppliedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceStagedChangesRemovedMessage ¶ added in v1.4.0 

type StandalonePriceStagedChangesRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Removed changes of the [StandalonePrice](ctp:api:type:StandalonePrice) after the [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action.
	StagedChanges StagedStandalonePrice `json:"stagedChanges"`
}

* * Generated after a successful [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action. *

func (StandalonePriceStagedChangesRemovedMessage) MarshalJSON ¶ added in v1.4.0 

func (obj StandalonePriceStagedChangesRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceStagedChangesRemovedMessage) UnmarshalJSON ¶ added in v1.4.0 

func (obj *StandalonePriceStagedChangesRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceStagedChangesRemovedMessagePayload ¶ added in v1.4.0 

type StandalonePriceStagedChangesRemovedMessagePayload struct {
	// Removed changes of the [StandalonePrice](ctp:api:type:StandalonePrice) after the [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action.
	StagedChanges StagedStandalonePrice `json:"stagedChanges"`
}

* * Generated after a successful [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action. *

func (StandalonePriceStagedChangesRemovedMessagePayload) MarshalJSON ¶ added in v1.4.0 

func (obj StandalonePriceStagedChangesRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceTierAddedMessage ¶ added in v1.3.0 

type StandalonePriceTierAddedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Price Tier](ctp:api:type:PriceTier) that has been added to the array field `tiers` for the [StandalonePrice](ctp:api:type:StandalonePrice).
	Tier PriceTier `json:"tier"`
}

* * Generated after a successful [Add Price Tier](ctp:api:type:StandalonePriceAddPriceTierAction) update action *

func (StandalonePriceTierAddedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceTierAddedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceTierAddedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *StandalonePriceTierAddedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceTierAddedMessagePayload ¶ added in v1.3.0 

type StandalonePriceTierAddedMessagePayload struct {
	// The [Price Tier](ctp:api:type:PriceTier) that has been added to the array field `tiers` for the [StandalonePrice](ctp:api:type:StandalonePrice).
	Tier PriceTier `json:"tier"`
}

* * Generated after a successful [Add Price Tier](ctp:api:type:StandalonePriceAddPriceTierAction) update action *

func (StandalonePriceTierAddedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceTierAddedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceTierRemovedMessage ¶ added in v1.3.0 

type StandalonePriceTierRemovedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The [Price Tier](ctp:api:type:PriceTier) that has been removed from the array field `tiers` for the [StandalonePrice](ctp:api:type:StandalonePrice).
	RemovedTier PriceTier `json:"removedTier"`
}

* * Generated after a successful [Remove Price Tier](ctp:api:type:StandalonePriceRemovePriceTierAction) update action *

func (StandalonePriceTierRemovedMessage) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceTierRemovedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceTierRemovedMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *StandalonePriceTierRemovedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceTierRemovedMessagePayload ¶ added in v1.3.0 

type StandalonePriceTierRemovedMessagePayload struct {
	// The [Price Tier](ctp:api:type:PriceTier) that has been removed from the array field `tiers` for the [StandalonePrice](ctp:api:type:StandalonePrice).
	RemovedTier PriceTier `json:"removedTier"`
}

* * Generated after a successful [Remove Price Tier](ctp:api:type:StandalonePriceRemovePriceTierAction) update action *

func (StandalonePriceTierRemovedMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceTierRemovedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceTiersSetMessage ¶ added in v1.3.0 

type StandalonePriceTiersSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The updated content of the field `tiers` of the affected [StandalonePrice](ctp:api:type:StandalonePrice).
	Tiers []PriceTier `json:"tiers"`
	// The previous content of the field `tiers` of the affected [StandalonePrice](ctp:api:type:StandalonePrice).
	PreviousTiers []PriceTier `json:"previousTiers"`
}

* * Generated after a successful [Set Price Tier](ctp:api:type:StandalonePriceSetPriceTiersAction) update action *

func (StandalonePriceTiersSetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceTiersSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceTiersSetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *StandalonePriceTiersSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceTiersSetMessagePayload ¶ added in v1.3.0 

type StandalonePriceTiersSetMessagePayload struct {
	// The updated content of the field `tiers` of the affected [StandalonePrice](ctp:api:type:StandalonePrice).
	Tiers []PriceTier `json:"tiers"`
	// The previous content of the field `tiers` of the affected [StandalonePrice](ctp:api:type:StandalonePrice).
	PreviousTiers []PriceTier `json:"previousTiers"`
}

* * Generated after a successful [Set Price Tier](ctp:api:type:StandalonePriceSetPriceTiersAction) update action *

func (StandalonePriceTiersSetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceTiersSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceUpdate ¶ 

type StandalonePriceUpdate struct {
	// Expected version of the StandalonePrice on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the StandalonePrice.
	Actions []StandalonePriceUpdateAction `json:"actions"`
}

func (*StandalonePriceUpdate) UnmarshalJSON ¶ 

func (obj *StandalonePriceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceUpdateAction ¶ 

type StandalonePriceUpdateAction interface{}

type StandalonePriceValidFromAndUntilSetMessage ¶ added in v1.3.0 

type StandalonePriceValidFromAndUntilSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` after the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` before the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
	PreviousValidFrom *time.Time `json:"previousValidFrom,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` after the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` before the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
	PreviousValidUntil *time.Time `json:"previousValidUntil,omitempty"`
}

* * Generated after a successful [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. *

func (StandalonePriceValidFromAndUntilSetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceValidFromAndUntilSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceValidFromAndUntilSetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *StandalonePriceValidFromAndUntilSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceValidFromAndUntilSetMessagePayload ¶ added in v1.3.0 

type StandalonePriceValidFromAndUntilSetMessagePayload struct {
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` after the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` before the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
	PreviousValidFrom *time.Time `json:"previousValidFrom,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` after the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` before the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
	PreviousValidUntil *time.Time `json:"previousValidUntil,omitempty"`
}

* * Generated after a successful [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. *

func (StandalonePriceValidFromAndUntilSetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceValidFromAndUntilSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceValidFromSetMessage ¶ added in v1.3.0 

type StandalonePriceValidFromSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` after the [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` before the [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action.
	PreviousValidFrom *time.Time `json:"previousValidFrom,omitempty"`
}

* * Generated after a successful [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action. *

func (StandalonePriceValidFromSetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceValidFromSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceValidFromSetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *StandalonePriceValidFromSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceValidFromSetMessagePayload ¶ added in v1.3.0 

type StandalonePriceValidFromSetMessagePayload struct {
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` after the [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action.
	ValidFrom *time.Time `json:"validFrom,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` before the [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action.
	PreviousValidFrom *time.Time `json:"previousValidFrom,omitempty"`
}

* * Generated after a successful [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action. *

func (StandalonePriceValidFromSetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceValidFromSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceValidUntilSetMessage ¶ added in v1.3.0 

type StandalonePriceValidUntilSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` after the [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` before the [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action.
	PreviousValidUntil *time.Time `json:"previousValidUntil,omitempty"`
}

* * Generated after a successful [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action. *

func (StandalonePriceValidUntilSetMessage) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceValidUntilSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceValidUntilSetMessage) UnmarshalJSON ¶ added in v1.3.0 

func (obj *StandalonePriceValidUntilSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceValidUntilSetMessagePayload ¶ added in v1.3.0 

type StandalonePriceValidUntilSetMessagePayload struct {
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` after the [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action.
	ValidUntil *time.Time `json:"validUntil,omitempty"`
	// Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` before the [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action.
	PreviousValidUntil *time.Time `json:"previousValidUntil,omitempty"`
}

* * Generated after a successful [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action. *

func (StandalonePriceValidUntilSetMessagePayload) MarshalJSON ¶ added in v1.3.0 

func (obj StandalonePriceValidUntilSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StandalonePriceValueChangedMessage ¶ 

type StandalonePriceValueChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The new value of the updated [StandalonePrice](ctp:api:type:StandalonePrice).
	Value Money `json:"value"`
	// Whether the new value was applied to the current or the staged representation of the StandalonePrice. Staged changes are stored on the [StagedStandalonePrice](ctp:api:type:StagedStandalonePrice).
	Staged bool `json:"staged"`
	// The old value of the updated [StandalonePrice](ctp:api:type:StandalonePrice).
	// Present on Messages created after 3 February 2023. Optional for backwards compatibility.
	OldValue *Money `json:"oldValue,omitempty"`
}

* * Generated after a successful [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action. *

func (StandalonePriceValueChangedMessage) MarshalJSON ¶ 

func (obj StandalonePriceValueChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StandalonePriceValueChangedMessage) UnmarshalJSON ¶ 

func (obj *StandalonePriceValueChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StandalonePriceValueChangedMessagePayload ¶ 

type StandalonePriceValueChangedMessagePayload struct {
	// The new value of the updated [StandalonePrice](ctp:api:type:StandalonePrice).
	Value Money `json:"value"`
	// Whether the new value was applied to the current or the staged representation of the StandalonePrice. Staged changes are stored on the [StagedStandalonePrice](ctp:api:type:StagedStandalonePrice).
	Staged bool `json:"staged"`
	// The old value of the updated [StandalonePrice](ctp:api:type:StandalonePrice).
	// Present on Messages created after 3 February 2023. Optional for backwards compatibility.
	OldValue *Money `json:"oldValue,omitempty"`
}

* * Generated after a successful [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action. *

func (StandalonePriceValueChangedMessagePayload) MarshalJSON ¶ 

func (obj StandalonePriceValueChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type State ¶ 

type State struct {
	// Unique identifier of the State.
	ID string `json:"id"`
	// Current version of the State.
	Version int `json:"version"`
	// Date and time (UTC) the State was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the State was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the State.
	Key string `json:"key"`
	// Indicates to which resource or object types the State is assigned to.
	Type StateTypeEnum `json:"type"`
	// Name of the State.
	Name *LocalizedString `json:"name,omitempty"`
	// Description of the State.
	Description *LocalizedString `json:"description,omitempty"`
	// `true` for an initial State, the first State in a workflow.
	Initial bool `json:"initial"`
	// `true` for States that are an integral part of the [Project](ctp:api:type:Project). Those States cannot be deleted and their `key` cannot be changed.
	BuiltIn bool `json:"builtIn"`
	// Roles the State can fulfill for [Reviews](ctp:api:type:Review) and [Line Items](ctp:api:type:LineItem).
	Roles []StateRoleEnum `json:"roles"`
	// - list of States of the same `type` that the current State can be transitioned to. For example, when the current State is the _Initial_ State of [StateType](ctp:api:type:StateTypeEnum) `OrderState` and this list contains the reference to the _Shipped_ `OrderState`, the transition _Initial_ -> _Shipped_ is allowed.
	// - if empty, no transitions are allowed from the current State, defining the current State as final for this workflow.
	// - if not set, the validation is turned off and the current State can be transitioned to any other State of the same `type` as the current State.
	Transitions []StateReference `json:"transitions"`
}

func (State) MarshalJSON ¶ 

func (obj State) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateAddRolesAction ¶ 

type StateAddRolesAction struct {
	// Value to append to the array.
	Roles []StateRoleEnum `json:"roles"`
}

func (StateAddRolesAction) MarshalJSON ¶ 

func (obj StateAddRolesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateChangeInitialAction ¶ 

type StateChangeInitialAction struct {
	// Set to `true` for defining the State as initial State in a state machine and making it the first step in a workflow.
	Initial bool `json:"initial"`
}

func (StateChangeInitialAction) MarshalJSON ¶ 

func (obj StateChangeInitialAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateChangeKeyAction ¶ 

type StateChangeKeyAction struct {
	// New value to set.
	// Must not be empty.
	Key string `json:"key"`
}

func (StateChangeKeyAction) MarshalJSON ¶ 

func (obj StateChangeKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateChangeTypeAction ¶ 

type StateChangeTypeAction struct {
	// Resource or object types the State shall be assigned to.
	// Must not be empty.
	Type StateTypeEnum `json:"type"`
}

func (StateChangeTypeAction) MarshalJSON ¶ 

func (obj StateChangeTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateDraft ¶ 

type StateDraft struct {
	// User-defined unique identifier for the State.
	Key string `json:"key"`
	// Specify to which resource or object type the State is assigned to.
	Type StateTypeEnum `json:"type"`
	// Name of the State.
	Name *LocalizedString `json:"name,omitempty"`
	// Description of the State.
	Description *LocalizedString `json:"description,omitempty"`
	// Set to `false` if the State is not the first step in a workflow.
	Initial *bool `json:"initial,omitempty"`
	// If suitable, assign predifined roles the State can fulfill in case the State's `type` is `LineItemState` or `ReviewState`.
	Roles []StateRoleEnum `json:"roles"`
	// Define the list of States of the same `type` to which the current State can be transitioned to.
	//
	// - If, for example, the current State is the _Initial_ State of [StateType](ctp:api:type:StateTypeEnum) `OrderState` and you want to allow the transition _Initial_ -> _Shipped_, then add the [StateResourceIdentifier](ctp:api:type:StateResourceIdentifier) to the _Shipped_ `OrderState` to this list.
	// - Set to empty list for not allowing any transition from the current State and defining it as final State for a workflow.
	// - Do not set this field at all to turn off validation and allowing transitions to any other State of the same `type` as the current State.
	Transitions []StateResourceIdentifier `json:"transitions"`
}

func (StateDraft) MarshalJSON ¶ 

func (obj StateDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StatePagedQueryResponse ¶ 

type StatePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [States](ctp:api:type:State) matching the query.
	Results []State `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of State(ctp:api:type:State). *

type StateReference ¶ 

type StateReference struct {
	// Unique identifier of the referenced [State](ctp:api:type:State).
	ID string `json:"id"`
	// Contains the representation of the expanded State. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for States.
	Obj *State `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a State(ctp:api:type:State). *

func (StateReference) MarshalJSON ¶ 

func (obj StateReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateRemoveRolesAction ¶ 

type StateRemoveRolesAction struct {
	// Roles to remove from the State.
	Roles []StateRoleEnum `json:"roles"`
}

func (StateRemoveRolesAction) MarshalJSON ¶ 

func (obj StateRemoveRolesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateResourceIdentifier ¶ 

type StateResourceIdentifier struct {
	// Unique identifier of the referenced [State](ctp:api:type:State). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [State](ctp:api:type:State). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a State(ctp:api:type:State). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (StateResourceIdentifier) MarshalJSON ¶ 

func (obj StateResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateRoleEnum ¶ 

type StateRoleEnum string

* * For some resource types, a State can fulfill the following predefined roles: * 

const (
	StateRoleEnumReviewIncludedInStatistics StateRoleEnum = "ReviewIncludedInStatistics"
	StateRoleEnumReturn                     StateRoleEnum = "Return"
)

type StateSetDescriptionAction ¶ 

type StateSetDescriptionAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Description LocalizedString `json:"description"`
}

func (StateSetDescriptionAction) MarshalJSON ¶ 

func (obj StateSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateSetNameAction ¶ 

type StateSetNameAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Name LocalizedString `json:"name"`
}

func (StateSetNameAction) MarshalJSON ¶ 

func (obj StateSetNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateSetRolesAction ¶ 

type StateSetRolesAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	Roles []StateRoleEnum `json:"roles"`
}

func (StateSetRolesAction) MarshalJSON ¶ 

func (obj StateSetRolesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateSetTransitionsAction ¶ 

type StateSetTransitionsAction struct {
	// Value to set.
	// If empty, any existing value will be removed.
	//
	// Possible transformations of the current State to other States of the same `type` (for example, _Initial_ -> _Shipped_).
	// When performing a `transitionState` update action and `transitions` is set, the currently referenced State must have a transition to the new State.
	//
	// If `transitions` is an empty list, it means the current State is a final State and no further transitions are allowed.
	// If `transitions` is not set, the validation is turned off.
	//
	// When performing a `transitionState` update action, any other State of the same `type` can be transitioned to.
	Transitions []StateResourceIdentifier `json:"transitions"`
}

func (StateSetTransitionsAction) MarshalJSON ¶ 

func (obj StateSetTransitionsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StateTypeEnum ¶ 

type StateTypeEnum string

* * Resource or object type the State can be assigned to. * 

const (
	StateTypeEnumOrderState        StateTypeEnum = "OrderState"
	StateTypeEnumLineItemState     StateTypeEnum = "LineItemState"
	StateTypeEnumProductState      StateTypeEnum = "ProductState"
	StateTypeEnumReviewState       StateTypeEnum = "ReviewState"
	StateTypeEnumPaymentState      StateTypeEnum = "PaymentState"
	StateTypeEnumQuoteRequestState StateTypeEnum = "QuoteRequestState"
	StateTypeEnumStagedQuoteState  StateTypeEnum = "StagedQuoteState"
	StateTypeEnumQuoteState        StateTypeEnum = "QuoteState"
)

type StateUpdate ¶ 

type StateUpdate struct {
	// Expected version of the State on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the State.
	Actions []StateUpdateAction `json:"actions"`
}

func (*StateUpdate) UnmarshalJSON ¶ 

func (obj *StateUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StateUpdateAction ¶ 

type StateUpdateAction interface{}

type Store ¶ 

type Store struct {
	// Unique ID of the Store.
	ID string `json:"id"`
	// Current version of the Store.
	Version int `json:"version"`
	// Date and time (UTC) the Store was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Store was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique and immutable identifier for the Store.
	Key string `json:"key"`
	// Name of the Store.
	Name *LocalizedString `json:"name,omitempty"`
	// Languages configured for the Store.
	Languages []string `json:"languages"`
	// Countries defined for the Store.
	Countries []StoreCountry `json:"countries"`
	// Product Distribution Channels allowed for the Store.
	DistributionChannels []ChannelReference `json:"distributionChannels"`
	// Inventory Supply Channels allowed for the Store.
	SupplyChannels []ChannelReference `json:"supplyChannels"`
	// Controls availability of Products for this Store via Product Selections:
	//
	// - Leave empty if all Products in the [Project](ctp:api:type:Project) should be available in this Store.
	// - If only `inactive` Product Selections with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode) are provided, all the Products are availlable in this Store.
	// - If all the Product Selections provided are `inactive` and there's at least a Product Selection of mode `Individual`, no Product is availlable in this Store.
	// - If at least an `active` Product Selection is provided, only `active` Product Selections are considered to compute the availlability in this Store.
	ProductSelections []ProductSelectionSetting `json:"productSelections"`
	// Custom fields for the Store.
	Custom *CustomFields `json:"custom,omitempty"`
}

type StoreAddCountryAction ¶ added in v1.2.0 

type StoreAddCountryAction struct {
	// Value to append to `countries`.
	Country StoreCountry `json:"country"`
}

* * This update action produces the [StoreCountriesChanged](ctp:api:type:StoreCountriesChangedMessage) Message. * It has no effect if the given country is already present in a Store. *

func (StoreAddCountryAction) MarshalJSON ¶ added in v1.2.0 

func (obj StoreAddCountryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreAddDistributionChannelAction ¶ 

type StoreAddDistributionChannelAction struct {
	// Value to append.
	DistributionChannel ChannelResourceIdentifier `json:"distributionChannel"`
}

* * This update action produces the [StoreDistributionChannelsChanged](ctp:api:type:StoreDistributionChannelsChangedMessage) Message. * It has no effect if a given distribution channel is already present in a Store. * * Adding a Channel(ctp:api:type:Channel) without the `ProductDistribution` ChannelRoleEnum(ctp:api:type:ChannelRoleEnum) returns a [MissingRoleOnChannel](ctp:api:type:MissingRoleOnChannelError) error. *

func (StoreAddDistributionChannelAction) MarshalJSON ¶ 

func (obj StoreAddDistributionChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreAddProductSelectionAction ¶ 

type StoreAddProductSelectionAction struct {
	// Product Selection to add to the Store either activated or deactivated.
	ProductSelection ProductSelectionResourceIdentifier `json:"productSelection"`
	// Set to `true` to make all Products assigned to the referenced Product Selection available in the Store.
	Active *bool `json:"active,omitempty"`
}

* * To make all included Products available to your customers of a given Store, add the [Product Selections](/../api/projects/product-selections) to the respective Store. This action has no effect if the given Product Selection is already present in the Store and has the same `active` flag. *

func (StoreAddProductSelectionAction) MarshalJSON ¶ 

func (obj StoreAddProductSelectionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreAddSupplyChannelAction ¶ 

type StoreAddSupplyChannelAction struct {
	// Value to append.
	SupplyChannel ChannelResourceIdentifier `json:"supplyChannel"`
}

* * This action has no effect if a given supply channel is already present in a Store. * * Adding a supply channel produces the [StoreSupplyChannelsChanged](ctp:api:type:StoreSupplyChannelsChangedMessage) Message. * * Adding a Channel(ctp:api:type:Channel) without the `InventorySupply` ChannelRoleEnum(ctp:api:type:ChannelRoleEnum) returns a [MissingRoleOnChannel](ctp:api:type:MissingRoleOnChannelError) error. *

func (StoreAddSupplyChannelAction) MarshalJSON ¶ 

func (obj StoreAddSupplyChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreCartDiscountsLimitReachedError ¶ added in v1.4.0 

type StoreCartDiscountsLimitReachedError struct {
	// `"Maximum number of active cart discounts reached for $stores."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
	// Stores for which the limit for active Cart Discounts that can exist has been reached.
	Stores []StoreKeyReference `json:"stores"`
}

* * Returned when a Cart Discount cannot be created or assigned to a Store as the [limit](/../api/limits#cart-discounts) for active Cart Discounts in a Store has been reached for one or more Stores in the request. * * The error is returned as a failed response to: * * - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests * - [Add Store](ctp:api:type:CartDiscountAddStoreAction) and [Set Store](ctp:api:type:CartDiscountSetStoresAction) update actions *

func (*StoreCartDiscountsLimitReachedError) DecodeStruct ¶ added in v1.4.0 

func (obj *StoreCartDiscountsLimitReachedError) DecodeStruct(src map[string]interface{}) error

func (StoreCartDiscountsLimitReachedError) Error ¶ added in v1.4.0 

func (obj StoreCartDiscountsLimitReachedError) Error() string

func (StoreCartDiscountsLimitReachedError) MarshalJSON ¶ added in v1.4.0 

func (obj StoreCartDiscountsLimitReachedError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StoreCartDiscountsLimitReachedError) UnmarshalJSON ¶ added in v1.4.0 

func (obj *StoreCartDiscountsLimitReachedError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreChangeProductSelectionAction ¶ 

type StoreChangeProductSelectionAction struct {
	// Current Product Selection of the Store to be activated or deactivated.
	ProductSelection ProductSelectionResourceIdentifier `json:"productSelection"`
	// Set to `true` if all Products assigned to the Product Selection should become part of the Store's assortment.
	Active *bool `json:"active,omitempty"`
}

* * ProductSelection(ctp:api:type:ProductSelection) in a Store can be activated or deactivated using this update action. *

func (StoreChangeProductSelectionAction) MarshalJSON ¶ 

func (obj StoreChangeProductSelectionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreCountriesChangedMessage ¶ added in v1.2.0 

type StoreCountriesChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Countries](ctp:api:type:StoreCountry) added to the [Store](ctp:api:type:Store).
	AddedCountries []StoreCountry `json:"addedCountries"`
	// [Countries](ctp:api:type:StoreCountry) removed from the [Store](ctp:api:type:Store).
	RemovedCountries []StoreCountry `json:"removedCountries"`
}

* * Generated after a successful [Add Country](ctp:api:type:StoreAddCountryAction), * [Remove Country](ctp:api:type:StoreRemoveCountryAction), or * [Set Countries](ctp:api:type:StoreSetCountriesAction) update action. *

func (StoreCountriesChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StoreCountriesChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StoreCountriesChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StoreCountriesChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreCountriesChangedMessagePayload ¶ added in v1.2.0 

type StoreCountriesChangedMessagePayload struct {
	// [Countries](ctp:api:type:StoreCountry) added to the [Store](ctp:api:type:Store).
	AddedCountries []StoreCountry `json:"addedCountries"`
	// [Countries](ctp:api:type:StoreCountry) removed from the [Store](ctp:api:type:Store).
	RemovedCountries []StoreCountry `json:"removedCountries"`
}

* * Generated after a successful [Add Country](ctp:api:type:StoreAddCountryAction), * [Remove Country](ctp:api:type:StoreRemoveCountryAction), or * [Set Countries](ctp:api:type:StoreSetCountriesAction) update action. *

func (StoreCountriesChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StoreCountriesChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreCountry ¶ added in v1.2.0 

type StoreCountry struct {
	// Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
	Code string `json:"code"`
}

type StoreCreatedMessage ¶ 

type StoreCreatedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// The `name` of the [Store](ctp:api:type:Store) that was created.
	Name *LocalizedString `json:"name,omitempty"`
	// Languages of the [Store](ctp:api:type:Store) that was created. Languages are represented as [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag).
	Languages []string `json:"languages"`
	// [Countries](ctp:api:type:StoreCountry) of the [Store](ctp:api:type:Store) that was created.
	Countries []StoreCountry `json:"countries"`
	// [Distribution Channels](ctp:api:type:ChannelRoleEnum) of the [Store](ctp:api:type:Store) that was created.
	DistributionChannels []ChannelReference `json:"distributionChannels"`
	// [Supply Channels](ctp:api:type:ChannelRoleEnum) of the [Store](ctp:api:type:Store) that was created.
	SupplyChannels []ChannelReference `json:"supplyChannels"`
	// [ProductSelectionSettings](ctp:api:type:ProductSelectionSetting) of the [Store](ctp:api:type:Store) that was created.
	ProductSelections []ProductSelectionSetting `json:"productSelections"`
	// [Custom Fields](ctp:api:type:CustomFields) on the [Store](ctp:api:type:Store) that was created.
	Custom *CustomFields `json:"custom,omitempty"`
}

* * Generated after a successful [Create Store](ctp:api:endpoint:/{projectKey}/stores:POST) request. *

func (StoreCreatedMessage) MarshalJSON ¶ 

func (obj StoreCreatedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StoreCreatedMessage) UnmarshalJSON ¶ 

func (obj *StoreCreatedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreCreatedMessagePayload ¶ 

type StoreCreatedMessagePayload struct {
	// The `name` of the [Store](ctp:api:type:Store) that was created.
	Name *LocalizedString `json:"name,omitempty"`
	// Languages of the [Store](ctp:api:type:Store) that was created. Languages are represented as [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag).
	Languages []string `json:"languages"`
	// [Countries](ctp:api:type:StoreCountry) of the [Store](ctp:api:type:Store) that was created.
	Countries []StoreCountry `json:"countries"`
	// [Distribution Channels](ctp:api:type:ChannelRoleEnum) of the [Store](ctp:api:type:Store) that was created.
	DistributionChannels []ChannelReference `json:"distributionChannels"`
	// [Supply Channels](ctp:api:type:ChannelRoleEnum) of the [Store](ctp:api:type:Store) that was created.
	SupplyChannels []ChannelReference `json:"supplyChannels"`
	// [ProductSelectionSettings](ctp:api:type:ProductSelectionSetting) of the [Store](ctp:api:type:Store) that was created.
	ProductSelections []ProductSelectionSetting `json:"productSelections"`
	// [Custom Fields](ctp:api:type:CustomFields) on the [Store](ctp:api:type:Store) that was created.
	Custom *CustomFields `json:"custom,omitempty"`
}

* * Generated after a successful [Create Store](ctp:api:endpoint:/{projectKey}/stores:POST) request. *

func (StoreCreatedMessagePayload) MarshalJSON ¶ 

func (obj StoreCreatedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreDeletedMessage ¶ 

type StoreDeletedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
}

* * Generated after a successful [Delete Store](/../api/projects/stores#delete-store) request. *

func (StoreDeletedMessage) MarshalJSON ¶ 

func (obj StoreDeletedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StoreDeletedMessage) UnmarshalJSON ¶ 

func (obj *StoreDeletedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreDeletedMessagePayload ¶ 

type StoreDeletedMessagePayload struct {
}

* * Generated after a successful [Delete Store](/../api/projects/stores#delete-store) request. *

func (StoreDeletedMessagePayload) MarshalJSON ¶ 

func (obj StoreDeletedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreDistributionChannelsChangedMessage ¶ added in v1.2.0 

type StoreDistributionChannelsChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Product distribution Channels that have been added to the [Store](ctp:api:type:Store).
	AddedDistributionChannels []ChannelReference `json:"addedDistributionChannels"`
	// Product distribution Channels that have been removed from the [Store](ctp:api:type:Store).
	RemovedDistributionChannels []ChannelReference `json:"removedDistributionChannels"`
}

* * Generated after a successful [Add Distribution Channel](ctp:api:type:StoreAddDistributionChannelAction), * [Remove Distribution Channel](ctp:api:type:StoreRemoveDistributionChannelAction), or * [Set Distribution Channels](ctp:api:type:StoreSetDistributionChannelsAction) update action. *

func (StoreDistributionChannelsChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StoreDistributionChannelsChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StoreDistributionChannelsChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StoreDistributionChannelsChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreDistributionChannelsChangedMessagePayload ¶ added in v1.2.0 

type StoreDistributionChannelsChangedMessagePayload struct {
	// Product distribution Channels that have been added to the [Store](ctp:api:type:Store).
	AddedDistributionChannels []ChannelReference `json:"addedDistributionChannels"`
	// Product distribution Channels that have been removed from the [Store](ctp:api:type:Store).
	RemovedDistributionChannels []ChannelReference `json:"removedDistributionChannels"`
}

* * Generated after a successful [Add Distribution Channel](ctp:api:type:StoreAddDistributionChannelAction), * [Remove Distribution Channel](ctp:api:type:StoreRemoveDistributionChannelAction), or * [Set Distribution Channels](ctp:api:type:StoreSetDistributionChannelsAction) update action. *

func (StoreDistributionChannelsChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StoreDistributionChannelsChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreDraft ¶ 

type StoreDraft struct {
	// User-defined unique and immutable identifier for the Store.
	// Keys can only contain alphanumeric characters, underscores, and hyphens.
	Key string `json:"key"`
	// Name of the Store.
	Name *LocalizedString `json:"name,omitempty"`
	// Languages defined in [Project](ctp:api:type:Project). Only languages defined in the Project can be used.
	Languages []string `json:"languages"`
	// Countries defined for the Store.
	Countries []StoreCountry `json:"countries"`
	// ResourceIdentifier of a Channel with `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	DistributionChannels []ChannelResourceIdentifier `json:"distributionChannels"`
	// ResourceIdentifier of a Channel with `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannels []ChannelResourceIdentifier `json:"supplyChannels"`
	// Controls availability of Products for this Store via active/inactive Product Selections:
	//
	// - Leave empty if all Products in the [Project](ctp:api:type:Project) should be available in this Store.
	// - If only `inactive` Product Selections with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode) are provided, all the Products are available in this Store.
	// - If all the Product Selections provided are `inactive` and there's at least a Product Selection of mode `Individual`, no Product is available in this Store.
	// - If at least an `active` Product Selection is provided, only `active` Product Selections are considered to compute the availability in this Store.
	ProductSelections []ProductSelectionSettingDraft `json:"productSelections"`
	// Custom fields for the Store.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

func (StoreDraft) MarshalJSON ¶ 

func (obj StoreDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreKeyReference ¶ 

type StoreKeyReference struct {
	// Unique and immutable key of the referenced [Store](ctp:api:type:Store).
	Key string `json:"key"`
}

* * Reference(ctp:api:type:Reference) to a Store(ctp:api:type:Store) by its key. *

func (StoreKeyReference) MarshalJSON ¶ 

func (obj StoreKeyReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreLanguagesChangedMessage ¶ added in v1.2.0 

type StoreLanguagesChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [Locales](ctp:api:type:Locale) added to the [Store](ctp:api:type:Store) after the [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action.
	AddedLanguages []string `json:"addedLanguages"`
	// [Locales](ctp:api:type:Locale) removed from the [Store](ctp:api:type:Store) during the [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action.
	RemovedLanguages []string `json:"removedLanguages"`
}

* * Generated after a successful [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action. *

func (StoreLanguagesChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StoreLanguagesChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StoreLanguagesChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StoreLanguagesChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreLanguagesChangedMessagePayload ¶ added in v1.2.0 

type StoreLanguagesChangedMessagePayload struct {
	// [Locales](ctp:api:type:Locale) added to the [Store](ctp:api:type:Store) after the [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action.
	AddedLanguages []string `json:"addedLanguages"`
	// [Locales](ctp:api:type:Locale) removed from the [Store](ctp:api:type:Store) during the [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action.
	RemovedLanguages []string `json:"removedLanguages"`
}

* * Generated after a successful [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action. *

func (StoreLanguagesChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StoreLanguagesChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreNameSetMessage ¶ added in v1.2.0 

type StoreNameSetMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Name of the [Store](ctp:api:type:Store) set during the [Set Name](ctp:api:type:StoreSetNameAction) update action.
	Name *LocalizedString `json:"name,omitempty"`
	// Names set for the [Store](ctp:api:type:Store) in different locales.
	NameAllLocales []LocalizedString `json:"nameAllLocales"`
}

* * Generated after a successful [Set Name](ctp:api:type:StoreSetNameAction) update action. *

func (StoreNameSetMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StoreNameSetMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StoreNameSetMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StoreNameSetMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreNameSetMessagePayload ¶ added in v1.2.0 

type StoreNameSetMessagePayload struct {
	// Name of the [Store](ctp:api:type:Store) set during the [Set Name](ctp:api:type:StoreSetNameAction) update action.
	Name *LocalizedString `json:"name,omitempty"`
	// Names set for the [Store](ctp:api:type:Store) in different locales.
	NameAllLocales []LocalizedString `json:"nameAllLocales"`
}

* * Generated after a successful [Set Name](ctp:api:type:StoreSetNameAction) update action. *

func (StoreNameSetMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StoreNameSetMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StorePagedQueryResponse ¶ 

type StorePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Stores](ctp:api:type:Store) matching the query.
	Results []Store `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of Store(ctp:api:type:Store). *

type StoreProductSelectionsChangedMessage ¶ 

type StoreProductSelectionsChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// [ProductSelectionSettings](ctp:api:type:ProductSelectionSetting) that were added to the [Store](ctp:api:type:Store).
	AddedProductSelections []ProductSelectionSetting `json:"addedProductSelections"`
	// [ProductSelectionSettings](ctp:api:type:ProductSelectionSetting) that were removed from the [Store](ctp:api:type:Store).
	RemovedProductSelections []ProductSelectionSetting `json:"removedProductSelections"`
	// [ProductSelectionSettings](ctp:api:type:ProductSelectionSetting) that were updated in the [Store](ctp:api:type:Store).
	UpdatedProductSelections []ProductSelectionSetting `json:"updatedProductSelections"`
}

* * Generated by a successful [Add Product Selection](ctp:api:type:StoreAddProductSelectionAction), * [Remove Product Selection](ctp:api:type:StoreRemoveProductSelectionAction), * [Set Product Selections](ctp:api:type:StoreSetProductSelectionsAction), * or [Change Product Selections Active](ctp:api:type:StoreChangeProductSelectionAction) update action. *

func (StoreProductSelectionsChangedMessage) MarshalJSON ¶ 

func (obj StoreProductSelectionsChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StoreProductSelectionsChangedMessage) UnmarshalJSON ¶ 

func (obj *StoreProductSelectionsChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreProductSelectionsChangedMessagePayload ¶ 

type StoreProductSelectionsChangedMessagePayload struct {
	// [ProductSelectionSettings](ctp:api:type:ProductSelectionSetting) that were added to the [Store](ctp:api:type:Store).
	AddedProductSelections []ProductSelectionSetting `json:"addedProductSelections"`
	// [ProductSelectionSettings](ctp:api:type:ProductSelectionSetting) that were removed from the [Store](ctp:api:type:Store).
	RemovedProductSelections []ProductSelectionSetting `json:"removedProductSelections"`
	// [ProductSelectionSettings](ctp:api:type:ProductSelectionSetting) that were updated in the [Store](ctp:api:type:Store).
	UpdatedProductSelections []ProductSelectionSetting `json:"updatedProductSelections"`
}

* * Generated by a successful [Add Product Selection](ctp:api:type:StoreAddProductSelectionAction), * [Remove Product Selection](ctp:api:type:StoreRemoveProductSelectionAction), * [Set Product Selections](ctp:api:type:StoreSetProductSelectionsAction), * or [Change Product Selections Active](ctp:api:type:StoreChangeProductSelectionAction) update action. *

func (StoreProductSelectionsChangedMessagePayload) MarshalJSON ¶ 

func (obj StoreProductSelectionsChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreReference ¶ 

type StoreReference struct {
	// Unique ID of the referenced [Store](ctp:api:type:Store).
	ID string `json:"id"`
	// Contains the representation of the expanded Store. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Stores.
	Obj *Store `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Store(ctp:api:type:Store). *

func (StoreReference) MarshalJSON ¶ 

func (obj StoreReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreRemoveCountryAction ¶ added in v1.2.0 

type StoreRemoveCountryAction struct {
	// Value to remove from `countries`.
	Country StoreCountry `json:"country"`
}

* * This update action produces the [StoreCountriesChanged](ctp:api:type:StoreCountriesChangedMessage) Message. * It has no effect if a given country is not present in a Store. *

func (StoreRemoveCountryAction) MarshalJSON ¶ added in v1.2.0 

func (obj StoreRemoveCountryAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreRemoveDistributionChannelAction ¶ 

type StoreRemoveDistributionChannelAction struct {
	// Value to remove. ResourceIdentifier of a Channel with the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	DistributionChannel ChannelResourceIdentifier `json:"distributionChannel"`
}

* * This update action produces the [StoreDistributionChannelsChanged](ctp:api:type:StoreDistributionChannelsChangedMessage) Message. *

func (StoreRemoveDistributionChannelAction) MarshalJSON ¶ 

func (obj StoreRemoveDistributionChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreRemoveProductSelectionAction ¶ 

type StoreRemoveProductSelectionAction struct {
	// Value to remove. The removed Product Selection is made offline.
	ProductSelection ProductSelectionResourceIdentifier `json:"productSelection"`
}

* * This action has no effect if the given Product Selection is not in the Store. *

func (StoreRemoveProductSelectionAction) MarshalJSON ¶ 

func (obj StoreRemoveProductSelectionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreRemoveSupplyChannelAction ¶ 

type StoreRemoveSupplyChannelAction struct {
	// Value to remove. ResourceIdentifier of a Channel with the `InventorySupply` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum).
	SupplyChannel ChannelResourceIdentifier `json:"supplyChannel"`
}

* * This update action produces the [StoreSupplyChannelsChanged](ctp:api:type:StoreSupplyChannelsChangedMessage) Message. *

func (StoreRemoveSupplyChannelAction) MarshalJSON ¶ 

func (obj StoreRemoveSupplyChannelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreResourceIdentifier ¶ 

type StoreResourceIdentifier struct {
	// Unique ID of the referenced [Store](ctp:api:type:Store). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// Unique key of the referenced [Store](ctp:api:type:Store). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a Store(ctp:api:type:Store). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (StoreResourceIdentifier) MarshalJSON ¶ 

func (obj StoreResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreSetCountriesAction ¶ added in v1.2.0 

type StoreSetCountriesAction struct {
	// New value to set.
	Countries []StoreCountry `json:"countries"`
}

* * This update action produces the [StoreCountriesChanged](ctp:api:type:StoreCountriesChangedMessage) Message. *

func (StoreSetCountriesAction) MarshalJSON ¶ added in v1.2.0 

func (obj StoreSetCountriesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreSetCustomFieldAction ¶ 

type StoreSetCustomFieldAction struct {
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// If `value` is absent or `null`, this field will be removed if it exists.
	// Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
	// If `value` is provided, it is set for the field defined by `name`.
	Value interface{} `json:"value,omitempty"`
}

func (StoreSetCustomFieldAction) MarshalJSON ¶ 

func (obj StoreSetCustomFieldAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreSetCustomTypeAction ¶ 

type StoreSetCustomTypeAction struct {
	// Defines the [Type](ctp:api:type:Type) that extends the Store with [Custom Fields](/../api/projects/custom-fields).
	// If absent, any existing Type and Custom Fields are removed from the Store.
	Type *TypeResourceIdentifier `json:"type,omitempty"`
	// Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Store.
	Fields *FieldContainer `json:"fields,omitempty"`
}

func (StoreSetCustomTypeAction) MarshalJSON ¶ 

func (obj StoreSetCustomTypeAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreSetDistributionChannelsAction ¶ 

type StoreSetDistributionChannelsAction struct {
	// Value to set.
	// If not defined, the Store's `distributionChannels` are unset.
	DistributionChannels []ChannelResourceIdentifier `json:"distributionChannels"`
}

* * This update action produces the [StoreDistributionChannelsChanged](ctp:api:type:StoreDistributionChannelsChangedMessage) Message. * * Setting a Channel(ctp:api:type:Channel) without the `ProductDistribution` ChannelRoleEnum(ctp:api:type:ChannelRoleEnum) returns a [MissingRoleOnChannel](ctp:api:type:MissingRoleOnChannelError) error. *

func (StoreSetDistributionChannelsAction) MarshalJSON ¶ 

func (obj StoreSetDistributionChannelsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreSetLanguagesAction ¶ 

type StoreSetLanguagesAction struct {
	// Value to set.
	Languages []string `json:"languages"`
}

* * This update action produces the [StoreLanguagesChanged](ctp:api:type:StoreLanguagesChangedMessage) Message. * Adding a language other than the ones defined in the Project(ctp:api:type:Project) returns a [ProjectNotConfiguredForLanguages](ctp:api:type:ProjectNotConfiguredForLanguagesError) error. *

func (StoreSetLanguagesAction) MarshalJSON ¶ 

func (obj StoreSetLanguagesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreSetNameAction ¶ 

type StoreSetNameAction struct {
	// Value to set.
	Name *LocalizedString `json:"name,omitempty"`
}

* * This update action produces the [StoreNameSet](ctp:api:type:StoreNameSetMessage) Message. *

func (StoreSetNameAction) MarshalJSON ¶ 

func (obj StoreSetNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreSetProductSelectionsAction ¶ 

type StoreSetProductSelectionsAction struct {
	// Value to set.
	//
	// - If provided, Product Selections for which `active` is set to `true` are available in the Store.
	// - If not provided or provided as empty array, the action removes all Product Selections from this Store, meaning all Products in the [Project](ctp:api:type:Project) are available in this Store.
	ProductSelections []ProductSelectionSettingDraft `json:"productSelections"`
}

* * Instead of adding or removing [Product Selections](/../api/projects/product-selections) individually, you can also change all the Store's Product Selections in one go using this update action. The Store will only contain the Product Selections specified in the request. *

func (StoreSetProductSelectionsAction) MarshalJSON ¶ 

func (obj StoreSetProductSelectionsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreSetSupplyChannelsAction ¶ 

type StoreSetSupplyChannelsAction struct {
	// Value to set.
	// If not defined, the Store's `supplyChannels` are unset.
	SupplyChannels []ChannelResourceIdentifier `json:"supplyChannels"`
}

* * Setting a supply channel produces the [StoreSupplyChannelsChanged](ctp:api:type:StoreSupplyChannelsChangedMessage) Message. * * Setting a Channel(ctp:api:type:Channel) without the `InventorySupply` ChannelRoleEnum(ctp:api:type:ChannelRoleEnum) returns a [MissingRoleOnChannel](ctp:api:type:MissingRoleOnChannelError) error. *

func (StoreSetSupplyChannelsAction) MarshalJSON ¶ 

func (obj StoreSetSupplyChannelsAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreSupplyChannelsChangedMessage ¶ added in v1.2.0 

type StoreSupplyChannelsChangedMessage struct {
	// Unique identifier of the Message. Can be used to track which Messages have been processed.
	ID string `json:"id"`
	// Version of a resource. In case of Messages, this is always `1`.
	Version int `json:"version"`
	// Date and time (UTC) the Message was generated.
	CreatedAt time.Time `json:"createdAt"`
	// Value of `createdAt`.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Value of `createdBy`.
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
	// `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
	SequenceNumber int `json:"sequenceNumber"`
	// [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
	Resource Reference `json:"resource"`
	// Version of the resource on which the change or action was performed.
	ResourceVersion int `json:"resourceVersion"`
	// User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
	ResourceUserProvidedIdentifiers *UserProvidedIdentifiers `json:"resourceUserProvidedIdentifiers,omitempty"`
	// Inventory supply Channels that have been added to the [Store](ctp:api:type:Store).
	AddedSupplyChannels []ChannelReference `json:"addedSupplyChannels"`
	// Inventory supply Channels that have been removed from the [Store](ctp:api:type:Store).
	RemovedSupplyChannels []ChannelReference `json:"removedSupplyChannels"`
}

* * Generated after a successful [Add Supply Channel](ctp:api:type:StoreAddSupplyChannelAction), * [Remove Supply Channel](ctp:api:type:StoreRemoveSupplyChannelAction), or * [Set Supply Channels](ctp:api:type:StoreSetSupplyChannelsAction) update action. *

func (StoreSupplyChannelsChangedMessage) MarshalJSON ¶ added in v1.2.0 

func (obj StoreSupplyChannelsChangedMessage) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*StoreSupplyChannelsChangedMessage) UnmarshalJSON ¶ added in v1.2.0 

func (obj *StoreSupplyChannelsChangedMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreSupplyChannelsChangedMessagePayload ¶ added in v1.2.0 

type StoreSupplyChannelsChangedMessagePayload struct {
	// Inventory supply Channels that have been added to the [Store](ctp:api:type:Store).
	AddedSupplyChannels []ChannelReference `json:"addedSupplyChannels"`
	// Inventory supply Channels that have been removed from the [Store](ctp:api:type:Store).
	RemovedSupplyChannels []ChannelReference `json:"removedSupplyChannels"`
}

* * Generated after a successful [Add Supply Channel](ctp:api:type:StoreAddSupplyChannelAction), * [Remove Supply Channel](ctp:api:type:StoreRemoveSupplyChannelAction), or * [Set Supply Channels](ctp:api:type:StoreSetSupplyChannelsAction) update action. *

func (StoreSupplyChannelsChangedMessagePayload) MarshalJSON ¶ added in v1.2.0 

func (obj StoreSupplyChannelsChangedMessagePayload) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StoreUpdate ¶ 

type StoreUpdate struct {
	// Expected version of the Store on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Store.
	Actions []StoreUpdateAction `json:"actions"`
}

func (*StoreUpdate) UnmarshalJSON ¶ 

func (obj *StoreUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type StoreUpdateAction ¶ 

type StoreUpdateAction interface{}

type SubRate ¶ 

type SubRate struct {
	// Name of the SubRate.
	Name   string  `json:"name"`
	Amount float64 `json:"amount"`
}

* * It is used to calculate the [taxPortions](/../api/projects/carts#taxedprice) field in a Cart or Order.

type Subscription ¶ 

type Subscription struct {
	// Unique identifier of the Subscription.
	ID string `json:"id"`
	// Current version of the Subscription.
	Version int `json:"version"`
	// Date and time (UTC) the Subscription was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Subscription was last modified.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Change notifications subscribed to.
	Changes []ChangeSubscription `json:"changes"`
	// Messaging service to which the messages are to be sent.
	Destination Destination `json:"destination"`
	// User-defined unique identifier of the Subscription.
	Key *string `json:"key,omitempty"`
	// Messages subscribed to.
	Messages []MessageSubscription `json:"messages"`
	// Format in which the payload is delivered.
	Format DeliveryFormat `json:"format"`
	// Status of the Subscription.
	Status SubscriptionHealthStatus `json:"status"`
}

func (*Subscription) UnmarshalJSON ¶ 

func (obj *Subscription) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SubscriptionChangeDestinationAction ¶ 

type SubscriptionChangeDestinationAction struct {
	// New value to set. Must not be empty.
	Destination Destination `json:"destination"`
}

* * A test message is sent to ensure the correct configuration of the Destination. If the message cannot be delivered, the update will fail. The payload of the test message is a notification of type [ResourceCreated](ctp:api:type:ResourceCreatedDeliveryPayload) for the `resourceTypeId` `subscription`. The `status` will change to [Healthy](ctp:api:type:SubscriptionHealthStatus), if it isn't already. *

func (SubscriptionChangeDestinationAction) MarshalJSON ¶ 

func (obj SubscriptionChangeDestinationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*SubscriptionChangeDestinationAction) UnmarshalJSON ¶ 

func (obj *SubscriptionChangeDestinationAction) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SubscriptionDraft ¶ 

type SubscriptionDraft struct {
	// Change notifications to be subscribed to.
	Changes []ChangeSubscription `json:"changes"`
	// Messaging service to which the messages are sent.
	Destination Destination `json:"destination"`
	// User-defined unique identifier for the Subscription.
	Key *string `json:"key,omitempty"`
	// Messages to be subscribed to.
	Messages []MessageSubscription `json:"messages"`
	// Format in which the payload is delivered. When not provided, the [PlatformFormat](ctp:api:type:PlatformFormat) is selected by default.
	Format DeliveryFormat `json:"format,omitempty"`
}

* * Either `messages` or `changes` must be set. *

func (SubscriptionDraft) MarshalJSON ¶ 

func (obj SubscriptionDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*SubscriptionDraft) UnmarshalJSON ¶ 

func (obj *SubscriptionDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SubscriptionHealthStatus ¶ 

type SubscriptionHealthStatus string

* * The health status of the Subscription that indicates whether messages are being delivered to the Destination. * 

const (
	SubscriptionHealthStatusHealthy                           SubscriptionHealthStatus = "Healthy"
	SubscriptionHealthStatusConfigurationError                SubscriptionHealthStatus = "ConfigurationError"
	SubscriptionHealthStatusConfigurationErrorDeliveryStopped SubscriptionHealthStatus = "ConfigurationErrorDeliveryStopped"
	SubscriptionHealthStatusTemporaryError                    SubscriptionHealthStatus = "TemporaryError"
)

type SubscriptionPagedQueryResponse ¶ 

type SubscriptionPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// Subscriptions matching the query.
	Results []Subscription `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of Subscription(ctp:api:type:Subscription). *

type SubscriptionSetChangesAction ¶ 

type SubscriptionSetChangesAction struct {
	// Value to set. Can only be unset if `messages` is set.
	Changes []ChangeSubscription `json:"changes"`
}

func (SubscriptionSetChangesAction) MarshalJSON ¶ 

func (obj SubscriptionSetChangesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SubscriptionSetKeyAction ¶ 

type SubscriptionSetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (SubscriptionSetKeyAction) MarshalJSON ¶ 

func (obj SubscriptionSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SubscriptionSetMessagesAction ¶ 

type SubscriptionSetMessagesAction struct {
	// Value to set. Can only be unset if `changes` is set.
	Messages []MessageSubscription `json:"messages"`
}

func (SubscriptionSetMessagesAction) MarshalJSON ¶ 

func (obj SubscriptionSetMessagesAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SubscriptionUpdate ¶ 

type SubscriptionUpdate struct {
	// Expected version of the Subscription on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Subscription.
	Actions []SubscriptionUpdateAction `json:"actions"`
}

func (*SubscriptionUpdate) UnmarshalJSON ¶ 

func (obj *SubscriptionUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type SubscriptionUpdateAction ¶ 

type SubscriptionUpdateAction interface{}

type SuggestTokenizer ¶ 

type SuggestTokenizer interface{}

type Suggestion ¶ 

type Suggestion struct {
	// The suggested text.
	Text string `json:"text"`
}

type SuggestionResult ¶ 

type SuggestionResult map[string][]Suggestion

type SyncInfo ¶ 

type SyncInfo struct {
	// Connection to a synchronization destination.
	Channel ChannelReference `json:"channel"`
	// Identifier of an external order instance, file, or other resource.
	ExternalId *string `json:"externalId,omitempty"`
	// Date and time (UTC) the information was synced.
	SyncedAt time.Time `json:"syncedAt"`
}

* * Contains synchronization activity information of the Order (like export or import). *

type SyntaxErrorError ¶ 

type SyntaxErrorError struct {
	// `"Syntax error while parsing $fieldDefinition."`
	Message string `json:"message"`
	// Error-specific additional fields.
	ExtraValues map[string]interface{} `json:"-"`
}

* * Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax. *

func (*SyntaxErrorError) DecodeStruct ¶ added in v1.1.0 

func (obj *SyntaxErrorError) DecodeStruct(src map[string]interface{}) error

func (SyntaxErrorError) Error ¶ 

func (obj SyntaxErrorError) Error() string

func (SyntaxErrorError) MarshalJSON ¶ 

func (obj SyntaxErrorError) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*SyntaxErrorError) UnmarshalJSON ¶ added in v1.1.0 

func (obj *SyntaxErrorError) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type TaxCalculationMode ¶ 

type TaxCalculationMode string

* * Determines in which [Tax calculation mode](/carts-orders-overview#tax-calculation-mode) taxed prices are calculated. * 

const (
	TaxCalculationModeLineItemLevel  TaxCalculationMode = "LineItemLevel"
	TaxCalculationModeUnitPriceLevel TaxCalculationMode = "UnitPriceLevel"
)

type TaxCategory ¶ 

type TaxCategory struct {
	// Unique identifier of the TaxCategory.
	ID string `json:"id"`
	// Current version of the TaxCategory.
	Version int `json:"version"`
	// Date and time (UTC) the TaxCategory was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the TaxCategory was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// Name of the TaxCategory.
	Name string `json:"name"`
	// Description of the TaxCategory.
	Description *string `json:"description,omitempty"`
	// Tax rates and subrates of states and countries. Each TaxRate in the array has a unique ID.
	Rates []TaxRate `json:"rates"`
	// User-defined unique identifier of the TaxCategory.
	Key *string `json:"key,omitempty"`
}

type TaxCategoryAddTaxRateAction ¶ 

type TaxCategoryAddTaxRateAction struct {
	// Value to append to the `rates` array.
	TaxRate TaxRateDraft `json:"taxRate"`
}

func (TaxCategoryAddTaxRateAction) MarshalJSON ¶ 

func (obj TaxCategoryAddTaxRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxCategoryChangeNameAction ¶ 

type TaxCategoryChangeNameAction struct {
	// New value to set. Must not be empty.
	Name string `json:"name"`
}

func (TaxCategoryChangeNameAction) MarshalJSON ¶ 

func (obj TaxCategoryChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxCategoryDraft ¶ 

type TaxCategoryDraft struct {
	// Name of the TaxCategory.
	Name string `json:"name"`
	// Description of the TaxCategory.
	Description *string `json:"description,omitempty"`
	// Tax rates and subrates of states and countries.
	Rates []TaxRateDraft `json:"rates"`
	// User-defined unique identifier for the TaxCategory.
	Key *string `json:"key,omitempty"`
}

func (TaxCategoryDraft) MarshalJSON ¶ 

func (obj TaxCategoryDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxCategoryPagedQueryResponse ¶ 

type TaxCategoryPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [TaxCategories](ctp:api:type:TaxCategory) matching the query.
	Results []TaxCategory `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of TaxCategory(ctp:api:type:TaxCategory). *

type TaxCategoryReference ¶ 

type TaxCategoryReference struct {
	// Unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory).
	ID string `json:"id"`
	// Contains the representation of the expanded TaxCategory. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for TaxCategories.
	Obj *TaxCategory `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a TaxCategory(ctp:api:type:TaxCategory). *

func (TaxCategoryReference) MarshalJSON ¶ 

func (obj TaxCategoryReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxCategoryRemoveTaxRateAction ¶ 

type TaxCategoryRemoveTaxRateAction struct {
	// ID of the TaxRate to remove.
	// Either `taxRateId` or `taxRateKey` is required for this update action.
	TaxRateId *string `json:"taxRateId,omitempty"`
	// Key of the TaxRate to remove.
	// Either `taxRateId` or `taxRateKey` is required for this update action.
	TaxRateKey *string `json:"taxRateKey,omitempty"`
}

func (TaxCategoryRemoveTaxRateAction) MarshalJSON ¶ 

func (obj TaxCategoryRemoveTaxRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxCategoryReplaceTaxRateAction ¶ 

type TaxCategoryReplaceTaxRateAction struct {
	// ID of the TaxRate to replace.
	// Either `taxRateId` or `taxRateKey` is required for this update action.
	TaxRateId *string `json:"taxRateId,omitempty"`
	// Key of the TaxRate to replace.
	// Either `taxRateId` or `taxRateKey` is required for this update action.
	TaxRateKey *string `json:"taxRateKey,omitempty"`
	// New TaxRate to replace with.
	TaxRate TaxRateDraft `json:"taxRate"`
}

func (TaxCategoryReplaceTaxRateAction) MarshalJSON ¶ 

func (obj TaxCategoryReplaceTaxRateAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxCategoryResourceIdentifier ¶ 

type TaxCategoryResourceIdentifier struct {
	// Unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a TaxCategory(ctp:api:type:TaxCategory). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (TaxCategoryResourceIdentifier) MarshalJSON ¶ 

func (obj TaxCategoryResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxCategorySetDescriptionAction ¶ 

type TaxCategorySetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *string `json:"description,omitempty"`
}

func (TaxCategorySetDescriptionAction) MarshalJSON ¶ 

func (obj TaxCategorySetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxCategorySetKeyAction ¶ 

type TaxCategorySetKeyAction struct {
	// Value to set. If empty, any existing value will be removed.
	Key *string `json:"key,omitempty"`
}

func (TaxCategorySetKeyAction) MarshalJSON ¶ 

func (obj TaxCategorySetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxCategoryUpdate ¶ 

type TaxCategoryUpdate struct {
	// Expected version of the TaxCategory on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the TaxCategory.
	Actions []TaxCategoryUpdateAction `json:"actions"`
}

func (*TaxCategoryUpdate) UnmarshalJSON ¶ 

func (obj *TaxCategoryUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type TaxCategoryUpdateAction ¶ 

type TaxCategoryUpdateAction interface{}

type TaxMode ¶ 

type TaxMode string

* * Indicates how taxes are set on the Cart. * 

const (
	TaxModePlatform       TaxMode = "Platform"
	TaxModeExternal       TaxMode = "External"
	TaxModeExternalAmount TaxMode = "ExternalAmount"
	TaxModeDisabled       TaxMode = "Disabled"
)

type TaxPortion ¶ 

type TaxPortion struct {
	// Name of the tax portion.
	Name *string `json:"name,omitempty"`
	// A number in the range 0-1.
	Rate float64 `json:"rate"`
	// Money value of the tax portion.
	Amount CentPrecisionMoney `json:"amount"`
}

* * The tax portions are calculated from the [TaxRates](ctp:api:type:TaxRate). * If a Tax Rate has [SubRates](ctp:api:type:SubRate), they are used and can be identified by name. * Tax portions from Line Items with the same `rate` and `name` are accumulated to the same tax portion. *

type TaxPortionDraft ¶ 

type TaxPortionDraft struct {
	// Name of the tax portion.
	Name *string `json:"name,omitempty"`
	// A number in the range 0-1.
	Rate float64 `json:"rate"`
	// Money value for the tax portion.
	Amount Money `json:"amount"`
}

* * Represents the portions that sum up to the `totalGross` field of a TaxedPrice(ctp:api:type:TaxedPrice). * * The portions are calculated from the [TaxRates](ctp:api:type:TaxRate). * If a Tax Rate has [SubRates](ctp:api:type:SubRate), they are used and can be identified by name. * Tax portions from Line Items with the same `rate` and `name` will be accumulated to the same tax portion. *

type TaxRate ¶ 

type TaxRate struct {
	// Present if the TaxRate is part of a [TaxCategory](ctp:api:type:TaxCategory).
	// Absent for external TaxRates in [LineItem](ctp:api:type:LineItem), [CustomLineItem](ctp:api:type:CustomLineItem), and [ShippingInfo](ctp:api:type:ShippingInfo).
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the TaxRate.
	// Present when set using [TaxRateDraft](ctp:api:type:TaxRateDraft). Not available for external TaxRates created using [ExternalTaxRateDraft](ctp:api:type:ExternalTaxRateDraft).
	Key *string `json:"key,omitempty"`
	// Name of the TaxRate.
	Name string `json:"name"`
	// Tax rate. If subrates are used, the amount is the sum of all rates in `subRates`.
	Amount float64 `json:"amount"`
	// If `true`, tax is included in [Embedded Prices](ctp:api:type:Price) or [Standalone Prices](ctp:api:type:StandalonePrice), and the `taxedPrice` is present on [LineItems](ctp:api:type:LineItem). In this case, the `totalNet` price on [TaxedPrice](ctp:api:type:TaxedPrice) includes the TaxRate.
	IncludedInPrice bool `json:"includedInPrice"`
	// Country in which the tax rate is applied in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
	Country string `json:"country"`
	// State within the country, such as Texas in the United States.
	State *string `json:"state,omitempty"`
	// Used to calculate the [taxPortions](/../api/projects/carts#taxedprice) field in a Cart or Order. It is useful if the total tax of a country (such as the US) is a combination of multiple taxes (such as state and local taxes). The total of all subrates equals the TaxRate `amount`.
	SubRates []SubRate `json:"subRates"`
}

func (TaxRate) MarshalJSON ¶ 

func (obj TaxRate) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxRateDraft ¶ 

type TaxRateDraft struct {
	// Name of the TaxRate.
	Name string `json:"name"`
	// Tax rate.
	// Must be supplied if no `subRates` are specified.
	// If `subRates` are specified, this field can be omitted or it must be the sum of amounts of all `subRates`.
	Amount *float64 `json:"amount,omitempty"`
	// If `true`, tax is included in [Embedded Prices](ctp:api:type:Price) or [Standalone Prices](ctp:api:type:StandalonePrice), and the `taxedPrice` is present on [LineItems](ctp:api:type:LineItem). In this case, the `totalNet` price on [TaxedPrice](ctp:api:type:TaxedPrice) includes the TaxRate.
	IncludedInPrice bool `json:"includedInPrice"`
	// Country in which the tax rate is applied in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
	Country string `json:"country"`
	// State within the country, such as Texas in the United States.
	State *string `json:"state,omitempty"`
	// Used to calculate the `taxPortions` field in a [Cart or Order](/../api/projects/carts#taxedprice) or [(Custom) Line Items](/../api/projects/carts#taxeditemprice). It is useful if the total tax of a country (such as the US) is a combination of multiple taxes (such as state and local taxes). The total of all subrates must equal the TaxRate `amount`.
	SubRates []SubRate `json:"subRates"`
	// User-defined unique identifier of the TaxRate.
	Key *string `json:"key,omitempty"`
}

func (TaxRateDraft) MarshalJSON ¶ 

func (obj TaxRateDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TaxedItemPrice ¶ 

type TaxedItemPrice struct {
	// Total net amount of the Line Item or Custom Line Item.
	TotalNet CentPrecisionMoney `json:"totalNet"`
	// Total gross amount of the Line Item or Custom Line Item.
	TotalGross CentPrecisionMoney `json:"totalGross"`
	// Taxable portions added to the total net price.
	//
	// Calculated from the [TaxRates](ctp:api:type:TaxRate).
	TaxPortions []TaxPortion `json:"taxPortions"`
	// Total tax applicable for the Line Item or Custom Line Item.
	// Automatically calculated as the difference between the `totalGross` and `totalNet` values.
	TotalTax *CentPrecisionMoney `json:"totalTax,omitempty"`
}

type TaxedItemPriceDraft ¶ 

type TaxedItemPriceDraft struct {
	// Draft type that stores amounts only in cent precision for the specified currency.
	TotalNet Money `json:"totalNet"`
	// Draft type that stores amounts only in cent precision for the specified currency.
	TotalGross Money `json:"totalGross"`
}

type TaxedPrice ¶ 

type TaxedPrice struct {
	// Total net price of the Cart or Order.
	TotalNet CentPrecisionMoney `json:"totalNet"`
	// Total gross price of the Cart or Order.
	TotalGross CentPrecisionMoney `json:"totalGross"`
	// Taxable portions added to the total net price.
	//
	// Calculated from the [TaxRates](ctp:api:type:TaxRate).
	TaxPortions []TaxPortion `json:"taxPortions"`
	// Total tax applicable for the Cart or Order.
	//
	// Automatically calculated as the difference between the `totalGross` and `totalNet` values.
	TotalTax *CentPrecisionMoney `json:"totalTax,omitempty"`
}

type TaxedPriceDraft ¶ 

type TaxedPriceDraft struct {
	// Total net price of the Cart or Order.
	TotalNet Money `json:"totalNet"`
	// Total gross price of the Cart or Order.
	TotalGross Money `json:"totalGross"`
	// Taxable portions added to the `totalGross`.
	//
	// Calculated from the [TaxRates](ctp:api:type:TaxRate).
	TaxPortions []TaxPortionDraft `json:"taxPortions"`
	// Total tax applicable for the Cart or Order.
	TotalTax TypedMoneyDraft `json:"totalTax,omitempty"`
}

func (*TaxedPriceDraft) UnmarshalJSON ¶ added in v1.5.1 

func (obj *TaxedPriceDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type TermFacetResult ¶ 

type TermFacetResult struct {
	DataType TermFacetResultType `json:"dataType"`
	Missing  int                 `json:"missing"`
	Total    int                 `json:"total"`
	Other    int                 `json:"other"`
	Terms    []FacetTerm         `json:"terms"`
}

func (TermFacetResult) MarshalJSON ¶ 

func (obj TermFacetResult) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TermFacetResultType ¶ 

type TermFacetResultType string
const (
	TermFacetResultTypeText     TermFacetResultType = "text"
	TermFacetResultTypeDate     TermFacetResultType = "date"
	TermFacetResultTypeTime     TermFacetResultType = "time"
	TermFacetResultTypeDatetime TermFacetResultType = "datetime"
	TermFacetResultTypeBoolean  TermFacetResultType = "boolean"
	TermFacetResultTypeNumber   TermFacetResultType = "number"
)

type TextInputHint ¶ 

type TextInputHint string

* * A text input hint is a string with one of the following values: * 

const (
	TextInputHintSingleLine TextInputHint = "SingleLine"
	TextInputHintMultiLine  TextInputHint = "MultiLine"
)

type TextLineItem ¶ 

type TextLineItem struct {
	// Date and time (UTC) the TextLineItem was added to the [ShoppingList](ctp:api:type:ShoppingList).
	AddedAt time.Time `json:"addedAt"`
	// Custom Fields of the TextLineItem.
	Custom *CustomFields `json:"custom,omitempty"`
	// Description of the TextLineItem.
	Description *LocalizedString `json:"description,omitempty"`
	// Unique identifier of the TextLineItem.
	ID string `json:"id"`
	// User-defined identifier of the TextLineItem. It is unique per [ShoppingList](ctp:api:type:ShoppingList).
	Key *string `json:"key,omitempty"`
	// Name of the TextLineItem.
	Name LocalizedString `json:"name"`
	// Number of entries in the TextLineItem.
	Quantity int `json:"quantity"`
}

* * TextLineItems are Line Items that use text values instead of references to Products. *

type TextLineItemDraft ¶ 

type TextLineItemDraft struct {
	// User-defined unique identifier of the TextLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
	Key *string `json:"key,omitempty"`
	// Date and time the TextLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
	AddedAt *time.Time `json:"addedAt,omitempty"`
	// Custom Fields for the TextLineItem.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
	// Description of the TextLineItem.
	Description *LocalizedString `json:"description,omitempty"`
	// Name of the TextLineItem.
	Name LocalizedString `json:"name"`
	// Number of entries in the TextLineItem.
	Quantity *int `json:"quantity,omitempty"`
}

type TrackingData ¶ 

type TrackingData struct {
	// Identifier to track the Parcel.
	TrackingId *string `json:"trackingId,omitempty"`
	// Name of the carrier that delivers the Parcel.
	Carrier *string `json:"carrier,omitempty"`
	// Name of the provider that serves as facade to several carriers.
	Provider *string `json:"provider,omitempty"`
	// Transaction identifier with the `provider`.
	ProviderTransaction *string `json:"providerTransaction,omitempty"`
	// - If `true`, the Parcel is being returned.
	// - If `false`, the Parcel is being delivered to the customer.
	IsReturn *bool `json:"isReturn,omitempty"`
}

* * Information that helps track a Parcel. *

type Transaction ¶ 

type Transaction struct {
	// Unique identifier of the Transaction.
	ID string `json:"id"`
	// Date and time (UTC) the Transaction took place.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Type of the Transaction. For example, `Authorization`.
	Type TransactionType `json:"type"`
	// Money value of the Transaction.
	Amount CentPrecisionMoney `json:"amount"`
	// Identifier used by the interface that manages the Transaction (usually the PSP).
	// If a matching interaction was logged in the `interfaceInteractions` array, the corresponding interaction can be found with this ID.
	InteractionId *string `json:"interactionId,omitempty"`
	// State of the Transaction.
	State TransactionState `json:"state"`
	// Custom Fields defined for the Transaction.
	Custom *CustomFields `json:"custom,omitempty"`
}

* * Represents a financial transaction typically created as a result of a notification from the payment service. *

type TransactionDraft ¶ 

type TransactionDraft struct {
	// Date and time (UTC) the Transaction took place.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Type of the Transaction.
	Type TransactionType `json:"type"`
	// Money value for the Transaction.
	Amount Money `json:"amount"`
	// Identifier used by the payment service that manages the Transaction.
	// Can be used to correlate the Transaction to an interface interaction.
	InteractionId *string `json:"interactionId,omitempty"`
	// State of the Transaction.
	State *TransactionState `json:"state,omitempty"`
	// Custom Fields of the Transaction.
	Custom *CustomFieldsDraft `json:"custom,omitempty"`
}

type TransactionState ¶ 

type TransactionState string

* * Transactions can be in one of the following States: * 

const (
	TransactionStateInitial TransactionState = "Initial"
	TransactionStatePending TransactionState = "Pending"
	TransactionStateSuccess TransactionState = "Success"
	TransactionStateFailure TransactionState = "Failure"
)

type TransactionType ¶ 

type TransactionType string
const (
	TransactionTypeAuthorization       TransactionType = "Authorization"
	TransactionTypeCancelAuthorization TransactionType = "CancelAuthorization"
	TransactionTypeCharge              TransactionType = "Charge"
	TransactionTypeRefund              TransactionType = "Refund"
	TransactionTypeChargeback          TransactionType = "Chargeback"
)

type Type ¶ 

type Type struct {
	// Unique identifier of the Type.
	ID string `json:"id"`
	// Current version of the Type.
	Version int `json:"version"`
	// Date and time (UTC) the Type was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Type was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the Type.
	Key string `json:"key"`
	// Name of the Type.
	Name LocalizedString `json:"name"`
	// Description of the Type.
	Description *LocalizedString `json:"description,omitempty"`
	// Resources and/or data types for which the Type is defined.
	ResourceTypeIds []ResourceTypeId `json:"resourceTypeIds"`
	// Defines Custom Fields.
	FieldDefinitions []FieldDefinition `json:"fieldDefinitions"`
}

type TypeAddEnumValueAction ¶ 

type TypeAddEnumValueAction struct {
	// `name` of the [Field Definition](ctp:api:type:FieldDefinition) to update.
	FieldName string `json:"fieldName"`
	// Value to append to the array.
	Value CustomFieldEnumValue `json:"value"`
}

* * Adds a value to an [EnumType](ctp:api:type:CustomFieldEnumType). * This update action can be used to update an [EnumType](ctp:api:type:CustomFieldEnumType) FieldDefinition and a [SetType](ctp:api:type:CustomFieldSetType) FieldDefinition of [EnumType](ctp:api:type:CustomFieldEnumType). *

func (TypeAddEnumValueAction) MarshalJSON ¶ 

func (obj TypeAddEnumValueAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeAddFieldDefinitionAction ¶ 

type TypeAddFieldDefinitionAction struct {
	// Value to append to the array.
	FieldDefinition FieldDefinition `json:"fieldDefinition"`
}

* * Defines a new field for a Type. Adding new required fields to a Type that is already referenced by existing entities can put those entities in a temporarily inconsistent state. * * If a Type that is already in use requires new fields, we recommend making them optional (`required` set to `false`) whenever possible. Alternatively, any new required fields should be added one at a time followed by an update to all the resources using the Type. This prevents validation errors caused by an entity missing more than one required custom field. *

func (TypeAddFieldDefinitionAction) MarshalJSON ¶ 

func (obj TypeAddFieldDefinitionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeAddLocalizedEnumValueAction ¶ 

type TypeAddLocalizedEnumValueAction struct {
	// `name` of the [FieldDefinition](ctp:api:type:FieldDefinition) to update.
	FieldName string `json:"fieldName"`
	// Value to append to the array.
	Value CustomFieldLocalizedEnumValue `json:"value"`
}

* * Adds a value to a [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType). * This update action can be used to update a [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) FieldDefinition and a [SetType](ctp:api:type:CustomFieldSetType) FieldDefinition of CustomFieldLocalizedEnumType(ctp:api:type:CustomFieldLocalizedEnumType). *

func (TypeAddLocalizedEnumValueAction) MarshalJSON ¶ 

func (obj TypeAddLocalizedEnumValueAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeEnumValueLabelAction ¶ 

type TypeChangeEnumValueLabelAction struct {
	// `name` of the [FieldDefinition](ctp:api:type:FieldDefinition) to update.
	FieldName string `json:"fieldName"`
	// New value to set.
	// Must not be empty.
	Value CustomFieldEnumValue `json:"value"`
}

* * Changes the `label` of an [EnumValue](ctp:api:type:CustomFieldEnumValue) of an [EnumType](ctp:api:type:CustomFieldEnumType) FieldDefinition. *

func (TypeChangeEnumValueLabelAction) MarshalJSON ¶ 

func (obj TypeChangeEnumValueLabelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeEnumValueOrderAction ¶ 

type TypeChangeEnumValueOrderAction struct {
	// `name` of the [FieldDefinition](ctp:api:type:FieldDefinition) to update.
	FieldName string `json:"fieldName"`
	// Must match the set of `key`s of the EnumValues in the FieldDefinition (apart from their order).
	Keys []string `json:"keys"`
}

* * Changes the order of [EnumValues](ctp:api:type:CustomFieldEnumValue) in an [EnumType](ctp:api:type:CustomFieldEnumType) FieldDefinition. * This update action can be used to update an [EnumType](ctp:api:type:CustomFieldEnumType) FieldDefinition and a [SetType](ctp:api:type:CustomFieldSetType) FieldDefinition of [EnumType](ctp:api:type:CustomFieldEnumType). *

func (TypeChangeEnumValueOrderAction) MarshalJSON ¶ 

func (obj TypeChangeEnumValueOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeFieldDefinitionLabelAction ¶ 

type TypeChangeFieldDefinitionLabelAction struct {
	// `name` of the [FieldDefinition](ctp:api:type:FieldDefinition) to update.
	FieldName string `json:"fieldName"`
	// New value to set.
	// Must not be empty.
	Label LocalizedString `json:"label"`
}

func (TypeChangeFieldDefinitionLabelAction) MarshalJSON ¶ 

func (obj TypeChangeFieldDefinitionLabelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeFieldDefinitionOrderAction ¶ 

type TypeChangeFieldDefinitionOrderAction struct {
	// Must match the set of `name`s of FieldDefinitions (up to order).
	FieldNames []string `json:"fieldNames"`
}

func (TypeChangeFieldDefinitionOrderAction) MarshalJSON ¶ 

func (obj TypeChangeFieldDefinitionOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeInputHintAction ¶ 

type TypeChangeInputHintAction struct {
	// `name` of the [Field Definition](ctp:api:type:FieldDefinition) to update.
	FieldName string `json:"fieldName"`
	// New value to set.
	// Must not be empty.
	InputHint TypeTextInputHint `json:"inputHint"`
}

* * Changes the `inputHint` of CustomFieldStringType(ctp:api:type:CustomFieldStringType) FieldDefinition(ctp:api:type:FieldDefinition), a CustomFieldLocalizedStringType(ctp:api:type:CustomFieldLocalizedStringType) FieldDefinition(ctp:api:type:FieldDefinition), and CustomFieldSetType(ctp:api:type:CustomFieldSetType) FieldDefinition(ctp:api:type:FieldDefinition) of these string-based FieldTypes. *

func (TypeChangeInputHintAction) MarshalJSON ¶ 

func (obj TypeChangeInputHintAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeKeyAction ¶ 

type TypeChangeKeyAction struct {
	// New value to set.
	// Must not be empty.
	Key string `json:"key"`
}

func (TypeChangeKeyAction) MarshalJSON ¶ 

func (obj TypeChangeKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeLabelAction ¶ 

type TypeChangeLabelAction struct {
	// Name of the [Field Definition](ctp:api:type:FieldDefinition) to update.
	FieldName string `json:"fieldName"`
	// JSON object where the keys are of type [Locale](ctp:api:type:Locale), and the values are the strings used for the corresponding language.
	Label LocalizedString `json:"label"`
}

func (TypeChangeLabelAction) MarshalJSON ¶ 

func (obj TypeChangeLabelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeLocalizedEnumValueLabelAction ¶ 

type TypeChangeLocalizedEnumValueLabelAction struct {
	// `name` of the [FieldDefinition](ctp:api:type:FieldDefinition) to update.
	FieldName string `json:"fieldName"`
	// New value to set.
	// Must not be empty.
	Value CustomFieldLocalizedEnumValue `json:"value"`
}

* * Changes the `label` of a [LocalizedEnumValue](ctp:api:type:CustomFieldLocalizedEnumValue) of a [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) FieldDefinition. *

func (TypeChangeLocalizedEnumValueLabelAction) MarshalJSON ¶ 

func (obj TypeChangeLocalizedEnumValueLabelAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeLocalizedEnumValueOrderAction ¶ 

type TypeChangeLocalizedEnumValueOrderAction struct {
	// `name` of the [Field Definition](ctp:api:type:FieldDefinition) to update.
	FieldName string `json:"fieldName"`
	// Must match the set of `key`s of the LocalizedEnumValues in the FieldDefinition (up to order).
	Keys []string `json:"keys"`
}

* * Changes the order of [LocalizedEnumValues](ctp:api:type:CustomFieldLocalizedEnumValue) in a [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) FieldDefinition. * This update action can be used to update a [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) FieldDefinition and a [SetType](ctp:api:type:CustomFieldSetType) of [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) FieldDefinitions. *

func (TypeChangeLocalizedEnumValueOrderAction) MarshalJSON ¶ 

func (obj TypeChangeLocalizedEnumValueOrderAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeChangeNameAction ¶ 

type TypeChangeNameAction struct {
	// New value to set.
	// Must not be empty.
	Name LocalizedString `json:"name"`
}

func (TypeChangeNameAction) MarshalJSON ¶ 

func (obj TypeChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeDraft ¶ 

type TypeDraft struct {
	// User-defined unique identifier for the Type.
	Key string `json:"key"`
	// Name of the Type.
	Name LocalizedString `json:"name"`
	// Description of the Type.
	Description *LocalizedString `json:"description,omitempty"`
	// Resources and/or data types for which the Type is defined.
	ResourceTypeIds []ResourceTypeId `json:"resourceTypeIds"`
	// Defines Custom Fields.
	FieldDefinitions []FieldDefinition `json:"fieldDefinitions"`
}

func (TypeDraft) MarshalJSON ¶ 

func (obj TypeDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypePagedQueryResponse ¶ 

type TypePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](ctp:api:type:QueryPredicate), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Types](ctp:api:type:Type) matching the query.
	Results []Type `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Types](ctp:api:type:Type). *

type TypeReference ¶ 

type TypeReference struct {
	// Unique identifier of the referenced [Type](ctp:api:type:Type).
	ID string `json:"id"`
	// Contains the representation of the expanded Type.
	// Only present in responses to requests with [Reference Expansion](ctp:api:type:Expansion) for Types.
	Obj *Type `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Type(ctp:api:type:Type). *

func (TypeReference) MarshalJSON ¶ 

func (obj TypeReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeRemoveFieldDefinitionAction ¶ 

type TypeRemoveFieldDefinitionAction struct {
	// `name` of the [FieldDefinition](ctp:api:type:FieldDefinition) to remove.
	// The removal of a FieldDefinition deletes [asynchronously](/../api/general-concepts#eventual-consistency) all Custom Fields using the FieldDefinition as well.
	FieldName string `json:"fieldName"`
}

func (TypeRemoveFieldDefinitionAction) MarshalJSON ¶ 

func (obj TypeRemoveFieldDefinitionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeResourceIdentifier ¶ 

type TypeResourceIdentifier struct {
	// Unique identifier of the referenced [Type](ctp:api:type:Type). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [Type](ctp:api:type:Type). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) of a Type(ctp:api:type:Type). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (TypeResourceIdentifier) MarshalJSON ¶ 

func (obj TypeResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeSetDescriptionAction ¶ 

type TypeSetDescriptionAction struct {
	// Value to set. If empty, any existing value will be removed.
	Description *LocalizedString `json:"description,omitempty"`
}

func (TypeSetDescriptionAction) MarshalJSON ¶ 

func (obj TypeSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TypeTextInputHint ¶ 

type TypeTextInputHint string

* * Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType(ctp:api:type:CustomFieldStringType) and CustomFieldLocalizedStringType(ctp:api:type:CustomFieldLocalizedStringType). Following values are supported: * 

const (
	TypeTextInputHintSingleLine TypeTextInputHint = "SingleLine"
	TypeTextInputHintMultiLine  TypeTextInputHint = "MultiLine"
)

type TypeUpdate ¶ 

type TypeUpdate struct {
	// Expected version of the type on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Type.
	Actions []TypeUpdateAction `json:"actions"`
}

func (*TypeUpdate) UnmarshalJSON ¶ 

func (obj *TypeUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type TypeUpdateAction ¶ 

type TypeUpdateAction interface{}

type TypedMoney ¶ 

type TypedMoney interface{}

* * Base polymorphic read-only money type that stores currency in cent precision or high precision, that is in sub-cents. *

type TypedMoneyDraft ¶ 

type TypedMoneyDraft interface{}

* * Base polymorphic money type containing common fields for Money(ctp:api:type:Money) and HighPrecisionMoneyDraft(ctp:api:type:HighPrecisionMoneyDraft). * * - To set money in cent precision, use Money(ctp:api:type:Money). * - To set money in high precision, use HighPrecisionMoneyDraft(ctp:api:type:HighPrecisionMoneyDraft). *

type Update ¶ 

type Update struct {
	Version int            `json:"version"`
	Actions []UpdateAction `json:"actions"`
}

type UpdateAction ¶ 

type UpdateAction struct {
	Action string `json:"action"`
}

type UserProvidedIdentifiers ¶ 

type UserProvidedIdentifiers struct {
	// User-provided unique identifier of the resource.
	Key *string `json:"key,omitempty"`
	// User-provided unique identifier of the resource.
	ExternalId *string `json:"externalId,omitempty"`
	// User-provided unique identifier of an [Order](ctp:api:type:Order).
	OrderNumber *string `json:"orderNumber,omitempty"`
	// User-provided unique identifier of a [Customer](ctp:api:type:Customer).
	CustomerNumber *string `json:"customerNumber,omitempty"`
	// Unique SKU of a [Product Variant](ctp:api:type:ProductVariant).
	Sku *string `json:"sku,omitempty"`
	// Unique identifier usually used in deep-link URLs for a [Product](ctp:api:type:Product). The value corresponds to the slug in the `current` [Product Projection](ctp:api:type:ProductProjection).
	Slug *LocalizedString `json:"slug,omitempty"`
	// Unique identifier of a [Custom Object](/../api/projects/custom-objects).
	ContainerAndKey *ContainerAndKey `json:"containerAndKey,omitempty"`
}

* * User-provided identifiers present on the resource for which the Message is created. The value of the identifier stored in the Message corresponds to the one that was set on the resource at the version shown in `resourceVersion`. *

type VariantValues ¶ 

type VariantValues struct {
	// SKU of the [ProductVariant](ctp:api:type:ProductVariant).
	Sku *string `json:"sku,omitempty"`
	// Embedded Prices of the [ProductVariant](ctp:api:type:ProductVariant).
	Prices []PriceDraft `json:"prices"`
	// Attributes of the [ProductVariant](ctp:api:type:ProductVariant).
	Attributes []Attribute `json:"attributes"`
}

type WhitespaceTokenizer ¶ 

type WhitespaceTokenizer struct {
}

* * Creates tokens by splitting the `text` field in SearchKeyword(ctp:api:type:SearchKeyword) by whitespaces. *

func (WhitespaceTokenizer) MarshalJSON ¶ 

func (obj WhitespaceTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Zone ¶ 

type Zone struct {
	// Unique identifier of the Zone.
	ID string `json:"id"`
	// Current version of the Zone.
	Version int `json:"version"`
	// Date and time (UTC) the Zone was initially created.
	CreatedAt time.Time `json:"createdAt"`
	// Date and time (UTC) the Zone was last updated.
	LastModifiedAt time.Time `json:"lastModifiedAt"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	LastModifiedBy *LastModifiedBy `json:"lastModifiedBy,omitempty"`
	// Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked).
	CreatedBy *CreatedBy `json:"createdBy,omitempty"`
	// User-defined unique identifier of the Zone.
	Key *string `json:"key,omitempty"`
	// Name of the Zone.
	Name string `json:"name"`
	// Description of the Zone.
	Description *string `json:"description,omitempty"`
	// List of locations that belong to the Zone.
	Locations []Location `json:"locations"`
}

type ZoneAddLocationAction ¶ 

type ZoneAddLocationAction struct {
	// Location to be added to the Zone.
	Location Location `json:"location"`
}

func (ZoneAddLocationAction) MarshalJSON ¶ 

func (obj ZoneAddLocationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ZoneChangeNameAction ¶ 

type ZoneChangeNameAction struct {
	// New name of the Zone.
	Name string `json:"name"`
}

func (ZoneChangeNameAction) MarshalJSON ¶ 

func (obj ZoneChangeNameAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ZoneDraft ¶ 

type ZoneDraft struct {
	// User-defined unique identifier for the Zone.
	Key *string `json:"key,omitempty"`
	// Name of the Zone.
	Name string `json:"name"`
	// Description of the Zone.
	Description *string `json:"description,omitempty"`
	// List of locations that belong to the Zone.
	Locations []Location `json:"locations"`
}

func (ZoneDraft) MarshalJSON ¶ 

func (obj ZoneDraft) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ZonePagedQueryResponse ¶ 

type ZonePagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
	// This field is returned by default.
	// For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
	// When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
	Total *int `json:"total,omitempty"`
	// [Zones](ctp:api:type:Zone) matching the query.
	Results []Zone `json:"results"`
}

* * [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of Zone(ctp:api:type:Zone). *

type ZoneRate ¶ 

type ZoneRate struct {
	// [Zone](ctp:api:type:Zone) for which the shipping rates are valid.
	Zone ZoneReference `json:"zone"`
	// Shipping rates defined per currency.
	ShippingRates []ShippingRate `json:"shippingRates"`
}

* * Defines shipping rates in different currencies for a specific Zone(ctp:api:type:Zone). *

type ZoneRateDraft ¶ 

type ZoneRateDraft struct {
	// Sets the [Zone](ctp:api:type:Zone) for which the shippng rates are valid.
	Zone ZoneResourceIdentifier `json:"zone"`
	// Shipping rates for the `currencies` configured in the [Project](ctp:api:type:Project). The array must not contain two ShippingRates with the same [CurrencyCode](ctp:api:type:CurrencyCode).
	ShippingRates []ShippingRateDraft `json:"shippingRates"`
}

type ZoneReference ¶ 

type ZoneReference struct {
	// Unique identifier of the referenced [Zone](ctp:api:type:Zone).
	ID string `json:"id"`
	// Contains the representation of the expanded Zone. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Zones.
	Obj *Zone `json:"obj,omitempty"`
}

* * Reference(ctp:api:type:Reference) to a Zone(ctp:api:type:Zone). *

func (ZoneReference) MarshalJSON ¶ 

func (obj ZoneReference) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ZoneRemoveLocationAction ¶ 

type ZoneRemoveLocationAction struct {
	// Location to be removed from the Zone.
	Location Location `json:"location"`
}

func (ZoneRemoveLocationAction) MarshalJSON ¶ 

func (obj ZoneRemoveLocationAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ZoneResourceIdentifier ¶ 

type ZoneResourceIdentifier struct {
	// Unique identifier of the referenced [Zone](ctp:api:type:Zone). Required if `key` is absent.
	ID *string `json:"id,omitempty"`
	// User-defined unique identifier of the referenced [Zone](ctp:api:type:Zone). Required if `id` is absent.
	Key *string `json:"key,omitempty"`
}

* * ResourceIdentifier(ctp:api:type:ResourceIdentifier) to a Zone(ctp:api:type:Zone). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. *

func (ZoneResourceIdentifier) MarshalJSON ¶ 

func (obj ZoneResourceIdentifier) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ZoneSetDescriptionAction ¶ 

type ZoneSetDescriptionAction struct {
	// Description of the Zone.
	Description *string `json:"description,omitempty"`
}

func (ZoneSetDescriptionAction) MarshalJSON ¶ 

func (obj ZoneSetDescriptionAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ZoneSetKeyAction ¶ 

type ZoneSetKeyAction struct {
	// If `key` is absent or `null`, the existing key, if any, will be removed.
	Key *string `json:"key,omitempty"`
}

func (ZoneSetKeyAction) MarshalJSON ¶ 

func (obj ZoneSetKeyAction) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ZoneUpdate ¶ 

type ZoneUpdate struct {
	// Expected version of the Zone on which the changes should be applied.
	// If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
	Version int `json:"version"`
	// Update actions to be performed on the Zone.
	Actions []ZoneUpdateAction `json:"actions"`
}

func (*ZoneUpdate) UnmarshalJSON ¶ 

func (obj *ZoneUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ZoneUpdateAction ¶ 

type ZoneUpdateAction interface{}

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.