Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type EmailAuthOK
- func (o *EmailAuthOK) Code() int
- func (o *EmailAuthOK) Error() string
- func (o *EmailAuthOK) GetPayload() *models.ActivityResponse
- func (o *EmailAuthOK) IsClientError() bool
- func (o *EmailAuthOK) IsCode(code int) bool
- func (o *EmailAuthOK) IsRedirect() bool
- func (o *EmailAuthOK) IsServerError() bool
- func (o *EmailAuthOK) IsSuccess() bool
- func (o *EmailAuthOK) String() string
- type EmailAuthParams
- func (o *EmailAuthParams) SetBody(body *models.EmailAuthRequest)
- func (o *EmailAuthParams) SetContext(ctx context.Context)
- func (o *EmailAuthParams) SetDefaults()
- func (o *EmailAuthParams) SetHTTPClient(client *http.Client)
- func (o *EmailAuthParams) SetTimeout(timeout time.Duration)
- func (o *EmailAuthParams) WithBody(body *models.EmailAuthRequest) *EmailAuthParams
- func (o *EmailAuthParams) WithContext(ctx context.Context) *EmailAuthParams
- func (o *EmailAuthParams) WithDefaults() *EmailAuthParams
- func (o *EmailAuthParams) WithHTTPClient(client *http.Client) *EmailAuthParams
- func (o *EmailAuthParams) WithTimeout(timeout time.Duration) *EmailAuthParams
- func (o *EmailAuthParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type EmailAuthReader
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 user auth API
func (*Client) EmailAuth ¶
func (a *Client) EmailAuth(params *EmailAuthParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*EmailAuthOK, error)
EmailAuth performs email auth
Authenticate a user via Email
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 {
EmailAuth(params *EmailAuthParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*EmailAuthOK, 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 user auth API client.
type EmailAuthOK ¶
type EmailAuthOK struct {
Payload *models.ActivityResponse
}
EmailAuthOK describes a response with status code 200, with default header values.
A successful response.
func NewEmailAuthOK ¶
func NewEmailAuthOK() *EmailAuthOK
NewEmailAuthOK creates a EmailAuthOK with default headers values
func (*EmailAuthOK) Code ¶
func (o *EmailAuthOK) Code() int
Code gets the status code for the email auth o k response
func (*EmailAuthOK) Error ¶
func (o *EmailAuthOK) Error() string
func (*EmailAuthOK) GetPayload ¶
func (o *EmailAuthOK) GetPayload() *models.ActivityResponse
func (*EmailAuthOK) IsClientError ¶
func (o *EmailAuthOK) IsClientError() bool
IsClientError returns true when this email auth o k response has a 4xx status code
func (*EmailAuthOK) IsCode ¶
func (o *EmailAuthOK) IsCode(code int) bool
IsCode returns true when this email auth o k response a status code equal to that given
func (*EmailAuthOK) IsRedirect ¶
func (o *EmailAuthOK) IsRedirect() bool
IsRedirect returns true when this email auth o k response has a 3xx status code
func (*EmailAuthOK) IsServerError ¶
func (o *EmailAuthOK) IsServerError() bool
IsServerError returns true when this email auth o k response has a 5xx status code
func (*EmailAuthOK) IsSuccess ¶
func (o *EmailAuthOK) IsSuccess() bool
IsSuccess returns true when this email auth o k response has a 2xx status code
func (*EmailAuthOK) String ¶
func (o *EmailAuthOK) String() string
type EmailAuthParams ¶
type EmailAuthParams struct {
// Body.
Body *models.EmailAuthRequest
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
EmailAuthParams contains all the parameters to send to the API endpoint
for the email auth operation. Typically these are written to a http.Request.
func NewEmailAuthParams ¶
func NewEmailAuthParams() *EmailAuthParams
NewEmailAuthParams creates a new EmailAuthParams 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 NewEmailAuthParamsWithContext ¶
func NewEmailAuthParamsWithContext(ctx context.Context) *EmailAuthParams
NewEmailAuthParamsWithContext creates a new EmailAuthParams object with the ability to set a context for a request.
func NewEmailAuthParamsWithHTTPClient ¶
func NewEmailAuthParamsWithHTTPClient(client *http.Client) *EmailAuthParams
NewEmailAuthParamsWithHTTPClient creates a new EmailAuthParams object with the ability to set a custom HTTPClient for a request.
func NewEmailAuthParamsWithTimeout ¶
func NewEmailAuthParamsWithTimeout(timeout time.Duration) *EmailAuthParams
NewEmailAuthParamsWithTimeout creates a new EmailAuthParams object with the ability to set a timeout on a request.
func (*EmailAuthParams) SetBody ¶
func (o *EmailAuthParams) SetBody(body *models.EmailAuthRequest)
SetBody adds the body to the email auth params
func (*EmailAuthParams) SetContext ¶
func (o *EmailAuthParams) SetContext(ctx context.Context)
SetContext adds the context to the email auth params
func (*EmailAuthParams) SetDefaults ¶
func (o *EmailAuthParams) SetDefaults()
SetDefaults hydrates default values in the email auth params (not the query body).
All values with no default are reset to their zero value.
func (*EmailAuthParams) SetHTTPClient ¶
func (o *EmailAuthParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the email auth params
func (*EmailAuthParams) SetTimeout ¶
func (o *EmailAuthParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the email auth params
func (*EmailAuthParams) WithBody ¶
func (o *EmailAuthParams) WithBody(body *models.EmailAuthRequest) *EmailAuthParams
WithBody adds the body to the email auth params
func (*EmailAuthParams) WithContext ¶
func (o *EmailAuthParams) WithContext(ctx context.Context) *EmailAuthParams
WithContext adds the context to the email auth params
func (*EmailAuthParams) WithDefaults ¶
func (o *EmailAuthParams) WithDefaults() *EmailAuthParams
WithDefaults hydrates default values in the email auth params (not the query body).
All values with no default are reset to their zero value.
func (*EmailAuthParams) WithHTTPClient ¶
func (o *EmailAuthParams) WithHTTPClient(client *http.Client) *EmailAuthParams
WithHTTPClient adds the HTTPClient to the email auth params
func (*EmailAuthParams) WithTimeout ¶
func (o *EmailAuthParams) WithTimeout(timeout time.Duration) *EmailAuthParams
WithTimeout adds the timeout to the email auth params
func (*EmailAuthParams) WriteToRequest ¶
func (o *EmailAuthParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type EmailAuthReader ¶
type EmailAuthReader struct {
// contains filtered or unexported fields
}
EmailAuthReader is a Reader for the EmailAuth structure.
func (*EmailAuthReader) ReadResponse ¶
func (o *EmailAuthReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files