types

package
v0.0.0-...-66e4c3a Latest Latest
Warning

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

 Go to latest Published: Oct 18, 2023 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetUserInfoResponse 

type GetUserInfoResponse struct {

	// Email address of user, if available
	// Example: user@example.com
	// Max Length: 255
	// Format: email
	Email strfmt.Email `json:"email,omitempty"`

	// Auth-Scopes of the user, if available
	// Example: ["app"]
	Scopes []string `json:"scopes"`

	// ID of user
	// Example: 82ebdfad-c586-4407-a873-4cc1c33d56fc
	// Required: true
	Sub *string `json:"sub"`

	// Unix timestamp the user's info was last updated at
	// Example: 1591960808
	// Required: true
	UpdatedAt *int64 `json:"updated_at"`
}

GetUserInfoResponse get user info response

swagger:model getUserInfoResponse

func (*GetUserInfoResponse) ContextValidate 

func (m *GetUserInfoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get user info response based on context it is used

func (*GetUserInfoResponse) MarshalBinary 

func (m *GetUserInfoResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetUserInfoResponse) UnmarshalBinary 

func (m *GetUserInfoResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetUserInfoResponse) Validate 

func (m *GetUserInfoResponse) Validate(formats strfmt.Registry) error

Validate validates this get user info response

type HTTPValidationErrorDetail 

type HTTPValidationErrorDetail struct {

	// Error describing field validation failure
	// Required: true
	Error *string `json:"error"`

	// Indicates how the invalid field was provided
	// Required: true
	In *string `json:"in"`

	// Key of field failing validation
	// Required: true
	Key *string `json:"key"`
}

HTTPValidationErrorDetail http validation error detail

swagger:model httpValidationErrorDetail

func (*HTTPValidationErrorDetail) ContextValidate 

func (m *HTTPValidationErrorDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this http validation error detail based on context it is used

func (*HTTPValidationErrorDetail) MarshalBinary 

func (m *HTTPValidationErrorDetail) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*HTTPValidationErrorDetail) UnmarshalBinary 

func (m *HTTPValidationErrorDetail) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*HTTPValidationErrorDetail) Validate 

func (m *HTTPValidationErrorDetail) Validate(formats strfmt.Registry) error

Validate validates this http validation error detail

type Nullables 

type Nullables struct {

	// nullable bool
	NullableBool nullable.Bool `json:"nullableBool,omitempty"`

	// nullable bool slice
	NullableBoolSlice nullable.BoolSlice `json:"nullableBoolSlice,omitempty"`

	// nullable float
	NullableFloat nullable.Float32 `json:"nullableFloat,omitempty"`

	// nullable float32
	NullableFloat32 nullable.Float32 `json:"nullableFloat32,omitempty"`

	// nullable float32 slice
	NullableFloat32Slice nullable.Float32Slice `json:"nullableFloat32Slice,omitempty"`

	// nullable float64
	NullableFloat64 nullable.Float64 `json:"nullableFloat64,omitempty"`

	// nullable float64 slice
	NullableFloat64Slice nullable.Float64Slice `json:"nullableFloat64Slice,omitempty"`

	// nullable float slice
	NullableFloatSlice nullable.Float32Slice `json:"nullableFloatSlice,omitempty"`

	// nullable int
	NullableInt nullable.Int `json:"nullableInt,omitempty"`

	// nullable int16
	NullableInt16 nullable.Int16 `json:"nullableInt16,omitempty"`

	// nullable int16 slice
	NullableInt16Slice nullable.Int16Slice `json:"nullableInt16Slice,omitempty"`

	// nullable int32
	NullableInt32 nullable.Int32 `json:"nullableInt32,omitempty"`

	// nullable int32 slice
	NullableInt32Slice nullable.Int32Slice `json:"nullableInt32Slice,omitempty"`

	// nullable int64
	NullableInt64 nullable.Int64 `json:"nullableInt64,omitempty"`

	// nullable int64 slice
	NullableInt64Slice nullable.Int64Slice `json:"nullableInt64Slice,omitempty"`

	// nullable int slice
	NullableIntSlice nullable.IntSlice `json:"nullableIntSlice,omitempty"`

	// nullable string
	NullableString nullable.String `json:"nullableString,omitempty"`

	// nullable string slice
	NullableStringSlice nullable.StringSlice `json:"nullableStringSlice,omitempty"`
}

Nullables nullables

swagger:model nullables

func (*Nullables) ContextValidate 

func (m *Nullables) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nullables based on the context it is used

func (*Nullables) MarshalBinary 

func (m *Nullables) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Nullables) UnmarshalBinary 

func (m *Nullables) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Nullables) Validate 

func (m *Nullables) Validate(formats strfmt.Registry) error

Validate validates this nullables

type OrderDir 

type OrderDir string

OrderDir order dir

swagger:model orderDir 

const (

	// OrderDirAsc captures enum value "asc"
	OrderDirAsc OrderDir = "asc"

	// OrderDirDesc captures enum value "desc"
	OrderDirDesc OrderDir = "desc"
)

func NewOrderDir 

func NewOrderDir(value OrderDir) *OrderDir

func (OrderDir) ContextValidate 

func (m OrderDir) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this order dir based on context it is used

func (OrderDir) Pointer 

func (m OrderDir) Pointer() *OrderDir

Pointer returns a pointer to a freshly-allocated OrderDir.

func (OrderDir) Validate 

func (m OrderDir) Validate(formats strfmt.Registry) error

Validate validates this order dir

type PostChangePasswordPayload 

type PostChangePasswordPayload struct {

	// Current password of user
	// Example: correct horse battery staple
	// Required: true
	// Max Length: 500
	// Min Length: 1
	CurrentPassword *string `json:"currentPassword"`

	// New password to set for user
	// Example: correct horse battery staple
	// Required: true
	// Max Length: 500
	// Min Length: 1
	NewPassword *string `json:"newPassword"`
}

PostChangePasswordPayload post change password payload

swagger:model postChangePasswordPayload

func (*PostChangePasswordPayload) ContextValidate 

func (m *PostChangePasswordPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post change password payload based on context it is used

func (*PostChangePasswordPayload) MarshalBinary 

func (m *PostChangePasswordPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostChangePasswordPayload) UnmarshalBinary 

func (m *PostChangePasswordPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostChangePasswordPayload) Validate 

func (m *PostChangePasswordPayload) Validate(formats strfmt.Registry) error

Validate validates this post change password payload

type PostForgotPasswordCompletePayload 

type PostForgotPasswordCompletePayload struct {

	// New password to set for user
	// Example: correct horse battery staple
	// Required: true
	// Max Length: 500
	// Min Length: 1
	Password *string `json:"password"`

	// Password reset token sent via email
	// Example: ec16f032-3c44-4148-bbcc-45557466fa74
	// Required: true
	// Format: uuid4
	Token *strfmt.UUID4 `json:"token"`
}

PostForgotPasswordCompletePayload post forgot password complete payload

swagger:model postForgotPasswordCompletePayload

func (*PostForgotPasswordCompletePayload) ContextValidate 

func (m *PostForgotPasswordCompletePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post forgot password complete payload based on context it is used

func (*PostForgotPasswordCompletePayload) MarshalBinary 

func (m *PostForgotPasswordCompletePayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostForgotPasswordCompletePayload) UnmarshalBinary 

func (m *PostForgotPasswordCompletePayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostForgotPasswordCompletePayload) Validate 

func (m *PostForgotPasswordCompletePayload) Validate(formats strfmt.Registry) error

Validate validates this post forgot password complete payload

type PostForgotPasswordPayload 

type PostForgotPasswordPayload struct {

	// Username to initiate password reset for
	// Example: user@example.com
	// Required: true
	// Max Length: 255
	// Min Length: 1
	// Format: email
	Username *strfmt.Email `json:"username"`
}

PostForgotPasswordPayload post forgot password payload

swagger:model postForgotPasswordPayload

func (*PostForgotPasswordPayload) ContextValidate 

func (m *PostForgotPasswordPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post forgot password payload based on context it is used

func (*PostForgotPasswordPayload) MarshalBinary 

func (m *PostForgotPasswordPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostForgotPasswordPayload) UnmarshalBinary 

func (m *PostForgotPasswordPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostForgotPasswordPayload) Validate 

func (m *PostForgotPasswordPayload) Validate(formats strfmt.Registry) error

Validate validates this post forgot password payload

type PostLoginPayload 

type PostLoginPayload struct {

	// Password of user to authenticate as
	// Example: correct horse battery staple
	// Required: true
	// Max Length: 500
	// Min Length: 1
	Password *string `json:"password"`

	// Username of user to authenticate as
	// Example: user@example.com
	// Required: true
	// Max Length: 255
	// Min Length: 1
	// Format: email
	Username *strfmt.Email `json:"username"`
}

PostLoginPayload post login payload

swagger:model postLoginPayload

func (*PostLoginPayload) ContextValidate 

func (m *PostLoginPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post login payload based on context it is used

func (*PostLoginPayload) MarshalBinary 

func (m *PostLoginPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostLoginPayload) UnmarshalBinary 

func (m *PostLoginPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostLoginPayload) Validate 

func (m *PostLoginPayload) Validate(formats strfmt.Registry) error

Validate validates this post login payload

type PostLoginResponse 

type PostLoginResponse struct {

	// Access token required for accessing protected API endpoints
	// Example: c1247d8d-0d65-41c4-bc86-ec041d2ac437
	// Required: true
	// Format: uuid4
	AccessToken *strfmt.UUID4 `json:"access_token"`

	// Access token expiry in seconds
	// Example: 86400
	// Required: true
	ExpiresIn *int64 `json:"expires_in"`

	// Refresh token for refreshing the access token once it expires
	// Example: 1dadb3bd-50d8-485d-83a3-6111392568f0
	// Required: true
	// Format: uuid4
	RefreshToken *strfmt.UUID4 `json:"refresh_token"`

	// Type of access token, will always be `bearer`
	// Example: bearer
	// Required: true
	TokenType *string `json:"token_type"`
}

PostLoginResponse post login response

swagger:model postLoginResponse

func (*PostLoginResponse) ContextValidate 

func (m *PostLoginResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post login response based on context it is used

func (*PostLoginResponse) MarshalBinary 

func (m *PostLoginResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostLoginResponse) UnmarshalBinary 

func (m *PostLoginResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostLoginResponse) Validate 

func (m *PostLoginResponse) Validate(formats strfmt.Registry) error

Validate validates this post login response

type PostLogoutPayload 

type PostLogoutPayload struct {

	// Optional refresh token to delete while logging out
	// Example: 700ebed3-40f7-4211-bc83-a89b22b9875e
	// Format: uuid4
	RefreshToken strfmt.UUID4 `json:"refresh_token,omitempty"`
}

PostLogoutPayload post logout payload

swagger:model postLogoutPayload

func (*PostLogoutPayload) ContextValidate 

func (m *PostLogoutPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post logout payload based on context it is used

func (*PostLogoutPayload) MarshalBinary 

func (m *PostLogoutPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostLogoutPayload) UnmarshalBinary 

func (m *PostLogoutPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostLogoutPayload) Validate 

func (m *PostLogoutPayload) Validate(formats strfmt.Registry) error

Validate validates this post logout payload

type PostRefreshPayload 

type PostRefreshPayload struct {

	// Refresh token to use for retrieving new token set
	// Example: 7503cd8a-c921-4368-a32d-6c1d01d86da9
	// Required: true
	// Format: uuid4
	RefreshToken *strfmt.UUID4 `json:"refresh_token"`
}

PostRefreshPayload post refresh payload

swagger:model postRefreshPayload

func (*PostRefreshPayload) ContextValidate 

func (m *PostRefreshPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post refresh payload based on context it is used

func (*PostRefreshPayload) MarshalBinary 

func (m *PostRefreshPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostRefreshPayload) UnmarshalBinary 

func (m *PostRefreshPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostRefreshPayload) Validate 

func (m *PostRefreshPayload) Validate(formats strfmt.Registry) error

Validate validates this post refresh payload

type PostRegisterPayload 

type PostRegisterPayload struct {

	// Password to register with
	// Example: correct horse battery staple
	// Required: true
	// Max Length: 500
	// Min Length: 1
	Password *string `json:"password"`

	// Username to register with
	// Example: user@example.com
	// Required: true
	// Max Length: 255
	// Min Length: 1
	// Format: email
	Username *strfmt.Email `json:"username"`
}

PostRegisterPayload post register payload

swagger:model postRegisterPayload

func (*PostRegisterPayload) ContextValidate 

func (m *PostRegisterPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post register payload based on context it is used

func (*PostRegisterPayload) MarshalBinary 

func (m *PostRegisterPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostRegisterPayload) UnmarshalBinary 

func (m *PostRegisterPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostRegisterPayload) Validate 

func (m *PostRegisterPayload) Validate(formats strfmt.Registry) error

Validate validates this post register payload

type PostUpdatePushTokenPayload 

type PostUpdatePushTokenPayload struct {

	// New push token for given provider.
	// Example: 1c91e550-8167-439c-8021-dee7de2f7e96
	// Required: true
	// Max Length: 500
	NewToken *string `json:"newToken"`

	// Old token that can be deleted if present.
	// Example: 495179de-b771-48f0-aab2-8d23701b0f02
	// Max Length: 500
	OldToken *string `json:"oldToken,omitempty"`

	// Identifier of the provider the token is for (eg. "fcm", "apn"). Currently only "fcm" is supported.
	// Example: fcm
	// Required: true
	// Max Length: 500
	Provider *string `json:"provider"`
}

PostUpdatePushTokenPayload post update push token payload

swagger:model postUpdatePushTokenPayload

func (*PostUpdatePushTokenPayload) ContextValidate 

func (m *PostUpdatePushTokenPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post update push token payload based on context it is used

func (*PostUpdatePushTokenPayload) MarshalBinary 

func (m *PostUpdatePushTokenPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostUpdatePushTokenPayload) UnmarshalBinary 

func (m *PostUpdatePushTokenPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostUpdatePushTokenPayload) Validate 

func (m *PostUpdatePushTokenPayload) Validate(formats strfmt.Registry) error

Validate validates this post update push token payload

type PublicHTTPError 

type PublicHTTPError struct {

	// HTTP status code returned for the error
	// Example: 403
	// Required: true
	// Maximum: 599
	// Minimum: 100
	Code *int64 `json:"status"`

	// More detailed, human-readable, optional explanation of the error
	// Example: User is lacking permission to access this resource
	Detail string `json:"detail,omitempty"`

	// Short, human-readable description of the error
	// Example: Forbidden
	// Required: true
	Title *string `json:"title"`

	// Type of error returned, should be used for client-side error handling
	// Example: generic
	// Required: true
	Type *string `json:"type"`

	// Error identifier
	// Example: MOD_117
	XRef string `json:"x_ref,omitempty"`
}

PublicHTTPError public Http error

swagger:model publicHttpError

func (*PublicHTTPError) ContextValidate 

func (m *PublicHTTPError) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this public Http error based on context it is used

func (*PublicHTTPError) MarshalBinary 

func (m *PublicHTTPError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PublicHTTPError) UnmarshalBinary 

func (m *PublicHTTPError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PublicHTTPError) Validate 

func (m *PublicHTTPError) Validate(formats strfmt.Registry) error

Validate validates this public Http error

type PublicHTTPValidationError 

type PublicHTTPValidationError struct {
	PublicHTTPError

	// List of errors received while validating payload against schema
	// Required: true
	ValidationErrors []*HTTPValidationErrorDetail `json:"validationErrors"`
}

PublicHTTPValidationError public Http validation error

swagger:model publicHttpValidationError

func (*PublicHTTPValidationError) ContextValidate 

func (m *PublicHTTPValidationError) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this public Http validation error based on the context it is used

func (*PublicHTTPValidationError) MarshalBinary 

func (m *PublicHTTPValidationError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (PublicHTTPValidationError) MarshalJSON 

func (m PublicHTTPValidationError) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*PublicHTTPValidationError) UnmarshalBinary 

func (m *PublicHTTPValidationError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PublicHTTPValidationError) UnmarshalJSON 

func (m *PublicHTTPValidationError) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*PublicHTTPValidationError) Validate 

func (m *PublicHTTPValidationError) Validate(formats strfmt.Registry) error

Validate validates this public Http validation error

type SwaggerSpec 

type SwaggerSpec struct {
	Handlers map[string]map[string]bool
}

SwaggerSpec API documentation

func NewSwaggerSpec 

func NewSwaggerSpec() *SwaggerSpec

NewSwaggerSpec creates a new SwaggerSpec instance

Source Files

View all Source files

Directories

Path Synopsis

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.