notifications_models

type AggregationFilter struct {

	// aggregation settings
	AggregationSettings *AggregationSettings `json:"aggregationSettings,omitempty"`
}

type AggregationSettings struct {

	// The supported time period to use to perform marketplace-ASIN level aggregation.
	// Required: true
	AggregationTimePeriod *AggregationTimePeriod `json:"aggregationTimePeriod"`
}

type AggregationTimePeriod string

type CreateDestinationRequest struct {

	// A developer-defined name to help identify this destination.
	// Required: true
	Name *string `json:"name"`

	// The information required to create a destination resource. Applications should use one resource type (sqs or eventBridge) per destination.
	// Required: true
	ResourceSpecification *DestinationResourceSpecification `json:"resourceSpecification"`
}

type CreateDestinationResponse struct {

	// One or more unexpected errors occurred during the `createDestination` operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the `createDestination` operation.
	Payload *Destination `json:"payload,omitempty"`
}

type CreateSubscriptionRequest struct {

	// The identifier for the destination where notifications will be delivered.
	// Required: true
	DestinationID *string `json:"destinationId"`

	// The version of the payload object to be used in the notification.
	// Required: true
	PayloadVersion *string `json:"payloadVersion"`

	// processing directive
	ProcessingDirective *ProcessingDirective `json:"processingDirective,omitempty"`
}

type CreateSubscriptionResponse struct {

	// One or more unexpected errors occurred during the `createSubscription` operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the `createSubscription` operation.
	Payload *Subscription `json:"payload,omitempty"`
}

type DeleteDestinationResponse struct {

	// One or more unexpected errors occurred during the `deleteDestination` operation.
	Errors ErrorList `json:"errors,omitempty"`
}

type DeleteSubscriptionByIDResponse struct {

	// An unexpected condition occurred during the `deleteSubscriptionById` operation.
	Errors ErrorList `json:"errors,omitempty"`
}

type Destination struct {

	// The destination identifier generated when you created the destination.
	// Required: true
	DestinationID *string `json:"destinationId"`

	// The developer-defined name for this destination.
	// Required: true
	// Max Length: 256
	Name *string `json:"name"`

	// The resource that will receive notifications associated with this destination.
	// Required: true
	Resource *DestinationResource `json:"resource"`
}

type DestinationList []*Destination

type DestinationResource struct {

	// An Amazon EventBridge destination.
	EventBridge *EventBridgeResource `json:"eventBridge,omitempty"`

	// An Amazon Simple Queue Service (SQS) queue destination.
	Sqs *SqsResource `json:"sqs,omitempty"`
}

type DestinationResourceSpecification struct {

	// The information required to create an Amazon EventBridge destination.
	EventBridge *EventBridgeResourceSpecification `json:"eventBridge,omitempty"`

	// The information required to create an Amazon Simple Queue Service (SQS) queue destination.
	Sqs *SqsResource `json:"sqs,omitempty"`
}

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"`
}

type ErrorList []*Error

type EventBridgeResource struct {

	// The identifier for the AWS account that is responsible for charges related to receiving notifications.
	// Required: true
	AccountID *string `json:"accountId"`

	// The name of the partner event source associated with the destination.
	// Required: true
	// Max Length: 256
	Name *string `json:"name"`

	// The AWS region in which you receive the notifications. For AWS regions that are supported in Amazon EventBridge, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html).
	// Required: true
	Region *string `json:"region"`
}

type EventBridgeResourceSpecification struct {

	// The identifier for the AWS account that is responsible for charges related to receiving notifications.
	// Required: true
	AccountID *string `json:"accountId"`

	// The AWS region in which you will be receiving the notifications.
	// Required: true
	Region *string `json:"region"`
}

type EventFilter struct {
	AggregationFilter

	MarketplaceFilter

	OrderChangeTypeFilter

	// An `eventFilterType` value that is supported by the specific `notificationType`. This is used by the subscription service to determine the type of event filter. Refer to the section of the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide) that describes the specific `notificationType` to determine if an `eventFilterType` is supported.
	// Required: true
	// Enum: [ANY_OFFER_CHANGED ORDER_CHANGE]
	EventFilterType *string `json:"eventFilterType"`
}

type GetDestinationResponse struct {

	// One or more unexpected errors occurred during the `getDestination` operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the `getDestination` operation.
	Payload *Destination `json:"payload,omitempty"`
}

type GetDestinationsResponse struct {

	// One or more unexpected errors occurred during the `getDestinations` operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the `getDestinations` operation.
	Payload DestinationList `json:"payload,omitempty"`
}

type GetSubscriptionByIDResponse struct {

	// An unexpected condition occurred during the `getSubscriptionById` operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the `getSubscriptionById` operation.
	Payload *Subscription `json:"payload,omitempty"`
}

type GetSubscriptionResponse struct {

	// One or more unexpected errors occurred during the `getSubscription` operation.
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the `getSubscription` operation.
	Payload *Subscription `json:"payload,omitempty"`
}

type MarketplaceFilter struct {

	// marketplace ids
	MarketplaceIds MarketplaceIds `json:"marketplaceIds,omitempty"`
}

type MarketplaceIds []string

type OrderChangeTypeEnum string

type OrderChangeTypeFilter struct {

	// order change types
	OrderChangeTypes OrderChangeTypes `json:"orderChangeTypes,omitempty"`
}

type OrderChangeTypes []OrderChangeTypeEnum

type ProcessingDirective struct {

	// A `notificationType` specific filter.
	EventFilter *EventFilter `json:"eventFilter,omitempty"`
}

type SqsResource struct {

	// The Amazon Resource Name (ARN) associated with the SQS queue.
	// Required: true
	// Max Length: 1000
	// Pattern: ^arn:aws:sqs:\S+:\S+:\S+
	Arn *string `json:"arn"`
}

type Subscription struct {

	// The identifier for the destination where notifications will be delivered.
	// Required: true
	DestinationID *string `json:"destinationId"`

	// The version of the payload object to be used in the notification.
	// Required: true
	PayloadVersion *string `json:"payloadVersion"`

	// processing directive
	ProcessingDirective *ProcessingDirective `json:"processingDirective,omitempty"`

	// The subscription identifier generated when the subscription is created.
	// Required: true
	SubscriptionID *string `json:"subscriptionId"`
}