amazonmarketingstream

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Sep 22, 2023 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen version v1.15.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCreateDspStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBody

func NewCreateDspStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBody(server string, params *CreateDspStreamSubscriptionParams, body CreateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody) (*http.Request, error)

NewCreateDspStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBody calls the generic CreateDspStreamSubscription builder with application/vnd.MarketingStreamSubscriptions.DspStreamSubscriptionResource.v1.0+json body

func NewCreateDspStreamSubscriptionRequestWithBody

func NewCreateDspStreamSubscriptionRequestWithBody(server string, params *CreateDspStreamSubscriptionParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateDspStreamSubscriptionRequestWithBody generates requests for CreateDspStreamSubscription with any type of body

func NewCreateStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBody

func NewCreateStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBody(server string, params *CreateStreamSubscriptionParams, body CreateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody) (*http.Request, error)

NewCreateStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBody calls the generic CreateStreamSubscription builder with application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json body

func NewCreateStreamSubscriptionRequestWithBody

func NewCreateStreamSubscriptionRequestWithBody(server string, params *CreateStreamSubscriptionParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateStreamSubscriptionRequestWithBody generates requests for CreateStreamSubscription with any type of body

func NewGetDspStreamSubscriptionRequest

func NewGetDspStreamSubscriptionRequest(server string, subscriptionId string, params *GetDspStreamSubscriptionParams) (*http.Request, error)

NewGetDspStreamSubscriptionRequest generates requests for GetDspStreamSubscription

func NewGetStreamSubscriptionRequest

func NewGetStreamSubscriptionRequest(server string, subscriptionId string, params *GetStreamSubscriptionParams) (*http.Request, error)

NewGetStreamSubscriptionRequest generates requests for GetStreamSubscription

func NewListDspStreamSubscriptionsRequest

func NewListDspStreamSubscriptionsRequest(server string, params *ListDspStreamSubscriptionsParams) (*http.Request, error)

NewListDspStreamSubscriptionsRequest generates requests for ListDspStreamSubscriptions

func NewListStreamSubscriptionsRequest

func NewListStreamSubscriptionsRequest(server string, params *ListStreamSubscriptionsParams) (*http.Request, error)

NewListStreamSubscriptionsRequest generates requests for ListStreamSubscriptions

func NewUpdateDspStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBody

func NewUpdateDspStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBody(server string, subscriptionId string, params *UpdateDspStreamSubscriptionParams, body UpdateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody) (*http.Request, error)

NewUpdateDspStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBody calls the generic UpdateDspStreamSubscription builder with application/vnd.MarketingStreamSubscriptions.DspStreamSubscriptionResource.v1.0+json body

func NewUpdateDspStreamSubscriptionRequestWithBody

func NewUpdateDspStreamSubscriptionRequestWithBody(server string, subscriptionId string, params *UpdateDspStreamSubscriptionParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDspStreamSubscriptionRequestWithBody generates requests for UpdateDspStreamSubscription with any type of body

func NewUpdateStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBody

func NewUpdateStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBody(server string, subscriptionId string, params *UpdateStreamSubscriptionParams, body UpdateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody) (*http.Request, error)

NewUpdateStreamSubscriptionRequestWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBody calls the generic UpdateStreamSubscription builder with application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json body

func NewUpdateStreamSubscriptionRequestWithBody

func NewUpdateStreamSubscriptionRequestWithBody(server string, subscriptionId string, params *UpdateStreamSubscriptionParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateStreamSubscriptionRequestWithBody generates requests for UpdateStreamSubscription with any type of body

Types

type AccessForbiddenErrorResponseContent

type AccessForbiddenErrorResponseContent struct {
	Code    *string `json:"code,omitempty"`
	Message string  `json:"message"`
}

AccessForbiddenErrorResponseContent defines model for AccessForbiddenErrorResponseContent.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn

	// A callback for modifying response which are generated after receive from the network.
	ResponseEditors []ResponseEditorFn

	// The user agent header identifies your application, its version number, and the platform and programming language you are using.
	// You must include a user agent header in each request submitted to the sales partner API.
	UserAgent string
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CreateDspStreamSubscriptionWithBody

func (c *Client) CreateDspStreamSubscriptionWithBody(ctx context.Context, params *CreateDspStreamSubscriptionParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateStreamSubscriptionWithBody

func (c *Client) CreateStreamSubscriptionWithBody(ctx context.Context, params *CreateStreamSubscriptionParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) GetDspStreamSubscription

func (c *Client) GetDspStreamSubscription(ctx context.Context, subscriptionId string, params *GetDspStreamSubscriptionParams) (*http.Response, error)

func (*Client) GetStreamSubscription

func (c *Client) GetStreamSubscription(ctx context.Context, subscriptionId string, params *GetStreamSubscriptionParams) (*http.Response, error)

func (*Client) ListDspStreamSubscriptions

func (c *Client) ListDspStreamSubscriptions(ctx context.Context, params *ListDspStreamSubscriptionsParams) (*http.Response, error)

func (*Client) ListStreamSubscriptions

func (c *Client) ListStreamSubscriptions(ctx context.Context, params *ListStreamSubscriptionsParams) (*http.Response, error)

func (*Client) UpdateDspStreamSubscriptionWithBody

func (c *Client) UpdateDspStreamSubscriptionWithBody(ctx context.Context, subscriptionId string, params *UpdateDspStreamSubscriptionParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateStreamSubscriptionWithBody

func (c *Client) UpdateStreamSubscriptionWithBody(ctx context.Context, subscriptionId string, params *UpdateStreamSubscriptionParams, contentType string, body io.Reader) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// ListDspStreamSubscriptions request
	ListDspStreamSubscriptions(ctx context.Context, params *ListDspStreamSubscriptionsParams) (*http.Response, error)

	// CreateDspStreamSubscriptionWithBody request with any body
	CreateDspStreamSubscriptionWithBody(ctx context.Context, params *CreateDspStreamSubscriptionParams, contentType string, body io.Reader) (*http.Response, error)

	CreateDspStreamSubscriptionWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBody(ctx context.Context, params *CreateDspStreamSubscriptionParams, body CreateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody) (*http.Response, error)

	// GetDspStreamSubscription request
	GetDspStreamSubscription(ctx context.Context, subscriptionId string, params *GetDspStreamSubscriptionParams) (*http.Response, error)

	// UpdateDspStreamSubscriptionWithBody request with any body
	UpdateDspStreamSubscriptionWithBody(ctx context.Context, subscriptionId string, params *UpdateDspStreamSubscriptionParams, contentType string, body io.Reader) (*http.Response, error)

	UpdateDspStreamSubscriptionWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBody(ctx context.Context, subscriptionId string, params *UpdateDspStreamSubscriptionParams, body UpdateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody) (*http.Response, error)

	// ListStreamSubscriptions request
	ListStreamSubscriptions(ctx context.Context, params *ListStreamSubscriptionsParams) (*http.Response, error)

	// CreateStreamSubscriptionWithBody request with any body
	CreateStreamSubscriptionWithBody(ctx context.Context, params *CreateStreamSubscriptionParams, contentType string, body io.Reader) (*http.Response, error)

	CreateStreamSubscriptionWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBody(ctx context.Context, params *CreateStreamSubscriptionParams, body CreateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody) (*http.Response, error)

	// GetStreamSubscription request
	GetStreamSubscription(ctx context.Context, subscriptionId string, params *GetStreamSubscriptionParams) (*http.Response, error)

	// UpdateStreamSubscriptionWithBody request with any body
	UpdateStreamSubscriptionWithBody(ctx context.Context, subscriptionId string, params *UpdateStreamSubscriptionParams, contentType string, body io.Reader) (*http.Response, error)

	UpdateStreamSubscriptionWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBody(ctx context.Context, subscriptionId string, params *UpdateStreamSubscriptionParams, body UpdateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithResponseEditorFn added in v0.0.2

func WithResponseEditorFn(fn ResponseEditorFn) ClientOption

WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CreateDspStreamSubscriptionWithBodyWithResponse

func (c *ClientWithResponses) CreateDspStreamSubscriptionWithBodyWithResponse(ctx context.Context, params *CreateDspStreamSubscriptionParams, contentType string, body io.Reader) (*CreateDspStreamSubscriptionResp, error)

CreateDspStreamSubscriptionWithBodyWithResponse request with arbitrary body returning *CreateDspStreamSubscriptionResp

func (*ClientWithResponses) CreateStreamSubscriptionWithBodyWithResponse

func (c *ClientWithResponses) CreateStreamSubscriptionWithBodyWithResponse(ctx context.Context, params *CreateStreamSubscriptionParams, contentType string, body io.Reader) (*CreateStreamSubscriptionResp, error)

CreateStreamSubscriptionWithBodyWithResponse request with arbitrary body returning *CreateStreamSubscriptionResp

func (*ClientWithResponses) GetDspStreamSubscriptionWithResponse

func (c *ClientWithResponses) GetDspStreamSubscriptionWithResponse(ctx context.Context, subscriptionId string, params *GetDspStreamSubscriptionParams) (*GetDspStreamSubscriptionResp, error)

GetDspStreamSubscriptionWithResponse request returning *GetDspStreamSubscriptionResp

func (*ClientWithResponses) GetStreamSubscriptionWithResponse

func (c *ClientWithResponses) GetStreamSubscriptionWithResponse(ctx context.Context, subscriptionId string, params *GetStreamSubscriptionParams) (*GetStreamSubscriptionResp, error)

GetStreamSubscriptionWithResponse request returning *GetStreamSubscriptionResp

func (*ClientWithResponses) ListDspStreamSubscriptionsWithResponse

func (c *ClientWithResponses) ListDspStreamSubscriptionsWithResponse(ctx context.Context, params *ListDspStreamSubscriptionsParams) (*ListDspStreamSubscriptionsResp, error)

ListDspStreamSubscriptionsWithResponse request returning *ListDspStreamSubscriptionsResp

func (*ClientWithResponses) ListStreamSubscriptionsWithResponse

func (c *ClientWithResponses) ListStreamSubscriptionsWithResponse(ctx context.Context, params *ListStreamSubscriptionsParams) (*ListStreamSubscriptionsResp, error)

ListStreamSubscriptionsWithResponse request returning *ListStreamSubscriptionsResp

func (*ClientWithResponses) UpdateDspStreamSubscriptionWithBodyWithResponse

func (c *ClientWithResponses) UpdateDspStreamSubscriptionWithBodyWithResponse(ctx context.Context, subscriptionId string, params *UpdateDspStreamSubscriptionParams, contentType string, body io.Reader) (*UpdateDspStreamSubscriptionResp, error)

UpdateDspStreamSubscriptionWithBodyWithResponse request with arbitrary body returning *UpdateDspStreamSubscriptionResp

func (*ClientWithResponses) UpdateStreamSubscriptionWithBodyWithResponse

func (c *ClientWithResponses) UpdateStreamSubscriptionWithBodyWithResponse(ctx context.Context, subscriptionId string, params *UpdateStreamSubscriptionParams, contentType string, body io.Reader) (*UpdateStreamSubscriptionResp, error)

UpdateStreamSubscriptionWithBodyWithResponse request with arbitrary body returning *UpdateStreamSubscriptionResp

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// ListDspStreamSubscriptionsWithResponse request
	ListDspStreamSubscriptionsWithResponse(ctx context.Context, params *ListDspStreamSubscriptionsParams) (*ListDspStreamSubscriptionsResp, error)

	// CreateDspStreamSubscriptionWithBodyWithResponse request with any body
	CreateDspStreamSubscriptionWithBodyWithResponse(ctx context.Context, params *CreateDspStreamSubscriptionParams, contentType string, body io.Reader) (*CreateDspStreamSubscriptionResp, error)

	CreateDspStreamSubscriptionWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBodyWithResponse(ctx context.Context, params *CreateDspStreamSubscriptionParams, body CreateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody) (*CreateDspStreamSubscriptionResp, error)

	// GetDspStreamSubscriptionWithResponse request
	GetDspStreamSubscriptionWithResponse(ctx context.Context, subscriptionId string, params *GetDspStreamSubscriptionParams) (*GetDspStreamSubscriptionResp, error)

	// UpdateDspStreamSubscriptionWithBodyWithResponse request with any body
	UpdateDspStreamSubscriptionWithBodyWithResponse(ctx context.Context, subscriptionId string, params *UpdateDspStreamSubscriptionParams, contentType string, body io.Reader) (*UpdateDspStreamSubscriptionResp, error)

	UpdateDspStreamSubscriptionWithApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONBodyWithResponse(ctx context.Context, subscriptionId string, params *UpdateDspStreamSubscriptionParams, body UpdateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody) (*UpdateDspStreamSubscriptionResp, error)

	// ListStreamSubscriptionsWithResponse request
	ListStreamSubscriptionsWithResponse(ctx context.Context, params *ListStreamSubscriptionsParams) (*ListStreamSubscriptionsResp, error)

	// CreateStreamSubscriptionWithBodyWithResponse request with any body
	CreateStreamSubscriptionWithBodyWithResponse(ctx context.Context, params *CreateStreamSubscriptionParams, contentType string, body io.Reader) (*CreateStreamSubscriptionResp, error)

	CreateStreamSubscriptionWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBodyWithResponse(ctx context.Context, params *CreateStreamSubscriptionParams, body CreateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody) (*CreateStreamSubscriptionResp, error)

	// GetStreamSubscriptionWithResponse request
	GetStreamSubscriptionWithResponse(ctx context.Context, subscriptionId string, params *GetStreamSubscriptionParams) (*GetStreamSubscriptionResp, error)

	// UpdateStreamSubscriptionWithBodyWithResponse request with any body
	UpdateStreamSubscriptionWithBodyWithResponse(ctx context.Context, subscriptionId string, params *UpdateStreamSubscriptionParams, contentType string, body io.Reader) (*UpdateStreamSubscriptionResp, error)

	UpdateStreamSubscriptionWithApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONBodyWithResponse(ctx context.Context, subscriptionId string, params *UpdateStreamSubscriptionParams, body UpdateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody) (*UpdateStreamSubscriptionResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody

type CreateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody = CreateDspStreamSubscriptionRequestContent

CreateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody defines body for CreateDspStreamSubscription for application/vnd.MarketingStreamSubscriptions.DspStreamSubscriptionResource.v1.0+json ContentType.

type CreateDspStreamSubscriptionParams

type CreateDspStreamSubscriptionParams struct {
	// AmazonAdsAccountID The identifier of a DSP advertiser level account
	AmazonAdsAccountID string `json:"Amazon-Ads-Account-ID"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`
}

CreateDspStreamSubscriptionParams defines parameters for CreateDspStreamSubscription.

type CreateDspStreamSubscriptionRequestContent

type CreateDspStreamSubscriptionRequestContent struct {
	// ClientRequestToken Unique value supplied by the caller used to track identical API requests.
	// Should request be re-tried, the caller should supply the same value. We recommend using GUID.
	ClientRequestToken string `json:"clientRequestToken"`

	// DataSetId Identifier of data set, callers can be subscribed to. Please refer to https://advertising.amazon.com/API/docs/en-us/amazon-marketing-stream/data-guide for the list of all data sets.
	DataSetId string `json:"dataSetId"`

	// DestinationArn AWS ARN of the destination endpoint associated with the subscription.
	// Supported destination types:
	// - SQS
	DestinationArn string `json:"destinationArn"`

	// Notes Additional details associated with the subscription
	Notes *string `json:"notes,omitempty"`
}

CreateDspStreamSubscriptionRequestContent defines model for CreateDspStreamSubscriptionRequestContent.

type CreateDspStreamSubscriptionResp

type CreateDspStreamSubscriptionResp struct {
	Body                                                                              []byte
	HTTPResponse                                                                      *http.Response
	ApplicationvndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10JSON200 *CreateDspStreamSubscriptionResponseContent
	JSON400                                                                           *InvalidRequestErrorResponseContent
	JSON403                                                                           *AccessForbiddenErrorResponseContent
	JSON409                                                                           *OperationConflictErrorResponseContent
	JSON429                                                                           *TooManyRequestsErrorResponseContent
	JSON500                                                                           *InternalServerErrorResponseContent
}

func ParseCreateDspStreamSubscriptionResp

func ParseCreateDspStreamSubscriptionResp(rsp *http.Response) (*CreateDspStreamSubscriptionResp, error)

ParseCreateDspStreamSubscriptionResp parses an HTTP response from a CreateDspStreamSubscriptionWithResponse call

func (CreateDspStreamSubscriptionResp) Status

Status returns HTTPResponse.Status

func (CreateDspStreamSubscriptionResp) StatusCode

func (r CreateDspStreamSubscriptionResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDspStreamSubscriptionResponseContent

type CreateDspStreamSubscriptionResponseContent struct {
	// ClientRequestToken Unique value supplied by the caller used to track identical API requests.
	// Should request be re-tried, the caller should supply the same value. We recommend using GUID.
	ClientRequestToken string `json:"clientRequestToken"`

	// SubscriptionId Unique subscription identifier
	SubscriptionId string `json:"subscriptionId"`
}

CreateDspStreamSubscriptionResponseContent defines model for CreateDspStreamSubscriptionResponseContent.

type CreateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody

type CreateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody = CreateStreamSubscriptionRequestContent

CreateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody defines body for CreateStreamSubscription for application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json ContentType.

type CreateStreamSubscriptionParams

type CreateStreamSubscriptionParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

CreateStreamSubscriptionParams defines parameters for CreateStreamSubscription.

type CreateStreamSubscriptionRequestContent

type CreateStreamSubscriptionRequestContent struct {
	// ClientRequestToken Unique value supplied by the caller used to track identical API requests.
	// Should request be re-tried, the caller should supply the same value. We recommend using GUID.
	ClientRequestToken string `json:"clientRequestToken"`

	// DataSetId Identifier of data set, callers can be subscribed to. Please refer to https://advertising.amazon.com/API/docs/en-us/amazon-marketing-stream/data-guide for the list of all data sets.
	DataSetId string `json:"dataSetId"`

	// DestinationArn AWS ARN of the destination endpoint associated with the subscription.
	// Supported destination types:
	// - SQS
	DestinationArn string `json:"destinationArn"`

	// Notes Additional details associated with the subscription
	Notes *string `json:"notes,omitempty"`
}

CreateStreamSubscriptionRequestContent defines model for CreateStreamSubscriptionRequestContent.

type CreateStreamSubscriptionResp

type CreateStreamSubscriptionResp struct {
	Body                                                                           []byte
	HTTPResponse                                                                   *http.Response
	ApplicationvndMarketingStreamSubscriptionsStreamSubscriptionResourceV10JSON200 *CreateStreamSubscriptionResponseContent
	JSON400                                                                        *InvalidRequestErrorResponseContent
	JSON401                                                                        *UnauthorizedAccessErrorResponseContent
	JSON403                                                                        *AccessForbiddenErrorResponseContent
	JSON404                                                                        *ResourceNotFoundErrorResponseContent
	JSON409                                                                        *OperationConflictErrorResponseContent
	JSON429                                                                        *TooManyRequestsErrorResponseContent
	JSON500                                                                        *InternalServerErrorResponseContent
}

func ParseCreateStreamSubscriptionResp

func ParseCreateStreamSubscriptionResp(rsp *http.Response) (*CreateStreamSubscriptionResp, error)

ParseCreateStreamSubscriptionResp parses an HTTP response from a CreateStreamSubscriptionWithResponse call

func (CreateStreamSubscriptionResp) Status

Status returns HTTPResponse.Status

func (CreateStreamSubscriptionResp) StatusCode

func (r CreateStreamSubscriptionResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateStreamSubscriptionResponseContent

type CreateStreamSubscriptionResponseContent struct {
	// ClientRequestToken Unique value supplied by the caller used to track identical API requests.
	// Should request be re-tried, the caller should supply the same value. We recommend using GUID.
	ClientRequestToken string `json:"clientRequestToken"`

	// SubscriptionId Unique subscription identifier
	SubscriptionId string `json:"subscriptionId"`
}

CreateStreamSubscriptionResponseContent defines model for CreateStreamSubscriptionResponseContent.

type GetDspStreamSubscriptionParams

type GetDspStreamSubscriptionParams struct {
	// AmazonAdsAccountID The identifier of a DSP advertiser level account
	AmazonAdsAccountID string `json:"Amazon-Ads-Account-ID"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`
}

GetDspStreamSubscriptionParams defines parameters for GetDspStreamSubscription.

type GetDspStreamSubscriptionResp

type GetDspStreamSubscriptionResp struct {
	Body                                                                              []byte
	HTTPResponse                                                                      *http.Response
	ApplicationvndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10JSON200 *GetDspStreamSubscriptionResponseContent
	JSON400                                                                           *InvalidRequestErrorResponseContent
	JSON403                                                                           *AccessForbiddenErrorResponseContent
	JSON404                                                                           *ResourceNotFoundErrorResponseContent
	JSON429                                                                           *TooManyRequestsErrorResponseContent
	JSON500                                                                           *InternalServerErrorResponseContent
}

func ParseGetDspStreamSubscriptionResp

func ParseGetDspStreamSubscriptionResp(rsp *http.Response) (*GetDspStreamSubscriptionResp, error)

ParseGetDspStreamSubscriptionResp parses an HTTP response from a GetDspStreamSubscriptionWithResponse call

func (GetDspStreamSubscriptionResp) Status

Status returns HTTPResponse.Status

func (GetDspStreamSubscriptionResp) StatusCode

func (r GetDspStreamSubscriptionResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDspStreamSubscriptionResponseContent

type GetDspStreamSubscriptionResponseContent struct {
	Subscription StreamSubscription `json:"subscription"`
}

GetDspStreamSubscriptionResponseContent defines model for GetDspStreamSubscriptionResponseContent.

type GetStreamSubscriptionParams

type GetStreamSubscriptionParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

GetStreamSubscriptionParams defines parameters for GetStreamSubscription.

type GetStreamSubscriptionResp

type GetStreamSubscriptionResp struct {
	Body                                                                           []byte
	HTTPResponse                                                                   *http.Response
	ApplicationvndMarketingStreamSubscriptionsStreamSubscriptionResourceV10JSON200 *GetStreamSubscriptionResponseContent
	JSON400                                                                        *InvalidRequestErrorResponseContent
	JSON401                                                                        *UnauthorizedAccessErrorResponseContent
	JSON403                                                                        *AccessForbiddenErrorResponseContent
	JSON404                                                                        *ResourceNotFoundErrorResponseContent
	JSON429                                                                        *TooManyRequestsErrorResponseContent
	JSON500                                                                        *InternalServerErrorResponseContent
}

func ParseGetStreamSubscriptionResp

func ParseGetStreamSubscriptionResp(rsp *http.Response) (*GetStreamSubscriptionResp, error)

ParseGetStreamSubscriptionResp parses an HTTP response from a GetStreamSubscriptionWithResponse call

func (GetStreamSubscriptionResp) Status

func (r GetStreamSubscriptionResp) Status() string

Status returns HTTPResponse.Status

func (GetStreamSubscriptionResp) StatusCode

func (r GetStreamSubscriptionResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStreamSubscriptionResponseContent

type GetStreamSubscriptionResponseContent struct {
	Subscription StreamSubscription `json:"subscription"`
}

GetStreamSubscriptionResponseContent defines model for GetStreamSubscriptionResponseContent.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InternalServerErrorResponseContent

type InternalServerErrorResponseContent struct {
	Code    *string `json:"code,omitempty"`
	Message string  `json:"message"`
}

InternalServerErrorResponseContent defines model for InternalServerErrorResponseContent.

type InvalidRequestErrorResponseContent

type InvalidRequestErrorResponseContent struct {
	Code    *string `json:"code,omitempty"`
	Message string  `json:"message"`
}

InvalidRequestErrorResponseContent defines model for InvalidRequestErrorResponseContent.

type ListDspStreamSubscriptionsParams

type ListDspStreamSubscriptionsParams struct {
	// MaxResults desired number of entries in the response, defaults to maximum value
	MaxResults *float32 `form:"maxResults,omitempty" json:"maxResults,omitempty"`

	// StartingToken Token which can be used to get the next page of results, if more entries exist
	StartingToken *string `form:"startingToken,omitempty" json:"startingToken,omitempty"`

	// AmazonAdsAccountID The identifier of a DSP advertiser level account
	AmazonAdsAccountID string `json:"Amazon-Ads-Account-ID"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`
}

ListDspStreamSubscriptionsParams defines parameters for ListDspStreamSubscriptions.

type ListDspStreamSubscriptionsResp

type ListDspStreamSubscriptionsResp struct {
	Body                                                                              []byte
	HTTPResponse                                                                      *http.Response
	ApplicationvndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10JSON200 *ListDspStreamSubscriptionsResponseContent
	JSON400                                                                           *InvalidRequestErrorResponseContent
	JSON403                                                                           *AccessForbiddenErrorResponseContent
	JSON429                                                                           *TooManyRequestsErrorResponseContent
	JSON500                                                                           *InternalServerErrorResponseContent
}

func ParseListDspStreamSubscriptionsResp

func ParseListDspStreamSubscriptionsResp(rsp *http.Response) (*ListDspStreamSubscriptionsResp, error)

ParseListDspStreamSubscriptionsResp parses an HTTP response from a ListDspStreamSubscriptionsWithResponse call

func (ListDspStreamSubscriptionsResp) Status

Status returns HTTPResponse.Status

func (ListDspStreamSubscriptionsResp) StatusCode

func (r ListDspStreamSubscriptionsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListDspStreamSubscriptionsResponseContent

type ListDspStreamSubscriptionsResponseContent struct {
	// NextToken Token which can be used to get the next page of results, if more entries exist
	NextToken     *string              `json:"nextToken,omitempty"`
	Subscriptions []StreamSubscription `json:"subscriptions"`
}

ListDspStreamSubscriptionsResponseContent defines model for ListDspStreamSubscriptionsResponseContent.

type ListStreamSubscriptionsParams

type ListStreamSubscriptionsParams struct {
	// MaxResults desired number of entries in the response, defaults to maximum value
	MaxResults *float32 `form:"maxResults,omitempty" json:"maxResults,omitempty"`

	// StartingToken Token which can be used to get the next page of results, if more entries exist
	StartingToken *string `form:"startingToken,omitempty" json:"startingToken,omitempty"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

ListStreamSubscriptionsParams defines parameters for ListStreamSubscriptions.

type ListStreamSubscriptionsResp

type ListStreamSubscriptionsResp struct {
	Body                                                                           []byte
	HTTPResponse                                                                   *http.Response
	ApplicationvndMarketingStreamSubscriptionsStreamSubscriptionResourceV10JSON200 *ListStreamSubscriptionsResponseContent
	JSON400                                                                        *InvalidRequestErrorResponseContent
	JSON401                                                                        *UnauthorizedAccessErrorResponseContent
	JSON403                                                                        *AccessForbiddenErrorResponseContent
	JSON404                                                                        *ResourceNotFoundErrorResponseContent
	JSON429                                                                        *TooManyRequestsErrorResponseContent
	JSON500                                                                        *InternalServerErrorResponseContent
}

func ParseListStreamSubscriptionsResp

func ParseListStreamSubscriptionsResp(rsp *http.Response) (*ListStreamSubscriptionsResp, error)

ParseListStreamSubscriptionsResp parses an HTTP response from a ListStreamSubscriptionsWithResponse call

func (ListStreamSubscriptionsResp) Status

Status returns HTTPResponse.Status

func (ListStreamSubscriptionsResp) StatusCode

func (r ListStreamSubscriptionsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListStreamSubscriptionsResponseContent

type ListStreamSubscriptionsResponseContent struct {
	// NextToken Token which can be used to get the next page of results, if more entries exist
	NextToken     *string              `json:"nextToken,omitempty"`
	Subscriptions []StreamSubscription `json:"subscriptions"`
}

ListStreamSubscriptionsResponseContent defines model for ListStreamSubscriptionsResponseContent.

type OperationConflictErrorResponseContent

type OperationConflictErrorResponseContent struct {
	Code    *string `json:"code,omitempty"`
	Message string  `json:"message"`
}

OperationConflictErrorResponseContent defines model for OperationConflictErrorResponseContent.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResourceNotFoundErrorResponseContent

type ResourceNotFoundErrorResponseContent struct {
	Code    *string `json:"code,omitempty"`
	Message string  `json:"message"`
}

ResourceNotFoundErrorResponseContent defines model for ResourceNotFoundErrorResponseContent.

type ResponseEditorFn added in v0.0.2

type ResponseEditorFn func(ctx context.Context, rsp *http.Response) error

ResponseEditorFn is the function signature for the ResponseEditor callback function

type StreamSubscription

type StreamSubscription struct {
	// CreatedDate ISO8601 Timestamp
	CreatedDate time.Time `json:"createdDate"`

	// DataSetId Identifier of data set, callers can be subscribed to. Please refer to https://advertising.amazon.com/API/docs/en-us/amazon-marketing-stream/data-guide for the list of all data sets.
	DataSetId string `json:"dataSetId"`

	// DestinationArn AWS ARN of the destination endpoint associated with the subscription.
	// Supported destination types:
	// - SQS
	DestinationArn string `json:"destinationArn"`

	// Notes Additional details associated with the subscription
	Notes *string `json:"notes,omitempty"`

	// Status Current status of the entity. Possible values are PROVISIONING, PENDING_CONFIRMATION, ACTIVE, ARCHIVED, FAILED_CONFIRMATION, SUSPENDED
	Status SubscriptionEntityStatus `json:"status"`

	// SubscriptionId Unique subscription identifier
	SubscriptionId string `json:"subscriptionId"`

	// UpdatedDate ISO8601 Timestamp
	UpdatedDate time.Time `json:"updatedDate"`
}

StreamSubscription defines model for StreamSubscription.

type SubscriptionEntityStatus

type SubscriptionEntityStatus string

SubscriptionEntityStatus Current status of the entity. Possible values are PROVISIONING, PENDING_CONFIRMATION, ACTIVE, ARCHIVED, FAILED_CONFIRMATION, SUSPENDED

const (
	SubscriptionEntityStatusACTIVE              SubscriptionEntityStatus = "ACTIVE"
	SubscriptionEntityStatusARCHIVED            SubscriptionEntityStatus = "ARCHIVED"
	SubscriptionEntityStatusFAILEDCONFIRMATION  SubscriptionEntityStatus = "FAILED_CONFIRMATION"
	SubscriptionEntityStatusPENDINGCONFIRMATION SubscriptionEntityStatus = "PENDING_CONFIRMATION"
	SubscriptionEntityStatusPROVISIONING        SubscriptionEntityStatus = "PROVISIONING"
	SubscriptionEntityStatusSUSPENDED           SubscriptionEntityStatus = "SUSPENDED"
)

Defines values for SubscriptionEntityStatus.

type TooManyRequestsErrorResponseContent

type TooManyRequestsErrorResponseContent struct {
	Code    *string `json:"code,omitempty"`
	Message string  `json:"message"`
}

TooManyRequestsErrorResponseContent defines model for TooManyRequestsErrorResponseContent.

type UnauthorizedAccessErrorResponseContent

type UnauthorizedAccessErrorResponseContent struct {
	Code    *string `json:"code,omitempty"`
	Message string  `json:"message"`
}

UnauthorizedAccessErrorResponseContent defines model for UnauthorizedAccessErrorResponseContent.

type UpdateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody

type UpdateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody = UpdateDspStreamSubscriptionRequestContent

UpdateDspStreamSubscriptionApplicationVndMarketingStreamSubscriptionsDspStreamSubscriptionResourceV10PlusJSONRequestBody defines body for UpdateDspStreamSubscription for application/vnd.MarketingStreamSubscriptions.DspStreamSubscriptionResource.v1.0+json ContentType.

type UpdateDspStreamSubscriptionParams

type UpdateDspStreamSubscriptionParams struct {
	// AmazonAdsAccountID The identifier of a DSP advertiser level account
	AmazonAdsAccountID string `json:"Amazon-Ads-Account-ID"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`
}

UpdateDspStreamSubscriptionParams defines parameters for UpdateDspStreamSubscription.

type UpdateDspStreamSubscriptionRequestContent

type UpdateDspStreamSubscriptionRequestContent struct {
	// Notes Additional details associated with the subscription
	Notes *string `json:"notes,omitempty"`

	// Status Update the status of the entity
	Status *UpdateEntityStatus `json:"status,omitempty"`
}

UpdateDspStreamSubscriptionRequestContent defines model for UpdateDspStreamSubscriptionRequestContent.

type UpdateDspStreamSubscriptionResp

func ParseUpdateDspStreamSubscriptionResp

func ParseUpdateDspStreamSubscriptionResp(rsp *http.Response) (*UpdateDspStreamSubscriptionResp, error)

ParseUpdateDspStreamSubscriptionResp parses an HTTP response from a UpdateDspStreamSubscriptionWithResponse call

func (UpdateDspStreamSubscriptionResp) Status

Status returns HTTPResponse.Status

func (UpdateDspStreamSubscriptionResp) StatusCode

func (r UpdateDspStreamSubscriptionResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateEntityStatus

type UpdateEntityStatus string

UpdateEntityStatus Update the status of the entity

const (
	UpdateEntityStatusARCHIVED UpdateEntityStatus = "ARCHIVED"
)

Defines values for UpdateEntityStatus.

type UpdateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody

type UpdateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody = UpdateStreamSubscriptionRequestContent

UpdateStreamSubscriptionApplicationVndMarketingStreamSubscriptionsStreamSubscriptionResourceV10PlusJSONRequestBody defines body for UpdateStreamSubscription for application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json ContentType.

type UpdateStreamSubscriptionParams

type UpdateStreamSubscriptionParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`

	// AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
	AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"`
}

UpdateStreamSubscriptionParams defines parameters for UpdateStreamSubscription.

type UpdateStreamSubscriptionRequestContent

type UpdateStreamSubscriptionRequestContent struct {
	// Notes Additional details associated with the subscription
	Notes *string `json:"notes,omitempty"`

	// Status Update the status of the entity
	Status *UpdateEntityStatus `json:"status,omitempty"`
}

UpdateStreamSubscriptionRequestContent defines model for UpdateStreamSubscriptionRequestContent.

type UpdateStreamSubscriptionResp

func ParseUpdateStreamSubscriptionResp

func ParseUpdateStreamSubscriptionResp(rsp *http.Response) (*UpdateStreamSubscriptionResp, error)

ParseUpdateStreamSubscriptionResp parses an HTTP response from a UpdateStreamSubscriptionWithResponse call

func (UpdateStreamSubscriptionResp) Status

Status returns HTTPResponse.Status

func (UpdateStreamSubscriptionResp) StatusCode

func (r UpdateStreamSubscriptionResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL