replenishment_2022_11_07_models

package
v0.24.10 Latest Latest
Warning

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

 Go to latest Published: Oct 15, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AggregationFrequency 

type AggregationFrequency string

AggregationFrequency The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type.

swagger:model AggregationFrequency 

const (

	// AggregationFrequencyWEEK captures enum value "WEEK"
	AggregationFrequencyWEEK AggregationFrequency = "WEEK"

	// AggregationFrequencyMONTH captures enum value "MONTH"
	AggregationFrequencyMONTH AggregationFrequency = "MONTH"

	// AggregationFrequencyQUARTER captures enum value "QUARTER"
	AggregationFrequencyQUARTER AggregationFrequency = "QUARTER"

	// AggregationFrequencyYEAR captures enum value "YEAR"
	AggregationFrequencyYEAR AggregationFrequency = "YEAR"
)

func NewAggregationFrequency 

func NewAggregationFrequency(value AggregationFrequency) *AggregationFrequency

func (AggregationFrequency) ContextValidate 

func (m AggregationFrequency) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this aggregation frequency based on context it is used

func (AggregationFrequency) Pointer 

func (m AggregationFrequency) Pointer() *AggregationFrequency

Pointer returns a pointer to a freshly-allocated AggregationFrequency.

func (AggregationFrequency) Validate 

func (m AggregationFrequency) Validate(formats strfmt.Registry) error

Validate validates this aggregation frequency

type AutoEnrollmentPreference 

type AutoEnrollmentPreference string

AutoEnrollmentPreference The auto-enrollment preference indicates whether the offer is opted-in to or opted-out of Amazon's auto-enrollment feature.

swagger:model AutoEnrollmentPreference 

const (

	// AutoEnrollmentPreferenceOPTEDIN captures enum value "OPTED_IN"
	AutoEnrollmentPreferenceOPTEDIN AutoEnrollmentPreference = "OPTED_IN"

	// AutoEnrollmentPreferenceOPTEDOUT captures enum value "OPTED_OUT"
	AutoEnrollmentPreferenceOPTEDOUT AutoEnrollmentPreference = "OPTED_OUT"
)

func NewAutoEnrollmentPreference 

func NewAutoEnrollmentPreference(value AutoEnrollmentPreference) *AutoEnrollmentPreference

func (AutoEnrollmentPreference) ContextValidate 

func (m AutoEnrollmentPreference) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this auto enrollment preference based on context it is used

func (AutoEnrollmentPreference) Pointer 

func (m AutoEnrollmentPreference) Pointer() *AutoEnrollmentPreference

Pointer returns a pointer to a freshly-allocated AutoEnrollmentPreference.

func (AutoEnrollmentPreference) Validate 

func (m AutoEnrollmentPreference) Validate(formats strfmt.Registry) error

Validate validates this auto enrollment preference

type DiscountFunding 

type DiscountFunding struct {

	// Filters the results to only include offers with the percentage specified.
	// Max Items: 10
	// Min Items: 1
	// Unique: true
	Percentage []*int64 `json:"percentage"`
}

DiscountFunding The discount funding on the offer.

swagger:model DiscountFunding

func (*DiscountFunding) ContextValidate 

func (m *DiscountFunding) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this discount funding based on context it is used

func (*DiscountFunding) MarshalBinary 

func (m *DiscountFunding) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DiscountFunding) UnmarshalBinary 

func (m *DiscountFunding) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DiscountFunding) Validate 

func (m *DiscountFunding) Validate(formats strfmt.Registry) error

Validate validates this discount funding

type EligibilityStatus 

type EligibilityStatus string

EligibilityStatus The current eligibility status of an offer.

swagger:model EligibilityStatus 

const (

	// EligibilityStatusELIGIBLE captures enum value "ELIGIBLE"
	EligibilityStatusELIGIBLE EligibilityStatus = "ELIGIBLE"

	// EligibilityStatusINELIGIBLE captures enum value "INELIGIBLE"
	EligibilityStatusINELIGIBLE EligibilityStatus = "INELIGIBLE"

	// EligibilityStatusSUSPENDED captures enum value "SUSPENDED"
	EligibilityStatusSUSPENDED EligibilityStatus = "SUSPENDED"

	// EligibilityStatusREPLENISHMENTONLYORDERING captures enum value "REPLENISHMENT_ONLY_ORDERING"
	EligibilityStatusREPLENISHMENTONLYORDERING EligibilityStatus = "REPLENISHMENT_ONLY_ORDERING"
)

func NewEligibilityStatus 

func NewEligibilityStatus(value EligibilityStatus) *EligibilityStatus

func (EligibilityStatus) ContextValidate 

func (m EligibilityStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this eligibility status based on context it is used

func (EligibilityStatus) Pointer 

func (m EligibilityStatus) Pointer() *EligibilityStatus

Pointer returns a pointer to a freshly-allocated EligibilityStatus.

func (EligibilityStatus) Validate 

func (m EligibilityStatus) Validate(formats strfmt.Registry) error

Validate validates this eligibility status

type EnrollmentMethod 

type EnrollmentMethod string

EnrollmentMethod The enrollment method used to enroll the offer into the program.

swagger:model EnrollmentMethod 

const (

	// EnrollmentMethodMANUAL captures enum value "MANUAL"
	EnrollmentMethodMANUAL EnrollmentMethod = "MANUAL"

	// EnrollmentMethodAUTOMATIC captures enum value "AUTOMATIC"
	EnrollmentMethodAUTOMATIC EnrollmentMethod = "AUTOMATIC"
)

func NewEnrollmentMethod 

func NewEnrollmentMethod(value EnrollmentMethod) *EnrollmentMethod

func (EnrollmentMethod) ContextValidate 

func (m EnrollmentMethod) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this enrollment method based on context it is used

func (EnrollmentMethod) Pointer 

func (m EnrollmentMethod) Pointer() *EnrollmentMethod

Pointer returns a pointer to a freshly-allocated EnrollmentMethod.

func (EnrollmentMethod) Validate 

func (m EnrollmentMethod) Validate(formats strfmt.Registry) error

Validate validates this enrollment method

type Error 

type Error struct {

	// An error code that identifies the type of error that occurred.
	// Required: true
	Code *string `json:"code"`

	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`

	// A message that describes the error condition.
	// Required: true
	Message *string `json:"message"`
}

Error Error response returned when the request is unsuccessful.

swagger:model Error

func (*Error) ContextValidate 

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error based on context it is used

func (*Error) MarshalBinary 

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary 

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type ErrorList 

type ErrorList struct {

	// A list of error responses returned when a request is unsuccessful.
	// Required: true
	Errors []*Error `json:"errors"`
}

ErrorList A list of error responses returned when a request is unsuccessful.

swagger:model ErrorList

func (*ErrorList) ContextValidate 

func (m *ErrorList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error list based on the context it is used

func (*ErrorList) MarshalBinary 

func (m *ErrorList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorList) UnmarshalBinary 

func (m *ErrorList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorList) Validate 

func (m *ErrorList) Validate(formats strfmt.Registry) error

Validate validates this error list

type GetSellingPartnerMetricsRequest 

type GetSellingPartnerMetricsRequest struct {

	// aggregation frequency
	AggregationFrequency AggregationFrequency `json:"aggregationFrequency,omitempty"`

	// The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL.  Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the identifier for the marketplace.
	// Required: true
	MarketplaceID *MarketplaceID `json:"marketplaceId"`

	// The list of metrics requested. If no metric value is provided, data for all of the metrics will be returned.
	// Min Items: 1
	// Unique: true
	Metrics []Metric `json:"metrics"`

	// The list of replenishment program types for which to return metrics.
	// Required: true
	ProgramTypes ProgramTypes `json:"programTypes"`

	// A time interval used to compute metrics.
	// Required: true
	TimeInterval *TimeInterval `json:"timeInterval"`

	// time period type
	// Required: true
	TimePeriodType *TimePeriodType `json:"timePeriodType"`
}

GetSellingPartnerMetricsRequest The request body for the `getSellingPartnerMetrics` operation.

swagger:model GetSellingPartnerMetricsRequest

func (*GetSellingPartnerMetricsRequest) ContextValidate 

func (m *GetSellingPartnerMetricsRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get selling partner metrics request based on the context it is used

func (*GetSellingPartnerMetricsRequest) MarshalBinary 

func (m *GetSellingPartnerMetricsRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetSellingPartnerMetricsRequest) UnmarshalBinary 

func (m *GetSellingPartnerMetricsRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetSellingPartnerMetricsRequest) Validate 

func (m *GetSellingPartnerMetricsRequest) Validate(formats strfmt.Registry) error

Validate validates this get selling partner metrics request

type GetSellingPartnerMetricsResponse 

type GetSellingPartnerMetricsResponse struct {

	// A list of metrics data for the selling partner.
	Metrics []*GetSellingPartnerMetricsResponseMetric `json:"metrics"`
}

GetSellingPartnerMetricsResponse The response schema for the `getSellingPartnerMetrics` operation.

swagger:model GetSellingPartnerMetricsResponse

func (*GetSellingPartnerMetricsResponse) ContextValidate 

func (m *GetSellingPartnerMetricsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get selling partner metrics response based on the context it is used

func (*GetSellingPartnerMetricsResponse) MarshalBinary 

func (m *GetSellingPartnerMetricsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetSellingPartnerMetricsResponse) UnmarshalBinary 

func (m *GetSellingPartnerMetricsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetSellingPartnerMetricsResponse) Validate 

func (m *GetSellingPartnerMetricsResponse) Validate(formats strfmt.Registry) error

Validate validates this get selling partner metrics response

type GetSellingPartnerMetricsResponseMetric 

type GetSellingPartnerMetricsResponseMetric struct {

	// The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.
	// Minimum: 0
	ActiveSubscriptions *int64 `json:"activeSubscriptions,omitempty"`

	// The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.
	// Maximum: 100
	// Minimum: 0
	CouponsRevenuePenetration *float64 `json:"couponsRevenuePenetration,omitempty"`

	// The currency code in ISO 4217 format.
	CurrencyCode string `json:"currencyCode,omitempty"`

	// The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.
	// Minimum: 0
	LostRevenueDueToOOS *float64 `json:"lostRevenueDueToOOS,omitempty"`

	// The average reorders per non-subscriber of the program over a period of past 12 months. Applicable only for the PERFORMANCE timePeriodType.
	// Minimum: 0
	NonSubscriberAverageReorders *float64 `json:"nonSubscriberAverageReorders,omitempty"`

	// The average revenue per non-subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the `PERFORMANCE` `timePeriodType`.
	// Minimum: 0
	NonSubscriberAverageRevenue *float64 `json:"nonSubscriberAverageRevenue,omitempty"`

	// The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the `PERFORMANCE` `timePeriodType`.
	// Maximum: 100
	// Minimum: 0
	NotDeliveredDueToOOS *float64 `json:"notDeliveredDueToOOS,omitempty"`

	// The number of units shipped to the subscribers over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.
	// Minimum: 0
	ShippedSubscriptionUnits *int64 `json:"shippedSubscriptionUnits,omitempty"`

	// The average reorders per subscriber of the program over a period of 12 months. Applicable only for the PERFORMANCE timePeriodType.
	// Minimum: 0
	SubscriberAverageReorders *float64 `json:"subscriberAverageReorders,omitempty"`

	// The average revenue per subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the `PERFORMANCE` `timePeriodType`.
	// Minimum: 0
	SubscriberAverageRevenue *float64 `json:"subscriberAverageRevenue,omitempty"`

	// A time interval used to compute metrics.
	TimeInterval *TimeInterval `json:"timeInterval,omitempty"`

	// The revenue generated from subscriptions over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.
	// Minimum: 0
	TotalSubscriptionsRevenue *float64 `json:"totalSubscriptionsRevenue,omitempty"`
}

GetSellingPartnerMetricsResponseMetric An object which contains metric data for a selling partner.

swagger:model GetSellingPartnerMetricsResponseMetric

func (*GetSellingPartnerMetricsResponseMetric) ContextValidate 

func (m *GetSellingPartnerMetricsResponseMetric) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get selling partner metrics response metric based on the context it is used

func (*GetSellingPartnerMetricsResponseMetric) MarshalBinary 

func (m *GetSellingPartnerMetricsResponseMetric) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetSellingPartnerMetricsResponseMetric) UnmarshalBinary 

func (m *GetSellingPartnerMetricsResponseMetric) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetSellingPartnerMetricsResponseMetric) Validate 

func (m *GetSellingPartnerMetricsResponseMetric) Validate(formats strfmt.Registry) error

Validate validates this get selling partner metrics response metric

type ListOfferMetricsRequest 

type ListOfferMetricsRequest struct {

	// Use these parameters to filter results. Any result must match all provided parameters. For any parameter that is an array, the result must match at least one element in the provided array.
	// Required: true
	Filters *ListOfferMetricsRequestFilters `json:"filters"`

	// Use these parameters to paginate through the response.
	// Required: true
	Pagination *ListOfferMetricsRequestPagination `json:"pagination"`

	// Use these parameters to sort the response.
	Sort *ListOfferMetricsRequestSort `json:"sort,omitempty"`
}

ListOfferMetricsRequest The request body for the `listOfferMetrics` operation.

swagger:model ListOfferMetricsRequest

func (*ListOfferMetricsRequest) ContextValidate 

func (m *ListOfferMetricsRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offer metrics request based on the context it is used

func (*ListOfferMetricsRequest) MarshalBinary 

func (m *ListOfferMetricsRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOfferMetricsRequest) UnmarshalBinary 

func (m *ListOfferMetricsRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOfferMetricsRequest) Validate 

func (m *ListOfferMetricsRequest) Validate(formats strfmt.Registry) error

Validate validates this list offer metrics request

type ListOfferMetricsRequestFilters 

type ListOfferMetricsRequestFilters struct {

	// aggregation frequency
	AggregationFrequency AggregationFrequency `json:"aggregationFrequency,omitempty"`

	// A list of Amazon Standard Identification Numbers (ASINs).
	// Max Items: 20
	// Min Items: 1
	// Unique: true
	Asins []string `json:"asins"`

	// The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL.  Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the identifier for the marketplace.
	// Required: true
	MarketplaceID *MarketplaceID `json:"marketplaceId"`

	// program types
	// Required: true
	ProgramTypes ProgramTypes `json:"programTypes"`

	// A time interval used to compute metrics.
	// Required: true
	TimeInterval *TimeInterval `json:"timeInterval"`

	// time period type
	// Required: true
	TimePeriodType *TimePeriodType `json:"timePeriodType"`
}

ListOfferMetricsRequestFilters Use these parameters to filter results. Any result must match all provided parameters. For any parameter that is an array, the result must match at least one element in the provided array.

swagger:model ListOfferMetricsRequestFilters

func (*ListOfferMetricsRequestFilters) ContextValidate 

func (m *ListOfferMetricsRequestFilters) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offer metrics request filters based on the context it is used

func (*ListOfferMetricsRequestFilters) MarshalBinary 

func (m *ListOfferMetricsRequestFilters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOfferMetricsRequestFilters) UnmarshalBinary 

func (m *ListOfferMetricsRequestFilters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOfferMetricsRequestFilters) Validate 

func (m *ListOfferMetricsRequestFilters) Validate(formats strfmt.Registry) error

Validate validates this list offer metrics request filters

type ListOfferMetricsRequestPagination 

type ListOfferMetricsRequestPagination struct {

	// The maximum number of results to return in the response.
	// Required: true
	// Maximum: 500
	// Minimum: 1
	Limit *int64 `json:"limit"`

	// The offset from which to retrieve the number of results specified by the `limit` value. The first result is at offset 0.
	// Required: true
	// Maximum: 9000
	// Minimum: 0
	Offset *int64 `json:"offset"`
}

ListOfferMetricsRequestPagination Use these parameters to paginate through the response.

swagger:model ListOfferMetricsRequestPagination

func (*ListOfferMetricsRequestPagination) ContextValidate 

func (m *ListOfferMetricsRequestPagination) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this list offer metrics request pagination based on context it is used

func (*ListOfferMetricsRequestPagination) MarshalBinary 

func (m *ListOfferMetricsRequestPagination) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOfferMetricsRequestPagination) UnmarshalBinary 

func (m *ListOfferMetricsRequestPagination) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOfferMetricsRequestPagination) Validate 

func (m *ListOfferMetricsRequestPagination) Validate(formats strfmt.Registry) error

Validate validates this list offer metrics request pagination

type ListOfferMetricsRequestSort 

type ListOfferMetricsRequestSort struct {

	// key
	// Required: true
	Key *ListOfferMetricsSortKey `json:"key"`

	// The sort order.
	// Required: true
	Order *SortOrder `json:"order"`
}

ListOfferMetricsRequestSort Use these parameters to sort the response.

swagger:model ListOfferMetricsRequestSort

func (*ListOfferMetricsRequestSort) ContextValidate 

func (m *ListOfferMetricsRequestSort) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offer metrics request sort based on the context it is used

func (*ListOfferMetricsRequestSort) MarshalBinary 

func (m *ListOfferMetricsRequestSort) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOfferMetricsRequestSort) UnmarshalBinary 

func (m *ListOfferMetricsRequestSort) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOfferMetricsRequestSort) Validate 

func (m *ListOfferMetricsRequestSort) Validate(formats strfmt.Registry) error

Validate validates this list offer metrics request sort

type ListOfferMetricsResponse 

type ListOfferMetricsResponse struct {

	// A list of offers and associated metrics.
	Offers []*ListOfferMetricsResponseOffer `json:"offers"`

	// Use these parameters to paginate through the response.
	Pagination *PaginationResponse `json:"pagination,omitempty"`
}

ListOfferMetricsResponse The response schema for the `listOfferMetrics` operation.

swagger:model ListOfferMetricsResponse

func (*ListOfferMetricsResponse) ContextValidate 

func (m *ListOfferMetricsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offer metrics response based on the context it is used

func (*ListOfferMetricsResponse) MarshalBinary 

func (m *ListOfferMetricsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOfferMetricsResponse) UnmarshalBinary 

func (m *ListOfferMetricsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOfferMetricsResponse) Validate 

func (m *ListOfferMetricsResponse) Validate(formats strfmt.Registry) error

Validate validates this list offer metrics response

type ListOfferMetricsResponseOffer 

type ListOfferMetricsResponseOffer struct {

	// The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.
	// Minimum: 0
	ActiveSubscriptions *int64 `json:"activeSubscriptions,omitempty"`

	// The Amazon Standard Identification Number (ASIN).
	Asin string `json:"asin,omitempty"`

	// The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.
	// Maximum: 100
	// Minimum: 0
	CouponsRevenuePenetration *float64 `json:"couponsRevenuePenetration,omitempty"`

	// The currency code in ISO 4217 format.
	CurrencyCode string `json:"currencyCode,omitempty"`

	// The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.
	// Minimum: 0
	LostRevenueDueToOOS *float64 `json:"lostRevenueDueToOOS,omitempty"`

	// The forecasted shipped subscription units for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.
	// Minimum: 0
	Next30DayShippedSubscriptionUnits *int64 `json:"next30DayShippedSubscriptionUnits,omitempty"`

	// The forecasted total subscription revenue for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.
	// Minimum: 0
	Next30DayTotalSubscriptionsRevenue *float64 `json:"next30DayTotalSubscriptionsRevenue,omitempty"`

	// The forecasted shipped subscription units for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.
	// Minimum: 0
	Next60DayShippedSubscriptionUnits *int64 `json:"next60DayShippedSubscriptionUnits,omitempty"`

	// The forecasted total subscription revenue for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.
	// Minimum: 0
	Next60DayTotalSubscriptionsRevenue *float64 `json:"next60DayTotalSubscriptionsRevenue,omitempty"`

	// The forecasted shipped subscription units for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.
	// Minimum: 0
	Next90DayShippedSubscriptionUnits *int64 `json:"next90DayShippedSubscriptionUnits,omitempty"`

	// The forecasted total subscription revenue for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.
	// Minimum: 0
	Next90DayTotalSubscriptionsRevenue *float64 `json:"next90DayTotalSubscriptionsRevenue,omitempty"`

	// The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the `PERFORMANCE` `timePeriodType`.
	// Maximum: 100
	// Minimum: 0
	NotDeliveredDueToOOS *float64 `json:"notDeliveredDueToOOS,omitempty"`

	// The percentage of total program revenue out of total product revenue. Applicable only for the `PERFORMANCE` `timePeriodType`.
	// Maximum: 100
	// Minimum: 0
	RevenuePenetration *float64 `json:"revenuePenetration,omitempty"`

	// The number of units shipped to the subscribers over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.
	// Minimum: 0
	ShippedSubscriptionUnits *int64 `json:"shippedSubscriptionUnits,omitempty"`

	// A time interval used to compute metrics.
	TimeInterval *TimeInterval `json:"timeInterval,omitempty"`

	// The revenue generated from subscriptions over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.
	// Minimum: 0
	TotalSubscriptionsRevenue *float64 `json:"totalSubscriptionsRevenue,omitempty"`
}

ListOfferMetricsResponseOffer An object which contains offer metrics.

swagger:model ListOfferMetricsResponseOffer

func (*ListOfferMetricsResponseOffer) ContextValidate 

func (m *ListOfferMetricsResponseOffer) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offer metrics response offer based on the context it is used

func (*ListOfferMetricsResponseOffer) MarshalBinary 

func (m *ListOfferMetricsResponseOffer) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOfferMetricsResponseOffer) UnmarshalBinary 

func (m *ListOfferMetricsResponseOffer) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOfferMetricsResponseOffer) Validate 

func (m *ListOfferMetricsResponseOffer) Validate(formats strfmt.Registry) error

Validate validates this list offer metrics response offer

type ListOfferMetricsSortKey 

type ListOfferMetricsSortKey string

ListOfferMetricsSortKey The attribute to use to sort the results.

swagger:model ListOfferMetricsSortKey 

const (

	// ListOfferMetricsSortKeySHIPPEDSUBSCRIPTIONUNITS captures enum value "SHIPPED_SUBSCRIPTION_UNITS"
	ListOfferMetricsSortKeySHIPPEDSUBSCRIPTIONUNITS ListOfferMetricsSortKey = "SHIPPED_SUBSCRIPTION_UNITS"

	// ListOfferMetricsSortKeyTOTALSUBSCRIPTIONSREVENUE captures enum value "TOTAL_SUBSCRIPTIONS_REVENUE"
	ListOfferMetricsSortKeyTOTALSUBSCRIPTIONSREVENUE ListOfferMetricsSortKey = "TOTAL_SUBSCRIPTIONS_REVENUE"

	// ListOfferMetricsSortKeyACTIVESUBSCRIPTIONS captures enum value "ACTIVE_SUBSCRIPTIONS"
	ListOfferMetricsSortKeyACTIVESUBSCRIPTIONS ListOfferMetricsSortKey = "ACTIVE_SUBSCRIPTIONS"

	// ListOfferMetricsSortKeyNEXT90DAYSSHIPPEDSUBSCRIPTIONUNITS captures enum value "NEXT_90DAYS_SHIPPED_SUBSCRIPTION_UNITS"
	ListOfferMetricsSortKeyNEXT90DAYSSHIPPEDSUBSCRIPTIONUNITS ListOfferMetricsSortKey = "NEXT_90DAYS_SHIPPED_SUBSCRIPTION_UNITS"

	// ListOfferMetricsSortKeyNEXT60DAYSSHIPPEDSUBSCRIPTIONUNITS captures enum value "NEXT_60DAYS_SHIPPED_SUBSCRIPTION_UNITS"
	ListOfferMetricsSortKeyNEXT60DAYSSHIPPEDSUBSCRIPTIONUNITS ListOfferMetricsSortKey = "NEXT_60DAYS_SHIPPED_SUBSCRIPTION_UNITS"

	// ListOfferMetricsSortKeyNEXT30DAYSSHIPPEDSUBSCRIPTIONUNITS captures enum value "NEXT_30DAYS_SHIPPED_SUBSCRIPTION_UNITS"
	ListOfferMetricsSortKeyNEXT30DAYSSHIPPEDSUBSCRIPTIONUNITS ListOfferMetricsSortKey = "NEXT_30DAYS_SHIPPED_SUBSCRIPTION_UNITS"

	// ListOfferMetricsSortKeyNEXT90DAYSTOTALSUBSCRIPTIONSREVENUE captures enum value "NEXT_90DAYS_TOTAL_SUBSCRIPTIONS_REVENUE"
	ListOfferMetricsSortKeyNEXT90DAYSTOTALSUBSCRIPTIONSREVENUE ListOfferMetricsSortKey = "NEXT_90DAYS_TOTAL_SUBSCRIPTIONS_REVENUE"

	// ListOfferMetricsSortKeyNEXT60DAYSTOTALSUBSCRIPTIONSREVENUE captures enum value "NEXT_60DAYS_TOTAL_SUBSCRIPTIONS_REVENUE"
	ListOfferMetricsSortKeyNEXT60DAYSTOTALSUBSCRIPTIONSREVENUE ListOfferMetricsSortKey = "NEXT_60DAYS_TOTAL_SUBSCRIPTIONS_REVENUE"

	// ListOfferMetricsSortKeyNEXT30DAYSTOTALSUBSCRIPTIONSREVENUE captures enum value "NEXT_30DAYS_TOTAL_SUBSCRIPTIONS_REVENUE"
	ListOfferMetricsSortKeyNEXT30DAYSTOTALSUBSCRIPTIONSREVENUE ListOfferMetricsSortKey = "NEXT_30DAYS_TOTAL_SUBSCRIPTIONS_REVENUE"
)

func NewListOfferMetricsSortKey 

func NewListOfferMetricsSortKey(value ListOfferMetricsSortKey) *ListOfferMetricsSortKey

func (ListOfferMetricsSortKey) ContextValidate 

func (m ListOfferMetricsSortKey) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this list offer metrics sort key based on context it is used

func (ListOfferMetricsSortKey) Pointer 

func (m ListOfferMetricsSortKey) Pointer() *ListOfferMetricsSortKey

Pointer returns a pointer to a freshly-allocated ListOfferMetricsSortKey.

func (ListOfferMetricsSortKey) Validate 

func (m ListOfferMetricsSortKey) Validate(formats strfmt.Registry) error

Validate validates this list offer metrics sort key

type ListOffersRequest 

type ListOffersRequest struct {

	// Use these parameters to filter results. Any result must match all provided parameters. For any parameter that is an array, the result must match at least one element in the provided array.
	// Required: true
	Filters *ListOffersRequestFilters `json:"filters"`

	// Use these parameters to paginate through the response.
	// Required: true
	Pagination *ListOffersRequestPagination `json:"pagination"`

	// Use these parameters to sort the response.
	Sort *ListOffersRequestSort `json:"sort,omitempty"`
}

ListOffersRequest The request body for the `listOffers` operation.

swagger:model ListOffersRequest

func (*ListOffersRequest) ContextValidate 

func (m *ListOffersRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offers request based on the context it is used

func (*ListOffersRequest) MarshalBinary 

func (m *ListOffersRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOffersRequest) UnmarshalBinary 

func (m *ListOffersRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOffersRequest) Validate 

func (m *ListOffersRequest) Validate(formats strfmt.Registry) error

Validate validates this list offers request

type ListOffersRequestFilters 

type ListOffersRequestFilters struct {

	// A list of Amazon Standard Identification Numbers (ASINs).
	// Max Items: 20
	// Min Items: 1
	// Unique: true
	Asins []string `json:"asins"`

	// A list of eligibilities associated with an offer.
	// Min Items: 1
	// Unique: true
	Eligibilities []EligibilityStatus `json:"eligibilities"`

	// The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL.  Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the identifier for the marketplace.
	// Required: true
	MarketplaceID *MarketplaceID `json:"marketplaceId"`

	// Offer preferences to include in the result filter criteria.
	Preferences *Preference `json:"preferences,omitempty"`

	// program types
	// Required: true
	ProgramTypes ProgramTypes `json:"programTypes"`

	// Offer promotions to include in the result filter criteria.
	Promotions *Promotion `json:"promotions,omitempty"`

	// A list of SKUs to filter. This filter is only supported for sellers and not for vendors.
	// Max Items: 20
	// Min Items: 1
	// Unique: true
	Skus []string `json:"skus"`
}

ListOffersRequestFilters Use these parameters to filter results. Any result must match all of the provided parameters. For any parameter that is an array, the result must match at least one element in the provided array.

swagger:model ListOffersRequestFilters

func (*ListOffersRequestFilters) ContextValidate 

func (m *ListOffersRequestFilters) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offers request filters based on the context it is used

func (*ListOffersRequestFilters) MarshalBinary 

func (m *ListOffersRequestFilters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOffersRequestFilters) UnmarshalBinary 

func (m *ListOffersRequestFilters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOffersRequestFilters) Validate 

func (m *ListOffersRequestFilters) Validate(formats strfmt.Registry) error

Validate validates this list offers request filters

type ListOffersRequestPagination 

type ListOffersRequestPagination struct {

	// The maximum number of results to return in the response.
	// Required: true
	// Maximum: 100
	// Minimum: 1
	Limit *int64 `json:"limit"`

	// The offset from which to retrieve the number of results specified by the `limit` value. The first result is at offset 0.
	// Required: true
	// Maximum: 9000
	// Minimum: 0
	Offset *int64 `json:"offset"`
}

ListOffersRequestPagination Use these parameters to paginate through the response.

swagger:model ListOffersRequestPagination

func (*ListOffersRequestPagination) ContextValidate 

func (m *ListOffersRequestPagination) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this list offers request pagination based on context it is used

func (*ListOffersRequestPagination) MarshalBinary 

func (m *ListOffersRequestPagination) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOffersRequestPagination) UnmarshalBinary 

func (m *ListOffersRequestPagination) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOffersRequestPagination) Validate 

func (m *ListOffersRequestPagination) Validate(formats strfmt.Registry) error

Validate validates this list offers request pagination

type ListOffersRequestSort 

type ListOffersRequestSort struct {

	// The attribute to use to sort the results.
	// Required: true
	Key *ListOffersSortKey `json:"key"`

	// The sort order.
	// Required: true
	Order *SortOrder `json:"order"`
}

ListOffersRequestSort Use these parameters to sort the response.

swagger:model ListOffersRequestSort

func (*ListOffersRequestSort) ContextValidate 

func (m *ListOffersRequestSort) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offers request sort based on the context it is used

func (*ListOffersRequestSort) MarshalBinary 

func (m *ListOffersRequestSort) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOffersRequestSort) UnmarshalBinary 

func (m *ListOffersRequestSort) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOffersRequestSort) Validate 

func (m *ListOffersRequestSort) Validate(formats strfmt.Registry) error

Validate validates this list offers request sort

type ListOffersResponse 

type ListOffersResponse struct {

	// A list of offers.
	Offers []*ListOffersResponseOffer `json:"offers"`

	// Use these parameters to paginate through the response.
	Pagination *PaginationResponse `json:"pagination,omitempty"`
}

ListOffersResponse The response schema for the `listOffers` operation.

swagger:model ListOffersResponse

func (*ListOffersResponse) ContextValidate 

func (m *ListOffersResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offers response based on the context it is used

func (*ListOffersResponse) MarshalBinary 

func (m *ListOffersResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOffersResponse) UnmarshalBinary 

func (m *ListOffersResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOffersResponse) Validate 

func (m *ListOffersResponse) Validate(formats strfmt.Registry) error

Validate validates this list offers response

type ListOffersResponseOffer 

type ListOffersResponseOffer struct {

	// The Amazon Standard Identification Number (ASIN).
	Asin string `json:"asin,omitempty"`

	// The offer eligibility status.
	Eligibility EligibilityStatus `json:"eligibility,omitempty"`

	// The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL.  Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the identifier for the marketplace.
	MarketplaceID MarketplaceID `json:"marketplaceId,omitempty"`

	// offer program configuration
	OfferProgramConfiguration *OfferProgramConfiguration `json:"offerProgramConfiguration,omitempty"`

	// The replenishment program for the offer.
	ProgramType ProgramType `json:"programType,omitempty"`

	// The SKU. This property is only supported for sellers and not for vendors.
	Sku string `json:"sku,omitempty"`

	// A list of vendor codes associated with the offer.
	VendorCodes []string `json:"vendorCodes"`
}

ListOffersResponseOffer An object which contains details about an offer.

swagger:model ListOffersResponseOffer

func (*ListOffersResponseOffer) ContextValidate 

func (m *ListOffersResponseOffer) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this list offers response offer based on the context it is used

func (*ListOffersResponseOffer) MarshalBinary 

func (m *ListOffersResponseOffer) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListOffersResponseOffer) UnmarshalBinary 

func (m *ListOffersResponseOffer) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListOffersResponseOffer) Validate 

func (m *ListOffersResponseOffer) Validate(formats strfmt.Registry) error

Validate validates this list offers response offer

type ListOffersSortKey 

type ListOffersSortKey string

ListOffersSortKey The attribute to use to sort the results.

swagger:model ListOffersSortKey 

const (

	// ListOffersSortKeyASIN captures enum value "ASIN"
	ListOffersSortKeyASIN ListOffersSortKey = "ASIN"

	// ListOffersSortKeySELLINGPARTNERFUNDEDBASEDISCOUNTPERCENTAGE captures enum value "SELLING_PARTNER_FUNDED_BASE_DISCOUNT_PERCENTAGE"
	ListOffersSortKeySELLINGPARTNERFUNDEDBASEDISCOUNTPERCENTAGE ListOffersSortKey = "SELLING_PARTNER_FUNDED_BASE_DISCOUNT_PERCENTAGE"

	// ListOffersSortKeySELLINGPARTNERFUNDEDTIEREDDISCOUNTPERCENTAGE captures enum value "SELLING_PARTNER_FUNDED_TIERED_DISCOUNT_PERCENTAGE"
	ListOffersSortKeySELLINGPARTNERFUNDEDTIEREDDISCOUNTPERCENTAGE ListOffersSortKey = "SELLING_PARTNER_FUNDED_TIERED_DISCOUNT_PERCENTAGE"

	// ListOffersSortKeyAMAZONFUNDEDBASEDISCOUNTPERCENTAGE captures enum value "AMAZON_FUNDED_BASE_DISCOUNT_PERCENTAGE"
	ListOffersSortKeyAMAZONFUNDEDBASEDISCOUNTPERCENTAGE ListOffersSortKey = "AMAZON_FUNDED_BASE_DISCOUNT_PERCENTAGE"

	// ListOffersSortKeyAMAZONFUNDEDTIEREDDISCOUNTPERCENTAGE captures enum value "AMAZON_FUNDED_TIERED_DISCOUNT_PERCENTAGE"
	ListOffersSortKeyAMAZONFUNDEDTIEREDDISCOUNTPERCENTAGE ListOffersSortKey = "AMAZON_FUNDED_TIERED_DISCOUNT_PERCENTAGE"
)

func NewListOffersSortKey 

func NewListOffersSortKey(value ListOffersSortKey) *ListOffersSortKey

func (ListOffersSortKey) ContextValidate 

func (m ListOffersSortKey) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this list offers sort key based on context it is used

func (ListOffersSortKey) Pointer 

func (m ListOffersSortKey) Pointer() *ListOffersSortKey

Pointer returns a pointer to a freshly-allocated ListOffersSortKey.

func (ListOffersSortKey) Validate 

func (m ListOffersSortKey) Validate(formats strfmt.Registry) error

Validate validates this list offers sort key

type MarketplaceID 

type MarketplaceID string

MarketplaceID The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the identifier for the marketplace.

swagger:model MarketplaceId

func (MarketplaceID) ContextValidate 

func (m MarketplaceID) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this marketplace Id based on context it is used

func (MarketplaceID) Validate 

func (m MarketplaceID) Validate(formats strfmt.Registry) error

Validate validates this marketplace Id

type Metric 

type Metric string

Metric The metric name and description.

swagger:model Metric 

const (

	// MetricSHIPPEDSUBSCRIPTIONUNITS captures enum value "SHIPPED_SUBSCRIPTION_UNITS"
	MetricSHIPPEDSUBSCRIPTIONUNITS Metric = "SHIPPED_SUBSCRIPTION_UNITS"

	// MetricTOTALSUBSCRIPTIONSREVENUE captures enum value "TOTAL_SUBSCRIPTIONS_REVENUE"
	MetricTOTALSUBSCRIPTIONSREVENUE Metric = "TOTAL_SUBSCRIPTIONS_REVENUE"

	// MetricACTIVESUBSCRIPTIONS captures enum value "ACTIVE_SUBSCRIPTIONS"
	MetricACTIVESUBSCRIPTIONS Metric = "ACTIVE_SUBSCRIPTIONS"

	// MetricNOTDELIVEREDDUETOOOS captures enum value "NOT_DELIVERED_DUE_TO_OOS"
	MetricNOTDELIVEREDDUETOOOS Metric = "NOT_DELIVERED_DUE_TO_OOS"

	// MetricSUBSCRIBERNONSUBSCRIBERAVERAGEREVENUE captures enum value "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE"
	MetricSUBSCRIBERNONSUBSCRIBERAVERAGEREVENUE Metric = "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE"

	// MetricLOSTREVENUEDUETOOOS captures enum value "LOST_REVENUE_DUE_TO_OOS"
	MetricLOSTREVENUEDUETOOOS Metric = "LOST_REVENUE_DUE_TO_OOS"

	// MetricSUBSCRIBERNONSUBSCRIBERAVERAGEREORDERS captures enum value "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS"
	MetricSUBSCRIBERNONSUBSCRIBERAVERAGEREORDERS Metric = "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS"

	// MetricCOUPONSREVENUEPENETRATION captures enum value "COUPONS_REVENUE_PENETRATION"
	MetricCOUPONSREVENUEPENETRATION Metric = "COUPONS_REVENUE_PENETRATION"
)

func NewMetric 

func NewMetric(value Metric) *Metric

func (Metric) ContextValidate 

func (m Metric) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this metric based on context it is used

func (Metric) Pointer 

func (m Metric) Pointer() *Metric

Pointer returns a pointer to a freshly-allocated Metric.

func (Metric) Validate 

func (m Metric) Validate(formats strfmt.Registry) error

Validate validates this metric

type OfferProgramConfiguration 

type OfferProgramConfiguration struct {

	// Determines whether the offer was automatically or manually enrolled in the program. This property is only supported for sellers and not vendors.
	EnrollmentMethod EnrollmentMethod `json:"enrollmentMethod,omitempty"`

	// An object which contains the preferences applied to the offer.
	Preferences *OfferProgramConfigurationPreferences `json:"preferences,omitempty"`

	// An object which contains the promotions applied to the offer.
	Promotions *OfferProgramConfigurationPromotions `json:"promotions,omitempty"`
}

OfferProgramConfiguration The offer program configuration contains a set of program properties for an offer.

swagger:model OfferProgramConfiguration

func (*OfferProgramConfiguration) ContextValidate 

func (m *OfferProgramConfiguration) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this offer program configuration based on the context it is used

func (*OfferProgramConfiguration) MarshalBinary 

func (m *OfferProgramConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OfferProgramConfiguration) UnmarshalBinary 

func (m *OfferProgramConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OfferProgramConfiguration) Validate 

func (m *OfferProgramConfiguration) Validate(formats strfmt.Registry) error

Validate validates this offer program configuration

type OfferProgramConfigurationPreferences 

type OfferProgramConfigurationPreferences struct {

	// The auto-enrollment preference indicates whether the offer is opted-in to or opted-out of Amazon's auto-enrollment feature.
	AutoEnrollment AutoEnrollmentPreference `json:"autoEnrollment,omitempty"`
}

OfferProgramConfigurationPreferences An object which contains the preferences applied to the offer.

swagger:model OfferProgramConfigurationPreferences

func (*OfferProgramConfigurationPreferences) ContextValidate 

func (m *OfferProgramConfigurationPreferences) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this offer program configuration preferences based on the context it is used

func (*OfferProgramConfigurationPreferences) MarshalBinary 

func (m *OfferProgramConfigurationPreferences) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OfferProgramConfigurationPreferences) UnmarshalBinary 

func (m *OfferProgramConfigurationPreferences) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OfferProgramConfigurationPreferences) Validate 

func (m *OfferProgramConfigurationPreferences) Validate(formats strfmt.Registry) error

Validate validates this offer program configuration preferences

type OfferProgramConfigurationPromotions 

type OfferProgramConfigurationPromotions struct {

	// A base discount set by Amazon on the offer.
	AmazonFundedBaseDiscount *OfferProgramConfigurationPromotionsDiscountFunding `json:"amazonFundedBaseDiscount,omitempty"`

	// A tiered discount set by Amazon on the offer.
	AmazonFundedTieredDiscount *OfferProgramConfigurationPromotionsDiscountFunding `json:"amazonFundedTieredDiscount,omitempty"`

	// A base discount set by the selling partner on the offer.
	SellingPartnerFundedBaseDiscount *OfferProgramConfigurationPromotionsDiscountFunding `json:"sellingPartnerFundedBaseDiscount,omitempty"`

	// A tiered discount set by the selling partner on the offer.
	SellingPartnerFundedTieredDiscount *OfferProgramConfigurationPromotionsDiscountFunding `json:"sellingPartnerFundedTieredDiscount,omitempty"`
}

OfferProgramConfigurationPromotions An object which represents all promotions applied to an offer.

swagger:model OfferProgramConfigurationPromotions

func (*OfferProgramConfigurationPromotions) ContextValidate 

func (m *OfferProgramConfigurationPromotions) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this offer program configuration promotions based on the context it is used

func (*OfferProgramConfigurationPromotions) MarshalBinary 

func (m *OfferProgramConfigurationPromotions) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OfferProgramConfigurationPromotions) UnmarshalBinary 

func (m *OfferProgramConfigurationPromotions) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OfferProgramConfigurationPromotions) Validate 

func (m *OfferProgramConfigurationPromotions) Validate(formats strfmt.Registry) error

Validate validates this offer program configuration promotions

type OfferProgramConfigurationPromotionsDiscountFunding 

type OfferProgramConfigurationPromotionsDiscountFunding struct {

	// The percentage discount on the offer.
	// Maximum: 100
	// Minimum: 0
	Percentage *int64 `json:"percentage,omitempty"`
}

OfferProgramConfigurationPromotionsDiscountFunding A promotional percentage discount applied to the offer.

swagger:model OfferProgramConfigurationPromotionsDiscountFunding

func (*OfferProgramConfigurationPromotionsDiscountFunding) ContextValidate 

func (m *OfferProgramConfigurationPromotionsDiscountFunding) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this offer program configuration promotions discount funding based on context it is used

func (*OfferProgramConfigurationPromotionsDiscountFunding) MarshalBinary 

func (m *OfferProgramConfigurationPromotionsDiscountFunding) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OfferProgramConfigurationPromotionsDiscountFunding) UnmarshalBinary 

func (m *OfferProgramConfigurationPromotionsDiscountFunding) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OfferProgramConfigurationPromotionsDiscountFunding) Validate 

func (m *OfferProgramConfigurationPromotionsDiscountFunding) Validate(formats strfmt.Registry) error

Validate validates this offer program configuration promotions discount funding

type PaginationResponse 

type PaginationResponse struct {

	// Total number of results matching the given filter criteria.
	// Minimum: 0
	TotalResults *int64 `json:"totalResults,omitempty"`
}

PaginationResponse Use these parameters to paginate through the response.

swagger:model PaginationResponse

func (*PaginationResponse) ContextValidate 

func (m *PaginationResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this pagination response based on context it is used

func (*PaginationResponse) MarshalBinary 

func (m *PaginationResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PaginationResponse) UnmarshalBinary 

func (m *PaginationResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PaginationResponse) Validate 

func (m *PaginationResponse) Validate(formats strfmt.Registry) error

Validate validates this pagination response

type Preference 

type Preference struct {

	// Filters the results to only include offers with the auto-enrollment preference specified.
	// Min Items: 1
	// Unique: true
	AutoEnrollment []AutoEnrollmentPreference `json:"autoEnrollment"`
}

Preference Offer preferences that you can include in the result filter criteria.

swagger:model Preference

func (*Preference) ContextValidate 

func (m *Preference) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this preference based on the context it is used

func (*Preference) MarshalBinary 

func (m *Preference) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Preference) UnmarshalBinary 

func (m *Preference) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Preference) Validate 

func (m *Preference) Validate(formats strfmt.Registry) error

Validate validates this preference

type ProgramType 

type ProgramType string

ProgramType The replenishment program type.

swagger:model ProgramType 

const (

	// ProgramTypeSUBSCRIBEANDSAVE captures enum value "SUBSCRIBE_AND_SAVE"
	ProgramTypeSUBSCRIBEANDSAVE ProgramType = "SUBSCRIBE_AND_SAVE"
)

func NewProgramType 

func NewProgramType(value ProgramType) *ProgramType

func (ProgramType) ContextValidate 

func (m ProgramType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this program type based on context it is used

func (ProgramType) Pointer 

func (m ProgramType) Pointer() *ProgramType

Pointer returns a pointer to a freshly-allocated ProgramType.

func (ProgramType) Validate 

func (m ProgramType) Validate(formats strfmt.Registry) error

Validate validates this program type

type ProgramTypes 

type ProgramTypes []ProgramType

ProgramTypes A list of replenishment program types.

swagger:model ProgramTypes

func (ProgramTypes) ContextValidate 

func (m ProgramTypes) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this program types based on the context it is used

func (ProgramTypes) Validate 

func (m ProgramTypes) Validate(formats strfmt.Registry) error

Validate validates this program types

type Promotion 

type Promotion struct {

	// A base discount set by Amazon on the offer.
	AmazonFundedBaseDiscount *DiscountFunding `json:"amazonFundedBaseDiscount,omitempty"`

	// A tiered discount set by Amazon on the offer.
	AmazonFundedTieredDiscount *DiscountFunding `json:"amazonFundedTieredDiscount,omitempty"`

	// A base discount set by the selling partner on the offer.
	SellingPartnerFundedBaseDiscount *DiscountFunding `json:"sellingPartnerFundedBaseDiscount,omitempty"`

	// A tiered discount set by the selling partner on the offer.
	SellingPartnerFundedTieredDiscount *DiscountFunding `json:"sellingPartnerFundedTieredDiscount,omitempty"`
}

Promotion Offer promotions to include in the result filter criteria.

swagger:model Promotion

func (*Promotion) ContextValidate 

func (m *Promotion) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this promotion based on the context it is used

func (*Promotion) MarshalBinary 

func (m *Promotion) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Promotion) UnmarshalBinary 

func (m *Promotion) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Promotion) Validate 

func (m *Promotion) Validate(formats strfmt.Registry) error

Validate validates this promotion

type SortOrder 

type SortOrder string

SortOrder The sort order.

swagger:model SortOrder 

const (

	// SortOrderASC captures enum value "ASC"
	SortOrderASC SortOrder = "ASC"

	// SortOrderDESC captures enum value "DESC"
	SortOrderDESC SortOrder = "DESC"
)

func NewSortOrder 

func NewSortOrder(value SortOrder) *SortOrder

func (SortOrder) ContextValidate 

func (m SortOrder) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this sort order based on context it is used

func (SortOrder) Pointer 

func (m SortOrder) Pointer() *SortOrder

Pointer returns a pointer to a freshly-allocated SortOrder.

func (SortOrder) Validate 

func (m SortOrder) Validate(formats strfmt.Registry) error

Validate validates this sort order

type TimeInterval 

type TimeInterval struct {

	// When this object is used as a request parameter, the specified `endDate` is adjusted based on the aggregation frequency.
	//
	// * For `WEEK` the metric is computed up to the last day of the week (Sunday, based on ISO 8601) that contains the `endDate`.
	// * For `MONTH`, the metric is computed up to the last day that contains the `endDate`.
	// * For `QUARTER` the metric is computed up to the last day of the quarter that contains the `endDate`.
	// * For `YEAR` the metric is computed up to the last day of the year that contains the `endDate`.
	//  Note: The end date may be adjusted to a lower value based on the data available in our system.
	// Required: true
	// Format: date-time
	EndDate *strfmt.DateTime `json:"endDate"`

	// When this object is used as a request parameter, the specified `startDate` is adjusted based on the aggregation frequency.
	//
	// * For `WEEK` the metric is computed from the first day of the week (Sunday, based on ISO 8601) that contains the `startDate`.
	// * For `MONTH` the metric is computed from the first day of the month that contains the `startDate`.
	// * For `QUARTER` the metric is computed from the first day of the quarter that contains the `startDate`.
	// * For `YEAR` the metric is computed from the first day of the year that contains the `startDate`.
	// Required: true
	// Format: date-time
	StartDate *strfmt.DateTime `json:"startDate"`
}

TimeInterval A date-time interval in ISO 8601 format which is used to compute metrics. Only the date is required, but you must pass the complete date and time value. For example, November 11, 2022 should be passed as "2022-11-07T00:00:00Z". Note that only data for the trailing 2 years is supported. 

**Note**: The `listOfferMetrics` operation only supports a time interval which covers a single unit of the aggregation frequency. For example, for a MONTH aggregation frequency, the duration of the interval between the startDate and endDate can not be more than 1 month.

swagger:model TimeInterval

func (*TimeInterval) ContextValidate 

func (m *TimeInterval) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this time interval based on context it is used

func (*TimeInterval) MarshalBinary 

func (m *TimeInterval) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TimeInterval) UnmarshalBinary 

func (m *TimeInterval) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TimeInterval) Validate 

func (m *TimeInterval) Validate(formats strfmt.Registry) error

Validate validates this time interval

type TimePeriodType 

type TimePeriodType string

TimePeriodType The time period type that determines whether the metrics requested are backward-looking (performance) or forward-looking (forecast).

swagger:model TimePeriodType 

const (

	// TimePeriodTypePERFORMANCE captures enum value "PERFORMANCE"
	TimePeriodTypePERFORMANCE TimePeriodType = "PERFORMANCE"

	// TimePeriodTypeFORECAST captures enum value "FORECAST"
	TimePeriodTypeFORECAST TimePeriodType = "FORECAST"
)

func NewTimePeriodType 

func NewTimePeriodType(value TimePeriodType) *TimePeriodType

func (TimePeriodType) ContextValidate 

func (m TimePeriodType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this time period type based on context it is used

func (TimePeriodType) Pointer 

func (m TimePeriodType) Pointer() *TimePeriodType

Pointer returns a pointer to a freshly-allocated TimePeriodType.

func (TimePeriodType) Validate 

func (m TimePeriodType) Validate(formats strfmt.Registry) error

Validate validates this time period type

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.