organization_api_keys

package
v1.0.97 Latest Latest
Warning

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

 Go to latest Published: Jun 15, 2022 License: MIT Imports: 13 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 organization api keys API

func New 

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

New creates a new organization api keys API client.

func (*Client) CreateAPIKey 

func (a *Client) CreateAPIKey(params *CreateAPIKeyParams, authInfo runtime.ClientAuthInfoWriter) (*CreateAPIKeyOK, error)

CreateAPIKey Create a new API key in the organization.

func (*Client) DeleteAPIKey 

func (a *Client) DeleteAPIKey(params *DeleteAPIKeyParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteAPIKeyNoContent, error)

DeleteAPIKey Delete an API key of the organization.

func (*Client) GetAPIKey 

func (a *Client) GetAPIKey(params *GetAPIKeyParams, authInfo runtime.ClientAuthInfoWriter) (*GetAPIKeyOK, error)

GetAPIKey Get an API key of the organization.

func (*Client) GetAPIKeys 

func (a *Client) GetAPIKeys(params *GetAPIKeysParams, authInfo runtime.ClientAuthInfoWriter) (*GetAPIKeysOK, error)

GetAPIKeys Get list of API keys of the organization.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) UpdateAPIkey added in v1.0.76 

func (a *Client) UpdateAPIkey(params *UpdateAPIkeyParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateAPIkeyOK, error)

UpdateAPIkey Update the information of an API key of the organization. If the API key has some information on the fields which aren't required and they are not sent or set to their default vaules, which depend of their types, the information will be removed.

type CreateAPIKeyDefault 

type CreateAPIKeyDefault struct {

	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
	// contains filtered or unexported fields
}

CreateAPIKeyDefault handles this case with default header values.

The response sent when an unexpected error happened, as known as an internal server error.

func NewCreateAPIKeyDefault 

func NewCreateAPIKeyDefault(code int) *CreateAPIKeyDefault

NewCreateAPIKeyDefault creates a CreateAPIKeyDefault with default headers values

func (*CreateAPIKeyDefault) Code 

func (o *CreateAPIKeyDefault) Code() int

Code gets the status code for the create API key default response

func (*CreateAPIKeyDefault) Error 

func (o *CreateAPIKeyDefault) Error() string

func (*CreateAPIKeyDefault) GetPayload 

func (o *CreateAPIKeyDefault) GetPayload() *models.ErrorPayload

type CreateAPIKeyLengthRequired 

type CreateAPIKeyLengthRequired struct {
}

CreateAPIKeyLengthRequired handles this case with default header values.

The request has a body but it doesn't have a Content-Length header.

func NewCreateAPIKeyLengthRequired 

func NewCreateAPIKeyLengthRequired() *CreateAPIKeyLengthRequired

NewCreateAPIKeyLengthRequired creates a CreateAPIKeyLengthRequired with default headers values

func (*CreateAPIKeyLengthRequired) Error 

func (o *CreateAPIKeyLengthRequired) Error() string

type CreateAPIKeyNotFound 

type CreateAPIKeyNotFound struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

CreateAPIKeyNotFound handles this case with default header values.

The response sent when any of the entities present in the path is not found.

func NewCreateAPIKeyNotFound 

func NewCreateAPIKeyNotFound() *CreateAPIKeyNotFound

NewCreateAPIKeyNotFound creates a CreateAPIKeyNotFound with default headers values

func (*CreateAPIKeyNotFound) Error 

func (o *CreateAPIKeyNotFound) Error() string

func (*CreateAPIKeyNotFound) GetPayload 

func (o *CreateAPIKeyNotFound) GetPayload() *models.ErrorPayload

type CreateAPIKeyOK 

type CreateAPIKeyOK struct {
	Payload *CreateAPIKeyOKBody
}

CreateAPIKeyOK handles this case with default header values.

API key created. The body contains the information of the new API key of the organization.

func NewCreateAPIKeyOK 

func NewCreateAPIKeyOK() *CreateAPIKeyOK

NewCreateAPIKeyOK creates a CreateAPIKeyOK with default headers values

func (*CreateAPIKeyOK) Error 

func (o *CreateAPIKeyOK) Error() string

func (*CreateAPIKeyOK) GetPayload 

func (o *CreateAPIKeyOK) GetPayload() *CreateAPIKeyOKBody

type CreateAPIKeyOKBody 

type CreateAPIKeyOKBody struct {

	// data
	// Required: true
	Data *models.APIKey `json:"data"`
}

CreateAPIKeyOKBody create API key o k body swagger:model CreateAPIKeyOKBody

func (*CreateAPIKeyOKBody) MarshalBinary 

func (o *CreateAPIKeyOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateAPIKeyOKBody) UnmarshalBinary 

func (o *CreateAPIKeyOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateAPIKeyOKBody) Validate 

func (o *CreateAPIKeyOKBody) Validate(formats strfmt.Registry) error

Validate validates this create API key o k body

type CreateAPIKeyParams 

type CreateAPIKeyParams struct {

	/*Body
	  The information of the API key to create.

	*/
	Body *models.NewAPIKey
	/*OrganizationCanonical
	  A canonical of an organization.

	*/
	OrganizationCanonical string

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

CreateAPIKeyParams contains all the parameters to send to the API endpoint for the create API key operation typically these are written to a http.Request

func NewCreateAPIKeyParams 

func NewCreateAPIKeyParams() *CreateAPIKeyParams

NewCreateAPIKeyParams creates a new CreateAPIKeyParams object with the default values initialized.

func NewCreateAPIKeyParamsWithContext 

func NewCreateAPIKeyParamsWithContext(ctx context.Context) *CreateAPIKeyParams

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

func NewCreateAPIKeyParamsWithHTTPClient 

func NewCreateAPIKeyParamsWithHTTPClient(client *http.Client) *CreateAPIKeyParams

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

func NewCreateAPIKeyParamsWithTimeout 

func NewCreateAPIKeyParamsWithTimeout(timeout time.Duration) *CreateAPIKeyParams

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

func (*CreateAPIKeyParams) SetBody 

func (o *CreateAPIKeyParams) SetBody(body *models.NewAPIKey)

SetBody adds the body to the create API key params

func (*CreateAPIKeyParams) SetContext 

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

SetContext adds the context to the create API key params

func (*CreateAPIKeyParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the create API key params

func (*CreateAPIKeyParams) SetOrganizationCanonical 

func (o *CreateAPIKeyParams) SetOrganizationCanonical(organizationCanonical string)

SetOrganizationCanonical adds the organizationCanonical to the create API key params

func (*CreateAPIKeyParams) SetTimeout 

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

SetTimeout adds the timeout to the create API key params

func (*CreateAPIKeyParams) WithBody 

func (o *CreateAPIKeyParams) WithBody(body *models.NewAPIKey) *CreateAPIKeyParams

WithBody adds the body to the create API key params

func (*CreateAPIKeyParams) WithContext 

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

WithContext adds the context to the create API key params

func (*CreateAPIKeyParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the create API key params

func (*CreateAPIKeyParams) WithOrganizationCanonical 

func (o *CreateAPIKeyParams) WithOrganizationCanonical(organizationCanonical string) *CreateAPIKeyParams

WithOrganizationCanonical adds the organizationCanonical to the create API key params

func (*CreateAPIKeyParams) WithTimeout 

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

WithTimeout adds the timeout to the create API key params

func (*CreateAPIKeyParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type CreateAPIKeyReader 

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

CreateAPIKeyReader is a Reader for the CreateAPIKey structure.

func (*CreateAPIKeyReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type CreateAPIKeyUnprocessableEntity 

type CreateAPIKeyUnprocessableEntity struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

CreateAPIKeyUnprocessableEntity handles this case with default header values.

All the custom errors that are generated from the Cycloid API

func NewCreateAPIKeyUnprocessableEntity 

func NewCreateAPIKeyUnprocessableEntity() *CreateAPIKeyUnprocessableEntity

NewCreateAPIKeyUnprocessableEntity creates a CreateAPIKeyUnprocessableEntity with default headers values

func (*CreateAPIKeyUnprocessableEntity) Error 

func (o *CreateAPIKeyUnprocessableEntity) Error() string

func (*CreateAPIKeyUnprocessableEntity) GetPayload 

func (o *CreateAPIKeyUnprocessableEntity) GetPayload() *models.ErrorPayload

type DeleteAPIKeyDefault 

type DeleteAPIKeyDefault struct {

	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
	// contains filtered or unexported fields
}

DeleteAPIKeyDefault handles this case with default header values.

The response sent when an unexpected error happened, as known as an internal server error.

func NewDeleteAPIKeyDefault 

func NewDeleteAPIKeyDefault(code int) *DeleteAPIKeyDefault

NewDeleteAPIKeyDefault creates a DeleteAPIKeyDefault with default headers values

func (*DeleteAPIKeyDefault) Code 

func (o *DeleteAPIKeyDefault) Code() int

Code gets the status code for the delete API key default response

func (*DeleteAPIKeyDefault) Error 

func (o *DeleteAPIKeyDefault) Error() string

func (*DeleteAPIKeyDefault) GetPayload 

func (o *DeleteAPIKeyDefault) GetPayload() *models.ErrorPayload

type DeleteAPIKeyForbidden 

type DeleteAPIKeyForbidden struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

DeleteAPIKeyForbidden handles this case with default header values.

The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.

func NewDeleteAPIKeyForbidden 

func NewDeleteAPIKeyForbidden() *DeleteAPIKeyForbidden

NewDeleteAPIKeyForbidden creates a DeleteAPIKeyForbidden with default headers values

func (*DeleteAPIKeyForbidden) Error 

func (o *DeleteAPIKeyForbidden) Error() string

func (*DeleteAPIKeyForbidden) GetPayload 

func (o *DeleteAPIKeyForbidden) GetPayload() *models.ErrorPayload

type DeleteAPIKeyNoContent 

type DeleteAPIKeyNoContent struct {
}

DeleteAPIKeyNoContent handles this case with default header values.

API key has been deleted.

func NewDeleteAPIKeyNoContent 

func NewDeleteAPIKeyNoContent() *DeleteAPIKeyNoContent

NewDeleteAPIKeyNoContent creates a DeleteAPIKeyNoContent with default headers values

func (*DeleteAPIKeyNoContent) Error 

func (o *DeleteAPIKeyNoContent) Error() string

type DeleteAPIKeyNotFound 

type DeleteAPIKeyNotFound struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

DeleteAPIKeyNotFound handles this case with default header values.

The response sent when any of the entities present in the path is not found.

func NewDeleteAPIKeyNotFound 

func NewDeleteAPIKeyNotFound() *DeleteAPIKeyNotFound

NewDeleteAPIKeyNotFound creates a DeleteAPIKeyNotFound with default headers values

func (*DeleteAPIKeyNotFound) Error 

func (o *DeleteAPIKeyNotFound) Error() string

func (*DeleteAPIKeyNotFound) GetPayload 

func (o *DeleteAPIKeyNotFound) GetPayload() *models.ErrorPayload

type DeleteAPIKeyParams 

type DeleteAPIKeyParams struct {

	/*APIKeyCanonical
	  A canonical of an API key.

	*/
	APIKeyCanonical string
	/*OrganizationCanonical
	  A canonical of an organization.

	*/
	OrganizationCanonical string

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

DeleteAPIKeyParams contains all the parameters to send to the API endpoint for the delete API key operation typically these are written to a http.Request

func NewDeleteAPIKeyParams 

func NewDeleteAPIKeyParams() *DeleteAPIKeyParams

NewDeleteAPIKeyParams creates a new DeleteAPIKeyParams object with the default values initialized.

func NewDeleteAPIKeyParamsWithContext 

func NewDeleteAPIKeyParamsWithContext(ctx context.Context) *DeleteAPIKeyParams

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

func NewDeleteAPIKeyParamsWithHTTPClient 

func NewDeleteAPIKeyParamsWithHTTPClient(client *http.Client) *DeleteAPIKeyParams

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

func NewDeleteAPIKeyParamsWithTimeout 

func NewDeleteAPIKeyParamsWithTimeout(timeout time.Duration) *DeleteAPIKeyParams

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

func (*DeleteAPIKeyParams) SetAPIKeyCanonical 

func (o *DeleteAPIKeyParams) SetAPIKeyCanonical(aPIKeyCanonical string)

SetAPIKeyCanonical adds the apiKeyCanonical to the delete API key params

func (*DeleteAPIKeyParams) SetContext 

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

SetContext adds the context to the delete API key params

func (*DeleteAPIKeyParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the delete API key params

func (*DeleteAPIKeyParams) SetOrganizationCanonical 

func (o *DeleteAPIKeyParams) SetOrganizationCanonical(organizationCanonical string)

SetOrganizationCanonical adds the organizationCanonical to the delete API key params

func (*DeleteAPIKeyParams) SetTimeout 

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

SetTimeout adds the timeout to the delete API key params

func (*DeleteAPIKeyParams) WithAPIKeyCanonical 

func (o *DeleteAPIKeyParams) WithAPIKeyCanonical(aPIKeyCanonical string) *DeleteAPIKeyParams

WithAPIKeyCanonical adds the aPIKeyCanonical to the delete API key params

func (*DeleteAPIKeyParams) WithContext 

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

WithContext adds the context to the delete API key params

func (*DeleteAPIKeyParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the delete API key params

func (*DeleteAPIKeyParams) WithOrganizationCanonical 

func (o *DeleteAPIKeyParams) WithOrganizationCanonical(organizationCanonical string) *DeleteAPIKeyParams

WithOrganizationCanonical adds the organizationCanonical to the delete API key params

func (*DeleteAPIKeyParams) WithTimeout 

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

WithTimeout adds the timeout to the delete API key params

func (*DeleteAPIKeyParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DeleteAPIKeyReader 

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

DeleteAPIKeyReader is a Reader for the DeleteAPIKey structure.

func (*DeleteAPIKeyReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetAPIKeyDefault 

type GetAPIKeyDefault struct {

	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
	// contains filtered or unexported fields
}

GetAPIKeyDefault handles this case with default header values.

The response sent when an unexpected error happened, as known as an internal server error.

func NewGetAPIKeyDefault 

func NewGetAPIKeyDefault(code int) *GetAPIKeyDefault

NewGetAPIKeyDefault creates a GetAPIKeyDefault with default headers values

func (*GetAPIKeyDefault) Code 

func (o *GetAPIKeyDefault) Code() int

Code gets the status code for the get API key default response

func (*GetAPIKeyDefault) Error 

func (o *GetAPIKeyDefault) Error() string

func (*GetAPIKeyDefault) GetPayload 

func (o *GetAPIKeyDefault) GetPayload() *models.ErrorPayload

type GetAPIKeyForbidden 

type GetAPIKeyForbidden struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

GetAPIKeyForbidden handles this case with default header values.

The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.

func NewGetAPIKeyForbidden 

func NewGetAPIKeyForbidden() *GetAPIKeyForbidden

NewGetAPIKeyForbidden creates a GetAPIKeyForbidden with default headers values

func (*GetAPIKeyForbidden) Error 

func (o *GetAPIKeyForbidden) Error() string

func (*GetAPIKeyForbidden) GetPayload 

func (o *GetAPIKeyForbidden) GetPayload() *models.ErrorPayload

type GetAPIKeyNotFound 

type GetAPIKeyNotFound struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

GetAPIKeyNotFound handles this case with default header values.

The response sent when any of the entities present in the path is not found.

func NewGetAPIKeyNotFound 

func NewGetAPIKeyNotFound() *GetAPIKeyNotFound

NewGetAPIKeyNotFound creates a GetAPIKeyNotFound with default headers values

func (*GetAPIKeyNotFound) Error 

func (o *GetAPIKeyNotFound) Error() string

func (*GetAPIKeyNotFound) GetPayload 

func (o *GetAPIKeyNotFound) GetPayload() *models.ErrorPayload

type GetAPIKeyOK 

type GetAPIKeyOK struct {
	Payload *GetAPIKeyOKBody
}

GetAPIKeyOK handles this case with default header values.

The information of the API key of the organization which has the specified canonical.

func NewGetAPIKeyOK 

func NewGetAPIKeyOK() *GetAPIKeyOK

NewGetAPIKeyOK creates a GetAPIKeyOK with default headers values

func (*GetAPIKeyOK) Error 

func (o *GetAPIKeyOK) Error() string

func (*GetAPIKeyOK) GetPayload 

func (o *GetAPIKeyOK) GetPayload() *GetAPIKeyOKBody

type GetAPIKeyOKBody 

type GetAPIKeyOKBody struct {

	// data
	// Required: true
	Data *models.APIKey `json:"data"`
}

GetAPIKeyOKBody get API key o k body swagger:model GetAPIKeyOKBody

func (*GetAPIKeyOKBody) MarshalBinary 

func (o *GetAPIKeyOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetAPIKeyOKBody) UnmarshalBinary 

func (o *GetAPIKeyOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetAPIKeyOKBody) Validate 

func (o *GetAPIKeyOKBody) Validate(formats strfmt.Registry) error

Validate validates this get API key o k body

type GetAPIKeyParams 

type GetAPIKeyParams struct {

	/*APIKeyCanonical
	  A canonical of an API key.

	*/
	APIKeyCanonical string
	/*OrganizationCanonical
	  A canonical of an organization.

	*/
	OrganizationCanonical string

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

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

func NewGetAPIKeyParams 

func NewGetAPIKeyParams() *GetAPIKeyParams

NewGetAPIKeyParams creates a new GetAPIKeyParams object with the default values initialized.

func NewGetAPIKeyParamsWithContext 

func NewGetAPIKeyParamsWithContext(ctx context.Context) *GetAPIKeyParams

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

func NewGetAPIKeyParamsWithHTTPClient 

func NewGetAPIKeyParamsWithHTTPClient(client *http.Client) *GetAPIKeyParams

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

func NewGetAPIKeyParamsWithTimeout 

func NewGetAPIKeyParamsWithTimeout(timeout time.Duration) *GetAPIKeyParams

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

func (*GetAPIKeyParams) SetAPIKeyCanonical 

func (o *GetAPIKeyParams) SetAPIKeyCanonical(aPIKeyCanonical string)

SetAPIKeyCanonical adds the apiKeyCanonical to the get API key params

func (*GetAPIKeyParams) SetContext 

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

SetContext adds the context to the get API key params

func (*GetAPIKeyParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get API key params

func (*GetAPIKeyParams) SetOrganizationCanonical 

func (o *GetAPIKeyParams) SetOrganizationCanonical(organizationCanonical string)

SetOrganizationCanonical adds the organizationCanonical to the get API key params

func (*GetAPIKeyParams) SetTimeout 

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

SetTimeout adds the timeout to the get API key params

func (*GetAPIKeyParams) WithAPIKeyCanonical 

func (o *GetAPIKeyParams) WithAPIKeyCanonical(aPIKeyCanonical string) *GetAPIKeyParams

WithAPIKeyCanonical adds the aPIKeyCanonical to the get API key params

func (*GetAPIKeyParams) WithContext 

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

WithContext adds the context to the get API key params

func (*GetAPIKeyParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get API key params

func (*GetAPIKeyParams) WithOrganizationCanonical 

func (o *GetAPIKeyParams) WithOrganizationCanonical(organizationCanonical string) *GetAPIKeyParams

WithOrganizationCanonical adds the organizationCanonical to the get API key params

func (*GetAPIKeyParams) WithTimeout 

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

WithTimeout adds the timeout to the get API key params

func (*GetAPIKeyParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetAPIKeyReader 

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

GetAPIKeyReader is a Reader for the GetAPIKey structure.

func (*GetAPIKeyReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetAPIKeysDefault 

type GetAPIKeysDefault struct {

	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
	// contains filtered or unexported fields
}

GetAPIKeysDefault handles this case with default header values.

The response sent when an unexpected error happened, as known as an internal server error.

func NewGetAPIKeysDefault 

func NewGetAPIKeysDefault(code int) *GetAPIKeysDefault

NewGetAPIKeysDefault creates a GetAPIKeysDefault with default headers values

func (*GetAPIKeysDefault) Code 

func (o *GetAPIKeysDefault) Code() int

Code gets the status code for the get API keys default response

func (*GetAPIKeysDefault) Error 

func (o *GetAPIKeysDefault) Error() string

func (*GetAPIKeysDefault) GetPayload 

func (o *GetAPIKeysDefault) GetPayload() *models.ErrorPayload

type GetAPIKeysForbidden 

type GetAPIKeysForbidden struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

GetAPIKeysForbidden handles this case with default header values.

The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.

func NewGetAPIKeysForbidden 

func NewGetAPIKeysForbidden() *GetAPIKeysForbidden

NewGetAPIKeysForbidden creates a GetAPIKeysForbidden with default headers values

func (*GetAPIKeysForbidden) Error 

func (o *GetAPIKeysForbidden) Error() string

func (*GetAPIKeysForbidden) GetPayload 

func (o *GetAPIKeysForbidden) GetPayload() *models.ErrorPayload

type GetAPIKeysNotFound 

type GetAPIKeysNotFound struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

GetAPIKeysNotFound handles this case with default header values.

The response sent when any of the entities present in the path is not found.

func NewGetAPIKeysNotFound 

func NewGetAPIKeysNotFound() *GetAPIKeysNotFound

NewGetAPIKeysNotFound creates a GetAPIKeysNotFound with default headers values

func (*GetAPIKeysNotFound) Error 

func (o *GetAPIKeysNotFound) Error() string

func (*GetAPIKeysNotFound) GetPayload 

func (o *GetAPIKeysNotFound) GetPayload() *models.ErrorPayload

type GetAPIKeysOK 

type GetAPIKeysOK struct {
	Payload *GetAPIKeysOKBody
}

GetAPIKeysOK handles this case with default header values.

List of the API keys which the organization has.

func NewGetAPIKeysOK 

func NewGetAPIKeysOK() *GetAPIKeysOK

NewGetAPIKeysOK creates a GetAPIKeysOK with default headers values

func (*GetAPIKeysOK) Error 

func (o *GetAPIKeysOK) Error() string

func (*GetAPIKeysOK) GetPayload 

func (o *GetAPIKeysOK) GetPayload() *GetAPIKeysOKBody

type GetAPIKeysOKBody 

type GetAPIKeysOKBody struct {

	// data
	// Required: true
	Data []*models.APIKey `json:"data"`

	// pagination
	// Required: true
	Pagination *models.Pagination `json:"pagination"`
}

GetAPIKeysOKBody get API keys o k body swagger:model GetAPIKeysOKBody

func (*GetAPIKeysOKBody) MarshalBinary 

func (o *GetAPIKeysOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetAPIKeysOKBody) UnmarshalBinary 

func (o *GetAPIKeysOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetAPIKeysOKBody) Validate 

func (o *GetAPIKeysOKBody) Validate(formats strfmt.Registry) error

Validate validates this get API keys o k body

type GetAPIKeysParams 

type GetAPIKeysParams struct {

	/*OrganizationCanonical
	  A canonical of an organization.

	*/
	OrganizationCanonical string
	/*PageIndex
	  The page number to request. The first page is 1.

	*/
	PageIndex *uint32
	/*PageSize
	  The number of items at most which the response can have.

	*/
	PageSize *uint32
	/*UserID
	  Search by entity's owner

	*/
	UserID *uint32

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

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

func NewGetAPIKeysParams 

func NewGetAPIKeysParams() *GetAPIKeysParams

NewGetAPIKeysParams creates a new GetAPIKeysParams object with the default values initialized.

func NewGetAPIKeysParamsWithContext 

func NewGetAPIKeysParamsWithContext(ctx context.Context) *GetAPIKeysParams

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

func NewGetAPIKeysParamsWithHTTPClient 

func NewGetAPIKeysParamsWithHTTPClient(client *http.Client) *GetAPIKeysParams

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

func NewGetAPIKeysParamsWithTimeout 

func NewGetAPIKeysParamsWithTimeout(timeout time.Duration) *GetAPIKeysParams

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

func (*GetAPIKeysParams) SetContext 

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

SetContext adds the context to the get API keys params

func (*GetAPIKeysParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get API keys params

func (*GetAPIKeysParams) SetOrganizationCanonical 

func (o *GetAPIKeysParams) SetOrganizationCanonical(organizationCanonical string)

SetOrganizationCanonical adds the organizationCanonical to the get API keys params

func (*GetAPIKeysParams) SetPageIndex 

func (o *GetAPIKeysParams) SetPageIndex(pageIndex *uint32)

SetPageIndex adds the pageIndex to the get API keys params

func (*GetAPIKeysParams) SetPageSize 

func (o *GetAPIKeysParams) SetPageSize(pageSize *uint32)

SetPageSize adds the pageSize to the get API keys params

func (*GetAPIKeysParams) SetTimeout 

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

SetTimeout adds the timeout to the get API keys params

func (*GetAPIKeysParams) SetUserID 

func (o *GetAPIKeysParams) SetUserID(userID *uint32)

SetUserID adds the userId to the get API keys params

func (*GetAPIKeysParams) WithContext 

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

WithContext adds the context to the get API keys params

func (*GetAPIKeysParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get API keys params

func (*GetAPIKeysParams) WithOrganizationCanonical 

func (o *GetAPIKeysParams) WithOrganizationCanonical(organizationCanonical string) *GetAPIKeysParams

WithOrganizationCanonical adds the organizationCanonical to the get API keys params

func (*GetAPIKeysParams) WithPageIndex 

func (o *GetAPIKeysParams) WithPageIndex(pageIndex *uint32) *GetAPIKeysParams

WithPageIndex adds the pageIndex to the get API keys params

func (*GetAPIKeysParams) WithPageSize 

func (o *GetAPIKeysParams) WithPageSize(pageSize *uint32) *GetAPIKeysParams

WithPageSize adds the pageSize to the get API keys params

func (*GetAPIKeysParams) WithTimeout 

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

WithTimeout adds the timeout to the get API keys params

func (*GetAPIKeysParams) WithUserID 

func (o *GetAPIKeysParams) WithUserID(userID *uint32) *GetAPIKeysParams

WithUserID adds the userID to the get API keys params

func (*GetAPIKeysParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetAPIKeysReader 

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

GetAPIKeysReader is a Reader for the GetAPIKeys structure.

func (*GetAPIKeysReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetAPIKeysUnprocessableEntity 

type GetAPIKeysUnprocessableEntity struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

GetAPIKeysUnprocessableEntity handles this case with default header values.

All the custom errors that are generated from the Cycloid API

func NewGetAPIKeysUnprocessableEntity 

func NewGetAPIKeysUnprocessableEntity() *GetAPIKeysUnprocessableEntity

NewGetAPIKeysUnprocessableEntity creates a GetAPIKeysUnprocessableEntity with default headers values

func (*GetAPIKeysUnprocessableEntity) Error 

func (o *GetAPIKeysUnprocessableEntity) Error() string

func (*GetAPIKeysUnprocessableEntity) GetPayload 

func (o *GetAPIKeysUnprocessableEntity) GetPayload() *models.ErrorPayload

type UpdateAPIkeyDefault added in v1.0.76 

type UpdateAPIkeyDefault struct {

	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
	// contains filtered or unexported fields
}

UpdateAPIkeyDefault handles this case with default header values.

The response sent when an unexpected error happened, as known as an internal server error.

func NewUpdateAPIkeyDefault added in v1.0.76 

func NewUpdateAPIkeyDefault(code int) *UpdateAPIkeyDefault

NewUpdateAPIkeyDefault creates a UpdateAPIkeyDefault with default headers values

func (*UpdateAPIkeyDefault) Code added in v1.0.76 

func (o *UpdateAPIkeyDefault) Code() int

Code gets the status code for the update a p ikey default response

func (*UpdateAPIkeyDefault) Error added in v1.0.76 

func (o *UpdateAPIkeyDefault) Error() string

func (*UpdateAPIkeyDefault) GetPayload added in v1.0.76 

func (o *UpdateAPIkeyDefault) GetPayload() *models.ErrorPayload

type UpdateAPIkeyForbidden added in v1.0.76 

type UpdateAPIkeyForbidden struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

UpdateAPIkeyForbidden handles this case with default header values.

The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.

func NewUpdateAPIkeyForbidden added in v1.0.76 

func NewUpdateAPIkeyForbidden() *UpdateAPIkeyForbidden

NewUpdateAPIkeyForbidden creates a UpdateAPIkeyForbidden with default headers values

func (*UpdateAPIkeyForbidden) Error added in v1.0.76 

func (o *UpdateAPIkeyForbidden) Error() string

func (*UpdateAPIkeyForbidden) GetPayload added in v1.0.76 

func (o *UpdateAPIkeyForbidden) GetPayload() *models.ErrorPayload

type UpdateAPIkeyLengthRequired added in v1.0.76 

type UpdateAPIkeyLengthRequired struct {
}

UpdateAPIkeyLengthRequired handles this case with default header values.

The request has a body but it doesn't have a Content-Length header.

func NewUpdateAPIkeyLengthRequired added in v1.0.76 

func NewUpdateAPIkeyLengthRequired() *UpdateAPIkeyLengthRequired

NewUpdateAPIkeyLengthRequired creates a UpdateAPIkeyLengthRequired with default headers values

func (*UpdateAPIkeyLengthRequired) Error added in v1.0.76 

func (o *UpdateAPIkeyLengthRequired) Error() string

type UpdateAPIkeyNotFound added in v1.0.76 

type UpdateAPIkeyNotFound struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

UpdateAPIkeyNotFound handles this case with default header values.

The response sent when any of the entities present in the path is not found.

func NewUpdateAPIkeyNotFound added in v1.0.76 

func NewUpdateAPIkeyNotFound() *UpdateAPIkeyNotFound

NewUpdateAPIkeyNotFound creates a UpdateAPIkeyNotFound with default headers values

func (*UpdateAPIkeyNotFound) Error added in v1.0.76 

func (o *UpdateAPIkeyNotFound) Error() string

func (*UpdateAPIkeyNotFound) GetPayload added in v1.0.76 

func (o *UpdateAPIkeyNotFound) GetPayload() *models.ErrorPayload

type UpdateAPIkeyOK added in v1.0.76 

type UpdateAPIkeyOK struct {
	Payload *UpdateAPIkeyOKBody
}

UpdateAPIkeyOK handles this case with default header values.

API ey updated. The body contains information of the updated API key.

func NewUpdateAPIkeyOK added in v1.0.76 

func NewUpdateAPIkeyOK() *UpdateAPIkeyOK

NewUpdateAPIkeyOK creates a UpdateAPIkeyOK with default headers values

func (*UpdateAPIkeyOK) Error added in v1.0.76 

func (o *UpdateAPIkeyOK) Error() string

func (*UpdateAPIkeyOK) GetPayload added in v1.0.76 

func (o *UpdateAPIkeyOK) GetPayload() *UpdateAPIkeyOKBody

type UpdateAPIkeyOKBody added in v1.0.76 

type UpdateAPIkeyOKBody struct {

	// data
	// Required: true
	Data *models.APIKey `json:"data"`
}

UpdateAPIkeyOKBody update a p ikey o k body swagger:model UpdateAPIkeyOKBody

func (*UpdateAPIkeyOKBody) MarshalBinary added in v1.0.76 

func (o *UpdateAPIkeyOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateAPIkeyOKBody) UnmarshalBinary added in v1.0.76 

func (o *UpdateAPIkeyOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateAPIkeyOKBody) Validate added in v1.0.76 

func (o *UpdateAPIkeyOKBody) Validate(formats strfmt.Registry) error

Validate validates this update a p ikey o k body

type UpdateAPIkeyParams added in v1.0.76 

type UpdateAPIkeyParams struct {

	/*APIKeyCanonical
	  A canonical of an API key.

	*/
	APIKeyCanonical string
	/*Body
	  The information of the API key to update.

	*/
	Body *models.UpdateAPIKey
	/*OrganizationCanonical
	  A canonical of an organization.

	*/
	OrganizationCanonical string

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

UpdateAPIkeyParams contains all the parameters to send to the API endpoint for the update a p ikey operation typically these are written to a http.Request

func NewUpdateAPIkeyParams added in v1.0.76 

func NewUpdateAPIkeyParams() *UpdateAPIkeyParams

NewUpdateAPIkeyParams creates a new UpdateAPIkeyParams object with the default values initialized.

func NewUpdateAPIkeyParamsWithContext added in v1.0.76 

func NewUpdateAPIkeyParamsWithContext(ctx context.Context) *UpdateAPIkeyParams

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

func NewUpdateAPIkeyParamsWithHTTPClient added in v1.0.76 

func NewUpdateAPIkeyParamsWithHTTPClient(client *http.Client) *UpdateAPIkeyParams

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

func NewUpdateAPIkeyParamsWithTimeout added in v1.0.76 

func NewUpdateAPIkeyParamsWithTimeout(timeout time.Duration) *UpdateAPIkeyParams

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

func (*UpdateAPIkeyParams) SetAPIKeyCanonical added in v1.0.76 

func (o *UpdateAPIkeyParams) SetAPIKeyCanonical(aPIKeyCanonical string)

SetAPIKeyCanonical adds the apiKeyCanonical to the update a p ikey params

func (*UpdateAPIkeyParams) SetBody added in v1.0.76 

func (o *UpdateAPIkeyParams) SetBody(body *models.UpdateAPIKey)

SetBody adds the body to the update a p ikey params

func (*UpdateAPIkeyParams) SetContext added in v1.0.76 

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

SetContext adds the context to the update a p ikey params

func (*UpdateAPIkeyParams) SetHTTPClient added in v1.0.76 

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

SetHTTPClient adds the HTTPClient to the update a p ikey params

func (*UpdateAPIkeyParams) SetOrganizationCanonical added in v1.0.76 

func (o *UpdateAPIkeyParams) SetOrganizationCanonical(organizationCanonical string)

SetOrganizationCanonical adds the organizationCanonical to the update a p ikey params

func (*UpdateAPIkeyParams) SetTimeout added in v1.0.76 

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

SetTimeout adds the timeout to the update a p ikey params

func (*UpdateAPIkeyParams) WithAPIKeyCanonical added in v1.0.76 

func (o *UpdateAPIkeyParams) WithAPIKeyCanonical(aPIKeyCanonical string) *UpdateAPIkeyParams

WithAPIKeyCanonical adds the aPIKeyCanonical to the update a p ikey params

func (*UpdateAPIkeyParams) WithBody added in v1.0.76 

func (o *UpdateAPIkeyParams) WithBody(body *models.UpdateAPIKey) *UpdateAPIkeyParams

WithBody adds the body to the update a p ikey params

func (*UpdateAPIkeyParams) WithContext added in v1.0.76 

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

WithContext adds the context to the update a p ikey params

func (*UpdateAPIkeyParams) WithHTTPClient added in v1.0.76 

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

WithHTTPClient adds the HTTPClient to the update a p ikey params

func (*UpdateAPIkeyParams) WithOrganizationCanonical added in v1.0.76 

func (o *UpdateAPIkeyParams) WithOrganizationCanonical(organizationCanonical string) *UpdateAPIkeyParams

WithOrganizationCanonical adds the organizationCanonical to the update a p ikey params

func (*UpdateAPIkeyParams) WithTimeout added in v1.0.76 

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

WithTimeout adds the timeout to the update a p ikey params

func (*UpdateAPIkeyParams) WriteToRequest added in v1.0.76 

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

WriteToRequest writes these params to a swagger request

type UpdateAPIkeyReader added in v1.0.76 

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

UpdateAPIkeyReader is a Reader for the UpdateAPIkey structure.

func (*UpdateAPIkeyReader) ReadResponse added in v1.0.76 

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

ReadResponse reads a server response into the received o.

type UpdateAPIkeyUnprocessableEntity added in v1.0.76 

type UpdateAPIkeyUnprocessableEntity struct {
	/*The length of the response body in octets (8-bit bytes).
	 */
	ContentLength uint64

	Payload *models.ErrorPayload
}

UpdateAPIkeyUnprocessableEntity handles this case with default header values.

All the custom errors that are generated from the Cycloid API

func NewUpdateAPIkeyUnprocessableEntity added in v1.0.76 

func NewUpdateAPIkeyUnprocessableEntity() *UpdateAPIkeyUnprocessableEntity

NewUpdateAPIkeyUnprocessableEntity creates a UpdateAPIkeyUnprocessableEntity with default headers values

func (*UpdateAPIkeyUnprocessableEntity) Error added in v1.0.76 

func (o *UpdateAPIkeyUnprocessableEntity) Error() string

func (*UpdateAPIkeyUnprocessableEntity) GetPayload added in v1.0.76 

func (o *UpdateAPIkeyUnprocessableEntity) GetPayload() *models.ErrorPayload

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.