invites

package
v3.2.1 Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2023 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 invites API

func (*Client) CreateInvite 

func (a *Client) CreateInvite(params *CreateInviteParams, authInfo runtime.ClientAuthInfoWriter) (*CreateInviteCreated, error)

CreateInvite creates a new invite

Creates a new invite.

func (*Client) GetInviteByID 

func (a *Client) GetInviteByID(params *GetInviteByIDParams, authInfo runtime.ClientAuthInfoWriter) (*GetInviteByIDOK, error)

GetInviteByID fetches an invite by id

Fetch an invite by id.

func (*Client) ListInvites 

func (a *Client) ListInvites(params *ListInvitesParams, authInfo runtime.ClientAuthInfoWriter) (*ListInvitesOK, error)

ListInvites lists details for all invites

List details for all invites.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientService 

type ClientService interface {
	CreateInvite(params *CreateInviteParams, authInfo runtime.ClientAuthInfoWriter) (*CreateInviteCreated, error)

	GetInviteByID(params *GetInviteByIDParams, authInfo runtime.ClientAuthInfoWriter) (*GetInviteByIDOK, error)

	ListInvites(params *ListInvitesParams, authInfo runtime.ClientAuthInfoWriter) (*ListInvitesOK, 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 invites API client.

type CreateInviteBadRequest 

type CreateInviteBadRequest struct {
	Payload *models.BadRequestError
}

CreateInviteBadRequest handles this case with default header values.

BadRequestError

func NewCreateInviteBadRequest 

func NewCreateInviteBadRequest() *CreateInviteBadRequest

NewCreateInviteBadRequest creates a CreateInviteBadRequest with default headers values

func (*CreateInviteBadRequest) Error 

func (o *CreateInviteBadRequest) Error() string

func (*CreateInviteBadRequest) GetPayload 

func (o *CreateInviteBadRequest) GetPayload() *models.BadRequestError

type CreateInviteCreated 

type CreateInviteCreated struct {
	Payload *models.Invite
}

CreateInviteCreated handles this case with default header values.

New invite details.

func NewCreateInviteCreated 

func NewCreateInviteCreated() *CreateInviteCreated

NewCreateInviteCreated creates a CreateInviteCreated with default headers values

func (*CreateInviteCreated) Error 

func (o *CreateInviteCreated) Error() string

func (*CreateInviteCreated) GetPayload 

func (o *CreateInviteCreated) GetPayload() *models.Invite

type CreateInviteForbidden 

type CreateInviteForbidden struct {
	Payload *models.AuthorizationError
}

CreateInviteForbidden handles this case with default header values.

AuthorizationError

func NewCreateInviteForbidden 

func NewCreateInviteForbidden() *CreateInviteForbidden

NewCreateInviteForbidden creates a CreateInviteForbidden with default headers values

func (*CreateInviteForbidden) Error 

func (o *CreateInviteForbidden) Error() string

func (*CreateInviteForbidden) GetPayload 

func (o *CreateInviteForbidden) GetPayload() *models.AuthorizationError

type CreateInviteInternalServerError 

type CreateInviteInternalServerError struct {
	Payload *models.InternalServerError
}

CreateInviteInternalServerError handles this case with default header values.

InternalServerError

func NewCreateInviteInternalServerError 

func NewCreateInviteInternalServerError() *CreateInviteInternalServerError

NewCreateInviteInternalServerError creates a CreateInviteInternalServerError with default headers values

func (*CreateInviteInternalServerError) Error 

func (o *CreateInviteInternalServerError) Error() string

func (*CreateInviteInternalServerError) GetPayload 

func (o *CreateInviteInternalServerError) GetPayload() *models.InternalServerError

type CreateInviteNotFound 

type CreateInviteNotFound struct {
	Payload *models.NotFoundError
}

CreateInviteNotFound handles this case with default header values.

NotFoundError

func NewCreateInviteNotFound 

func NewCreateInviteNotFound() *CreateInviteNotFound

NewCreateInviteNotFound creates a CreateInviteNotFound with default headers values

func (*CreateInviteNotFound) Error 

func (o *CreateInviteNotFound) Error() string

func (*CreateInviteNotFound) GetPayload 

func (o *CreateInviteNotFound) GetPayload() *models.NotFoundError

type CreateInviteParams 

type CreateInviteParams struct {

	/*Invite
	  Configuration options for the new invite.

	*/
	Invite *models.CreateInviteInput

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

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

func NewCreateInviteParams 

func NewCreateInviteParams() *CreateInviteParams

NewCreateInviteParams creates a new CreateInviteParams object with the default values initialized.

func NewCreateInviteParamsWithContext 

func NewCreateInviteParamsWithContext(ctx context.Context) *CreateInviteParams

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

func NewCreateInviteParamsWithHTTPClient 

func NewCreateInviteParamsWithHTTPClient(client *http.Client) *CreateInviteParams

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

func NewCreateInviteParamsWithTimeout 

func NewCreateInviteParamsWithTimeout(timeout time.Duration) *CreateInviteParams

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

func (*CreateInviteParams) SetContext 

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

SetContext adds the context to the create invite params

func (*CreateInviteParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the create invite params

func (*CreateInviteParams) SetInvite 

func (o *CreateInviteParams) SetInvite(invite *models.CreateInviteInput)

SetInvite adds the invite to the create invite params

func (*CreateInviteParams) SetTimeout 

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

SetTimeout adds the timeout to the create invite params

func (*CreateInviteParams) WithContext 

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

WithContext adds the context to the create invite params

func (*CreateInviteParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the create invite params

func (*CreateInviteParams) WithInvite 

func (o *CreateInviteParams) WithInvite(invite *models.CreateInviteInput) *CreateInviteParams

WithInvite adds the invite to the create invite params

func (*CreateInviteParams) WithTimeout 

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

WithTimeout adds the timeout to the create invite params

func (*CreateInviteParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type CreateInviteReader 

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

CreateInviteReader is a Reader for the CreateInvite structure.

func (*CreateInviteReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type CreateInviteUnauthorized 

type CreateInviteUnauthorized struct {
	Payload *models.AuthenticationError
}

CreateInviteUnauthorized handles this case with default header values.

AuthenticationError

func NewCreateInviteUnauthorized 

func NewCreateInviteUnauthorized() *CreateInviteUnauthorized

NewCreateInviteUnauthorized creates a CreateInviteUnauthorized with default headers values

func (*CreateInviteUnauthorized) Error 

func (o *CreateInviteUnauthorized) Error() string

func (*CreateInviteUnauthorized) GetPayload 

func (o *CreateInviteUnauthorized) GetPayload() *models.AuthenticationError

type GetInviteByIDBadRequest 

type GetInviteByIDBadRequest struct {
	Payload *models.BadRequestError
}

GetInviteByIDBadRequest handles this case with default header values.

BadRequestError

func NewGetInviteByIDBadRequest 

func NewGetInviteByIDBadRequest() *GetInviteByIDBadRequest

NewGetInviteByIDBadRequest creates a GetInviteByIDBadRequest with default headers values

func (*GetInviteByIDBadRequest) Error 

func (o *GetInviteByIDBadRequest) Error() string

func (*GetInviteByIDBadRequest) GetPayload 

func (o *GetInviteByIDBadRequest) GetPayload() *models.BadRequestError

type GetInviteByIDForbidden 

type GetInviteByIDForbidden struct {
	Payload *models.AuthorizationError
}

GetInviteByIDForbidden handles this case with default header values.

AuthorizationError

func NewGetInviteByIDForbidden 

func NewGetInviteByIDForbidden() *GetInviteByIDForbidden

NewGetInviteByIDForbidden creates a GetInviteByIDForbidden with default headers values

func (*GetInviteByIDForbidden) Error 

func (o *GetInviteByIDForbidden) Error() string

func (*GetInviteByIDForbidden) GetPayload 

func (o *GetInviteByIDForbidden) GetPayload() *models.AuthorizationError

type GetInviteByIDInternalServerError 

type GetInviteByIDInternalServerError struct {
	Payload *models.InternalServerError
}

GetInviteByIDInternalServerError handles this case with default header values.

InternalServerError

func NewGetInviteByIDInternalServerError 

func NewGetInviteByIDInternalServerError() *GetInviteByIDInternalServerError

NewGetInviteByIDInternalServerError creates a GetInviteByIDInternalServerError with default headers values

func (*GetInviteByIDInternalServerError) Error 

func (o *GetInviteByIDInternalServerError) Error() string

func (*GetInviteByIDInternalServerError) GetPayload 

func (o *GetInviteByIDInternalServerError) GetPayload() *models.InternalServerError

type GetInviteByIDNotFound 

type GetInviteByIDNotFound struct {
	Payload *models.NotFoundError
}

GetInviteByIDNotFound handles this case with default header values.

NotFoundError

func NewGetInviteByIDNotFound 

func NewGetInviteByIDNotFound() *GetInviteByIDNotFound

NewGetInviteByIDNotFound creates a GetInviteByIDNotFound with default headers values

func (*GetInviteByIDNotFound) Error 

func (o *GetInviteByIDNotFound) Error() string

func (*GetInviteByIDNotFound) GetPayload 

func (o *GetInviteByIDNotFound) GetPayload() *models.NotFoundError

type GetInviteByIDOK 

type GetInviteByIDOK struct {
	Payload *models.Invite
}

GetInviteByIDOK handles this case with default header values.

Invite details.

func NewGetInviteByIDOK 

func NewGetInviteByIDOK() *GetInviteByIDOK

NewGetInviteByIDOK creates a GetInviteByIDOK with default headers values

func (*GetInviteByIDOK) Error 

func (o *GetInviteByIDOK) Error() string

func (*GetInviteByIDOK) GetPayload 

func (o *GetInviteByIDOK) GetPayload() *models.Invite

type GetInviteByIDParams 

type GetInviteByIDParams struct {

	/*InviteID
	  id of the invite

	*/
	InviteID string

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

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

func NewGetInviteByIDParams 

func NewGetInviteByIDParams() *GetInviteByIDParams

NewGetInviteByIDParams creates a new GetInviteByIDParams object with the default values initialized.

func NewGetInviteByIDParamsWithContext 

func NewGetInviteByIDParamsWithContext(ctx context.Context) *GetInviteByIDParams

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

func NewGetInviteByIDParamsWithHTTPClient 

func NewGetInviteByIDParamsWithHTTPClient(client *http.Client) *GetInviteByIDParams

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

func NewGetInviteByIDParamsWithTimeout 

func NewGetInviteByIDParamsWithTimeout(timeout time.Duration) *GetInviteByIDParams

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

func (*GetInviteByIDParams) SetContext 

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

SetContext adds the context to the get invite by Id params

func (*GetInviteByIDParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get invite by Id params

func (*GetInviteByIDParams) SetInviteID 

func (o *GetInviteByIDParams) SetInviteID(inviteID string)

SetInviteID adds the inviteId to the get invite by Id params

func (*GetInviteByIDParams) SetTimeout 

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

SetTimeout adds the timeout to the get invite by Id params

func (*GetInviteByIDParams) WithContext 

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

WithContext adds the context to the get invite by Id params

func (*GetInviteByIDParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get invite by Id params

func (*GetInviteByIDParams) WithInviteID 

func (o *GetInviteByIDParams) WithInviteID(inviteID string) *GetInviteByIDParams

WithInviteID adds the inviteID to the get invite by Id params

func (*GetInviteByIDParams) WithTimeout 

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

WithTimeout adds the timeout to the get invite by Id params

func (*GetInviteByIDParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetInviteByIDReader 

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

GetInviteByIDReader is a Reader for the GetInviteByID structure.

func (*GetInviteByIDReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetInviteByIDUnauthorized 

type GetInviteByIDUnauthorized struct {
	Payload *models.AuthenticationError
}

GetInviteByIDUnauthorized handles this case with default header values.

AuthenticationError

func NewGetInviteByIDUnauthorized 

func NewGetInviteByIDUnauthorized() *GetInviteByIDUnauthorized

NewGetInviteByIDUnauthorized creates a GetInviteByIDUnauthorized with default headers values

func (*GetInviteByIDUnauthorized) Error 

func (o *GetInviteByIDUnauthorized) Error() string

func (*GetInviteByIDUnauthorized) GetPayload 

func (o *GetInviteByIDUnauthorized) GetPayload() *models.AuthenticationError

type ListInvitesBadRequest 

type ListInvitesBadRequest struct {
	Payload *models.BadRequestError
}

ListInvitesBadRequest handles this case with default header values.

BadRequestError

func NewListInvitesBadRequest 

func NewListInvitesBadRequest() *ListInvitesBadRequest

NewListInvitesBadRequest creates a ListInvitesBadRequest with default headers values

func (*ListInvitesBadRequest) Error 

func (o *ListInvitesBadRequest) Error() string

func (*ListInvitesBadRequest) GetPayload 

func (o *ListInvitesBadRequest) GetPayload() *models.BadRequestError

type ListInvitesForbidden 

type ListInvitesForbidden struct {
	Payload *models.AuthorizationError
}

ListInvitesForbidden handles this case with default header values.

AuthorizationError

func NewListInvitesForbidden 

func NewListInvitesForbidden() *ListInvitesForbidden

NewListInvitesForbidden creates a ListInvitesForbidden with default headers values

func (*ListInvitesForbidden) Error 

func (o *ListInvitesForbidden) Error() string

func (*ListInvitesForbidden) GetPayload 

func (o *ListInvitesForbidden) GetPayload() *models.AuthorizationError

type ListInvitesInternalServerError 

type ListInvitesInternalServerError struct {
	Payload *models.InternalServerError
}

ListInvitesInternalServerError handles this case with default header values.

InternalServerError

func NewListInvitesInternalServerError 

func NewListInvitesInternalServerError() *ListInvitesInternalServerError

NewListInvitesInternalServerError creates a ListInvitesInternalServerError with default headers values

func (*ListInvitesInternalServerError) Error 

func (o *ListInvitesInternalServerError) Error() string

func (*ListInvitesInternalServerError) GetPayload 

func (o *ListInvitesInternalServerError) GetPayload() *models.InternalServerError

type ListInvitesNotFound 

type ListInvitesNotFound struct {
	Payload *models.NotFoundError
}

ListInvitesNotFound handles this case with default header values.

NotFoundError

func NewListInvitesNotFound 

func NewListInvitesNotFound() *ListInvitesNotFound

NewListInvitesNotFound creates a ListInvitesNotFound with default headers values

func (*ListInvitesNotFound) Error 

func (o *ListInvitesNotFound) Error() string

func (*ListInvitesNotFound) GetPayload 

func (o *ListInvitesNotFound) GetPayload() *models.NotFoundError

type ListInvitesOK 

type ListInvitesOK struct {
	Payload *models.Invites
}

ListInvitesOK handles this case with default header values.

Invite details.

func NewListInvitesOK 

func NewListInvitesOK() *ListInvitesOK

NewListInvitesOK creates a ListInvitesOK with default headers values

func (*ListInvitesOK) Error 

func (o *ListInvitesOK) Error() string

func (*ListInvitesOK) GetPayload 

func (o *ListInvitesOK) GetPayload() *models.Invites

type ListInvitesParams 

type ListInvitesParams struct {

	/*Email
	  Used to filter list to a single invite by email.

	*/
	Email *string
	/*MaxItems
	  Maximum number of items to return.

	*/
	MaxItems *int64
	/*Offset
	  Number of items to skip before returning. This parameter is used when the number of items spans multiple pages.

	*/
	Offset *int64
	/*OrderDirection
	  Direction to sort the items in.

	*/
	OrderDirection *string

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

ListInvitesParams contains all the parameters to send to the API endpoint for the list invites operation typically these are written to a http.Request

func NewListInvitesParams 

func NewListInvitesParams() *ListInvitesParams

NewListInvitesParams creates a new ListInvitesParams object with the default values initialized.

func NewListInvitesParamsWithContext 

func NewListInvitesParamsWithContext(ctx context.Context) *ListInvitesParams

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

func NewListInvitesParamsWithHTTPClient 

func NewListInvitesParamsWithHTTPClient(client *http.Client) *ListInvitesParams

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

func NewListInvitesParamsWithTimeout 

func NewListInvitesParamsWithTimeout(timeout time.Duration) *ListInvitesParams

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

func (*ListInvitesParams) SetContext 

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

SetContext adds the context to the list invites params

func (*ListInvitesParams) SetEmail 

func (o *ListInvitesParams) SetEmail(email *string)

SetEmail adds the email to the list invites params

func (*ListInvitesParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the list invites params

func (*ListInvitesParams) SetMaxItems 

func (o *ListInvitesParams) SetMaxItems(maxItems *int64)

SetMaxItems adds the maxItems to the list invites params

func (*ListInvitesParams) SetOffset 

func (o *ListInvitesParams) SetOffset(offset *int64)

SetOffset adds the offset to the list invites params

func (*ListInvitesParams) SetOrderDirection 

func (o *ListInvitesParams) SetOrderDirection(orderDirection *string)

SetOrderDirection adds the orderDirection to the list invites params

func (*ListInvitesParams) SetTimeout 

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

SetTimeout adds the timeout to the list invites params

func (*ListInvitesParams) WithContext 

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

WithContext adds the context to the list invites params

func (*ListInvitesParams) WithEmail 

func (o *ListInvitesParams) WithEmail(email *string) *ListInvitesParams

WithEmail adds the email to the list invites params

func (*ListInvitesParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the list invites params

func (*ListInvitesParams) WithMaxItems 

func (o *ListInvitesParams) WithMaxItems(maxItems *int64) *ListInvitesParams

WithMaxItems adds the maxItems to the list invites params

func (*ListInvitesParams) WithOffset 

func (o *ListInvitesParams) WithOffset(offset *int64) *ListInvitesParams

WithOffset adds the offset to the list invites params

func (*ListInvitesParams) WithOrderDirection 

func (o *ListInvitesParams) WithOrderDirection(orderDirection *string) *ListInvitesParams

WithOrderDirection adds the orderDirection to the list invites params

func (*ListInvitesParams) WithTimeout 

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

WithTimeout adds the timeout to the list invites params

func (*ListInvitesParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ListInvitesReader 

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

ListInvitesReader is a Reader for the ListInvites structure.

func (*ListInvitesReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ListInvitesUnauthorized 

type ListInvitesUnauthorized struct {
	Payload *models.AuthenticationError
}

ListInvitesUnauthorized handles this case with default header values.

AuthenticationError

func NewListInvitesUnauthorized 

func NewListInvitesUnauthorized() *ListInvitesUnauthorized

NewListInvitesUnauthorized creates a ListInvitesUnauthorized with default headers values

func (*ListInvitesUnauthorized) Error 

func (o *ListInvitesUnauthorized) Error() string

func (*ListInvitesUnauthorized) GetPayload 

func (o *ListInvitesUnauthorized) GetPayload() *models.AuthenticationError

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.