payments

package
v0.0.0-...-13576d3 Latest Latest
Warning

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

 Go to latest Published: Mar 7, 2018 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for payments API

func New 

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

New creates a new payments API client.

func (*Client) GetAllPayments 

func (a *Client) GetAllPayments(params *GetAllPaymentsParams) (*GetAllPaymentsOK, error)

GetAllPayments returns a collection of all payments by default 10 values are returned records are returned in natural order

{"nickname":"Get all payments","response":"getPaymentAll.html"}

func (*Client) GetPaymentByID 

func (a *Client) GetPaymentByID(params *GetPaymentByIDParams) (*GetPaymentByIDOK, error)

GetPaymentByID returns a single payment specified by the payment ID parameter

{"nickname":"Retrieve an existing payment","response":"getPaymentByID.html"}

func (*Client) GetPaymentByInvoiceID 

func (a *Client) GetPaymentByInvoiceID(params *GetPaymentByInvoiceIDParams) (*GetPaymentByInvoiceIDOK, error)

GetPaymentByInvoiceID returns a collection of payments specified by the invoice ID parameter by default 10 values are returned records are returned in natural order

{"nickname":"Get for invoice","response":"getPaymentByInvoice.html"}

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type GetAllPaymentsDefault 

type GetAllPaymentsDefault struct {
	Payload *models.BFError
	// contains filtered or unexported fields
}

GetAllPaymentsDefault handles this case with default header values.

error

func NewGetAllPaymentsDefault 

func NewGetAllPaymentsDefault(code int) *GetAllPaymentsDefault

NewGetAllPaymentsDefault creates a GetAllPaymentsDefault with default headers values

func (*GetAllPaymentsDefault) Code 

func (o *GetAllPaymentsDefault) Code() int

Code gets the status code for the get all payments default response

func (*GetAllPaymentsDefault) Error 

func (o *GetAllPaymentsDefault) Error() string

type GetAllPaymentsOK 

type GetAllPaymentsOK struct {
	Payload *models.PaymentPagedMetadata
}

GetAllPaymentsOK handles this case with default header values.

success

func NewGetAllPaymentsOK 

func NewGetAllPaymentsOK() *GetAllPaymentsOK

NewGetAllPaymentsOK creates a GetAllPaymentsOK with default headers values

func (*GetAllPaymentsOK) Error 

func (o *GetAllPaymentsOK) Error() string

type GetAllPaymentsParams 

type GetAllPaymentsParams struct {

	/*IncludeRetired
	  Whether retired products should be returned.

	*/
	IncludeRetired *bool
	/*Offset
	  The offset from the first payment to return.

	*/
	Offset *int32
	/*Order
	  Ihe direction of any ordering, either ASC or DESC.

	*/
	Order *string
	/*OrderBy
	  Specify a field used to order the result set.

	*/
	OrderBy *string
	/*Organizations
	  A list of organization-IDs used to restrict the scope of API calls.

	*/
	Organizations []string
	/*Records
	  The maximum number of payments to return.

	*/
	Records *int32

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

GetAllPaymentsParams contains all the parameters to send to the API endpoint for the get all payments operation typically these are written to a http.Request

func NewGetAllPaymentsParams 

func NewGetAllPaymentsParams() *GetAllPaymentsParams

NewGetAllPaymentsParams creates a new GetAllPaymentsParams object with the default values initialized.

func NewGetAllPaymentsParamsWithContext 

func NewGetAllPaymentsParamsWithContext(ctx context.Context) *GetAllPaymentsParams

NewGetAllPaymentsParamsWithContext creates a new GetAllPaymentsParams object with the default values initialized, and the ability to set a context for a request

func NewGetAllPaymentsParamsWithHTTPClient 

func NewGetAllPaymentsParamsWithHTTPClient(client *http.Client) *GetAllPaymentsParams

NewGetAllPaymentsParamsWithHTTPClient creates a new GetAllPaymentsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetAllPaymentsParamsWithTimeout 

func NewGetAllPaymentsParamsWithTimeout(timeout time.Duration) *GetAllPaymentsParams

NewGetAllPaymentsParamsWithTimeout creates a new GetAllPaymentsParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetAllPaymentsParams) SetContext 

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

SetContext adds the context to the get all payments params

func (*GetAllPaymentsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get all payments params

func (*GetAllPaymentsParams) SetIncludeRetired 

func (o *GetAllPaymentsParams) SetIncludeRetired(includeRetired *bool)

SetIncludeRetired adds the includeRetired to the get all payments params

func (*GetAllPaymentsParams) SetOffset 

func (o *GetAllPaymentsParams) SetOffset(offset *int32)

SetOffset adds the offset to the get all payments params

func (*GetAllPaymentsParams) SetOrder 

func (o *GetAllPaymentsParams) SetOrder(order *string)

SetOrder adds the order to the get all payments params

func (*GetAllPaymentsParams) SetOrderBy 

func (o *GetAllPaymentsParams) SetOrderBy(orderBy *string)

SetOrderBy adds the orderBy to the get all payments params

func (*GetAllPaymentsParams) SetOrganizations 

func (o *GetAllPaymentsParams) SetOrganizations(organizations []string)

SetOrganizations adds the organizations to the get all payments params

func (*GetAllPaymentsParams) SetRecords 

func (o *GetAllPaymentsParams) SetRecords(records *int32)

SetRecords adds the records to the get all payments params

func (*GetAllPaymentsParams) SetTimeout 

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

SetTimeout adds the timeout to the get all payments params

func (*GetAllPaymentsParams) WithContext 

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

WithContext adds the context to the get all payments params

func (*GetAllPaymentsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get all payments params

func (*GetAllPaymentsParams) WithIncludeRetired 

func (o *GetAllPaymentsParams) WithIncludeRetired(includeRetired *bool) *GetAllPaymentsParams

WithIncludeRetired adds the includeRetired to the get all payments params

func (*GetAllPaymentsParams) WithOffset 

func (o *GetAllPaymentsParams) WithOffset(offset *int32) *GetAllPaymentsParams

WithOffset adds the offset to the get all payments params

func (*GetAllPaymentsParams) WithOrder 

func (o *GetAllPaymentsParams) WithOrder(order *string) *GetAllPaymentsParams

WithOrder adds the order to the get all payments params

func (*GetAllPaymentsParams) WithOrderBy 

func (o *GetAllPaymentsParams) WithOrderBy(orderBy *string) *GetAllPaymentsParams

WithOrderBy adds the orderBy to the get all payments params

func (*GetAllPaymentsParams) WithOrganizations 

func (o *GetAllPaymentsParams) WithOrganizations(organizations []string) *GetAllPaymentsParams

WithOrganizations adds the organizations to the get all payments params

func (*GetAllPaymentsParams) WithRecords 

func (o *GetAllPaymentsParams) WithRecords(records *int32) *GetAllPaymentsParams

WithRecords adds the records to the get all payments params

func (*GetAllPaymentsParams) WithTimeout 

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

WithTimeout adds the timeout to the get all payments params

func (*GetAllPaymentsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetAllPaymentsReader 

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

GetAllPaymentsReader is a Reader for the GetAllPayments structure.

func (*GetAllPaymentsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetPaymentByIDDefault 

type GetPaymentByIDDefault struct {
	Payload *models.BFError
	// contains filtered or unexported fields
}

GetPaymentByIDDefault handles this case with default header values.

error

func NewGetPaymentByIDDefault 

func NewGetPaymentByIDDefault(code int) *GetPaymentByIDDefault

NewGetPaymentByIDDefault creates a GetPaymentByIDDefault with default headers values

func (*GetPaymentByIDDefault) Code 

func (o *GetPaymentByIDDefault) Code() int

Code gets the status code for the get payment by ID default response

func (*GetPaymentByIDDefault) Error 

func (o *GetPaymentByIDDefault) Error() string

type GetPaymentByIDOK 

type GetPaymentByIDOK struct {
	Payload *models.PaymentPagedMetadata
}

GetPaymentByIDOK handles this case with default header values.

success

func NewGetPaymentByIDOK 

func NewGetPaymentByIDOK() *GetPaymentByIDOK

NewGetPaymentByIDOK creates a GetPaymentByIDOK with default headers values

func (*GetPaymentByIDOK) Error 

func (o *GetPaymentByIDOK) Error() string

type GetPaymentByIDParams 

type GetPaymentByIDParams struct {

	/*Organizations
	  A list of organization-IDs used to restrict the scope of API calls.

	*/
	Organizations []string
	/*PaymentID
	  The unique string-ID of the payment.

	*/
	PaymentID string

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

GetPaymentByIDParams contains all the parameters to send to the API endpoint for the get payment by ID operation typically these are written to a http.Request

func NewGetPaymentByIDParams 

func NewGetPaymentByIDParams() *GetPaymentByIDParams

NewGetPaymentByIDParams creates a new GetPaymentByIDParams object with the default values initialized.

func NewGetPaymentByIDParamsWithContext 

func NewGetPaymentByIDParamsWithContext(ctx context.Context) *GetPaymentByIDParams

NewGetPaymentByIDParamsWithContext creates a new GetPaymentByIDParams object with the default values initialized, and the ability to set a context for a request

func NewGetPaymentByIDParamsWithHTTPClient 

func NewGetPaymentByIDParamsWithHTTPClient(client *http.Client) *GetPaymentByIDParams

NewGetPaymentByIDParamsWithHTTPClient creates a new GetPaymentByIDParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetPaymentByIDParamsWithTimeout 

func NewGetPaymentByIDParamsWithTimeout(timeout time.Duration) *GetPaymentByIDParams

NewGetPaymentByIDParamsWithTimeout creates a new GetPaymentByIDParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetPaymentByIDParams) SetContext 

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

SetContext adds the context to the get payment by ID params

func (*GetPaymentByIDParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get payment by ID params

func (*GetPaymentByIDParams) SetOrganizations 

func (o *GetPaymentByIDParams) SetOrganizations(organizations []string)

SetOrganizations adds the organizations to the get payment by ID params

func (*GetPaymentByIDParams) SetPaymentID 

func (o *GetPaymentByIDParams) SetPaymentID(paymentID string)

SetPaymentID adds the paymentId to the get payment by ID params

func (*GetPaymentByIDParams) SetTimeout 

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

SetTimeout adds the timeout to the get payment by ID params

func (*GetPaymentByIDParams) WithContext 

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

WithContext adds the context to the get payment by ID params

func (*GetPaymentByIDParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get payment by ID params

func (*GetPaymentByIDParams) WithOrganizations 

func (o *GetPaymentByIDParams) WithOrganizations(organizations []string) *GetPaymentByIDParams

WithOrganizations adds the organizations to the get payment by ID params

func (*GetPaymentByIDParams) WithPaymentID 

func (o *GetPaymentByIDParams) WithPaymentID(paymentID string) *GetPaymentByIDParams

WithPaymentID adds the paymentID to the get payment by ID params

func (*GetPaymentByIDParams) WithTimeout 

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

WithTimeout adds the timeout to the get payment by ID params

func (*GetPaymentByIDParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetPaymentByIDReader 

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

GetPaymentByIDReader is a Reader for the GetPaymentByID structure.

func (*GetPaymentByIDReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetPaymentByInvoiceIDDefault 

type GetPaymentByInvoiceIDDefault struct {
	Payload *models.BFError
	// contains filtered or unexported fields
}

GetPaymentByInvoiceIDDefault handles this case with default header values.

error

func NewGetPaymentByInvoiceIDDefault 

func NewGetPaymentByInvoiceIDDefault(code int) *GetPaymentByInvoiceIDDefault

NewGetPaymentByInvoiceIDDefault creates a GetPaymentByInvoiceIDDefault with default headers values

func (*GetPaymentByInvoiceIDDefault) Code 

func (o *GetPaymentByInvoiceIDDefault) Code() int

Code gets the status code for the get payment by invoice ID default response

func (*GetPaymentByInvoiceIDDefault) Error 

func (o *GetPaymentByInvoiceIDDefault) Error() string

type GetPaymentByInvoiceIDOK 

type GetPaymentByInvoiceIDOK struct {
	Payload *models.PaymentPagedMetadata
}

GetPaymentByInvoiceIDOK handles this case with default header values.

success

func NewGetPaymentByInvoiceIDOK 

func NewGetPaymentByInvoiceIDOK() *GetPaymentByInvoiceIDOK

NewGetPaymentByInvoiceIDOK creates a GetPaymentByInvoiceIDOK with default headers values

func (*GetPaymentByInvoiceIDOK) Error 

func (o *GetPaymentByInvoiceIDOK) Error() string

type GetPaymentByInvoiceIDParams 

type GetPaymentByInvoiceIDParams struct {

	/*IncludeRetired
	  Whether retired products should be returned.

	*/
	IncludeRetired *bool
	/*InvoiceID
	  The string ID of the account

	*/
	InvoiceID string
	/*Offset
	  The offset from the first payment to return.

	*/
	Offset *int32
	/*Order
	  Ihe direction of any ordering, either ASC or DESC.

	*/
	Order *string
	/*OrderBy
	  Specify a field used to order the result set.

	*/
	OrderBy *string
	/*Organizations
	  A list of organization-IDs used to restrict the scope of API calls.

	*/
	Organizations []string
	/*Records
	  The maximum number of payments to return.

	*/
	Records *int32

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

GetPaymentByInvoiceIDParams contains all the parameters to send to the API endpoint for the get payment by invoice ID operation typically these are written to a http.Request

func NewGetPaymentByInvoiceIDParams 

func NewGetPaymentByInvoiceIDParams() *GetPaymentByInvoiceIDParams

NewGetPaymentByInvoiceIDParams creates a new GetPaymentByInvoiceIDParams object with the default values initialized.

func NewGetPaymentByInvoiceIDParamsWithContext 

func NewGetPaymentByInvoiceIDParamsWithContext(ctx context.Context) *GetPaymentByInvoiceIDParams

NewGetPaymentByInvoiceIDParamsWithContext creates a new GetPaymentByInvoiceIDParams object with the default values initialized, and the ability to set a context for a request

func NewGetPaymentByInvoiceIDParamsWithHTTPClient 

func NewGetPaymentByInvoiceIDParamsWithHTTPClient(client *http.Client) *GetPaymentByInvoiceIDParams

NewGetPaymentByInvoiceIDParamsWithHTTPClient creates a new GetPaymentByInvoiceIDParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetPaymentByInvoiceIDParamsWithTimeout 

func NewGetPaymentByInvoiceIDParamsWithTimeout(timeout time.Duration) *GetPaymentByInvoiceIDParams

NewGetPaymentByInvoiceIDParamsWithTimeout creates a new GetPaymentByInvoiceIDParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetPaymentByInvoiceIDParams) SetContext 

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

SetContext adds the context to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) SetIncludeRetired 

func (o *GetPaymentByInvoiceIDParams) SetIncludeRetired(includeRetired *bool)

SetIncludeRetired adds the includeRetired to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) SetInvoiceID 

func (o *GetPaymentByInvoiceIDParams) SetInvoiceID(invoiceID string)

SetInvoiceID adds the invoiceId to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) SetOffset 

func (o *GetPaymentByInvoiceIDParams) SetOffset(offset *int32)

SetOffset adds the offset to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) SetOrder 

func (o *GetPaymentByInvoiceIDParams) SetOrder(order *string)

SetOrder adds the order to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) SetOrderBy 

func (o *GetPaymentByInvoiceIDParams) SetOrderBy(orderBy *string)

SetOrderBy adds the orderBy to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) SetOrganizations 

func (o *GetPaymentByInvoiceIDParams) SetOrganizations(organizations []string)

SetOrganizations adds the organizations to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) SetRecords 

func (o *GetPaymentByInvoiceIDParams) SetRecords(records *int32)

SetRecords adds the records to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) SetTimeout 

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

SetTimeout adds the timeout to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithContext 

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

WithContext adds the context to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithIncludeRetired 

func (o *GetPaymentByInvoiceIDParams) WithIncludeRetired(includeRetired *bool) *GetPaymentByInvoiceIDParams

WithIncludeRetired adds the includeRetired to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithInvoiceID 

func (o *GetPaymentByInvoiceIDParams) WithInvoiceID(invoiceID string) *GetPaymentByInvoiceIDParams

WithInvoiceID adds the invoiceID to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithOffset 

func (o *GetPaymentByInvoiceIDParams) WithOffset(offset *int32) *GetPaymentByInvoiceIDParams

WithOffset adds the offset to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithOrder 

func (o *GetPaymentByInvoiceIDParams) WithOrder(order *string) *GetPaymentByInvoiceIDParams

WithOrder adds the order to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithOrderBy 

func (o *GetPaymentByInvoiceIDParams) WithOrderBy(orderBy *string) *GetPaymentByInvoiceIDParams

WithOrderBy adds the orderBy to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithOrganizations 

func (o *GetPaymentByInvoiceIDParams) WithOrganizations(organizations []string) *GetPaymentByInvoiceIDParams

WithOrganizations adds the organizations to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithRecords 

func (o *GetPaymentByInvoiceIDParams) WithRecords(records *int32) *GetPaymentByInvoiceIDParams

WithRecords adds the records to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WithTimeout 

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

WithTimeout adds the timeout to the get payment by invoice ID params

func (*GetPaymentByInvoiceIDParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetPaymentByInvoiceIDReader 

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

GetPaymentByInvoiceIDReader is a Reader for the GetPaymentByInvoiceID structure.

func (*GetPaymentByInvoiceIDReader) ReadResponse 

func (o *GetPaymentByInvoiceIDReader) 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.