external_id

Documentation

Index

• type Client
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
  • func (a *Client) GetExternalID(params *GetExternalIDParams) (*GetExternalIDOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type GetExternalIDOK
  • func NewGetExternalIDOK() *GetExternalIDOK
  • func (o *GetExternalIDOK) Error() string
• type GetExternalIDParams
  • func NewGetExternalIDParams() *GetExternalIDParams
  • func NewGetExternalIDParamsWithContext(ctx context.Context) *GetExternalIDParams
  • func NewGetExternalIDParamsWithHTTPClient(client *http.Client) *GetExternalIDParams
  • func NewGetExternalIDParamsWithTimeout(timeout time.Duration) *GetExternalIDParams
  • func (o *GetExternalIDParams) SetContext(ctx context.Context)
  • func (o *GetExternalIDParams) SetHTTPClient(client *http.Client)
  • func (o *GetExternalIDParams) SetTimeout(timeout time.Duration)
  • func (o *GetExternalIDParams) WithContext(ctx context.Context) *GetExternalIDParams
  • func (o *GetExternalIDParams) WithHTTPClient(client *http.Client) *GetExternalIDParams
  • func (o *GetExternalIDParams) WithTimeout(timeout time.Duration) *GetExternalIDParams
  • func (o *GetExternalIDParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type GetExternalIDReader
  • func (o *GetExternalIDReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type Client

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

Client for external id API

func New

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

New creates a new external id API client.

func (*Client) GetExternalID

func (a *Client) GetExternalID(params *GetExternalIDParams) (*GetExternalIDOK, error)

GetExternalID gets organisation external ID

This endpoint allows you to get your organisation's external ID.

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type GetExternalIDOK

type GetExternalIDOK struct {
	Payload *models.GetExternalIDOKBody
}

GetExternalIDOK handles this case with default header values.

OK

func NewGetExternalIDOK

func NewGetExternalIDOK() *GetExternalIDOK

NewGetExternalIDOK creates a GetExternalIDOK with default headers values

func (*GetExternalIDOK) Error

func (o *GetExternalIDOK) Error() string

type GetExternalIDParams

type GetExternalIDParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetExternalIDParams contains all the parameters to send to the API endpoint for the get external Id operation typically these are written to a http.Request

func NewGetExternalIDParams

func NewGetExternalIDParams() *GetExternalIDParams

NewGetExternalIDParams creates a new GetExternalIDParams object with the default values initialized.

func NewGetExternalIDParamsWithContext

func NewGetExternalIDParamsWithContext(ctx context.Context) *GetExternalIDParams

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

func NewGetExternalIDParamsWithHTTPClient

func NewGetExternalIDParamsWithHTTPClient(client *http.Client) *GetExternalIDParams

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

func NewGetExternalIDParamsWithTimeout

func NewGetExternalIDParamsWithTimeout(timeout time.Duration) *GetExternalIDParams

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

func (*GetExternalIDParams) SetContext

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

SetContext adds the context to the get external Id params

func (*GetExternalIDParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get external Id params

func (*GetExternalIDParams) SetTimeout

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

SetTimeout adds the timeout to the get external Id params

func (*GetExternalIDParams) WithContext

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

WithContext adds the context to the get external Id params

func (*GetExternalIDParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get external Id params

func (*GetExternalIDParams) WithTimeout

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

WithTimeout adds the timeout to the get external Id params

func (*GetExternalIDParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetExternalIDReader

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

GetExternalIDReader is a Reader for the GetExternalID structure.

func (*GetExternalIDReader) ReadResponse

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

ReadResponse reads a server response into the received o.