subscriptions

package
v0.0.0-...-dc3cc4a Latest Latest
Warning

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

 Go to latest Published: Nov 30, 2021 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CancelSubscriptionOK 

type CancelSubscriptionOK struct {
	Payload *models.CancelSubscriptionResponse
}
CancelSubscriptionOK describes a response with status code 200, with default header values.

Success

func NewCancelSubscriptionOK 

func NewCancelSubscriptionOK() *CancelSubscriptionOK

NewCancelSubscriptionOK creates a CancelSubscriptionOK with default headers values

func (*CancelSubscriptionOK) Error 

func (o *CancelSubscriptionOK) Error() string

func (*CancelSubscriptionOK) GetPayload 

func (o *CancelSubscriptionOK) GetPayload() *models.CancelSubscriptionResponse

type CancelSubscriptionParams 

type CancelSubscriptionParams struct {

	/* SubscriptionID.

	   The ID of the subscription to cancel.
	*/
	SubscriptionID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

CancelSubscriptionParams contains all the parameters to send to the API endpoint 

for the cancel subscription operation.

Typically these are written to a http.Request.

func NewCancelSubscriptionParams 

func NewCancelSubscriptionParams() *CancelSubscriptionParams

NewCancelSubscriptionParams creates a new CancelSubscriptionParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewCancelSubscriptionParamsWithContext 

func NewCancelSubscriptionParamsWithContext(ctx context.Context) *CancelSubscriptionParams

NewCancelSubscriptionParamsWithContext creates a new CancelSubscriptionParams object with the ability to set a context for a request.

func NewCancelSubscriptionParamsWithHTTPClient 

func NewCancelSubscriptionParamsWithHTTPClient(client *http.Client) *CancelSubscriptionParams

NewCancelSubscriptionParamsWithHTTPClient creates a new CancelSubscriptionParams object with the ability to set a custom HTTPClient for a request.

func NewCancelSubscriptionParamsWithTimeout 

func NewCancelSubscriptionParamsWithTimeout(timeout time.Duration) *CancelSubscriptionParams

NewCancelSubscriptionParamsWithTimeout creates a new CancelSubscriptionParams object with the ability to set a timeout on a request.

func (*CancelSubscriptionParams) SetContext 

func (o *CancelSubscriptionParams) SetContext(ctx context.Context)

SetContext adds the context to the cancel subscription params

func (*CancelSubscriptionParams) SetDefaults 

func (o *CancelSubscriptionParams) SetDefaults()

SetDefaults hydrates default values in the cancel subscription params (not the query body).

All values with no default are reset to their zero value.

func (*CancelSubscriptionParams) SetHTTPClient 

func (o *CancelSubscriptionParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the cancel subscription params

func (*CancelSubscriptionParams) SetSubscriptionID 

func (o *CancelSubscriptionParams) SetSubscriptionID(subscriptionID string)

SetSubscriptionID adds the subscriptionId to the cancel subscription params

func (*CancelSubscriptionParams) SetTimeout 

func (o *CancelSubscriptionParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the cancel subscription params

func (*CancelSubscriptionParams) WithContext 

func (o *CancelSubscriptionParams) WithContext(ctx context.Context) *CancelSubscriptionParams

WithContext adds the context to the cancel subscription params

func (*CancelSubscriptionParams) WithDefaults 

func (o *CancelSubscriptionParams) WithDefaults() *CancelSubscriptionParams

WithDefaults hydrates default values in the cancel subscription params (not the query body).

All values with no default are reset to their zero value.

func (*CancelSubscriptionParams) WithHTTPClient 

func (o *CancelSubscriptionParams) WithHTTPClient(client *http.Client) *CancelSubscriptionParams

WithHTTPClient adds the HTTPClient to the cancel subscription params

func (*CancelSubscriptionParams) WithSubscriptionID 

func (o *CancelSubscriptionParams) WithSubscriptionID(subscriptionID string) *CancelSubscriptionParams

WithSubscriptionID adds the subscriptionID to the cancel subscription params

func (*CancelSubscriptionParams) WithTimeout 

func (o *CancelSubscriptionParams) WithTimeout(timeout time.Duration) *CancelSubscriptionParams

WithTimeout adds the timeout to the cancel subscription params

func (*CancelSubscriptionParams) WriteToRequest 

func (o *CancelSubscriptionParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type CancelSubscriptionReader 

type CancelSubscriptionReader struct {
	// contains filtered or unexported fields
}

CancelSubscriptionReader is a Reader for the CancelSubscription structure.

func (*CancelSubscriptionReader) ReadResponse 

func (o *CancelSubscriptionReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client for subscriptions API

func (*Client) CancelSubscription 

func (a *Client) CancelSubscription(params *CancelSubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CancelSubscriptionOK, error)
CancelSubscription cancels subscription

Sets the `canceled_date` field to the end of the active billing period.

After this date, the status changes from ACTIVE to CANCELED.

func (*Client) CreateSubscription 

func (a *Client) CreateSubscription(params *CreateSubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateSubscriptionOK, error)
CreateSubscription creates subscription

Creates a subscription for a customer to a subscription plan.

If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location.

func (*Client) ListSubscriptionEvents 

func (a *Client) ListSubscriptionEvents(params *ListSubscriptionEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListSubscriptionEventsOK, error)
ListSubscriptionEvents lists subscription events

Lists all events for a specific subscription.

In the current implementation, only `START_SUBSCRIPTION` and `STOP_SUBSCRIPTION` (when the subscription was canceled) events are returned.

func (*Client) RetrieveSubscription 

func (a *Client) RetrieveSubscription(params *RetrieveSubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RetrieveSubscriptionOK, error)

RetrieveSubscription retrieves subscription

Retrieves a subscription.

func (*Client) SearchSubscriptions 

func (a *Client) SearchSubscriptions(params *SearchSubscriptionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchSubscriptionsOK, error)
SearchSubscriptions searches subscriptions

Searches for subscriptions.

Results are ordered chronologically by subscription creation date. If the request specifies more than one location ID, the endpoint orders the result by location ID, and then by creation date within each location. If no locations are given in the query, all locations are searched.

You can also optionally specify `customer_ids` to search by customer. If left unset, all customers associated with the specified locations are returned. If the request specifies customer IDs, the endpoint orders results first by location, within location by customer ID, and within customer by subscription creation date.

For more information, see [Retrieve subscriptions](/docs/subscriptions-api/overview#retrieve-subscriptions).

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) UpdateSubscription 

func (a *Client) UpdateSubscription(params *UpdateSubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateSubscriptionOK, error)
UpdateSubscription updates subscription

Updates a subscription. You can set, modify, and clear the

`subscription` field values.

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	CancelSubscription(params *CancelSubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CancelSubscriptionOK, error)

	CreateSubscription(params *CreateSubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateSubscriptionOK, error)

	ListSubscriptionEvents(params *ListSubscriptionEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListSubscriptionEventsOK, error)

	RetrieveSubscription(params *RetrieveSubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RetrieveSubscriptionOK, error)

	SearchSubscriptions(params *SearchSubscriptionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchSubscriptionsOK, error)

	UpdateSubscription(params *UpdateSubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateSubscriptionOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new subscriptions API client.

type CreateSubscriptionOK 

type CreateSubscriptionOK struct {
	Payload *models.CreateSubscriptionResponse
}
CreateSubscriptionOK describes a response with status code 200, with default header values.

Success

func NewCreateSubscriptionOK 

func NewCreateSubscriptionOK() *CreateSubscriptionOK

NewCreateSubscriptionOK creates a CreateSubscriptionOK with default headers values

func (*CreateSubscriptionOK) Error 

func (o *CreateSubscriptionOK) Error() string

func (*CreateSubscriptionOK) GetPayload 

func (o *CreateSubscriptionOK) GetPayload() *models.CreateSubscriptionResponse

type CreateSubscriptionParams 

type CreateSubscriptionParams struct {

	/* Body.

	     An object containing the fields to POST for the request.

	See the corresponding object definition for field details.
	*/
	Body *models.CreateSubscriptionRequest

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

CreateSubscriptionParams contains all the parameters to send to the API endpoint 

for the create subscription operation.

Typically these are written to a http.Request.

func NewCreateSubscriptionParams 

func NewCreateSubscriptionParams() *CreateSubscriptionParams

NewCreateSubscriptionParams creates a new CreateSubscriptionParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewCreateSubscriptionParamsWithContext 

func NewCreateSubscriptionParamsWithContext(ctx context.Context) *CreateSubscriptionParams

NewCreateSubscriptionParamsWithContext creates a new CreateSubscriptionParams object with the ability to set a context for a request.

func NewCreateSubscriptionParamsWithHTTPClient 

func NewCreateSubscriptionParamsWithHTTPClient(client *http.Client) *CreateSubscriptionParams

NewCreateSubscriptionParamsWithHTTPClient creates a new CreateSubscriptionParams object with the ability to set a custom HTTPClient for a request.

func NewCreateSubscriptionParamsWithTimeout 

func NewCreateSubscriptionParamsWithTimeout(timeout time.Duration) *CreateSubscriptionParams

NewCreateSubscriptionParamsWithTimeout creates a new CreateSubscriptionParams object with the ability to set a timeout on a request.

func (*CreateSubscriptionParams) SetBody 

func (o *CreateSubscriptionParams) SetBody(body *models.CreateSubscriptionRequest)

SetBody adds the body to the create subscription params

func (*CreateSubscriptionParams) SetContext 

func (o *CreateSubscriptionParams) SetContext(ctx context.Context)

SetContext adds the context to the create subscription params

func (*CreateSubscriptionParams) SetDefaults 

func (o *CreateSubscriptionParams) SetDefaults()

SetDefaults hydrates default values in the create subscription params (not the query body).

All values with no default are reset to their zero value.

func (*CreateSubscriptionParams) SetHTTPClient 

func (o *CreateSubscriptionParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the create subscription params

func (*CreateSubscriptionParams) SetTimeout 

func (o *CreateSubscriptionParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the create subscription params

func (*CreateSubscriptionParams) WithBody 

func (o *CreateSubscriptionParams) WithBody(body *models.CreateSubscriptionRequest) *CreateSubscriptionParams

WithBody adds the body to the create subscription params

func (*CreateSubscriptionParams) WithContext 

func (o *CreateSubscriptionParams) WithContext(ctx context.Context) *CreateSubscriptionParams

WithContext adds the context to the create subscription params

func (*CreateSubscriptionParams) WithDefaults 

func (o *CreateSubscriptionParams) WithDefaults() *CreateSubscriptionParams

WithDefaults hydrates default values in the create subscription params (not the query body).

All values with no default are reset to their zero value.

func (*CreateSubscriptionParams) WithHTTPClient 

func (o *CreateSubscriptionParams) WithHTTPClient(client *http.Client) *CreateSubscriptionParams

WithHTTPClient adds the HTTPClient to the create subscription params

func (*CreateSubscriptionParams) WithTimeout 

func (o *CreateSubscriptionParams) WithTimeout(timeout time.Duration) *CreateSubscriptionParams

WithTimeout adds the timeout to the create subscription params

func (*CreateSubscriptionParams) WriteToRequest 

func (o *CreateSubscriptionParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type CreateSubscriptionReader 

type CreateSubscriptionReader struct {
	// contains filtered or unexported fields
}

CreateSubscriptionReader is a Reader for the CreateSubscription structure.

func (*CreateSubscriptionReader) ReadResponse 

func (o *CreateSubscriptionReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListSubscriptionEventsOK 

type ListSubscriptionEventsOK struct {
	Payload *models.ListSubscriptionEventsResponse
}
ListSubscriptionEventsOK describes a response with status code 200, with default header values.

Success

func NewListSubscriptionEventsOK 

func NewListSubscriptionEventsOK() *ListSubscriptionEventsOK

NewListSubscriptionEventsOK creates a ListSubscriptionEventsOK with default headers values

func (*ListSubscriptionEventsOK) Error 

func (o *ListSubscriptionEventsOK) Error() string

func (*ListSubscriptionEventsOK) GetPayload 

func (o *ListSubscriptionEventsOK) GetPayload() *models.ListSubscriptionEventsResponse

type ListSubscriptionEventsParams 

type ListSubscriptionEventsParams struct {

	/* Cursor.

	     A pagination cursor returned by a previous call to this endpoint.
	Provide this to retrieve the next set of results for the original query.

	For more information, see [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination).
	*/
	Cursor *string

	/* Limit.

	     The upper limit on the number of subscription events to return
	in the response.

	Default: `200`
	*/
	Limit *int64

	/* SubscriptionID.

	   The ID of the subscription to retrieve the events for.
	*/
	SubscriptionID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListSubscriptionEventsParams contains all the parameters to send to the API endpoint 

for the list subscription events operation.

Typically these are written to a http.Request.

func NewListSubscriptionEventsParams 

func NewListSubscriptionEventsParams() *ListSubscriptionEventsParams

NewListSubscriptionEventsParams creates a new ListSubscriptionEventsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewListSubscriptionEventsParamsWithContext 

func NewListSubscriptionEventsParamsWithContext(ctx context.Context) *ListSubscriptionEventsParams

NewListSubscriptionEventsParamsWithContext creates a new ListSubscriptionEventsParams object with the ability to set a context for a request.

func NewListSubscriptionEventsParamsWithHTTPClient 

func NewListSubscriptionEventsParamsWithHTTPClient(client *http.Client) *ListSubscriptionEventsParams

NewListSubscriptionEventsParamsWithHTTPClient creates a new ListSubscriptionEventsParams object with the ability to set a custom HTTPClient for a request.

func NewListSubscriptionEventsParamsWithTimeout 

func NewListSubscriptionEventsParamsWithTimeout(timeout time.Duration) *ListSubscriptionEventsParams

NewListSubscriptionEventsParamsWithTimeout creates a new ListSubscriptionEventsParams object with the ability to set a timeout on a request.

func (*ListSubscriptionEventsParams) SetContext 

func (o *ListSubscriptionEventsParams) SetContext(ctx context.Context)

SetContext adds the context to the list subscription events params

func (*ListSubscriptionEventsParams) SetCursor 

func (o *ListSubscriptionEventsParams) SetCursor(cursor *string)

SetCursor adds the cursor to the list subscription events params

func (*ListSubscriptionEventsParams) SetDefaults 

func (o *ListSubscriptionEventsParams) SetDefaults()

SetDefaults hydrates default values in the list subscription events params (not the query body).

All values with no default are reset to their zero value.

func (*ListSubscriptionEventsParams) SetHTTPClient 

func (o *ListSubscriptionEventsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list subscription events params

func (*ListSubscriptionEventsParams) SetLimit 

func (o *ListSubscriptionEventsParams) SetLimit(limit *int64)

SetLimit adds the limit to the list subscription events params

func (*ListSubscriptionEventsParams) SetSubscriptionID 

func (o *ListSubscriptionEventsParams) SetSubscriptionID(subscriptionID string)

SetSubscriptionID adds the subscriptionId to the list subscription events params

func (*ListSubscriptionEventsParams) SetTimeout 

func (o *ListSubscriptionEventsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list subscription events params

func (*ListSubscriptionEventsParams) WithContext 

func (o *ListSubscriptionEventsParams) WithContext(ctx context.Context) *ListSubscriptionEventsParams

WithContext adds the context to the list subscription events params

func (*ListSubscriptionEventsParams) WithCursor 

func (o *ListSubscriptionEventsParams) WithCursor(cursor *string) *ListSubscriptionEventsParams

WithCursor adds the cursor to the list subscription events params

func (*ListSubscriptionEventsParams) WithDefaults 

func (o *ListSubscriptionEventsParams) WithDefaults() *ListSubscriptionEventsParams

WithDefaults hydrates default values in the list subscription events params (not the query body).

All values with no default are reset to their zero value.

func (*ListSubscriptionEventsParams) WithHTTPClient 

func (o *ListSubscriptionEventsParams) WithHTTPClient(client *http.Client) *ListSubscriptionEventsParams

WithHTTPClient adds the HTTPClient to the list subscription events params

func (*ListSubscriptionEventsParams) WithLimit 

func (o *ListSubscriptionEventsParams) WithLimit(limit *int64) *ListSubscriptionEventsParams

WithLimit adds the limit to the list subscription events params

func (*ListSubscriptionEventsParams) WithSubscriptionID 

func (o *ListSubscriptionEventsParams) WithSubscriptionID(subscriptionID string) *ListSubscriptionEventsParams

WithSubscriptionID adds the subscriptionID to the list subscription events params

func (*ListSubscriptionEventsParams) WithTimeout 

func (o *ListSubscriptionEventsParams) WithTimeout(timeout time.Duration) *ListSubscriptionEventsParams

WithTimeout adds the timeout to the list subscription events params

func (*ListSubscriptionEventsParams) WriteToRequest 

func (o *ListSubscriptionEventsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListSubscriptionEventsReader 

type ListSubscriptionEventsReader struct {
	// contains filtered or unexported fields
}

ListSubscriptionEventsReader is a Reader for the ListSubscriptionEvents structure.

func (*ListSubscriptionEventsReader) ReadResponse 

func (o *ListSubscriptionEventsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type RetrieveSubscriptionOK 

type RetrieveSubscriptionOK struct {
	Payload *models.RetrieveSubscriptionResponse
}
RetrieveSubscriptionOK describes a response with status code 200, with default header values.

Success

func NewRetrieveSubscriptionOK 

func NewRetrieveSubscriptionOK() *RetrieveSubscriptionOK

NewRetrieveSubscriptionOK creates a RetrieveSubscriptionOK with default headers values

func (*RetrieveSubscriptionOK) Error 

func (o *RetrieveSubscriptionOK) Error() string

func (*RetrieveSubscriptionOK) GetPayload 

func (o *RetrieveSubscriptionOK) GetPayload() *models.RetrieveSubscriptionResponse

type RetrieveSubscriptionParams 

type RetrieveSubscriptionParams struct {

	/* SubscriptionID.

	   The ID of the subscription to retrieve.
	*/
	SubscriptionID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

RetrieveSubscriptionParams contains all the parameters to send to the API endpoint 

for the retrieve subscription operation.

Typically these are written to a http.Request.

func NewRetrieveSubscriptionParams 

func NewRetrieveSubscriptionParams() *RetrieveSubscriptionParams

NewRetrieveSubscriptionParams creates a new RetrieveSubscriptionParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewRetrieveSubscriptionParamsWithContext 

func NewRetrieveSubscriptionParamsWithContext(ctx context.Context) *RetrieveSubscriptionParams

NewRetrieveSubscriptionParamsWithContext creates a new RetrieveSubscriptionParams object with the ability to set a context for a request.

func NewRetrieveSubscriptionParamsWithHTTPClient 

func NewRetrieveSubscriptionParamsWithHTTPClient(client *http.Client) *RetrieveSubscriptionParams

NewRetrieveSubscriptionParamsWithHTTPClient creates a new RetrieveSubscriptionParams object with the ability to set a custom HTTPClient for a request.

func NewRetrieveSubscriptionParamsWithTimeout 

func NewRetrieveSubscriptionParamsWithTimeout(timeout time.Duration) *RetrieveSubscriptionParams

NewRetrieveSubscriptionParamsWithTimeout creates a new RetrieveSubscriptionParams object with the ability to set a timeout on a request.

func (*RetrieveSubscriptionParams) SetContext 

func (o *RetrieveSubscriptionParams) SetContext(ctx context.Context)

SetContext adds the context to the retrieve subscription params

func (*RetrieveSubscriptionParams) SetDefaults 

func (o *RetrieveSubscriptionParams) SetDefaults()

SetDefaults hydrates default values in the retrieve subscription params (not the query body).

All values with no default are reset to their zero value.

func (*RetrieveSubscriptionParams) SetHTTPClient 

func (o *RetrieveSubscriptionParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the retrieve subscription params

func (*RetrieveSubscriptionParams) SetSubscriptionID 

func (o *RetrieveSubscriptionParams) SetSubscriptionID(subscriptionID string)

SetSubscriptionID adds the subscriptionId to the retrieve subscription params

func (*RetrieveSubscriptionParams) SetTimeout 

func (o *RetrieveSubscriptionParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the retrieve subscription params

func (*RetrieveSubscriptionParams) WithContext 

func (o *RetrieveSubscriptionParams) WithContext(ctx context.Context) *RetrieveSubscriptionParams

WithContext adds the context to the retrieve subscription params

func (*RetrieveSubscriptionParams) WithDefaults 

func (o *RetrieveSubscriptionParams) WithDefaults() *RetrieveSubscriptionParams

WithDefaults hydrates default values in the retrieve subscription params (not the query body).

All values with no default are reset to their zero value.

func (*RetrieveSubscriptionParams) WithHTTPClient 

func (o *RetrieveSubscriptionParams) WithHTTPClient(client *http.Client) *RetrieveSubscriptionParams

WithHTTPClient adds the HTTPClient to the retrieve subscription params

func (*RetrieveSubscriptionParams) WithSubscriptionID 

func (o *RetrieveSubscriptionParams) WithSubscriptionID(subscriptionID string) *RetrieveSubscriptionParams

WithSubscriptionID adds the subscriptionID to the retrieve subscription params

func (*RetrieveSubscriptionParams) WithTimeout 

func (o *RetrieveSubscriptionParams) WithTimeout(timeout time.Duration) *RetrieveSubscriptionParams

WithTimeout adds the timeout to the retrieve subscription params

func (*RetrieveSubscriptionParams) WriteToRequest 

func (o *RetrieveSubscriptionParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type RetrieveSubscriptionReader 

type RetrieveSubscriptionReader struct {
	// contains filtered or unexported fields
}

RetrieveSubscriptionReader is a Reader for the RetrieveSubscription structure.

func (*RetrieveSubscriptionReader) ReadResponse 

func (o *RetrieveSubscriptionReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type SearchSubscriptionsOK 

type SearchSubscriptionsOK struct {
	Payload *models.SearchSubscriptionsResponse
}
SearchSubscriptionsOK describes a response with status code 200, with default header values.

Success

func NewSearchSubscriptionsOK 

func NewSearchSubscriptionsOK() *SearchSubscriptionsOK

NewSearchSubscriptionsOK creates a SearchSubscriptionsOK with default headers values

func (*SearchSubscriptionsOK) Error 

func (o *SearchSubscriptionsOK) Error() string

func (*SearchSubscriptionsOK) GetPayload 

func (o *SearchSubscriptionsOK) GetPayload() *models.SearchSubscriptionsResponse

type SearchSubscriptionsParams 

type SearchSubscriptionsParams struct {

	/* Body.

	     An object containing the fields to POST for the request.

	See the corresponding object definition for field details.
	*/
	Body *models.SearchSubscriptionsRequest

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

SearchSubscriptionsParams contains all the parameters to send to the API endpoint 

for the search subscriptions operation.

Typically these are written to a http.Request.

func NewSearchSubscriptionsParams 

func NewSearchSubscriptionsParams() *SearchSubscriptionsParams

NewSearchSubscriptionsParams creates a new SearchSubscriptionsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewSearchSubscriptionsParamsWithContext 

func NewSearchSubscriptionsParamsWithContext(ctx context.Context) *SearchSubscriptionsParams

NewSearchSubscriptionsParamsWithContext creates a new SearchSubscriptionsParams object with the ability to set a context for a request.

func NewSearchSubscriptionsParamsWithHTTPClient 

func NewSearchSubscriptionsParamsWithHTTPClient(client *http.Client) *SearchSubscriptionsParams

NewSearchSubscriptionsParamsWithHTTPClient creates a new SearchSubscriptionsParams object with the ability to set a custom HTTPClient for a request.

func NewSearchSubscriptionsParamsWithTimeout 

func NewSearchSubscriptionsParamsWithTimeout(timeout time.Duration) *SearchSubscriptionsParams

NewSearchSubscriptionsParamsWithTimeout creates a new SearchSubscriptionsParams object with the ability to set a timeout on a request.

func (*SearchSubscriptionsParams) SetBody 

func (o *SearchSubscriptionsParams) SetBody(body *models.SearchSubscriptionsRequest)

SetBody adds the body to the search subscriptions params

func (*SearchSubscriptionsParams) SetContext 

func (o *SearchSubscriptionsParams) SetContext(ctx context.Context)

SetContext adds the context to the search subscriptions params

func (*SearchSubscriptionsParams) SetDefaults 

func (o *SearchSubscriptionsParams) SetDefaults()

SetDefaults hydrates default values in the search subscriptions params (not the query body).

All values with no default are reset to their zero value.

func (*SearchSubscriptionsParams) SetHTTPClient 

func (o *SearchSubscriptionsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the search subscriptions params

func (*SearchSubscriptionsParams) SetTimeout 

func (o *SearchSubscriptionsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the search subscriptions params

func (*SearchSubscriptionsParams) WithBody 

func (o *SearchSubscriptionsParams) WithBody(body *models.SearchSubscriptionsRequest) *SearchSubscriptionsParams

WithBody adds the body to the search subscriptions params

func (*SearchSubscriptionsParams) WithContext 

func (o *SearchSubscriptionsParams) WithContext(ctx context.Context) *SearchSubscriptionsParams

WithContext adds the context to the search subscriptions params

func (*SearchSubscriptionsParams) WithDefaults 

func (o *SearchSubscriptionsParams) WithDefaults() *SearchSubscriptionsParams

WithDefaults hydrates default values in the search subscriptions params (not the query body).

All values with no default are reset to their zero value.

func (*SearchSubscriptionsParams) WithHTTPClient 

func (o *SearchSubscriptionsParams) WithHTTPClient(client *http.Client) *SearchSubscriptionsParams

WithHTTPClient adds the HTTPClient to the search subscriptions params

func (*SearchSubscriptionsParams) WithTimeout 

func (o *SearchSubscriptionsParams) WithTimeout(timeout time.Duration) *SearchSubscriptionsParams

WithTimeout adds the timeout to the search subscriptions params

func (*SearchSubscriptionsParams) WriteToRequest 

func (o *SearchSubscriptionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type SearchSubscriptionsReader 

type SearchSubscriptionsReader struct {
	// contains filtered or unexported fields
}

SearchSubscriptionsReader is a Reader for the SearchSubscriptions structure.

func (*SearchSubscriptionsReader) ReadResponse 

func (o *SearchSubscriptionsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type UpdateSubscriptionOK 

type UpdateSubscriptionOK struct {
	Payload *models.UpdateSubscriptionResponse
}
UpdateSubscriptionOK describes a response with status code 200, with default header values.

Success

func NewUpdateSubscriptionOK 

func NewUpdateSubscriptionOK() *UpdateSubscriptionOK

NewUpdateSubscriptionOK creates a UpdateSubscriptionOK with default headers values

func (*UpdateSubscriptionOK) Error 

func (o *UpdateSubscriptionOK) Error() string

func (*UpdateSubscriptionOK) GetPayload 

func (o *UpdateSubscriptionOK) GetPayload() *models.UpdateSubscriptionResponse

type UpdateSubscriptionParams 

type UpdateSubscriptionParams struct {

	/* Body.

	     An object containing the fields to POST for the request.

	See the corresponding object definition for field details.
	*/
	Body *models.UpdateSubscriptionRequest

	/* SubscriptionID.

	   The ID for the subscription to update.
	*/
	SubscriptionID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

UpdateSubscriptionParams contains all the parameters to send to the API endpoint 

for the update subscription operation.

Typically these are written to a http.Request.

func NewUpdateSubscriptionParams 

func NewUpdateSubscriptionParams() *UpdateSubscriptionParams

NewUpdateSubscriptionParams creates a new UpdateSubscriptionParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewUpdateSubscriptionParamsWithContext 

func NewUpdateSubscriptionParamsWithContext(ctx context.Context) *UpdateSubscriptionParams

NewUpdateSubscriptionParamsWithContext creates a new UpdateSubscriptionParams object with the ability to set a context for a request.

func NewUpdateSubscriptionParamsWithHTTPClient 

func NewUpdateSubscriptionParamsWithHTTPClient(client *http.Client) *UpdateSubscriptionParams

NewUpdateSubscriptionParamsWithHTTPClient creates a new UpdateSubscriptionParams object with the ability to set a custom HTTPClient for a request.

func NewUpdateSubscriptionParamsWithTimeout 

func NewUpdateSubscriptionParamsWithTimeout(timeout time.Duration) *UpdateSubscriptionParams

NewUpdateSubscriptionParamsWithTimeout creates a new UpdateSubscriptionParams object with the ability to set a timeout on a request.

func (*UpdateSubscriptionParams) SetBody 

func (o *UpdateSubscriptionParams) SetBody(body *models.UpdateSubscriptionRequest)

SetBody adds the body to the update subscription params

func (*UpdateSubscriptionParams) SetContext 

func (o *UpdateSubscriptionParams) SetContext(ctx context.Context)

SetContext adds the context to the update subscription params

func (*UpdateSubscriptionParams) SetDefaults 

func (o *UpdateSubscriptionParams) SetDefaults()

SetDefaults hydrates default values in the update subscription params (not the query body).

All values with no default are reset to their zero value.

func (*UpdateSubscriptionParams) SetHTTPClient 

func (o *UpdateSubscriptionParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the update subscription params

func (*UpdateSubscriptionParams) SetSubscriptionID 

func (o *UpdateSubscriptionParams) SetSubscriptionID(subscriptionID string)

SetSubscriptionID adds the subscriptionId to the update subscription params

func (*UpdateSubscriptionParams) SetTimeout 

func (o *UpdateSubscriptionParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the update subscription params

func (*UpdateSubscriptionParams) WithBody 

func (o *UpdateSubscriptionParams) WithBody(body *models.UpdateSubscriptionRequest) *UpdateSubscriptionParams

WithBody adds the body to the update subscription params

func (*UpdateSubscriptionParams) WithContext 

func (o *UpdateSubscriptionParams) WithContext(ctx context.Context) *UpdateSubscriptionParams

WithContext adds the context to the update subscription params

func (*UpdateSubscriptionParams) WithDefaults 

func (o *UpdateSubscriptionParams) WithDefaults() *UpdateSubscriptionParams

WithDefaults hydrates default values in the update subscription params (not the query body).

All values with no default are reset to their zero value.

func (*UpdateSubscriptionParams) WithHTTPClient 

func (o *UpdateSubscriptionParams) WithHTTPClient(client *http.Client) *UpdateSubscriptionParams

WithHTTPClient adds the HTTPClient to the update subscription params

func (*UpdateSubscriptionParams) WithSubscriptionID 

func (o *UpdateSubscriptionParams) WithSubscriptionID(subscriptionID string) *UpdateSubscriptionParams

WithSubscriptionID adds the subscriptionID to the update subscription params

func (*UpdateSubscriptionParams) WithTimeout 

func (o *UpdateSubscriptionParams) WithTimeout(timeout time.Duration) *UpdateSubscriptionParams

WithTimeout adds the timeout to the update subscription params

func (*UpdateSubscriptionParams) WriteToRequest 

func (o *UpdateSubscriptionParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type UpdateSubscriptionReader 

type UpdateSubscriptionReader struct {
	// contains filtered or unexported fields
}

UpdateSubscriptionReader is a Reader for the UpdateSubscription structure.

func (*UpdateSubscriptionReader) ReadResponse 

func (o *UpdateSubscriptionReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

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.