appearance

package
v1.0.98 Latest Latest
Warning

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

Go to latest
Published: May 29, 2025 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithAcceptApplicationJSON

func WithAcceptApplicationJSON(r *runtime.ClientOperation)

WithAcceptApplicationJSON sets the Accept header to "application/json".

func WithAcceptApplicationVndCycloidIoV1JSON

func WithAcceptApplicationVndCycloidIoV1JSON(r *runtime.ClientOperation)

WithAcceptApplicationVndCycloidIoV1JSON sets the Accept header to "application/vnd.cycloid.io.v1+json".

func WithContentTypeApplicationJSON

func WithContentTypeApplicationJSON(r *runtime.ClientOperation)

WithContentTypeApplicationJSON sets the Content-Type header to "application/json".

func WithContentTypeApplicationVndCycloidIoV1JSON

func WithContentTypeApplicationVndCycloidIoV1JSON(r *runtime.ClientOperation)

WithContentTypeApplicationVndCycloidIoV1JSON sets the Content-Type header to "application/vnd.cycloid.io.v1+json".

func WithContentTypeApplicationxWwwFormUrlencoded

func WithContentTypeApplicationxWwwFormUrlencoded(r *runtime.ClientOperation)

WithContentTypeApplicationxWwwFormUrlencoded sets the Content-Type header to "application/x-www-form-urlencoded".

Types

type Client

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

Client for appearance API

func (*Client) GetActiveAppearance

func (a *Client) GetActiveAppearance(params *GetActiveAppearanceParams, opts ...ClientOption) (*GetActiveAppearanceOK, error)

GetActiveAppearance Get the active appearance available in the organization

func (*Client) GetDefaultAppearance

func (a *Client) GetDefaultAppearance(params *GetDefaultAppearanceParams, opts ...ClientOption) (*GetDefaultAppearanceOK, error)

GetDefaultAppearance Get the default appearance available in the platform

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

func WithAccept

func WithAccept(mime string) ClientOption

WithAccept allows the client to force the Accept header to negotiate a specific Producer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

func WithContentType

func WithContentType(mime string) ClientOption

WithContentType allows the client to force the Content-Type header to negotiate a specific Consumer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

type ClientService

type ClientService interface {
	GetActiveAppearance(params *GetActiveAppearanceParams, opts ...ClientOption) (*GetActiveAppearanceOK, error)

	GetDefaultAppearance(params *GetDefaultAppearanceParams, opts ...ClientOption) (*GetDefaultAppearanceOK, 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 appearance API client.

func NewClientWithBasicAuth

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new appearance API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new appearance API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type GetActiveAppearanceDefault

type GetActiveAppearanceDefault struct {

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

	   Format: uint64
	*/
	ContentLength uint64

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

GetActiveAppearanceDefault describes a response with status code -1, with default header values.

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

func NewGetActiveAppearanceDefault

func NewGetActiveAppearanceDefault(code int) *GetActiveAppearanceDefault

NewGetActiveAppearanceDefault creates a GetActiveAppearanceDefault with default headers values

func (*GetActiveAppearanceDefault) Code

func (o *GetActiveAppearanceDefault) Code() int

Code gets the status code for the get active appearance default response

func (*GetActiveAppearanceDefault) Error

func (*GetActiveAppearanceDefault) GetPayload

func (*GetActiveAppearanceDefault) IsClientError

func (o *GetActiveAppearanceDefault) IsClientError() bool

IsClientError returns true when this get active appearance default response has a 4xx status code

func (*GetActiveAppearanceDefault) IsCode

func (o *GetActiveAppearanceDefault) IsCode(code int) bool

IsCode returns true when this get active appearance default response a status code equal to that given

func (*GetActiveAppearanceDefault) IsRedirect

func (o *GetActiveAppearanceDefault) IsRedirect() bool

IsRedirect returns true when this get active appearance default response has a 3xx status code

func (*GetActiveAppearanceDefault) IsServerError

func (o *GetActiveAppearanceDefault) IsServerError() bool

IsServerError returns true when this get active appearance default response has a 5xx status code

func (*GetActiveAppearanceDefault) IsSuccess

func (o *GetActiveAppearanceDefault) IsSuccess() bool

IsSuccess returns true when this get active appearance default response has a 2xx status code

func (*GetActiveAppearanceDefault) String

func (o *GetActiveAppearanceDefault) String() string

type GetActiveAppearanceOK

type GetActiveAppearanceOK struct {
	Payload *GetActiveAppearanceOKBody
}

GetActiveAppearanceOK describes a response with status code 200, with default header values.

Default Appearance available in the organization.

func NewGetActiveAppearanceOK

func NewGetActiveAppearanceOK() *GetActiveAppearanceOK

NewGetActiveAppearanceOK creates a GetActiveAppearanceOK with default headers values

func (*GetActiveAppearanceOK) Code

func (o *GetActiveAppearanceOK) Code() int

Code gets the status code for the get active appearance o k response

func (*GetActiveAppearanceOK) Error

func (o *GetActiveAppearanceOK) Error() string

func (*GetActiveAppearanceOK) GetPayload

func (*GetActiveAppearanceOK) IsClientError

func (o *GetActiveAppearanceOK) IsClientError() bool

IsClientError returns true when this get active appearance o k response has a 4xx status code

func (*GetActiveAppearanceOK) IsCode

func (o *GetActiveAppearanceOK) IsCode(code int) bool

IsCode returns true when this get active appearance o k response a status code equal to that given

func (*GetActiveAppearanceOK) IsRedirect

func (o *GetActiveAppearanceOK) IsRedirect() bool

IsRedirect returns true when this get active appearance o k response has a 3xx status code

func (*GetActiveAppearanceOK) IsServerError

func (o *GetActiveAppearanceOK) IsServerError() bool

IsServerError returns true when this get active appearance o k response has a 5xx status code

func (*GetActiveAppearanceOK) IsSuccess

func (o *GetActiveAppearanceOK) IsSuccess() bool

IsSuccess returns true when this get active appearance o k response has a 2xx status code

func (*GetActiveAppearanceOK) String

func (o *GetActiveAppearanceOK) String() string

type GetActiveAppearanceOKBody

type GetActiveAppearanceOKBody struct {

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

GetActiveAppearanceOKBody get active appearance o k body swagger:model GetActiveAppearanceOKBody

func (*GetActiveAppearanceOKBody) ContextValidate

func (o *GetActiveAppearanceOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get active appearance o k body based on the context it is used

func (*GetActiveAppearanceOKBody) MarshalBinary

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

MarshalBinary interface implementation

func (*GetActiveAppearanceOKBody) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*GetActiveAppearanceOKBody) Validate

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

Validate validates this get active appearance o k body

type GetActiveAppearanceParams

type GetActiveAppearanceParams struct {

	/* OrganizationCanonical.

	   A canonical of an organization.
	*/
	OrganizationCanonical string

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

GetActiveAppearanceParams contains all the parameters to send to the API endpoint

for the get active appearance operation.

Typically these are written to a http.Request.

func NewGetActiveAppearanceParams

func NewGetActiveAppearanceParams() *GetActiveAppearanceParams

NewGetActiveAppearanceParams creates a new GetActiveAppearanceParams 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 NewGetActiveAppearanceParamsWithContext

func NewGetActiveAppearanceParamsWithContext(ctx context.Context) *GetActiveAppearanceParams

NewGetActiveAppearanceParamsWithContext creates a new GetActiveAppearanceParams object with the ability to set a context for a request.

func NewGetActiveAppearanceParamsWithHTTPClient

func NewGetActiveAppearanceParamsWithHTTPClient(client *http.Client) *GetActiveAppearanceParams

NewGetActiveAppearanceParamsWithHTTPClient creates a new GetActiveAppearanceParams object with the ability to set a custom HTTPClient for a request.

func NewGetActiveAppearanceParamsWithTimeout

func NewGetActiveAppearanceParamsWithTimeout(timeout time.Duration) *GetActiveAppearanceParams

NewGetActiveAppearanceParamsWithTimeout creates a new GetActiveAppearanceParams object with the ability to set a timeout on a request.

func (*GetActiveAppearanceParams) SetContext

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

SetContext adds the context to the get active appearance params

func (*GetActiveAppearanceParams) SetDefaults

func (o *GetActiveAppearanceParams) SetDefaults()

SetDefaults hydrates default values in the get active appearance params (not the query body).

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

func (*GetActiveAppearanceParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get active appearance params

func (*GetActiveAppearanceParams) SetOrganizationCanonical

func (o *GetActiveAppearanceParams) SetOrganizationCanonical(organizationCanonical string)

SetOrganizationCanonical adds the organizationCanonical to the get active appearance params

func (*GetActiveAppearanceParams) SetTimeout

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

SetTimeout adds the timeout to the get active appearance params

func (*GetActiveAppearanceParams) WithContext

WithContext adds the context to the get active appearance params

func (*GetActiveAppearanceParams) WithDefaults

WithDefaults hydrates default values in the get active appearance params (not the query body).

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

func (*GetActiveAppearanceParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get active appearance params

func (*GetActiveAppearanceParams) WithOrganizationCanonical

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

WithOrganizationCanonical adds the organizationCanonical to the get active appearance params

func (*GetActiveAppearanceParams) WithTimeout

WithTimeout adds the timeout to the get active appearance params

func (*GetActiveAppearanceParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetActiveAppearanceReader

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

GetActiveAppearanceReader is a Reader for the GetActiveAppearance structure.

func (*GetActiveAppearanceReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetDefaultAppearanceDefault

type GetDefaultAppearanceDefault struct {

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

	   Format: uint64
	*/
	ContentLength uint64

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

GetDefaultAppearanceDefault describes a response with status code -1, with default header values.

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

func NewGetDefaultAppearanceDefault

func NewGetDefaultAppearanceDefault(code int) *GetDefaultAppearanceDefault

NewGetDefaultAppearanceDefault creates a GetDefaultAppearanceDefault with default headers values

func (*GetDefaultAppearanceDefault) Code

func (o *GetDefaultAppearanceDefault) Code() int

Code gets the status code for the get default appearance default response

func (*GetDefaultAppearanceDefault) Error

func (*GetDefaultAppearanceDefault) GetPayload

func (*GetDefaultAppearanceDefault) IsClientError

func (o *GetDefaultAppearanceDefault) IsClientError() bool

IsClientError returns true when this get default appearance default response has a 4xx status code

func (*GetDefaultAppearanceDefault) IsCode

func (o *GetDefaultAppearanceDefault) IsCode(code int) bool

IsCode returns true when this get default appearance default response a status code equal to that given

func (*GetDefaultAppearanceDefault) IsRedirect

func (o *GetDefaultAppearanceDefault) IsRedirect() bool

IsRedirect returns true when this get default appearance default response has a 3xx status code

func (*GetDefaultAppearanceDefault) IsServerError

func (o *GetDefaultAppearanceDefault) IsServerError() bool

IsServerError returns true when this get default appearance default response has a 5xx status code

func (*GetDefaultAppearanceDefault) IsSuccess

func (o *GetDefaultAppearanceDefault) IsSuccess() bool

IsSuccess returns true when this get default appearance default response has a 2xx status code

func (*GetDefaultAppearanceDefault) String

func (o *GetDefaultAppearanceDefault) String() string

type GetDefaultAppearanceOK

type GetDefaultAppearanceOK struct {
	Payload *GetDefaultAppearanceOKBody
}

GetDefaultAppearanceOK describes a response with status code 200, with default header values.

Default Appearance available in the platform.

func NewGetDefaultAppearanceOK

func NewGetDefaultAppearanceOK() *GetDefaultAppearanceOK

NewGetDefaultAppearanceOK creates a GetDefaultAppearanceOK with default headers values

func (*GetDefaultAppearanceOK) Code

func (o *GetDefaultAppearanceOK) Code() int

Code gets the status code for the get default appearance o k response

func (*GetDefaultAppearanceOK) Error

func (o *GetDefaultAppearanceOK) Error() string

func (*GetDefaultAppearanceOK) GetPayload

func (*GetDefaultAppearanceOK) IsClientError

func (o *GetDefaultAppearanceOK) IsClientError() bool

IsClientError returns true when this get default appearance o k response has a 4xx status code

func (*GetDefaultAppearanceOK) IsCode

func (o *GetDefaultAppearanceOK) IsCode(code int) bool

IsCode returns true when this get default appearance o k response a status code equal to that given

func (*GetDefaultAppearanceOK) IsRedirect

func (o *GetDefaultAppearanceOK) IsRedirect() bool

IsRedirect returns true when this get default appearance o k response has a 3xx status code

func (*GetDefaultAppearanceOK) IsServerError

func (o *GetDefaultAppearanceOK) IsServerError() bool

IsServerError returns true when this get default appearance o k response has a 5xx status code

func (*GetDefaultAppearanceOK) IsSuccess

func (o *GetDefaultAppearanceOK) IsSuccess() bool

IsSuccess returns true when this get default appearance o k response has a 2xx status code

func (*GetDefaultAppearanceOK) String

func (o *GetDefaultAppearanceOK) String() string

type GetDefaultAppearanceOKBody

type GetDefaultAppearanceOKBody struct {

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

GetDefaultAppearanceOKBody get default appearance o k body swagger:model GetDefaultAppearanceOKBody

func (*GetDefaultAppearanceOKBody) ContextValidate

func (o *GetDefaultAppearanceOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get default appearance o k body based on the context it is used

func (*GetDefaultAppearanceOKBody) MarshalBinary

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

MarshalBinary interface implementation

func (*GetDefaultAppearanceOKBody) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*GetDefaultAppearanceOKBody) Validate

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

Validate validates this get default appearance o k body

type GetDefaultAppearanceParams

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

GetDefaultAppearanceParams contains all the parameters to send to the API endpoint

for the get default appearance operation.

Typically these are written to a http.Request.

func NewGetDefaultAppearanceParams

func NewGetDefaultAppearanceParams() *GetDefaultAppearanceParams

NewGetDefaultAppearanceParams creates a new GetDefaultAppearanceParams 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 NewGetDefaultAppearanceParamsWithContext

func NewGetDefaultAppearanceParamsWithContext(ctx context.Context) *GetDefaultAppearanceParams

NewGetDefaultAppearanceParamsWithContext creates a new GetDefaultAppearanceParams object with the ability to set a context for a request.

func NewGetDefaultAppearanceParamsWithHTTPClient

func NewGetDefaultAppearanceParamsWithHTTPClient(client *http.Client) *GetDefaultAppearanceParams

NewGetDefaultAppearanceParamsWithHTTPClient creates a new GetDefaultAppearanceParams object with the ability to set a custom HTTPClient for a request.

func NewGetDefaultAppearanceParamsWithTimeout

func NewGetDefaultAppearanceParamsWithTimeout(timeout time.Duration) *GetDefaultAppearanceParams

NewGetDefaultAppearanceParamsWithTimeout creates a new GetDefaultAppearanceParams object with the ability to set a timeout on a request.

func (*GetDefaultAppearanceParams) SetContext

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

SetContext adds the context to the get default appearance params

func (*GetDefaultAppearanceParams) SetDefaults

func (o *GetDefaultAppearanceParams) SetDefaults()

SetDefaults hydrates default values in the get default appearance params (not the query body).

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

func (*GetDefaultAppearanceParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get default appearance params

func (*GetDefaultAppearanceParams) SetTimeout

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

SetTimeout adds the timeout to the get default appearance params

func (*GetDefaultAppearanceParams) WithContext

WithContext adds the context to the get default appearance params

func (*GetDefaultAppearanceParams) WithDefaults

WithDefaults hydrates default values in the get default appearance params (not the query body).

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

func (*GetDefaultAppearanceParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get default appearance params

func (*GetDefaultAppearanceParams) WithTimeout

WithTimeout adds the timeout to the get default appearance params

func (*GetDefaultAppearanceParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetDefaultAppearanceReader

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

GetDefaultAppearanceReader is a Reader for the GetDefaultAppearance structure.

func (*GetDefaultAppearanceReader) ReadResponse

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

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

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