employees

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client for employees API

func (*Client) ListEmployees

func (a *Client) ListEmployees(params *ListEmployeesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListEmployeesOK, error)

ListEmployees lists employees

func (*Client) RetrieveEmployee

func (a *Client) RetrieveEmployee(params *RetrieveEmployeeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RetrieveEmployeeOK, error)

RetrieveEmployee retrieves employee

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 is the option for Client methods

type ClientService

type ClientService interface {
	ListEmployees(params *ListEmployeesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListEmployeesOK, error)

	RetrieveEmployee(params *RetrieveEmployeeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RetrieveEmployeeOK, 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 employees API client.

type ListEmployeesOK

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

Success

func NewListEmployeesOK

func NewListEmployeesOK() *ListEmployeesOK

NewListEmployeesOK creates a ListEmployeesOK with default headers values

func (*ListEmployeesOK) Error

func (o *ListEmployeesOK) Error() string

func (*ListEmployeesOK) GetPayload

func (o *ListEmployeesOK) GetPayload() *models.ListEmployeesResponse

type ListEmployeesParams

type ListEmployeesParams struct {

	/* Cursor.

	   The token required to retrieve the specified page of results.
	*/
	Cursor *string

	/* Limit.

	   The number of employees to be returned on each page.
	*/
	Limit *int64

	// LocationID.
	LocationID *string

	/* Status.

	   Specifies the EmployeeStatus to filter the employee by.
	*/
	Status *string

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

ListEmployeesParams contains all the parameters to send to the API endpoint

for the list employees operation.

Typically these are written to a http.Request.

func NewListEmployeesParams

func NewListEmployeesParams() *ListEmployeesParams

NewListEmployeesParams creates a new ListEmployeesParams 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 NewListEmployeesParamsWithContext

func NewListEmployeesParamsWithContext(ctx context.Context) *ListEmployeesParams

NewListEmployeesParamsWithContext creates a new ListEmployeesParams object with the ability to set a context for a request.

func NewListEmployeesParamsWithHTTPClient

func NewListEmployeesParamsWithHTTPClient(client *http.Client) *ListEmployeesParams

NewListEmployeesParamsWithHTTPClient creates a new ListEmployeesParams object with the ability to set a custom HTTPClient for a request.

func NewListEmployeesParamsWithTimeout

func NewListEmployeesParamsWithTimeout(timeout time.Duration) *ListEmployeesParams

NewListEmployeesParamsWithTimeout creates a new ListEmployeesParams object with the ability to set a timeout on a request.

func (*ListEmployeesParams) SetContext

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

SetContext adds the context to the list employees params

func (*ListEmployeesParams) SetCursor

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

SetCursor adds the cursor to the list employees params

func (*ListEmployeesParams) SetDefaults

func (o *ListEmployeesParams) SetDefaults()

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

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

func (*ListEmployeesParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the list employees params

func (*ListEmployeesParams) SetLimit

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

SetLimit adds the limit to the list employees params

func (*ListEmployeesParams) SetLocationID

func (o *ListEmployeesParams) SetLocationID(locationID *string)

SetLocationID adds the locationId to the list employees params

func (*ListEmployeesParams) SetStatus

func (o *ListEmployeesParams) SetStatus(status *string)

SetStatus adds the status to the list employees params

func (*ListEmployeesParams) SetTimeout

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

SetTimeout adds the timeout to the list employees params

func (*ListEmployeesParams) WithContext

WithContext adds the context to the list employees params

func (*ListEmployeesParams) WithCursor

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

WithCursor adds the cursor to the list employees params

func (*ListEmployeesParams) WithDefaults

func (o *ListEmployeesParams) WithDefaults() *ListEmployeesParams

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

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

func (*ListEmployeesParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the list employees params

func (*ListEmployeesParams) WithLimit

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

WithLimit adds the limit to the list employees params

func (*ListEmployeesParams) WithLocationID

func (o *ListEmployeesParams) WithLocationID(locationID *string) *ListEmployeesParams

WithLocationID adds the locationID to the list employees params

func (*ListEmployeesParams) WithStatus

func (o *ListEmployeesParams) WithStatus(status *string) *ListEmployeesParams

WithStatus adds the status to the list employees params

func (*ListEmployeesParams) WithTimeout

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

WithTimeout adds the timeout to the list employees params

func (*ListEmployeesParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type ListEmployeesReader

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

ListEmployeesReader is a Reader for the ListEmployees structure.

func (*ListEmployeesReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type RetrieveEmployeeOK

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

Success

func NewRetrieveEmployeeOK

func NewRetrieveEmployeeOK() *RetrieveEmployeeOK

NewRetrieveEmployeeOK creates a RetrieveEmployeeOK with default headers values

func (*RetrieveEmployeeOK) Error

func (o *RetrieveEmployeeOK) Error() string

func (*RetrieveEmployeeOK) GetPayload

type RetrieveEmployeeParams

type RetrieveEmployeeParams struct {

	/* ID.

	   UUID for the employee that was requested.
	*/
	ID string

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

RetrieveEmployeeParams contains all the parameters to send to the API endpoint

for the retrieve employee operation.

Typically these are written to a http.Request.

func NewRetrieveEmployeeParams

func NewRetrieveEmployeeParams() *RetrieveEmployeeParams

NewRetrieveEmployeeParams creates a new RetrieveEmployeeParams 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 NewRetrieveEmployeeParamsWithContext

func NewRetrieveEmployeeParamsWithContext(ctx context.Context) *RetrieveEmployeeParams

NewRetrieveEmployeeParamsWithContext creates a new RetrieveEmployeeParams object with the ability to set a context for a request.

func NewRetrieveEmployeeParamsWithHTTPClient

func NewRetrieveEmployeeParamsWithHTTPClient(client *http.Client) *RetrieveEmployeeParams

NewRetrieveEmployeeParamsWithHTTPClient creates a new RetrieveEmployeeParams object with the ability to set a custom HTTPClient for a request.

func NewRetrieveEmployeeParamsWithTimeout

func NewRetrieveEmployeeParamsWithTimeout(timeout time.Duration) *RetrieveEmployeeParams

NewRetrieveEmployeeParamsWithTimeout creates a new RetrieveEmployeeParams object with the ability to set a timeout on a request.

func (*RetrieveEmployeeParams) SetContext

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

SetContext adds the context to the retrieve employee params

func (*RetrieveEmployeeParams) SetDefaults

func (o *RetrieveEmployeeParams) SetDefaults()

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

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

func (*RetrieveEmployeeParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the retrieve employee params

func (*RetrieveEmployeeParams) SetID

func (o *RetrieveEmployeeParams) SetID(id string)

SetID adds the id to the retrieve employee params

func (*RetrieveEmployeeParams) SetTimeout

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

SetTimeout adds the timeout to the retrieve employee params

func (*RetrieveEmployeeParams) WithContext

WithContext adds the context to the retrieve employee params

func (*RetrieveEmployeeParams) WithDefaults

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

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

func (*RetrieveEmployeeParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the retrieve employee params

func (*RetrieveEmployeeParams) WithID

WithID adds the id to the retrieve employee params

func (*RetrieveEmployeeParams) WithTimeout

WithTimeout adds the timeout to the retrieve employee params

func (*RetrieveEmployeeParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type RetrieveEmployeeReader

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

RetrieveEmployeeReader is a Reader for the RetrieveEmployee structure.

func (*RetrieveEmployeeReader) ReadResponse

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