api

package
v0.1.5 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

View Source
const (
	ApiKeyScopes = "apiKey.Scopes"
	NoneScopes   = "none.Scopes"
)

Variables

This section is empty.

Functions

func NewBulkUploadAccountPhotosRequestWithBody

func NewBulkUploadAccountPhotosRequestWithBody(server string, params *BulkUploadAccountPhotosParams, contentType string, body io.Reader) (*http.Request, error)

NewBulkUploadAccountPhotosRequestWithBody generates requests for BulkUploadAccountPhotos with any type of body

func NewCancelRequestRequest

func NewCancelRequestRequest(server string, requestID string) (*http.Request, error)

NewCancelRequestRequest generates requests for CancelRequest

func NewComparePeopleRequest

func NewComparePeopleRequest(server string, subject string, body ComparePeopleJSONRequestBody) (*http.Request, error)

NewComparePeopleRequest calls the generic ComparePeople builder with application/json body

func NewComparePeopleRequestWithBody

func NewComparePeopleRequestWithBody(server string, subject string, contentType string, body io.Reader) (*http.Request, error)

NewComparePeopleRequestWithBody generates requests for ComparePeople with any type of body

func NewCompareSelfieRequestWithBody

func NewCompareSelfieRequestWithBody(server string, subject string, contentType string, body io.Reader) (*http.Request, error)

NewCompareSelfieRequestWithBody generates requests for CompareSelfie with any type of body

func NewCreateAPIKeyRequest

func NewCreateAPIKeyRequest(server string, body CreateAPIKeyJSONRequestBody) (*http.Request, error)

NewCreateAPIKeyRequest calls the generic CreateAPIKey builder with application/json body

func NewCreateAPIKeyRequestWithBody

func NewCreateAPIKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateAPIKeyRequestWithBody generates requests for CreateAPIKey with any type of body

func NewCreateDirectoryRequest

func NewCreateDirectoryRequest(server string, env string, body CreateDirectoryJSONRequestBody) (*http.Request, error)

NewCreateDirectoryRequest calls the generic CreateDirectory builder with application/json body

func NewCreateDirectoryRequestWithBody

func NewCreateDirectoryRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)

NewCreateDirectoryRequestWithBody generates requests for CreateDirectory with any type of body

func NewCreateEnvRequest

func NewCreateEnvRequest(server string, body CreateEnvJSONRequestBody) (*http.Request, error)

NewCreateEnvRequest calls the generic CreateEnv builder with application/json body

func NewCreateEnvRequestWithBody

func NewCreateEnvRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateEnvRequestWithBody generates requests for CreateEnv with any type of body

func NewCreateRequestRequest

func NewCreateRequestRequest(server string, body CreateRequestJSONRequestBody) (*http.Request, error)

NewCreateRequestRequest calls the generic CreateRequest builder with application/json body

func NewCreateRequestRequestWithBody

func NewCreateRequestRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateRequestRequestWithBody generates requests for CreateRequest with any type of body

func NewCreateTemplateRequest

func NewCreateTemplateRequest(server string, env string, body CreateTemplateJSONRequestBody) (*http.Request, error)

NewCreateTemplateRequest calls the generic CreateTemplate builder with application/json body

func NewCreateTemplateRequestWithBody

func NewCreateTemplateRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)

NewCreateTemplateRequestWithBody generates requests for CreateTemplate with any type of body

func NewDeleteAPIKeyRequest

func NewDeleteAPIKeyRequest(server string, apiKey string) (*http.Request, error)

NewDeleteAPIKeyRequest generates requests for DeleteAPIKey

func NewDeleteDirectoryRequest

func NewDeleteDirectoryRequest(server string, env string, directory string) (*http.Request, error)

NewDeleteDirectoryRequest generates requests for DeleteDirectory

func NewDeleteEnvRequest

func NewDeleteEnvRequest(server string, env string) (*http.Request, error)

NewDeleteEnvRequest generates requests for DeleteEnv

func NewDeleteLogoRequest

func NewDeleteLogoRequest(server string, env string, params *DeleteLogoParams) (*http.Request, error)

NewDeleteLogoRequest generates requests for DeleteLogo

func NewDeletePersonPropertiesRequest

func NewDeletePersonPropertiesRequest(server string, subject string, scopes string, params *DeletePersonPropertiesParams) (*http.Request, error)

NewDeletePersonPropertiesRequest generates requests for DeletePersonProperties

func NewDeleteTemplateRequest

func NewDeleteTemplateRequest(server string, env string, template string) (*http.Request, error)

NewDeleteTemplateRequest generates requests for DeleteTemplate

func NewGetAPIKeyRequest

func NewGetAPIKeyRequest(server string, apiKey string) (*http.Request, error)

NewGetAPIKeyRequest generates requests for GetAPIKey

func NewGetAccountRequest

func NewGetAccountRequest(server string, account string) (*http.Request, error)

NewGetAccountRequest generates requests for GetAccount

func NewGetBulkPeoplePropertiesRequest

func NewGetBulkPeoplePropertiesRequest(server string, body GetBulkPeoplePropertiesJSONRequestBody) (*http.Request, error)

NewGetBulkPeoplePropertiesRequest calls the generic GetBulkPeopleProperties builder with application/json body

func NewGetBulkPeoplePropertiesRequestWithBody

func NewGetBulkPeoplePropertiesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewGetBulkPeoplePropertiesRequestWithBody generates requests for GetBulkPeopleProperties with any type of body

func NewGetDirectoryAuthorizationURLRequest

func NewGetDirectoryAuthorizationURLRequest(server string, env string, directory string) (*http.Request, error)

NewGetDirectoryAuthorizationURLRequest generates requests for GetDirectoryAuthorizationURL

func NewGetDirectoryRequest

func NewGetDirectoryRequest(server string, env string, directory string) (*http.Request, error)

NewGetDirectoryRequest generates requests for GetDirectory

func NewGetEnvRequest

func NewGetEnvRequest(server string, env string) (*http.Request, error)

NewGetEnvRequest generates requests for GetEnv

func NewGetEnvRequestRequest

func NewGetEnvRequestRequest(server string, env string, requestID string) (*http.Request, error)

NewGetEnvRequestRequest generates requests for GetEnvRequest

func NewGetOrgRequest

func NewGetOrgRequest(server string) (*http.Request, error)

NewGetOrgRequest generates requests for GetOrg

func NewGetPersonPropertiesRequest

func NewGetPersonPropertiesRequest(server string, subject string, scopes string, params *GetPersonPropertiesParams) (*http.Request, error)

NewGetPersonPropertiesRequest generates requests for GetPersonProperties

func NewGetRequestRequest

func NewGetRequestRequest(server string, requestID string) (*http.Request, error)

NewGetRequestRequest generates requests for GetRequest

func NewInviteOrgMemberRequest

func NewInviteOrgMemberRequest(server string, body InviteOrgMemberJSONRequestBody) (*http.Request, error)

NewInviteOrgMemberRequest calls the generic InviteOrgMember builder with application/json body

func NewInviteOrgMemberRequestWithBody

func NewInviteOrgMemberRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewInviteOrgMemberRequestWithBody generates requests for InviteOrgMember with any type of body

func NewListAPIKeysRequest

func NewListAPIKeysRequest(server string) (*http.Request, error)

NewListAPIKeysRequest generates requests for ListAPIKeys

func NewListAccountsRequest

func NewListAccountsRequest(server string, params *ListAccountsParams) (*http.Request, error)

NewListAccountsRequest generates requests for ListAccounts

func NewListDirectoriesRequest

func NewListDirectoriesRequest(server string, env string, params *ListDirectoriesParams) (*http.Request, error)

NewListDirectoriesRequest generates requests for ListDirectories

func NewListEnvRequestsRequest

func NewListEnvRequestsRequest(server string, env string, params *ListEnvRequestsParams) (*http.Request, error)

NewListEnvRequestsRequest generates requests for ListEnvRequests

func NewListEnvsRequest

func NewListEnvsRequest(server string) (*http.Request, error)

NewListEnvsRequest generates requests for ListEnvs

func NewListOrgMembersRequest

func NewListOrgMembersRequest(server string) (*http.Request, error)

NewListOrgMembersRequest generates requests for ListOrgMembers

func NewListWebhooksRequest

func NewListWebhooksRequest(server string, env string) (*http.Request, error)

NewListWebhooksRequest generates requests for ListWebhooks

func NewOauth2AuthorizeIframeRequest

func NewOauth2AuthorizeIframeRequest(server string, params *Oauth2AuthorizeIframeParams) (*http.Request, error)

NewOauth2AuthorizeIframeRequest generates requests for Oauth2AuthorizeIframe

func NewOauth2AuthorizeRequest

func NewOauth2AuthorizeRequest(server string, params *Oauth2AuthorizeParams) (*http.Request, error)

NewOauth2AuthorizeRequest generates requests for Oauth2Authorize

func NewOauth2AuthorizeWithExperienceRequest

func NewOauth2AuthorizeWithExperienceRequest(server string, experience string, params *Oauth2AuthorizeWithExperienceParams) (*http.Request, error)

NewOauth2AuthorizeWithExperienceRequest generates requests for Oauth2AuthorizeWithExperience

func NewOauth2AuthorizeWithRequestAndExperienceRequest

func NewOauth2AuthorizeWithRequestAndExperienceRequest(server string, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams) (*http.Request, error)

NewOauth2AuthorizeWithRequestAndExperienceRequest generates requests for Oauth2AuthorizeWithRequestAndExperience

func NewOauth2AuthorizeWithRequestRequest

func NewOauth2AuthorizeWithRequestRequest(server string, requestID string, params *Oauth2AuthorizeWithRequestParams) (*http.Request, error)

NewOauth2AuthorizeWithRequestRequest generates requests for Oauth2AuthorizeWithRequest

func NewOauth2CancelRequest

func NewOauth2CancelRequest(server string, requestID string, params *Oauth2CancelParams) (*http.Request, error)

NewOauth2CancelRequest generates requests for Oauth2Cancel

func NewOauth2LogoutRequest

func NewOauth2LogoutRequest(server string) (*http.Request, error)

NewOauth2LogoutRequest generates requests for Oauth2Logout

func NewOauth2PollRequest

func NewOauth2PollRequest(server string, requestID string, params *Oauth2PollParams) (*http.Request, error)

NewOauth2PollRequest generates requests for Oauth2Poll

func NewOauth2TokenRequestWithBody

func NewOauth2TokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewOauth2TokenRequestWithBody generates requests for Oauth2Token with any type of body

func NewOauth2TokenRequestWithFormdataBody

func NewOauth2TokenRequestWithFormdataBody(server string, body Oauth2TokenFormdataRequestBody) (*http.Request, error)

NewOauth2TokenRequestWithFormdataBody calls the generic Oauth2Token builder with application/x-www-form-urlencoded body

func NewRemoveOrgMemberRequest

func NewRemoveOrgMemberRequest(server string, member string) (*http.Request, error)

NewRemoveOrgMemberRequest generates requests for RemoveOrgMember

func NewSetDirectoryCredentialsRequest

func NewSetDirectoryCredentialsRequest(server string, env string, directory string, body SetDirectoryCredentialsJSONRequestBody) (*http.Request, error)

NewSetDirectoryCredentialsRequest calls the generic SetDirectoryCredentials builder with application/json body

func NewSetDirectoryCredentialsRequestWithBody

func NewSetDirectoryCredentialsRequestWithBody(server string, env string, directory string, contentType string, body io.Reader) (*http.Request, error)

NewSetDirectoryCredentialsRequestWithBody generates requests for SetDirectoryCredentials with any type of body

func NewSyncDirectoryRequest

func NewSyncDirectoryRequest(server string, env string, directory string) (*http.Request, error)

NewSyncDirectoryRequest generates requests for SyncDirectory

func NewUpdateAPIKeyRequest

func NewUpdateAPIKeyRequest(server string, apiKey string, body UpdateAPIKeyJSONRequestBody) (*http.Request, error)

NewUpdateAPIKeyRequest calls the generic UpdateAPIKey builder with application/json body

func NewUpdateAPIKeyRequestWithBody

func NewUpdateAPIKeyRequestWithBody(server string, apiKey string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAPIKeyRequestWithBody generates requests for UpdateAPIKey with any type of body

func NewUpdateAccountRequest

func NewUpdateAccountRequest(server string, account string, body UpdateAccountJSONRequestBody) (*http.Request, error)

NewUpdateAccountRequest calls the generic UpdateAccount builder with application/json body

func NewUpdateAccountRequestWithBody

func NewUpdateAccountRequestWithBody(server string, account string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAccountRequestWithBody generates requests for UpdateAccount with any type of body

func NewUpdateEnvRequest

func NewUpdateEnvRequest(server string, env string, body UpdateEnvJSONRequestBody) (*http.Request, error)

NewUpdateEnvRequest calls the generic UpdateEnv builder with application/json body

func NewUpdateEnvRequestWithBody

func NewUpdateEnvRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateEnvRequestWithBody generates requests for UpdateEnv with any type of body

func NewUpdateOrgMemberRequest

func NewUpdateOrgMemberRequest(server string, member string, body UpdateOrgMemberJSONRequestBody) (*http.Request, error)

NewUpdateOrgMemberRequest calls the generic UpdateOrgMember builder with application/json body

func NewUpdateOrgMemberRequestWithBody

func NewUpdateOrgMemberRequestWithBody(server string, member string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateOrgMemberRequestWithBody generates requests for UpdateOrgMember with any type of body

func NewUpdateOrgRequest

func NewUpdateOrgRequest(server string, body UpdateOrgJSONRequestBody) (*http.Request, error)

NewUpdateOrgRequest calls the generic UpdateOrg builder with application/json body

func NewUpdateOrgRequestWithBody

func NewUpdateOrgRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateOrgRequestWithBody generates requests for UpdateOrg with any type of body

func NewUpdateRequestRequest

func NewUpdateRequestRequest(server string, requestID string, body UpdateRequestJSONRequestBody) (*http.Request, error)

NewUpdateRequestRequest calls the generic UpdateRequest builder with application/json body

func NewUpdateRequestRequestWithBody

func NewUpdateRequestRequestWithBody(server string, requestID string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateRequestRequestWithBody generates requests for UpdateRequest with any type of body

func NewUpdateTemplateRequest

func NewUpdateTemplateRequest(server string, env string, template string, body UpdateTemplateJSONRequestBody) (*http.Request, error)

NewUpdateTemplateRequest calls the generic UpdateTemplate builder with application/json body

func NewUpdateTemplateRequestWithBody

func NewUpdateTemplateRequestWithBody(server string, env string, template string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTemplateRequestWithBody generates requests for UpdateTemplate with any type of body

func NewUploadAccountPhotoRequestWithBody

func NewUploadAccountPhotoRequestWithBody(server string, account string, contentType string, body io.Reader) (*http.Request, error)

NewUploadAccountPhotoRequestWithBody generates requests for UploadAccountPhoto with any type of body

func NewUploadLogoRequestWithBody

func NewUploadLogoRequestWithBody(server string, env string, params *UploadLogoParams, contentType string, body io.Reader) (*http.Request, error)

NewUploadLogoRequestWithBody generates requests for UploadLogo with any type of body

Types

type APIKey

type APIKey struct {
	// ID The unique identifier for the API key
	ID string `json:"id"`

	// Name A descriptive name for the API key
	Name string `json:"name"`

	// CreatedAt When the API key was created
	CreatedAt time.Time `json:"created_at"`
	Enabled   bool      `json:"enabled"`

	// EnvIDs The unique identifier for the environments this API key belongs to, or `["*"]` if the key applies to all environments.
	EnvIDs []string `json:"envs"`
	Role   Role     `json:"role"`
}

APIKey defines model for APIKey.

type APIKeyUpdateRequest

type APIKeyUpdateRequest struct {
	// Name A descriptive name for the API key
	Name *string `json:"name,omitempty"`

	// Enabled `true` if the API key is enabled, or `false` if it cannot be used.
	Enabled *bool `json:"enabled,omitempty"`
	Role    *Role `json:"role,omitempty"`

	// EnvIDs The unique identifier for the environments this API key belongs to, or `["*"]` if the key applies to all environments.
	EnvIDs []string `json:"envs,omitempty"`
}

APIKeyUpdateRequest defines model for APIKeyUpdateRequest.

type Account

type Account struct {
	// ID The Nametag identifier for the account.
	ID string `json:"id"`

	// DirectoryIdentifiers The identifiers for the account used by the directory (typically an email address, username)
	DirectoryIdentifiers []string `json:"directory_identifiers"`

	// DirectoryImmutableIdentifier The unchanging identifier for the account used by the directory. Most directories have an UUID or other opaque identifier that doesn't change even when `directory_identifiers` changes.
	DirectoryImmutableIdentifier string `json:"directory_immutable_identifier"`

	// Name The person's name, according to the directory
	Name string `json:"name"`

	// Subject The Nametag Subject for this person, if the account has been bound to a `subject`. Null otherwise.
	Subject *string `json:"subject,omitempty"`

	// HaveBirthDate true if the person's expected birth date has been set for the directory.
	HaveBirthDate *bool         `json:"have_birth_date,omitempty"`
	Photo         *AccountPhoto `json:"photo,omitempty"`
}

Account defines model for Account.

type AccountPhoto

type AccountPhoto struct {
	// SHA256 The SHA256 hash of the uploaded image.
	SHA256 string `json:"sha256"`

	// CreatedAt The time when the image was added.
	CreatedAt time.Time `json:"created_at"`
}

AccountPhoto defines model for AccountPhoto.

type AccountUpdateRequest

type AccountUpdateRequest struct {
	// Subject The subject for this person. Set this to an empty string to remove the binding for this person.
	Subject *string `json:"subject,omitempty"`

	// BirthDate The subject's date of birth. If this is set prior to the account being bound to a `subject`, then the birth  date on their ID must match this date.
	// You can also specify the SHA256 hash of the person's email address and birth date. The format of the field should be `sha256:HASH` where `HASH` is the hex-encoded SHA256 hash of the lower-cased email, a newline, and the birth date in the format `YYYY-MM-DD`.  For example, if the person's birth date is January 2nd, 2006 then you hash "alice@example.com\n2006-01-02" and the resulting hash is `sha256:7dc9eb50ce8330b4691590447d86b9caf6f7f1fe88b029ce571cf8533cc62c89`.
	// Similarly you can specify `hmac-sha256:HMAC` where `HMAC` is the hex-encoded HMAC SHA256 hash of same string as above using the webhook secret as the key. If the webhook shared secret is  `webhook-0194fdc2fa2ffcc041d3ff12045b73c86e4ff95ff662a5eee82abdf44a2d0b75` then you could specify  `hmac-sha256:88a0f947381a5a6fe1bed4b89f932140267bec6d90be4decc8f758676b4cd302`.
	BirthDate *string `json:"birth_date,omitempty"`
}

AccountUpdateRequest defines model for AccountUpdateRequest.

type AccountsList

type AccountsList struct {
	// Accounts The list of accounts
	Accounts []Account `json:"accounts"`
}

AccountsList defines model for AccountsList.

type AuthorizeResponse

type AuthorizeResponse struct {
	ErrorMessage      string          `json:"error_message,omitempty"`
	RedirectURI       string          `json:"redirect_uri,omitempty"`
	EnvName           string          `json:"env_name,omitempty"`
	QRCode            []byte          `json:"qrcode,omitempty"`
	InstallTicket     string          `json:"install_ticket,omitempty"`
	RequestID         string          `json:"request,omitempty"`
	SessionToken      string          `json:"session_token,omitempty"`
	AppClipExperience string          `json:"app_clip_experience,omitempty"`
	Return            AuthorizeReturn `json:"return"`
}

AuthorizeResponse defines model for AuthorizeResponse.

type AuthorizeReturn

type AuthorizeReturn string

AuthorizeReturn defines model for AuthorizeReturn.

const (
	AuthorizeReturnChrome  AuthorizeReturn = "chrome"
	AuthorizeReturnFirefox AuthorizeReturn = "firefox"
	AuthorizeReturnHTTPS   AuthorizeReturn = "https"
	AuthorizeReturnNone    AuthorizeReturn = ""
)

Defines values for AuthorizeReturn.

type AuthorizeStatus

type AuthorizeStatus int

AuthorizeStatus defines model for AuthorizeStatus.

const (
	AuthorizeStatusComplete AuthorizeStatus = 200
	AuthorizeStatusExpired  AuthorizeStatus = 510
	AuthorizeStatusPending  AuthorizeStatus = 100
	AuthorizeStatusRejected AuthorizeStatus = 403
)

Defines values for AuthorizeStatus.

type BadRequestResponse

type BadRequestResponse struct {
	// Status The status code for the request. Always 400, meaning the request was invalid
	Status BadRequestResponseStatus `json:"status"`

	// Errors A set of descriptive error messages that caused the request to be invalid
	Errors []string `json:"errors"`
}

BadRequestResponse defines model for BadRequestResponse.

type BadRequestResponseStatus

type BadRequestResponseStatus int

BadRequestResponseStatus The status code for the request. Always 400, meaning the request was invalid

const (
	BadRequestResponseStatusN400 BadRequestResponseStatus = 400
)

Defines values for BadRequestResponseStatus.

type BulkRequest

type BulkRequest struct {
	// Requests A list of property requests, one for each person about whom you are requesting information.
	Requests []BulkRequestItem `json:"requests"`
}

BulkRequest defines model for BulkRequest.

type BulkRequestItem

type BulkRequestItem struct {
	// Subject The subject of the request. This is the person whose properties are being requested.
	Subject string `json:"subject"`

	// Scopes Which scopes you are requesting for this person.
	Scopes []Scope `json:"scopes"`
}

BulkRequestItem defines model for BulkRequestItem.

type BulkResponse

type BulkResponse struct {
	// Responses A list of responses for each person requested.
	Responses []PropertiesResponse `json:"data"`
}

BulkResponse defines model for BulkResponse.

type BulkUploadAccountPhotosParams

type BulkUploadAccountPhotosParams struct {
	// Directory Modify only accounts in the specified directory(s)
	Directory string `form:"directory" json:"directory"`
}

BulkUploadAccountPhotosParams defines parameters for BulkUploadAccountPhotos.

type BulkUploadAccountPhotosResp

type BulkUploadAccountPhotosResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BulkUploadAccountPhotosResponse
	JSON400      *N400
}

func ParseBulkUploadAccountPhotosResp

func ParseBulkUploadAccountPhotosResp(rsp *http.Response) (*BulkUploadAccountPhotosResp, error)

ParseBulkUploadAccountPhotosResp parses an HTTP response from a BulkUploadAccountPhotosWithResponse call

func (BulkUploadAccountPhotosResp) Status

Status returns HTTPResponse.Status

func (BulkUploadAccountPhotosResp) StatusCode

func (r BulkUploadAccountPhotosResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BulkUploadAccountPhotosResponse

type BulkUploadAccountPhotosResponse struct {
	// Files A list of responses, each corresponding to a file in the uploaded archive.
	Files []BulkUploadAccountPhotosResponseItem `json:"files"`
}

BulkUploadAccountPhotosResponse defines model for BulkUploadAccountPhotosResponse.

type BulkUploadAccountPhotosResponseItem

type BulkUploadAccountPhotosResponseItem struct {
	// Filename The name of the file
	Filename string `json:"filename"`

	// AccountID The Nametag identifier for the account that matched this file. If this field is absent, then  the file was not matched to an existing account.
	AccountID *string `json:"account_id,omitempty"`

	// DirectoryIdentifiers The identifiers for the account used by the directory (typically an email address, username)
	DirectoryIdentifiers *[]string `json:"directory_identifiers,omitempty"`

	// DirectoryImmutableIdentifier The unchanging identifier for the account used by the directory. Most directories have an UUID or other opaque identifier that doesn't change even when `directory_identifiers` changes.
	DirectoryImmutableIdentifier *string `json:"directory_immutable_identifier,omitempty"`

	// Status This field is 200 if adding the photo was successful, 404 if an account could not be found,  400 if the image is invalid, or 422 if the image contains multiple faces, doesn't match the existing selfie, or no face at all.
	Status int `json:"status"`

	// Error A human readable error message describing the reason a file could not be processed.
	Error *string `json:"error,omitempty"`
}

BulkUploadAccountPhotosResponseItem defines model for BulkUploadAccountPhotosResponseItem.

type CancelRequestResp

type CancelRequestResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseCancelRequestResp

func ParseCancelRequestResp(rsp *http.Response) (*CancelRequestResp, error)

ParseCancelRequestResp parses an HTTP response from a CancelRequestWithResponse call

func (CancelRequestResp) Status

func (r CancelRequestResp) Status() string

Status returns HTTPResponse.Status

func (CancelRequestResp) StatusCode

func (r CancelRequestResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CancelResponse

type CancelResponse struct {
	RedirectURI string `json:"redirect_uri"`
}

CancelResponse defines model for CancelResponse.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) BulkUploadAccountPhotosWithBody

func (c *Client) BulkUploadAccountPhotosWithBody(ctx context.Context, params *BulkUploadAccountPhotosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CancelRequest

func (c *Client) CancelRequest(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ComparePeople

func (c *Client) ComparePeople(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ComparePeopleWithBody

func (c *Client) ComparePeopleWithBody(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CompareSelfieWithBody

func (c *Client) CompareSelfieWithBody(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAPIKey

func (c *Client) CreateAPIKey(ctx context.Context, body CreateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAPIKeyWithBody

func (c *Client) CreateAPIKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDirectory

func (c *Client) CreateDirectory(ctx context.Context, env string, body CreateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDirectoryWithBody

func (c *Client) CreateDirectoryWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnv

func (c *Client) CreateEnv(ctx context.Context, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnvWithBody

func (c *Client) CreateEnvWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateRequest

func (c *Client) CreateRequest(ctx context.Context, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateRequestWithBody

func (c *Client) CreateRequestWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTemplate

func (c *Client) CreateTemplate(ctx context.Context, env string, body CreateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTemplateWithBody

func (c *Client) CreateTemplateWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteAPIKey

func (c *Client) DeleteAPIKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteDirectory

func (c *Client) DeleteDirectory(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteEnv

func (c *Client) DeleteEnv(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)
func (c *Client) DeleteLogo(ctx context.Context, env string, params *DeleteLogoParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeletePersonProperties

func (c *Client) DeletePersonProperties(ctx context.Context, subject string, scopes string, params *DeletePersonPropertiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteTemplate

func (c *Client) DeleteTemplate(ctx context.Context, env string, template string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAPIKey

func (c *Client) GetAPIKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAccount

func (c *Client) GetAccount(ctx context.Context, account string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBulkPeopleProperties

func (c *Client) GetBulkPeopleProperties(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBulkPeoplePropertiesWithBody

func (c *Client) GetBulkPeoplePropertiesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDirectory

func (c *Client) GetDirectory(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDirectoryAuthorizationURL

func (c *Client) GetDirectoryAuthorizationURL(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEnv

func (c *Client) GetEnv(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEnvRequest

func (c *Client) GetEnvRequest(ctx context.Context, env string, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOrg

func (c *Client) GetOrg(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetPersonProperties

func (c *Client) GetPersonProperties(ctx context.Context, subject string, scopes string, params *GetPersonPropertiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRequest

func (c *Client) GetRequest(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InviteOrgMember

func (c *Client) InviteOrgMember(ctx context.Context, body InviteOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InviteOrgMemberWithBody

func (c *Client) InviteOrgMemberWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAPIKeys

func (c *Client) ListAPIKeys(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAccounts

func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListDirectories

func (c *Client) ListDirectories(ctx context.Context, env string, params *ListDirectoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListEnvRequests

func (c *Client) ListEnvRequests(ctx context.Context, env string, params *ListEnvRequestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListEnvs

func (c *Client) ListEnvs(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListOrgMembers

func (c *Client) ListOrgMembers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListWebhooks

func (c *Client) ListWebhooks(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2Authorize

func (c *Client) Oauth2Authorize(ctx context.Context, params *Oauth2AuthorizeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2AuthorizeIframe

func (c *Client) Oauth2AuthorizeIframe(ctx context.Context, params *Oauth2AuthorizeIframeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2AuthorizeWithExperience

func (c *Client) Oauth2AuthorizeWithExperience(ctx context.Context, experience string, params *Oauth2AuthorizeWithExperienceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2AuthorizeWithRequest

func (c *Client) Oauth2AuthorizeWithRequest(ctx context.Context, requestID string, params *Oauth2AuthorizeWithRequestParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2AuthorizeWithRequestAndExperience

func (c *Client) Oauth2AuthorizeWithRequestAndExperience(ctx context.Context, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2Cancel

func (c *Client) Oauth2Cancel(ctx context.Context, requestID string, params *Oauth2CancelParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2Logout

func (c *Client) Oauth2Logout(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2Poll

func (c *Client) Oauth2Poll(ctx context.Context, requestID string, params *Oauth2PollParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2TokenWithBody

func (c *Client) Oauth2TokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Oauth2TokenWithFormdataBody

func (c *Client) Oauth2TokenWithFormdataBody(ctx context.Context, body Oauth2TokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RemoveOrgMember

func (c *Client) RemoveOrgMember(ctx context.Context, member string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetDirectoryCredentials

func (c *Client) SetDirectoryCredentials(ctx context.Context, env string, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetDirectoryCredentialsWithBody

func (c *Client) SetDirectoryCredentialsWithBody(ctx context.Context, env string, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SyncDirectory

func (c *Client) SyncDirectory(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAPIKey

func (c *Client) UpdateAPIKey(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAPIKeyWithBody

func (c *Client) UpdateAPIKeyWithBody(ctx context.Context, apiKey string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAccount

func (c *Client) UpdateAccount(ctx context.Context, account string, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAccountWithBody

func (c *Client) UpdateAccountWithBody(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEnv

func (c *Client) UpdateEnv(ctx context.Context, env string, body UpdateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEnvWithBody

func (c *Client) UpdateEnvWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateOrg

func (c *Client) UpdateOrg(ctx context.Context, body UpdateOrgJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateOrgMember

func (c *Client) UpdateOrgMember(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateOrgMemberWithBody

func (c *Client) UpdateOrgMemberWithBody(ctx context.Context, member string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateOrgWithBody

func (c *Client) UpdateOrgWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateRequest

func (c *Client) UpdateRequest(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateRequestWithBody

func (c *Client) UpdateRequestWithBody(ctx context.Context, requestID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTemplate

func (c *Client) UpdateTemplate(ctx context.Context, env string, template string, body UpdateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTemplateWithBody

func (c *Client) UpdateTemplateWithBody(ctx context.Context, env string, template string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UploadAccountPhotoWithBody

func (c *Client) UploadAccountPhotoWithBody(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UploadLogoWithBody

func (c *Client) UploadLogoWithBody(ctx context.Context, env string, params *UploadLogoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// BulkUploadAccountPhotosWithBody request with any body
	BulkUploadAccountPhotosWithBody(ctx context.Context, params *BulkUploadAccountPhotosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAccounts request
	ListAccounts(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAccount request
	GetAccount(ctx context.Context, account string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAccountWithBody request with any body
	UpdateAccountWithBody(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAccount(ctx context.Context, account string, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UploadAccountPhotoWithBody request with any body
	UploadAccountPhotoWithBody(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAPIKeys request
	ListAPIKeys(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateAPIKeyWithBody request with any body
	CreateAPIKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateAPIKey(ctx context.Context, body CreateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteAPIKey request
	DeleteAPIKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAPIKey request
	GetAPIKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAPIKeyWithBody request with any body
	UpdateAPIKeyWithBody(ctx context.Context, apiKey string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAPIKey(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Oauth2Cancel request
	Oauth2Cancel(ctx context.Context, requestID string, params *Oauth2CancelParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Oauth2Poll request
	Oauth2Poll(ctx context.Context, requestID string, params *Oauth2PollParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListEnvs request
	ListEnvs(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateEnvWithBody request with any body
	CreateEnvWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateEnv(ctx context.Context, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteEnv request
	DeleteEnv(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEnv request
	GetEnv(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateEnvWithBody request with any body
	UpdateEnvWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateEnv(ctx context.Context, env string, body UpdateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListDirectories request
	ListDirectories(ctx context.Context, env string, params *ListDirectoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDirectoryWithBody request with any body
	CreateDirectoryWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDirectory(ctx context.Context, env string, body CreateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteDirectory request
	DeleteDirectory(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDirectory request
	GetDirectory(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDirectoryAuthorizationURL request
	GetDirectoryAuthorizationURL(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetDirectoryCredentialsWithBody request with any body
	SetDirectoryCredentialsWithBody(ctx context.Context, env string, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SetDirectoryCredentials(ctx context.Context, env string, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SyncDirectory request
	SyncDirectory(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

	DeleteLogo(ctx context.Context, env string, params *DeleteLogoParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UploadLogoWithBody request with any body
	UploadLogoWithBody(ctx context.Context, env string, params *UploadLogoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListEnvRequests request
	ListEnvRequests(ctx context.Context, env string, params *ListEnvRequestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEnvRequest request
	GetEnvRequest(ctx context.Context, env string, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTemplateWithBody request with any body
	CreateTemplateWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateTemplate(ctx context.Context, env string, body CreateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteTemplate request
	DeleteTemplate(ctx context.Context, env string, template string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateTemplateWithBody request with any body
	UpdateTemplateWithBody(ctx context.Context, env string, template string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateTemplate(ctx context.Context, env string, template string, body UpdateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListWebhooks request
	ListWebhooks(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrg request
	GetOrg(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateOrgWithBody request with any body
	UpdateOrgWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateOrg(ctx context.Context, body UpdateOrgJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListOrgMembers request
	ListOrgMembers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InviteOrgMemberWithBody request with any body
	InviteOrgMemberWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	InviteOrgMember(ctx context.Context, body InviteOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RemoveOrgMember request
	RemoveOrgMember(ctx context.Context, member string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateOrgMemberWithBody request with any body
	UpdateOrgMemberWithBody(ctx context.Context, member string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateOrgMember(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRequestWithBody request with any body
	CreateRequestWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateRequest(ctx context.Context, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelRequest request
	CancelRequest(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRequest request
	GetRequest(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateRequestWithBody request with any body
	UpdateRequestWithBody(ctx context.Context, requestID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateRequest(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Oauth2Authorize request
	Oauth2Authorize(ctx context.Context, params *Oauth2AuthorizeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Oauth2AuthorizeIframe request
	Oauth2AuthorizeIframe(ctx context.Context, params *Oauth2AuthorizeIframeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Oauth2AuthorizeWithRequest request
	Oauth2AuthorizeWithRequest(ctx context.Context, requestID string, params *Oauth2AuthorizeWithRequestParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Oauth2Logout request
	Oauth2Logout(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBulkPeoplePropertiesWithBody request with any body
	GetBulkPeoplePropertiesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	GetBulkPeopleProperties(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ComparePeopleWithBody request with any body
	ComparePeopleWithBody(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ComparePeople(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CompareSelfieWithBody request with any body
	CompareSelfieWithBody(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeletePersonProperties request
	DeletePersonProperties(ctx context.Context, subject string, scopes string, params *DeletePersonPropertiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPersonProperties request
	GetPersonProperties(ctx context.Context, subject string, scopes string, params *GetPersonPropertiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Oauth2TokenWithBody request with any body
	Oauth2TokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	Oauth2TokenWithFormdataBody(ctx context.Context, body Oauth2TokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Oauth2AuthorizeWithExperience request
	Oauth2AuthorizeWithExperience(ctx context.Context, experience string, params *Oauth2AuthorizeWithExperienceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Oauth2AuthorizeWithRequestAndExperience request
	Oauth2AuthorizeWithRequestAndExperience(ctx context.Context, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) BulkUploadAccountPhotosWithBodyWithResponse

func (c *ClientWithResponses) BulkUploadAccountPhotosWithBodyWithResponse(ctx context.Context, params *BulkUploadAccountPhotosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUploadAccountPhotosResp, error)

BulkUploadAccountPhotosWithBodyWithResponse request with arbitrary body returning *BulkUploadAccountPhotosResp

func (*ClientWithResponses) CancelRequestWithResponse

func (c *ClientWithResponses) CancelRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*CancelRequestResp, error)

CancelRequestWithResponse request returning *CancelRequestResp

func (*ClientWithResponses) ComparePeopleWithBodyWithResponse

func (c *ClientWithResponses) ComparePeopleWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ComparePeopleResp, error)

ComparePeopleWithBodyWithResponse request with arbitrary body returning *ComparePeopleResp

func (*ClientWithResponses) ComparePeopleWithResponse

func (c *ClientWithResponses) ComparePeopleWithResponse(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, reqEditors ...RequestEditorFn) (*ComparePeopleResp, error)

func (*ClientWithResponses) CompareSelfieWithBodyWithResponse

func (c *ClientWithResponses) CompareSelfieWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CompareSelfieResp, error)

CompareSelfieWithBodyWithResponse request with arbitrary body returning *CompareSelfieResp

func (*ClientWithResponses) CreateAPIKeyWithBodyWithResponse

func (c *ClientWithResponses) CreateAPIKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAPIKeyResp, error)

CreateAPIKeyWithBodyWithResponse request with arbitrary body returning *CreateAPIKeyResp

func (*ClientWithResponses) CreateAPIKeyWithResponse

func (c *ClientWithResponses) CreateAPIKeyWithResponse(ctx context.Context, body CreateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAPIKeyResp, error)

func (*ClientWithResponses) CreateDirectoryWithBodyWithResponse

func (c *ClientWithResponses) CreateDirectoryWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDirectoryResp, error)

CreateDirectoryWithBodyWithResponse request with arbitrary body returning *CreateDirectoryResp

func (*ClientWithResponses) CreateDirectoryWithResponse

func (c *ClientWithResponses) CreateDirectoryWithResponse(ctx context.Context, env string, body CreateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDirectoryResp, error)

func (*ClientWithResponses) CreateEnvWithBodyWithResponse

func (c *ClientWithResponses) CreateEnvWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvResp, error)

CreateEnvWithBodyWithResponse request with arbitrary body returning *CreateEnvResp

func (*ClientWithResponses) CreateEnvWithResponse

func (c *ClientWithResponses) CreateEnvWithResponse(ctx context.Context, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvResp, error)

func (*ClientWithResponses) CreateRequestWithBodyWithResponse

func (c *ClientWithResponses) CreateRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRequestResp, error)

CreateRequestWithBodyWithResponse request with arbitrary body returning *CreateRequestResp

func (*ClientWithResponses) CreateRequestWithResponse

func (c *ClientWithResponses) CreateRequestWithResponse(ctx context.Context, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRequestResp, error)

func (*ClientWithResponses) CreateTemplateWithBodyWithResponse

func (c *ClientWithResponses) CreateTemplateWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTemplateResp, error)

CreateTemplateWithBodyWithResponse request with arbitrary body returning *CreateTemplateResp

func (*ClientWithResponses) CreateTemplateWithResponse

func (c *ClientWithResponses) CreateTemplateWithResponse(ctx context.Context, env string, body CreateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTemplateResp, error)

func (*ClientWithResponses) DeleteAPIKeyWithResponse

func (c *ClientWithResponses) DeleteAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*DeleteAPIKeyResp, error)

DeleteAPIKeyWithResponse request returning *DeleteAPIKeyResp

func (*ClientWithResponses) DeleteDirectoryWithResponse

func (c *ClientWithResponses) DeleteDirectoryWithResponse(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryResp, error)

DeleteDirectoryWithResponse request returning *DeleteDirectoryResp

func (*ClientWithResponses) DeleteEnvWithResponse

func (c *ClientWithResponses) DeleteEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*DeleteEnvResp, error)

DeleteEnvWithResponse request returning *DeleteEnvResp

func (*ClientWithResponses) DeleteLogoWithResponse

func (c *ClientWithResponses) DeleteLogoWithResponse(ctx context.Context, env string, params *DeleteLogoParams, reqEditors ...RequestEditorFn) (*DeleteLogoResp, error)

DeleteLogoWithResponse request returning *DeleteLogoResp

func (*ClientWithResponses) DeletePersonPropertiesWithResponse

func (c *ClientWithResponses) DeletePersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, params *DeletePersonPropertiesParams, reqEditors ...RequestEditorFn) (*DeletePersonPropertiesResp, error)

DeletePersonPropertiesWithResponse request returning *DeletePersonPropertiesResp

func (*ClientWithResponses) DeleteTemplateWithResponse

func (c *ClientWithResponses) DeleteTemplateWithResponse(ctx context.Context, env string, template string, reqEditors ...RequestEditorFn) (*DeleteTemplateResp, error)

DeleteTemplateWithResponse request returning *DeleteTemplateResp

func (*ClientWithResponses) GetAPIKeyWithResponse

func (c *ClientWithResponses) GetAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*GetAPIKeyResp, error)

GetAPIKeyWithResponse request returning *GetAPIKeyResp

func (*ClientWithResponses) GetAccountWithResponse

func (c *ClientWithResponses) GetAccountWithResponse(ctx context.Context, account string, reqEditors ...RequestEditorFn) (*GetAccountResp, error)

GetAccountWithResponse request returning *GetAccountResp

func (*ClientWithResponses) GetBulkPeoplePropertiesWithBodyWithResponse

func (c *ClientWithResponses) GetBulkPeoplePropertiesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetBulkPeoplePropertiesResp, error)

GetBulkPeoplePropertiesWithBodyWithResponse request with arbitrary body returning *GetBulkPeoplePropertiesResp

func (*ClientWithResponses) GetBulkPeoplePropertiesWithResponse

func (c *ClientWithResponses) GetBulkPeoplePropertiesWithResponse(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*GetBulkPeoplePropertiesResp, error)

func (*ClientWithResponses) GetDirectoryAuthorizationURLWithResponse

func (c *ClientWithResponses) GetDirectoryAuthorizationURLWithResponse(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryAuthorizationURLResp, error)

GetDirectoryAuthorizationURLWithResponse request returning *GetDirectoryAuthorizationURLResp

func (*ClientWithResponses) GetDirectoryWithResponse

func (c *ClientWithResponses) GetDirectoryWithResponse(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryResp, error)

GetDirectoryWithResponse request returning *GetDirectoryResp

func (*ClientWithResponses) GetEnvRequestWithResponse

func (c *ClientWithResponses) GetEnvRequestWithResponse(ctx context.Context, env string, requestID string, reqEditors ...RequestEditorFn) (*GetEnvRequestResp, error)

GetEnvRequestWithResponse request returning *GetEnvRequestResp

func (*ClientWithResponses) GetEnvWithResponse

func (c *ClientWithResponses) GetEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*GetEnvResp, error)

GetEnvWithResponse request returning *GetEnvResp

func (*ClientWithResponses) GetOrgWithResponse

func (c *ClientWithResponses) GetOrgWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrgResp, error)

GetOrgWithResponse request returning *GetOrgResp

func (*ClientWithResponses) GetPersonPropertiesWithResponse

func (c *ClientWithResponses) GetPersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, params *GetPersonPropertiesParams, reqEditors ...RequestEditorFn) (*GetPersonPropertiesResp, error)

GetPersonPropertiesWithResponse request returning *GetPersonPropertiesResp

func (*ClientWithResponses) GetRequestWithResponse

func (c *ClientWithResponses) GetRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*GetRequestResp, error)

GetRequestWithResponse request returning *GetRequestResp

func (*ClientWithResponses) InviteOrgMemberWithBodyWithResponse

func (c *ClientWithResponses) InviteOrgMemberWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteOrgMemberResp, error)

InviteOrgMemberWithBodyWithResponse request with arbitrary body returning *InviteOrgMemberResp

func (*ClientWithResponses) InviteOrgMemberWithResponse

func (c *ClientWithResponses) InviteOrgMemberWithResponse(ctx context.Context, body InviteOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteOrgMemberResp, error)

func (*ClientWithResponses) ListAPIKeysWithResponse

func (c *ClientWithResponses) ListAPIKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListAPIKeysResp, error)

ListAPIKeysWithResponse request returning *ListAPIKeysResp

func (*ClientWithResponses) ListAccountsWithResponse

func (c *ClientWithResponses) ListAccountsWithResponse(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*ListAccountsResp, error)

ListAccountsWithResponse request returning *ListAccountsResp

func (*ClientWithResponses) ListDirectoriesWithResponse

func (c *ClientWithResponses) ListDirectoriesWithResponse(ctx context.Context, env string, params *ListDirectoriesParams, reqEditors ...RequestEditorFn) (*ListDirectoriesResp, error)

ListDirectoriesWithResponse request returning *ListDirectoriesResp

func (*ClientWithResponses) ListEnvRequestsWithResponse

func (c *ClientWithResponses) ListEnvRequestsWithResponse(ctx context.Context, env string, params *ListEnvRequestsParams, reqEditors ...RequestEditorFn) (*ListEnvRequestsResp, error)

ListEnvRequestsWithResponse request returning *ListEnvRequestsResp

func (*ClientWithResponses) ListEnvsWithResponse

func (c *ClientWithResponses) ListEnvsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListEnvsResp, error)

ListEnvsWithResponse request returning *ListEnvsResp

func (*ClientWithResponses) ListOrgMembersWithResponse

func (c *ClientWithResponses) ListOrgMembersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListOrgMembersResp, error)

ListOrgMembersWithResponse request returning *ListOrgMembersResp

func (*ClientWithResponses) ListWebhooksWithResponse

func (c *ClientWithResponses) ListWebhooksWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListWebhooksResp, error)

ListWebhooksWithResponse request returning *ListWebhooksResp

func (*ClientWithResponses) Oauth2AuthorizeIframeWithResponse

func (c *ClientWithResponses) Oauth2AuthorizeIframeWithResponse(ctx context.Context, params *Oauth2AuthorizeIframeParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeIframeResp, error)

Oauth2AuthorizeIframeWithResponse request returning *Oauth2AuthorizeIframeResp

func (*ClientWithResponses) Oauth2AuthorizeWithExperienceWithResponse

func (c *ClientWithResponses) Oauth2AuthorizeWithExperienceWithResponse(ctx context.Context, experience string, params *Oauth2AuthorizeWithExperienceParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithExperienceResp, error)

Oauth2AuthorizeWithExperienceWithResponse request returning *Oauth2AuthorizeWithExperienceResp

func (*ClientWithResponses) Oauth2AuthorizeWithRequestAndExperienceWithResponse

func (c *ClientWithResponses) Oauth2AuthorizeWithRequestAndExperienceWithResponse(ctx context.Context, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithRequestAndExperienceResp, error)

Oauth2AuthorizeWithRequestAndExperienceWithResponse request returning *Oauth2AuthorizeWithRequestAndExperienceResp

func (*ClientWithResponses) Oauth2AuthorizeWithRequestWithResponse

func (c *ClientWithResponses) Oauth2AuthorizeWithRequestWithResponse(ctx context.Context, requestID string, params *Oauth2AuthorizeWithRequestParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithRequestResp, error)

Oauth2AuthorizeWithRequestWithResponse request returning *Oauth2AuthorizeWithRequestResp

func (*ClientWithResponses) Oauth2AuthorizeWithResponse

func (c *ClientWithResponses) Oauth2AuthorizeWithResponse(ctx context.Context, params *Oauth2AuthorizeParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeResp, error)

Oauth2AuthorizeWithResponse request returning *Oauth2AuthorizeResp

func (*ClientWithResponses) Oauth2CancelWithResponse

func (c *ClientWithResponses) Oauth2CancelWithResponse(ctx context.Context, requestID string, params *Oauth2CancelParams, reqEditors ...RequestEditorFn) (*Oauth2CancelResp, error)

Oauth2CancelWithResponse request returning *Oauth2CancelResp

func (*ClientWithResponses) Oauth2LogoutWithResponse

func (c *ClientWithResponses) Oauth2LogoutWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*Oauth2LogoutResp, error)

Oauth2LogoutWithResponse request returning *Oauth2LogoutResp

func (*ClientWithResponses) Oauth2PollWithResponse

func (c *ClientWithResponses) Oauth2PollWithResponse(ctx context.Context, requestID string, params *Oauth2PollParams, reqEditors ...RequestEditorFn) (*Oauth2PollResp, error)

Oauth2PollWithResponse request returning *Oauth2PollResp

func (*ClientWithResponses) Oauth2TokenWithBodyWithResponse

func (c *ClientWithResponses) Oauth2TokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*Oauth2TokenResp, error)

Oauth2TokenWithBodyWithResponse request with arbitrary body returning *Oauth2TokenResp

func (*ClientWithResponses) Oauth2TokenWithFormdataBodyWithResponse

func (c *ClientWithResponses) Oauth2TokenWithFormdataBodyWithResponse(ctx context.Context, body Oauth2TokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*Oauth2TokenResp, error)

func (*ClientWithResponses) RemoveOrgMemberWithResponse

func (c *ClientWithResponses) RemoveOrgMemberWithResponse(ctx context.Context, member string, reqEditors ...RequestEditorFn) (*RemoveOrgMemberResp, error)

RemoveOrgMemberWithResponse request returning *RemoveOrgMemberResp

func (*ClientWithResponses) SetDirectoryCredentialsWithBodyWithResponse

func (c *ClientWithResponses) SetDirectoryCredentialsWithBodyWithResponse(ctx context.Context, env string, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetDirectoryCredentialsResp, error)

SetDirectoryCredentialsWithBodyWithResponse request with arbitrary body returning *SetDirectoryCredentialsResp

func (*ClientWithResponses) SetDirectoryCredentialsWithResponse

func (c *ClientWithResponses) SetDirectoryCredentialsWithResponse(ctx context.Context, env string, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*SetDirectoryCredentialsResp, error)

func (*ClientWithResponses) SyncDirectoryWithResponse

func (c *ClientWithResponses) SyncDirectoryWithResponse(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*SyncDirectoryResp, error)

SyncDirectoryWithResponse request returning *SyncDirectoryResp

func (*ClientWithResponses) UpdateAPIKeyWithBodyWithResponse

func (c *ClientWithResponses) UpdateAPIKeyWithBodyWithResponse(ctx context.Context, apiKey string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResp, error)

UpdateAPIKeyWithBodyWithResponse request with arbitrary body returning *UpdateAPIKeyResp

func (*ClientWithResponses) UpdateAPIKeyWithResponse

func (c *ClientWithResponses) UpdateAPIKeyWithResponse(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResp, error)

func (*ClientWithResponses) UpdateAccountWithBodyWithResponse

func (c *ClientWithResponses) UpdateAccountWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountResp, error)

UpdateAccountWithBodyWithResponse request with arbitrary body returning *UpdateAccountResp

func (*ClientWithResponses) UpdateAccountWithResponse

func (c *ClientWithResponses) UpdateAccountWithResponse(ctx context.Context, account string, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountResp, error)

func (*ClientWithResponses) UpdateEnvWithBodyWithResponse

func (c *ClientWithResponses) UpdateEnvWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEnvResp, error)

UpdateEnvWithBodyWithResponse request with arbitrary body returning *UpdateEnvResp

func (*ClientWithResponses) UpdateEnvWithResponse

func (c *ClientWithResponses) UpdateEnvWithResponse(ctx context.Context, env string, body UpdateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEnvResp, error)

func (*ClientWithResponses) UpdateOrgMemberWithBodyWithResponse

func (c *ClientWithResponses) UpdateOrgMemberWithBodyWithResponse(ctx context.Context, member string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrgMemberResp, error)

UpdateOrgMemberWithBodyWithResponse request with arbitrary body returning *UpdateOrgMemberResp

func (*ClientWithResponses) UpdateOrgMemberWithResponse

func (c *ClientWithResponses) UpdateOrgMemberWithResponse(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrgMemberResp, error)

func (*ClientWithResponses) UpdateOrgWithBodyWithResponse

func (c *ClientWithResponses) UpdateOrgWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrgResp, error)

UpdateOrgWithBodyWithResponse request with arbitrary body returning *UpdateOrgResp

func (*ClientWithResponses) UpdateOrgWithResponse

func (c *ClientWithResponses) UpdateOrgWithResponse(ctx context.Context, body UpdateOrgJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrgResp, error)

func (*ClientWithResponses) UpdateRequestWithBodyWithResponse

func (c *ClientWithResponses) UpdateRequestWithBodyWithResponse(ctx context.Context, requestID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRequestResp, error)

UpdateRequestWithBodyWithResponse request with arbitrary body returning *UpdateRequestResp

func (*ClientWithResponses) UpdateRequestWithResponse

func (c *ClientWithResponses) UpdateRequestWithResponse(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRequestResp, error)

func (*ClientWithResponses) UpdateTemplateWithBodyWithResponse

func (c *ClientWithResponses) UpdateTemplateWithBodyWithResponse(ctx context.Context, env string, template string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTemplateResp, error)

UpdateTemplateWithBodyWithResponse request with arbitrary body returning *UpdateTemplateResp

func (*ClientWithResponses) UpdateTemplateWithResponse

func (c *ClientWithResponses) UpdateTemplateWithResponse(ctx context.Context, env string, template string, body UpdateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTemplateResp, error)

func (*ClientWithResponses) UploadAccountPhotoWithBodyWithResponse

func (c *ClientWithResponses) UploadAccountPhotoWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadAccountPhotoResp, error)

UploadAccountPhotoWithBodyWithResponse request with arbitrary body returning *UploadAccountPhotoResp

func (*ClientWithResponses) UploadLogoWithBodyWithResponse

func (c *ClientWithResponses) UploadLogoWithBodyWithResponse(ctx context.Context, env string, params *UploadLogoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadLogoResp, error)

UploadLogoWithBodyWithResponse request with arbitrary body returning *UploadLogoResp

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// BulkUploadAccountPhotosWithBodyWithResponse request with any body
	BulkUploadAccountPhotosWithBodyWithResponse(ctx context.Context, params *BulkUploadAccountPhotosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUploadAccountPhotosResp, error)

	// ListAccountsWithResponse request
	ListAccountsWithResponse(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*ListAccountsResp, error)

	// GetAccountWithResponse request
	GetAccountWithResponse(ctx context.Context, account string, reqEditors ...RequestEditorFn) (*GetAccountResp, error)

	// UpdateAccountWithBodyWithResponse request with any body
	UpdateAccountWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountResp, error)

	UpdateAccountWithResponse(ctx context.Context, account string, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountResp, error)

	// UploadAccountPhotoWithBodyWithResponse request with any body
	UploadAccountPhotoWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadAccountPhotoResp, error)

	// ListAPIKeysWithResponse request
	ListAPIKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListAPIKeysResp, error)

	// CreateAPIKeyWithBodyWithResponse request with any body
	CreateAPIKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAPIKeyResp, error)

	CreateAPIKeyWithResponse(ctx context.Context, body CreateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAPIKeyResp, error)

	// DeleteAPIKeyWithResponse request
	DeleteAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*DeleteAPIKeyResp, error)

	// GetAPIKeyWithResponse request
	GetAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*GetAPIKeyResp, error)

	// UpdateAPIKeyWithBodyWithResponse request with any body
	UpdateAPIKeyWithBodyWithResponse(ctx context.Context, apiKey string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResp, error)

	UpdateAPIKeyWithResponse(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResp, error)

	// Oauth2CancelWithResponse request
	Oauth2CancelWithResponse(ctx context.Context, requestID string, params *Oauth2CancelParams, reqEditors ...RequestEditorFn) (*Oauth2CancelResp, error)

	// Oauth2PollWithResponse request
	Oauth2PollWithResponse(ctx context.Context, requestID string, params *Oauth2PollParams, reqEditors ...RequestEditorFn) (*Oauth2PollResp, error)

	// ListEnvsWithResponse request
	ListEnvsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListEnvsResp, error)

	// CreateEnvWithBodyWithResponse request with any body
	CreateEnvWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvResp, error)

	CreateEnvWithResponse(ctx context.Context, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvResp, error)

	// DeleteEnvWithResponse request
	DeleteEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*DeleteEnvResp, error)

	// GetEnvWithResponse request
	GetEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*GetEnvResp, error)

	// UpdateEnvWithBodyWithResponse request with any body
	UpdateEnvWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEnvResp, error)

	UpdateEnvWithResponse(ctx context.Context, env string, body UpdateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEnvResp, error)

	// ListDirectoriesWithResponse request
	ListDirectoriesWithResponse(ctx context.Context, env string, params *ListDirectoriesParams, reqEditors ...RequestEditorFn) (*ListDirectoriesResp, error)

	// CreateDirectoryWithBodyWithResponse request with any body
	CreateDirectoryWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDirectoryResp, error)

	CreateDirectoryWithResponse(ctx context.Context, env string, body CreateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDirectoryResp, error)

	// DeleteDirectoryWithResponse request
	DeleteDirectoryWithResponse(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryResp, error)

	// GetDirectoryWithResponse request
	GetDirectoryWithResponse(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryResp, error)

	// GetDirectoryAuthorizationURLWithResponse request
	GetDirectoryAuthorizationURLWithResponse(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryAuthorizationURLResp, error)

	// SetDirectoryCredentialsWithBodyWithResponse request with any body
	SetDirectoryCredentialsWithBodyWithResponse(ctx context.Context, env string, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetDirectoryCredentialsResp, error)

	SetDirectoryCredentialsWithResponse(ctx context.Context, env string, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*SetDirectoryCredentialsResp, error)

	// SyncDirectoryWithResponse request
	SyncDirectoryWithResponse(ctx context.Context, env string, directory string, reqEditors ...RequestEditorFn) (*SyncDirectoryResp, error)

	// DeleteLogoWithResponse request
	DeleteLogoWithResponse(ctx context.Context, env string, params *DeleteLogoParams, reqEditors ...RequestEditorFn) (*DeleteLogoResp, error)

	// UploadLogoWithBodyWithResponse request with any body
	UploadLogoWithBodyWithResponse(ctx context.Context, env string, params *UploadLogoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadLogoResp, error)

	// ListEnvRequestsWithResponse request
	ListEnvRequestsWithResponse(ctx context.Context, env string, params *ListEnvRequestsParams, reqEditors ...RequestEditorFn) (*ListEnvRequestsResp, error)

	// GetEnvRequestWithResponse request
	GetEnvRequestWithResponse(ctx context.Context, env string, requestID string, reqEditors ...RequestEditorFn) (*GetEnvRequestResp, error)

	// CreateTemplateWithBodyWithResponse request with any body
	CreateTemplateWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTemplateResp, error)

	CreateTemplateWithResponse(ctx context.Context, env string, body CreateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTemplateResp, error)

	// DeleteTemplateWithResponse request
	DeleteTemplateWithResponse(ctx context.Context, env string, template string, reqEditors ...RequestEditorFn) (*DeleteTemplateResp, error)

	// UpdateTemplateWithBodyWithResponse request with any body
	UpdateTemplateWithBodyWithResponse(ctx context.Context, env string, template string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTemplateResp, error)

	UpdateTemplateWithResponse(ctx context.Context, env string, template string, body UpdateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTemplateResp, error)

	// ListWebhooksWithResponse request
	ListWebhooksWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListWebhooksResp, error)

	// GetOrgWithResponse request
	GetOrgWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrgResp, error)

	// UpdateOrgWithBodyWithResponse request with any body
	UpdateOrgWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrgResp, error)

	UpdateOrgWithResponse(ctx context.Context, body UpdateOrgJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrgResp, error)

	// ListOrgMembersWithResponse request
	ListOrgMembersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListOrgMembersResp, error)

	// InviteOrgMemberWithBodyWithResponse request with any body
	InviteOrgMemberWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteOrgMemberResp, error)

	InviteOrgMemberWithResponse(ctx context.Context, body InviteOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteOrgMemberResp, error)

	// RemoveOrgMemberWithResponse request
	RemoveOrgMemberWithResponse(ctx context.Context, member string, reqEditors ...RequestEditorFn) (*RemoveOrgMemberResp, error)

	// UpdateOrgMemberWithBodyWithResponse request with any body
	UpdateOrgMemberWithBodyWithResponse(ctx context.Context, member string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrgMemberResp, error)

	UpdateOrgMemberWithResponse(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrgMemberResp, error)

	// CreateRequestWithBodyWithResponse request with any body
	CreateRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRequestResp, error)

	CreateRequestWithResponse(ctx context.Context, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRequestResp, error)

	// CancelRequestWithResponse request
	CancelRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*CancelRequestResp, error)

	// GetRequestWithResponse request
	GetRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*GetRequestResp, error)

	// UpdateRequestWithBodyWithResponse request with any body
	UpdateRequestWithBodyWithResponse(ctx context.Context, requestID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRequestResp, error)

	UpdateRequestWithResponse(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRequestResp, error)

	// Oauth2AuthorizeWithResponse request
	Oauth2AuthorizeWithResponse(ctx context.Context, params *Oauth2AuthorizeParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeResp, error)

	// Oauth2AuthorizeIframeWithResponse request
	Oauth2AuthorizeIframeWithResponse(ctx context.Context, params *Oauth2AuthorizeIframeParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeIframeResp, error)

	// Oauth2AuthorizeWithRequestWithResponse request
	Oauth2AuthorizeWithRequestWithResponse(ctx context.Context, requestID string, params *Oauth2AuthorizeWithRequestParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithRequestResp, error)

	// Oauth2LogoutWithResponse request
	Oauth2LogoutWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*Oauth2LogoutResp, error)

	// GetBulkPeoplePropertiesWithBodyWithResponse request with any body
	GetBulkPeoplePropertiesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetBulkPeoplePropertiesResp, error)

	GetBulkPeoplePropertiesWithResponse(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*GetBulkPeoplePropertiesResp, error)

	// ComparePeopleWithBodyWithResponse request with any body
	ComparePeopleWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ComparePeopleResp, error)

	ComparePeopleWithResponse(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, reqEditors ...RequestEditorFn) (*ComparePeopleResp, error)

	// CompareSelfieWithBodyWithResponse request with any body
	CompareSelfieWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CompareSelfieResp, error)

	// DeletePersonPropertiesWithResponse request
	DeletePersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, params *DeletePersonPropertiesParams, reqEditors ...RequestEditorFn) (*DeletePersonPropertiesResp, error)

	// GetPersonPropertiesWithResponse request
	GetPersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, params *GetPersonPropertiesParams, reqEditors ...RequestEditorFn) (*GetPersonPropertiesResp, error)

	// Oauth2TokenWithBodyWithResponse request with any body
	Oauth2TokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*Oauth2TokenResp, error)

	Oauth2TokenWithFormdataBodyWithResponse(ctx context.Context, body Oauth2TokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*Oauth2TokenResp, error)

	// Oauth2AuthorizeWithExperienceWithResponse request
	Oauth2AuthorizeWithExperienceWithResponse(ctx context.Context, experience string, params *Oauth2AuthorizeWithExperienceParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithExperienceResp, error)

	// Oauth2AuthorizeWithRequestAndExperienceWithResponse request
	Oauth2AuthorizeWithRequestAndExperienceWithResponse(ctx context.Context, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithRequestAndExperienceResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type ComparePeopleJSONRequestBody

type ComparePeopleJSONRequestBody = SubjectComparisonRequest

ComparePeopleJSONRequestBody defines body for ComparePeople for application/json ContentType.

type ComparePeopleResp

type ComparePeopleResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ComparisonResult
	JSON400      *N400
}

func ParseComparePeopleResp

func ParseComparePeopleResp(rsp *http.Response) (*ComparePeopleResp, error)

ParseComparePeopleResp parses an HTTP response from a ComparePeopleWithResponse call

func (ComparePeopleResp) Status

func (r ComparePeopleResp) Status() string

Status returns HTTPResponse.Status

func (ComparePeopleResp) StatusCode

func (r ComparePeopleResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CompareSelfieResp

type CompareSelfieResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompareSelfieResult
	JSON400      *N400
}

func ParseCompareSelfieResp

func ParseCompareSelfieResp(rsp *http.Response) (*CompareSelfieResp, error)

ParseCompareSelfieResp parses an HTTP response from a CompareSelfieWithResponse call

func (CompareSelfieResp) Status

func (r CompareSelfieResp) Status() string

Status returns HTTPResponse.Status

func (CompareSelfieResp) StatusCode

func (r CompareSelfieResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CompareSelfieResult

type CompareSelfieResult struct {
	// Match True if the `match_confidence` exceeds Nametag's recommended threshold for a match, false otherwise.
	Match bool `json:"match"`

	// Confidence A number between 0 and 1 that represents Nametag's confidence that the values match. A value of 1 means Nametag is very confident that the values match, while 0 means that the values do not match at all.
	Confidence float64 `json:"confidence"`
}

CompareSelfieResult defines model for CompareSelfieResult.

type Comparison

type Comparison struct {
	// Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you  must first define it in your environment and provide additional parameters, such as what type of data and how  long you need the data. This is done separately for each environment you manage in the developer console.
	Scope Scope `json:"scope"`

	// Expected The expected value for this scope.
	Expected string `json:"expected"`

	// Actual The actual value for this scope.
	Actual string `json:"actual"`

	// Match True if the `match_confidence` exceeds Nametag's recommended threshold for a match, false otherwise.
	Match bool `json:"match"`

	// MatchConfidence A number between 0 and 1 that represents Nametag's confidence that the values match. A value of 1 means Nametag is very confident that the values match, while 0 means that the values do not match at all.
	MatchConfidence float64 `json:"match_confidence"`
}

Comparison defines model for Comparison.

type ComparisonResult

type ComparisonResult struct {
	// Confidence A number between 0 and 1 that represents Nametag's confidence that the value matches the expected value. A value of 1 means Nametag is very confident that the values match,  while 0 means that the values do not match at all.
	Confidence float64 `json:"confidence"`

	// Comparisons A list of comparisons between the expected and actual values.
	Comparisons []Comparison `json:"comparisons"`
}

ComparisonResult defines model for ComparisonResult.

type CreateAPIKeyJSONRequestBody

type CreateAPIKeyJSONRequestBody = CreateAPIKeyRequest

CreateAPIKeyJSONRequestBody defines body for CreateAPIKey for application/json ContentType.

type CreateAPIKeyRequest

type CreateAPIKeyRequest struct {
	// Name A descriptive name for the API key
	Name string `json:"name,omitempty"`

	// Enabled `true` if the API key is enabled, or `false` if it cannot be used.
	Enabled bool `json:"enabled,omitempty"`

	// EnvIDs The unique identifier for the environments this API key belongs to, or `["*"]` if the key applies to all environments.
	EnvIDs []string `json:"envs"`
	Role   *Role    `json:"role,omitempty"`
}

CreateAPIKeyRequest defines model for CreateAPIKeyRequest.

type CreateAPIKeyResp

type CreateAPIKeyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *CreateAPIKeyResponse
	JSON400      *N400
}

func ParseCreateAPIKeyResp

func ParseCreateAPIKeyResp(rsp *http.Response) (*CreateAPIKeyResp, error)

ParseCreateAPIKeyResp parses an HTTP response from a CreateAPIKeyWithResponse call

func (CreateAPIKeyResp) Status

func (r CreateAPIKeyResp) Status() string

Status returns HTTPResponse.Status

func (CreateAPIKeyResp) StatusCode

func (r CreateAPIKeyResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateAPIKeyResponse

type CreateAPIKeyResponse struct {
	// ID The unique identifier for the API key
	ID string `json:"id"`

	// Key The full secret API key
	Key string `json:"key"`
}

CreateAPIKeyResponse defines model for CreateAPIKeyResponse.

type CreateDirectoryJSONRequestBody

type CreateDirectoryJSONRequestBody = CreateDirectoryRequest

CreateDirectoryJSONRequestBody defines body for CreateDirectory for application/json ContentType.

type CreateDirectoryRequest

type CreateDirectoryRequest struct {
	// Kind The type of the directory connection.
	Kind        DirectoryKind `json:"kind"`
	Credentials *Credentials  `json:"credentials,omitempty"`
}

CreateDirectoryRequest defines model for CreateDirectoryRequest.

type CreateDirectoryResp

type CreateDirectoryResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *CreateDirectoryResponse
	JSON400      *N400
}

func ParseCreateDirectoryResp

func ParseCreateDirectoryResp(rsp *http.Response) (*CreateDirectoryResp, error)

ParseCreateDirectoryResp parses an HTTP response from a CreateDirectoryWithResponse call

func (CreateDirectoryResp) Status

func (r CreateDirectoryResp) Status() string

Status returns HTTPResponse.Status

func (CreateDirectoryResp) StatusCode

func (r CreateDirectoryResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDirectoryResponse

type CreateDirectoryResponse struct {
	CustomAuthToken *string `json:"custom_auth_token,omitempty"`

	// ID The unique identifier for the directory.
	ID string `json:"id"`

	// RedirectURL The OAuth 2.0 redirect URL to authorize the directory.
	//
	// If the directory uses OAuth 2.0 for authorization (e.g. `"azure-ad"`), then
	// this field contains the URL to redirect the user to authorize the directory.
	RedirectURL *string `json:"redirect_url,omitempty"`
}

CreateDirectoryResponse defines model for CreateDirectoryResponse.

type CreateEnvJSONRequestBody

type CreateEnvJSONRequestBody = CreateEnvRequest

CreateEnvJSONRequestBody defines body for CreateEnv for application/json ContentType.

type CreateEnvRequest

type CreateEnvRequest = map[string]interface{}

CreateEnvRequest defines model for CreateEnvRequest.

type CreateEnvResp

type CreateEnvResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *CreateEnvResponse
	JSON400      *N400
}

func ParseCreateEnvResp

func ParseCreateEnvResp(rsp *http.Response) (*CreateEnvResp, error)

ParseCreateEnvResp parses an HTTP response from a CreateEnvWithResponse call

func (CreateEnvResp) Status

func (r CreateEnvResp) Status() string

Status returns HTTPResponse.Status

func (CreateEnvResp) StatusCode

func (r CreateEnvResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateEnvResponse

type CreateEnvResponse struct {
	// ID The unique identifier of the environment
	ID string `json:"id"`
}

CreateEnvResponse defines model for CreateEnvResponse.

type CreateRequestJSONRequestBody

type CreateRequestJSONRequestBody = CreateRequestRequest

CreateRequestJSONRequestBody defines body for CreateRequest for application/json ContentType.

type CreateRequestRequest

type CreateRequestRequest struct {
	// EnvID The ID of the environment associated with the request.
	EnvID string `json:"env"`

	// Scopes A list of the information (scopes) that the request is asking for.
	// If you specify `template`, you must not specify `scopes`.
	Scopes []Scope `json:"scopes,omitempty"`

	// Template The name of a template that customizes how the request is presented to the user.
	//
	// Because a template contains it's own scope definitions, you must not specify `scopes` when you specify `template`.
	Template string `json:"template,omitempty"`

	// ExpiresAt The last time this request will be valid. After this time, the request is expired and the user will no longer be able to complete it. This cannot be used with `ttl`.
	ExpiresAt time.Time `json:"expires_at,omitempty"`

	// Phone The phone number to which the request link should be sent.
	Phone string `json:"phone,omitempty"`

	// Whatsapp The Whatsapp phone number to which the request link should be sent.
	Whatsapp string `json:"whatsapp,omitempty"`

	// Label An internal label for this request. You can use this field to help you track the request in your own systems. Nametag stores this field, but does not process it at
	Label string `json:"label,omitempty"`
}

CreateRequestRequest defines model for CreateRequestRequest.

type CreateRequestResp

type CreateRequestResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *CreateRequestResponse
	JSON400      *N400
}

func ParseCreateRequestResp

func ParseCreateRequestResp(rsp *http.Response) (*CreateRequestResp, error)

ParseCreateRequestResp parses an HTTP response from a CreateRequestWithResponse call

func (CreateRequestResp) Status

func (r CreateRequestResp) Status() string

Status returns HTTPResponse.Status

func (CreateRequestResp) StatusCode

func (r CreateRequestResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRequestResponse

type CreateRequestResponse struct {
	// ID A unique identifier for the request
	ID     string               `json:"id"`
	Status NumericRequestStatus `json:"status"`

	// EnvID The ID of the environment associated with the request.
	EnvID string `json:"env"`

	// Scopes A list of the information (scopes) that the request is asking for.
	Scopes []Scope `json:"scopes"`

	// Template The name of a template that customizes how the request is presented to the user.
	Template string `json:"template,omitempty"`

	// Link An authorization link. Passing this link to the user will prompt them to complete the request.
	Link string `json:"link"`

	// Phone The phone number to which the request link was sent, in E.184 format.
	Phone string `json:"phone,omitempty"`

	// Label An internal label for this request. You can use this field to help you track the
	// request in your own systems. Nametag stores this field, but does not process it at
	Label string `json:"label,omitempty"`

	// ExpiresAt The last time this request will be valid. After this time, the request is expired
	// and the user will no longer be able to complete it.
	ExpiresAt *time.Time `json:"expires_at,omitempty"`
}

CreateRequestResponse defines model for CreateRequestResponse.

type CreateTemplateJSONRequestBody

type CreateTemplateJSONRequestBody = CreateTemplateRequest

CreateTemplateJSONRequestBody defines body for CreateTemplate for application/json ContentType.

type CreateTemplateRequest

type CreateTemplateRequest struct {
	// Name A descriptive name of the template
	Name string `json:"name"`

	// Headline The text that appears at the top of the mobile app when showing the request
	Headline *string `json:"headline,omitempty"`

	// QrHeadline The text that appears above the QR code when directing the user from desktop to mobile.
	QrHeadline *string `json:"qr_headline,omitempty"`

	// ExpirationText The text that describes when the request expires. This should include `{{.TTL}}` which is a placeholder  for the expiration of the data sharing authorization in human readable form, e.g. "3 hours"
	ExpirationText *string `json:"expiration_text,omitempty"`

	// AcceptText The text on the accept button in the mobile app.
	AcceptText *string `json:"accept_text,omitempty"`

	// AcceptedText The text that appears on the confirmation view after a request has been accepted.
	AcceptedText *string `json:"accepted_text,omitempty"`

	// InstallMessageSMS The contents of the SMS message sent to users to direct them to the mobile app. This must contain the  `{{.Link}}` which is a placeholder for the actual link.
	InstallMessageSMS *string `json:"install_message_sms,omitempty"`

	// IsDefault If true then this is the default template used when a template is not explicitly specified. There must be  exactly one default template.
	IsDefault *bool `json:"is_default,omitempty"`

	// ScopeDefinitions A list of scopes that are requested when requests are created with this template.
	ScopeDefinitions []TemplateScopeDefinition `json:"scope_definitions,omitempty"`

	// ScopesExpireIn How long the data sharing authorization should last, in seconds.
	ScopesExpireIn *int `json:"scopes_expire_in,omitempty"`

	// Enabled If true, then this template is enabled for requests. The default template must be enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// RequireSelfieReverification If true, existing users must provide a new selfie to validate their identity.
	RequireSelfieReverification *bool `json:"require_selfie_reverification,omitempty"`
}

CreateTemplateRequest defines model for CreateTemplateRequest.

type CreateTemplateResp

type CreateTemplateResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CreateTemplateResponse
	JSON400      *N400
}

func ParseCreateTemplateResp

func ParseCreateTemplateResp(rsp *http.Response) (*CreateTemplateResp, error)

ParseCreateTemplateResp parses an HTTP response from a CreateTemplateWithResponse call

func (CreateTemplateResp) Status

func (r CreateTemplateResp) Status() string

Status returns HTTPResponse.Status

func (CreateTemplateResp) StatusCode

func (r CreateTemplateResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTemplateResponse

type CreateTemplateResponse struct {
	// ID The unique identifier of the template
	ID string `json:"id"`
}

CreateTemplateResponse defines model for CreateTemplateResponse.

type Credentials

type Credentials struct {
	// Account * For Duo, the integration key
	// * For Okta, this field should be blank
	// * For Onelogin, the client ID, e.g. `98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4`
	Account string `json:"account,omitempty"`

	// Partition * For Duo, the API hostname, e.g. `api-33091yc9.duosecurity.com`.
	// * For Okta, the service hostname, e.g. `your-company.okta.com`.
	// * For Onelogin, the subdomain, e.g. `example.onelogin.com`.
	Partition string `json:"partition"`

	// Secret * For Duo, the secret key, e.g. `cv9wJSC10XDFRGY5L9DcgHuNtR76vM8kuB1sDCpc`
	// * For Okta, the API token, e.g. `21lgux-M8uJC4w-9kN_PL0ivV5tM81AvSd7l0IuAS3`
	// * For Onelogin, the client secret, e.g. `f3d4bd80d4d4007be3455453819d3359f8a5eb2eb66fdbc7bae5e44083605118`
	Secret string `json:"secret"`
}

Credentials defines model for Credentials.

type DeleteAPIKeyResp

type DeleteAPIKeyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseDeleteAPIKeyResp

func ParseDeleteAPIKeyResp(rsp *http.Response) (*DeleteAPIKeyResp, error)

ParseDeleteAPIKeyResp parses an HTTP response from a DeleteAPIKeyWithResponse call

func (DeleteAPIKeyResp) Status

func (r DeleteAPIKeyResp) Status() string

Status returns HTTPResponse.Status

func (DeleteAPIKeyResp) StatusCode

func (r DeleteAPIKeyResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteDirectoryResp

type DeleteDirectoryResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseDeleteDirectoryResp

func ParseDeleteDirectoryResp(rsp *http.Response) (*DeleteDirectoryResp, error)

ParseDeleteDirectoryResp parses an HTTP response from a DeleteDirectoryWithResponse call

func (DeleteDirectoryResp) Status

func (r DeleteDirectoryResp) Status() string

Status returns HTTPResponse.Status

func (DeleteDirectoryResp) StatusCode

func (r DeleteDirectoryResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteEnvResp

type DeleteEnvResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseDeleteEnvResp

func ParseDeleteEnvResp(rsp *http.Response) (*DeleteEnvResp, error)

ParseDeleteEnvResp parses an HTTP response from a DeleteEnvWithResponse call

func (DeleteEnvResp) Status

func (r DeleteEnvResp) Status() string

Status returns HTTPResponse.Status

func (DeleteEnvResp) StatusCode

func (r DeleteEnvResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteLogoParams

type DeleteLogoParams struct {
	// Kind The kind of logo to remove
	Kind LogoKind `form:"kind" json:"kind"`
}

DeleteLogoParams defines parameters for DeleteLogo.

type DeleteLogoResp

type DeleteLogoResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseDeleteLogoResp

func ParseDeleteLogoResp(rsp *http.Response) (*DeleteLogoResp, error)

ParseDeleteLogoResp parses an HTTP response from a DeleteLogoWithResponse call

func (DeleteLogoResp) Status

func (r DeleteLogoResp) Status() string

Status returns HTTPResponse.Status

func (DeleteLogoResp) StatusCode

func (r DeleteLogoResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeletePersonPropertiesParams

type DeletePersonPropertiesParams struct {
	// Token The `id_token` you received from the `/token` endpoint. This may only be used if the subject is the special value `me`.
	Token  *string `form:"token,omitempty" json:"token,omitempty"`
	Origin *string `json:"Origin,omitempty"`
}

DeletePersonPropertiesParams defines parameters for DeletePersonProperties.

type DeletePersonPropertiesResp

type DeletePersonPropertiesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseDeletePersonPropertiesResp

func ParseDeletePersonPropertiesResp(rsp *http.Response) (*DeletePersonPropertiesResp, error)

ParseDeletePersonPropertiesResp parses an HTTP response from a DeletePersonPropertiesWithResponse call

func (DeletePersonPropertiesResp) Status

Status returns HTTPResponse.Status

func (DeletePersonPropertiesResp) StatusCode

func (r DeletePersonPropertiesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteTemplateResp

type DeleteTemplateResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseDeleteTemplateResp

func ParseDeleteTemplateResp(rsp *http.Response) (*DeleteTemplateResp, error)

ParseDeleteTemplateResp parses an HTTP response from a DeleteTemplateWithResponse call

func (DeleteTemplateResp) Status

func (r DeleteTemplateResp) Status() string

Status returns HTTPResponse.Status

func (DeleteTemplateResp) StatusCode

func (r DeleteTemplateResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Directory

type Directory struct {
	// ID The unique identifier for the directory.
	ID string `json:"id"`

	// Kind The type of the directory connection.
	Kind DirectoryKind `json:"kind"`

	// Name The internal name of the directory.
	// This field is derived from inspecting the directory itself, for example for  Entra ID this field is the primary domain name. This field is used to you identify the directory.
	Name           string              `json:"name"`
	MfaPolicy      RecoveryPolicyRules `json:"mfa_policy"`
	PasswordPolicy RecoveryPolicyRules `json:"password_policy"`
	UnlockPolicy   RecoveryPolicyRules `json:"unlock_policy"`
	Credentials    *PartialCredentials `json:"credentials,omitempty"`

	// LastSyncStartedAt When the last sync started.
	LastSyncStartedAt *time.Time `json:"last_sync_started_at,omitempty"`

	// LastSyncCompletedAt When the last sync completed
	LastSyncCompletedAt *time.Time `json:"last_sync_completed_at,omitempty"`

	// LastSyncError An error describing the failure of the last sync, or null if the last sync was successful.
	LastSyncError *string `json:"last_sync_error,omitempty"`

	// Count The number of accounts in the directory.
	Count *int `json:"count,omitempty"`

	// NeedsReconnect If the directory needs to reconnect.
	NeedsReconnect *bool `json:"needs_reconnect,omitempty"`

	// SyncRunning true if the directory sync is currently running
	SyncRunning bool `json:"sync_running"`
}

Directory defines model for Directory.

type DirectoryGroup

type DirectoryGroup struct {
	// DirectoryImmutableIdentifier The unique identifier for the group.
	DirectoryImmutableIdentifier string `json:"directory_immutable_identifier"`

	// Name The display name of the group.
	Name string `json:"name"`
}

DirectoryGroup defines model for DirectoryGroup.

type DirectoryKind

type DirectoryKind string

DirectoryKind The type of the directory connection.

const (
	DirectoryKindAzureAD  DirectoryKind = "azure-ad"
	DirectoryKindCustom   DirectoryKind = "custom"
	DirectoryKindDuo      DirectoryKind = "duo"
	DirectoryKindOkta     DirectoryKind = "okta"
	DirectoryKindOnelogin DirectoryKind = "onelogin"
)

Defines values for DirectoryKind.

type Env

type Env struct {
	// ID The identifier for this environment
	ID string `json:"id"`

	// Name The internal name for this environment
	Name string `json:"name"`

	// PublicName The name of the environment that is shared with people
	PublicName string `json:"public_name"`

	// LogoURL A URL to your logo, which is displayed in the Nametag mobile app.
	LogoURL string `json:"logo_url"`

	// TermsOfServiceURL The URL of the terms of service.
	//
	// Formerly, this URL was provided to end-users in the Nametag mobile app, but it
	// is no longer used.
	// Deprecated:
	TermsOfServiceURL string `json:"terms_of_service_url"`

	// CallbackURLs A list of valid URLs for use as OAuth 2.0 callback URLs.
	CallbackURLs []string `json:"callback_urls"`

	// Webhooks A list of webhooks.
	Webhooks []WebhookDefinition `json:"webhooks"`

	// Templates A list of request templates.
	Templates []Template  `json:"templates"`
	Storage   *EnvStorage `json:"storage,omitempty"`
}

Env defines model for Env.

type EnvStorage

type EnvStorage struct {
	// S3BucketUS The S3 bucket for data stored in the United States. Must be in the us-east-2 AWS region.
	S3BucketUS *string `json:"s3_bucket_us,omitempty"`

	// S3BucketEU The S3 bucket for data stored in Europe. Must be in the eu-west-1 AWS region.
	S3BucketEU *string `json:"s3_bucket_eu,omitempty"`

	// AWSRoleARN The role Nametag should use to access the S3 buckets.
	AWSRoleARN *string `json:"aws_role_arn,omitempty"`
}

EnvStorage defines model for EnvStorage.

type EnvUpdateRequest

type EnvUpdateRequest struct {
	// Name Update the name of the environment, for internal use.
	Name *string `json:"name,omitempty"`

	// PublicName Update the public-facing name for your environment, typically your company or brand name.
	PublicName *string `json:"public_name,omitempty"`

	// CallbackURLs Set the list of allowed OAuth 2.0 callback URLs
	CallbackURLs []string `json:"callback_urls,omitempty"`

	// TermsOfServiceURL Update the terms of service URL.
	// Deprecated:
	TermsOfServiceURL *string `json:"terms_of_service_url,omitempty"`

	// RemoveWebhooks Remove webhooks from the environment (IDs of the webhooks to remove)
	RemoveWebhooks []string `json:"remove_webhooks,omitempty"`

	// AddWebhooks Add webhooks to the environment
	AddWebhooks   []WebhookDefinition      `json:"add_webhooks,omitempty"`
	UpdateWebhook *WebhookDefinitionUpdate `json:"update_webhook,omitempty"`
	Storage       *EnvStorage              `json:"storage,omitempty"`
}

EnvUpdateRequest defines model for EnvUpdateRequest.

type Expectation

type Expectation struct {
	// Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you  must first define it in your environment and provide additional parameters, such as what type of data and how  long you need the data. This is done separately for each environment you manage in the developer console.
	Scope Scope `json:"scope"`

	// Value The value you expect the person to have for this scope.
	Value string `json:"value"`
}

Expectation defines model for Expectation.

type GetAPIKeyResp

type GetAPIKeyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *APIKey
	JSON400      *N400
}

func ParseGetAPIKeyResp

func ParseGetAPIKeyResp(rsp *http.Response) (*GetAPIKeyResp, error)

ParseGetAPIKeyResp parses an HTTP response from a GetAPIKeyWithResponse call

func (GetAPIKeyResp) Status

func (r GetAPIKeyResp) Status() string

Status returns HTTPResponse.Status

func (GetAPIKeyResp) StatusCode

func (r GetAPIKeyResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAccountResp

type GetAccountResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Account
	JSON400      *N400
}

func ParseGetAccountResp

func ParseGetAccountResp(rsp *http.Response) (*GetAccountResp, error)

ParseGetAccountResp parses an HTTP response from a GetAccountWithResponse call

func (GetAccountResp) Status

func (r GetAccountResp) Status() string

Status returns HTTPResponse.Status

func (GetAccountResp) StatusCode

func (r GetAccountResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBulkPeoplePropertiesJSONRequestBody

type GetBulkPeoplePropertiesJSONRequestBody = BulkRequest

GetBulkPeoplePropertiesJSONRequestBody defines body for GetBulkPeopleProperties for application/json ContentType.

type GetBulkPeoplePropertiesResp

type GetBulkPeoplePropertiesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BulkResponse
	JSON400      *N400
}

func ParseGetBulkPeoplePropertiesResp

func ParseGetBulkPeoplePropertiesResp(rsp *http.Response) (*GetBulkPeoplePropertiesResp, error)

ParseGetBulkPeoplePropertiesResp parses an HTTP response from a GetBulkPeoplePropertiesWithResponse call

func (GetBulkPeoplePropertiesResp) Status

Status returns HTTPResponse.Status

func (GetBulkPeoplePropertiesResp) StatusCode

func (r GetBulkPeoplePropertiesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDirectoriesResponse

type GetDirectoriesResponse struct {
	// Directories A list of all directories.
	Directories []Directory `json:"directories"`
}

GetDirectoriesResponse defines model for GetDirectoriesResponse.

type GetDirectoryAuthorizationURLResp

type GetDirectoryAuthorizationURLResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OAuth2AuthorizeResponse
	JSON400      *N400
}

func ParseGetDirectoryAuthorizationURLResp

func ParseGetDirectoryAuthorizationURLResp(rsp *http.Response) (*GetDirectoryAuthorizationURLResp, error)

ParseGetDirectoryAuthorizationURLResp parses an HTTP response from a GetDirectoryAuthorizationURLWithResponse call

func (GetDirectoryAuthorizationURLResp) Status

Status returns HTTPResponse.Status

func (GetDirectoryAuthorizationURLResp) StatusCode

func (r GetDirectoryAuthorizationURLResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDirectoryResp

type GetDirectoryResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Directory
	JSON400      *N400
}

func ParseGetDirectoryResp

func ParseGetDirectoryResp(rsp *http.Response) (*GetDirectoryResp, error)

ParseGetDirectoryResp parses an HTTP response from a GetDirectoryWithResponse call

func (GetDirectoryResp) Status

func (r GetDirectoryResp) Status() string

Status returns HTTPResponse.Status

func (GetDirectoryResp) StatusCode

func (r GetDirectoryResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEnvRequestResp

type GetEnvRequestResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Request
	JSON400      *N400
}

func ParseGetEnvRequestResp

func ParseGetEnvRequestResp(rsp *http.Response) (*GetEnvRequestResp, error)

ParseGetEnvRequestResp parses an HTTP response from a GetEnvRequestWithResponse call

func (GetEnvRequestResp) Status

func (r GetEnvRequestResp) Status() string

Status returns HTTPResponse.Status

func (GetEnvRequestResp) StatusCode

func (r GetEnvRequestResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEnvResp

type GetEnvResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Env
	JSON400      *N400
}

func ParseGetEnvResp

func ParseGetEnvResp(rsp *http.Response) (*GetEnvResp, error)

ParseGetEnvResp parses an HTTP response from a GetEnvWithResponse call

func (GetEnvResp) Status

func (r GetEnvResp) Status() string

Status returns HTTPResponse.Status

func (GetEnvResp) StatusCode

func (r GetEnvResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrgResp

type GetOrgResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Org
	JSON400      *N400
}

func ParseGetOrgResp

func ParseGetOrgResp(rsp *http.Response) (*GetOrgResp, error)

ParseGetOrgResp parses an HTTP response from a GetOrgWithResponse call

func (GetOrgResp) Status

func (r GetOrgResp) Status() string

Status returns HTTPResponse.Status

func (GetOrgResp) StatusCode

func (r GetOrgResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPersonPropertiesParams

type GetPersonPropertiesParams struct {
	// Token The `id_token` you received from the `/token` endpoint. This may only be used if the subject is the special value `me`.
	Token  *string `form:"token,omitempty" json:"token,omitempty"`
	Origin *string `json:"Origin,omitempty"`
}

GetPersonPropertiesParams defines parameters for GetPersonProperties.

type GetPersonPropertiesResp

type GetPersonPropertiesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PropertiesResponse
	JSON400      *N400
}

func ParseGetPersonPropertiesResp

func ParseGetPersonPropertiesResp(rsp *http.Response) (*GetPersonPropertiesResp, error)

ParseGetPersonPropertiesResp parses an HTTP response from a GetPersonPropertiesWithResponse call

func (GetPersonPropertiesResp) Status

func (r GetPersonPropertiesResp) Status() string

Status returns HTTPResponse.Status

func (GetPersonPropertiesResp) StatusCode

func (r GetPersonPropertiesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRequestResp

type GetRequestResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Request
	JSON400      *N400
}

func ParseGetRequestResp

func ParseGetRequestResp(rsp *http.Response) (*GetRequestResp, error)

ParseGetRequestResp parses an HTTP response from a GetRequestWithResponse call

func (GetRequestResp) Status

func (r GetRequestResp) Status() string

Status returns HTTPResponse.Status

func (GetRequestResp) StatusCode

func (r GetRequestResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRequestsResponse

type GetRequestsResponse struct {
	NextOffset string    `json:"next_offset"`
	Requests   []Request `json:"requests"`
}

GetRequestsResponse defines model for GetRequestsResponse.

type GovtidDetailsValue

type GovtidDetailsValue struct {
	Type GovtidType `json:"type"`

	// Issuer The issuer of the identity document, an  [ISO 3166-1 alpha 3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) optionally followed by  a jurisdiction code, e.g. `USA.CA` or `CAN.ON`
	Issuer *string `json:"issuer,omitempty"`

	// Number The unique number of the identity document
	Number *string `json:"number,omitempty"`

	// Expiration The date when the identity document expires
	Expiration *openapi_types.Date `json:"expiration,omitempty"`
}

GovtidDetailsValue defines model for GovtidDetailsValue.

type GovtidType

type GovtidType string

GovtidType defines model for GovtidType.

const (
	DriverLicense GovtidType = "driver_license"
	Passport      GovtidType = "passport"
)

Defines values for GovtidType.

type GroupRecoveryPolicy

type GroupRecoveryPolicy struct {
	Group  DirectoryGroup `json:"group"`
	Policy RecoveryPolicy `json:"policy"`
}

GroupRecoveryPolicy defines model for GroupRecoveryPolicy.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InviteOrgMemberJSONRequestBody

type InviteOrgMemberJSONRequestBody = InviteOrgMemberRequest

InviteOrgMemberJSONRequestBody defines body for InviteOrgMember for application/json ContentType.

type InviteOrgMemberRequest

type InviteOrgMemberRequest struct {
	// Email The email address of the person you want to invite.
	Email openapi_types.Email `json:"email"`

	// Envs The list of environments the member will have access to. If the list contains `*`, the member will have access to all environments.
	Envs []string `json:"envs"`
	Role Role     `json:"role"`
}

InviteOrgMemberRequest defines model for InviteOrgMemberRequest.

type InviteOrgMemberResp

type InviteOrgMemberResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseInviteOrgMemberResp

func ParseInviteOrgMemberResp(rsp *http.Response) (*InviteOrgMemberResp, error)

ParseInviteOrgMemberResp parses an HTTP response from a InviteOrgMemberWithResponse call

func (InviteOrgMemberResp) Status

func (r InviteOrgMemberResp) Status() string

Status returns HTTPResponse.Status

func (InviteOrgMemberResp) StatusCode

func (r InviteOrgMemberResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAPIKeysResp

type ListAPIKeysResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListAPIKeysResponse
	JSON400      *N400
}

func ParseListAPIKeysResp

func ParseListAPIKeysResp(rsp *http.Response) (*ListAPIKeysResp, error)

ParseListAPIKeysResp parses an HTTP response from a ListAPIKeysWithResponse call

func (ListAPIKeysResp) Status

func (r ListAPIKeysResp) Status() string

Status returns HTTPResponse.Status

func (ListAPIKeysResp) StatusCode

func (r ListAPIKeysResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAPIKeysResponse

type ListAPIKeysResponse struct {
	// APIKeys A list of API keys
	APIKeys []APIKey `json:"apikeys"`
}

ListAPIKeysResponse defines model for ListAPIKeysResponse.

type ListAccountsParams

type ListAccountsParams struct {
	// Envs List only accounts in the specified environments
	Envs *[]string `form:"env,omitempty" json:"env,omitempty"`

	// Offset The offset to start from
	Offset *string `form:"offset,omitempty" json:"offset,omitempty"`

	// Count The number of items to return
	Count *int `form:"count,omitempty" json:"count,omitempty"`

	// Verified Show only verified accounts
	Verified *bool `form:"verified,omitempty" json:"verified,omitempty"`

	// Directories Show only accounts in these directories
	Directories *[]string `form:"directory,omitempty" json:"directory,omitempty"`

	// Q Search query
	Q *string `form:"q,omitempty" json:"q,omitempty"`

	// Sort Sort by this field, or prefix with "-" for descending order
	Sort *ListAccountsParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
}

ListAccountsParams defines parameters for ListAccounts.

type ListAccountsParamsSort

type ListAccountsParamsSort string

ListAccountsParamsSort defines parameters for ListAccounts.

const (
	AccountBoundAt      ListAccountsParamsSort = "account_bound_at"
	ExternalId          ListAccountsParamsSort = "external_id"
	LastVerifiedAt      ListAccountsParamsSort = "last_verified_at"
	MinusAccountBoundAt ListAccountsParamsSort = "-account_bound_at"
	MinusExternalId     ListAccountsParamsSort = "-external_id"
	MinusLastVerifiedAt ListAccountsParamsSort = "-last_verified_at"
	MinusName           ListAccountsParamsSort = "-name"
	Name                ListAccountsParamsSort = "name"
)

Defines values for ListAccountsParamsSort.

type ListAccountsResp

type ListAccountsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AccountsList
	JSON400      *N400
}

func ParseListAccountsResp

func ParseListAccountsResp(rsp *http.Response) (*ListAccountsResp, error)

ParseListAccountsResp parses an HTTP response from a ListAccountsWithResponse call

func (ListAccountsResp) Status

func (r ListAccountsResp) Status() string

Status returns HTTPResponse.Status

func (ListAccountsResp) StatusCode

func (r ListAccountsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListDirectoriesParams

type ListDirectoriesParams struct {
	Env *string `form:"env,omitempty" json:"env,omitempty"`
}

ListDirectoriesParams defines parameters for ListDirectories.

type ListDirectoriesResp

type ListDirectoriesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetDirectoriesResponse
	JSON400      *N400
}

func ParseListDirectoriesResp

func ParseListDirectoriesResp(rsp *http.Response) (*ListDirectoriesResp, error)

ParseListDirectoriesResp parses an HTTP response from a ListDirectoriesWithResponse call

func (ListDirectoriesResp) Status

func (r ListDirectoriesResp) Status() string

Status returns HTTPResponse.Status

func (ListDirectoriesResp) StatusCode

func (r ListDirectoriesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListEnvRequestsParams

type ListEnvRequestsParams struct {
	Q         *string                    `form:"q,omitempty" json:"q,omitempty"`
	Requestor *string                    `form:"requestor,omitempty" json:"requestor,omitempty"`
	Count     *int                       `form:"count,omitempty" json:"count,omitempty"`
	Offset    *string                    `form:"offset,omitempty" json:"offset,omitempty"`
	Sort      *ListEnvRequestsParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
}

ListEnvRequestsParams defines parameters for ListEnvRequests.

type ListEnvRequestsParamsSort

type ListEnvRequestsParamsSort string

ListEnvRequestsParamsSort defines parameters for ListEnvRequests.

const (
	LastUpdated      ListEnvRequestsParamsSort = "last_updated"
	MinusLastUpdated ListEnvRequestsParamsSort = "-last_updated"
)

Defines values for ListEnvRequestsParamsSort.

type ListEnvRequestsResp

type ListEnvRequestsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetRequestsResponse
	JSON400      *N400
}

func ParseListEnvRequestsResp

func ParseListEnvRequestsResp(rsp *http.Response) (*ListEnvRequestsResp, error)

ParseListEnvRequestsResp parses an HTTP response from a ListEnvRequestsWithResponse call

func (ListEnvRequestsResp) Status

func (r ListEnvRequestsResp) Status() string

Status returns HTTPResponse.Status

func (ListEnvRequestsResp) StatusCode

func (r ListEnvRequestsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListEnvsResp

type ListEnvsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListEnvsResponse
	JSON400      *N400
}

func ParseListEnvsResp

func ParseListEnvsResp(rsp *http.Response) (*ListEnvsResp, error)

ParseListEnvsResp parses an HTTP response from a ListEnvsWithResponse call

func (ListEnvsResp) Status

func (r ListEnvsResp) Status() string

Status returns HTTPResponse.Status

func (ListEnvsResp) StatusCode

func (r ListEnvsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListEnvsResponse

type ListEnvsResponse struct {
	// Envs A list of all your environments.
	Envs []Env `json:"envs"`
}

ListEnvsResponse defines model for ListEnvsResponse.

type ListOrgMembersResp

type ListOrgMembersResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListOrgMembersResponse
	JSON400      *N400
}

func ParseListOrgMembersResp

func ParseListOrgMembersResp(rsp *http.Response) (*ListOrgMembersResp, error)

ParseListOrgMembersResp parses an HTTP response from a ListOrgMembersWithResponse call

func (ListOrgMembersResp) Status

func (r ListOrgMembersResp) Status() string

Status returns HTTPResponse.Status

func (ListOrgMembersResp) StatusCode

func (r ListOrgMembersResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListOrgMembersResponse

type ListOrgMembersResponse struct {
	// Members A list of each member of the organization
	Members []OrgMember `json:"members"`
}

ListOrgMembersResponse defines model for ListOrgMembersResponse.

type ListWebhooksResp

type ListWebhooksResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListWebhooksResponse
	JSON400      *N400
}

func ParseListWebhooksResp

func ParseListWebhooksResp(rsp *http.Response) (*ListWebhooksResp, error)

ParseListWebhooksResp parses an HTTP response from a ListWebhooksWithResponse call

func (ListWebhooksResp) Status

func (r ListWebhooksResp) Status() string

Status returns HTTPResponse.Status

func (ListWebhooksResp) StatusCode

func (r ListWebhooksResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListWebhooksResponse

type ListWebhooksResponse struct {
	Webhooks []Webhook `json:"webhooks"`
}

ListWebhooksResponse defines model for ListWebhooksResponse.

type Location

type Location struct {
	// Business Whether the location is a business.
	Business bool `json:"business,omitempty"`

	// City The city of the location.
	City string `json:"city,omitempty"`

	// Country The country of the location.
	Country string `json:"country,omitempty"`

	// Latitude The latitude of the location.
	Latitude float64 `json:"latitude"`

	// Longitude The longitude of the location.
	Longitude float64 `json:"longitude"`

	// PoBox Whether the location is a PO box.
	PoBox bool `json:"po_box,omitempty"`

	// Residential Whether the location is residential.
	Residential bool `json:"residential,omitempty"`

	// Subdivision The subdivision of the location (e.g. the state or province).
	Subdivision string `json:"subdivision,omitempty"`
}

Location defines model for Location.

type LogoKind

type LogoKind string

LogoKind defines model for LogoKind.

const (
	Install LogoKind = "install"
	Mobile  LogoKind = "mobile"
	Qr      LogoKind = "qr"
)

Defines values for LogoKind.

type N400

type N400 = BadRequestResponse

N400 defines model for 400.

type NumericRequestStatus

type NumericRequestStatus int

NumericRequestStatus defines model for NumericRequestStatus.

const (
	NumericRequestStatusCancelled        NumericRequestStatus = 404
	NumericRequestStatusCompleted        NumericRequestStatus = 200
	NumericRequestStatusExpired          NumericRequestStatus = 410
	NumericRequestStatusExpiredScopes    NumericRequestStatus = 411
	NumericRequestStatusInProgress       NumericRequestStatus = 101
	NumericRequestStatusPending          NumericRequestStatus = 100
	NumericRequestStatusRejectedFraud    NumericRequestStatus = 552
	NumericRequestStatusRejectedInReview NumericRequestStatus = 550
	NumericRequestStatusRejectedUnusable NumericRequestStatus = 551
	NumericRequestStatusRevoked          NumericRequestStatus = 403
)

Defines values for NumericRequestStatus.

type OAuth2AuthorizeResponse

type OAuth2AuthorizeResponse struct {
	// RedirectURL The URL to redirect the user to authorize the directory.
	RedirectURL string `json:"redirect_url"`
}

OAuth2AuthorizeResponse defines model for OAuth2AuthorizeResponse.

type Oauth2AuthorizeIframeParams

type Oauth2AuthorizeIframeParams struct {
	// ClientId The client ID
	ClientId string `form:"client_id" json:"client_id"`

	// RedirectUri The redirect URI
	RedirectUri string `form:"redirect_uri" json:"redirect_uri"`

	// State The state
	State string `form:"state" json:"state"`

	// Scope Space-separated list of scopes
	Scope string `form:"scope" json:"scope"`

	// ResponseType The response type
	ResponseType Oauth2AuthorizeIframeParamsResponseType `form:"response_type" json:"response_type"`

	// ResponseMode The response mode
	ResponseMode *Oauth2AuthorizeIframeParamsResponseMode `form:"response_mode,omitempty" json:"response_mode,omitempty"`

	// CodeChallenge The code challenge
	CodeChallenge *string `form:"code_challenge,omitempty" json:"code_challenge,omitempty"`

	// CodeChallengeMethod The code challenge method
	CodeChallengeMethod *Oauth2AuthorizeIframeParamsCodeChallengeMethod `form:"code_challenge_method,omitempty" json:"code_challenge_method,omitempty"`

	// EmailHint The email hint
	EmailHint *openapi_types.Email `form:"email_hint,omitempty" json:"email_hint,omitempty"`

	// Template The template to use
	Template *string `form:"template,omitempty" json:"template,omitempty"`

	// Return The return URL
	Return *AuthorizeReturn `form:"return,omitempty" json:"return,omitempty"`
}

Oauth2AuthorizeIframeParams defines parameters for Oauth2AuthorizeIframe.

type Oauth2AuthorizeIframeParamsCodeChallengeMethod

type Oauth2AuthorizeIframeParamsCodeChallengeMethod string

Oauth2AuthorizeIframeParamsCodeChallengeMethod defines parameters for Oauth2AuthorizeIframe.

const (
	Oauth2AuthorizeIframeParamsCodeChallengeMethodPlain Oauth2AuthorizeIframeParamsCodeChallengeMethod = "plain"
	Oauth2AuthorizeIframeParamsCodeChallengeMethodS256  Oauth2AuthorizeIframeParamsCodeChallengeMethod = "S256"
)

Defines values for Oauth2AuthorizeIframeParamsCodeChallengeMethod.

type Oauth2AuthorizeIframeParamsResponseMode

type Oauth2AuthorizeIframeParamsResponseMode string

Oauth2AuthorizeIframeParamsResponseMode defines parameters for Oauth2AuthorizeIframe.

const (
	Oauth2AuthorizeIframeParamsResponseModeFragment Oauth2AuthorizeIframeParamsResponseMode = "fragment"
)

Defines values for Oauth2AuthorizeIframeParamsResponseMode.

type Oauth2AuthorizeIframeParamsResponseType

type Oauth2AuthorizeIframeParamsResponseType string

Oauth2AuthorizeIframeParamsResponseType defines parameters for Oauth2AuthorizeIframe.

const (
	Oauth2AuthorizeIframeParamsResponseTypeCode Oauth2AuthorizeIframeParamsResponseType = "code"
)

Defines values for Oauth2AuthorizeIframeParamsResponseType.

type Oauth2AuthorizeIframeResp

type Oauth2AuthorizeIframeResp struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseOauth2AuthorizeIframeResp

func ParseOauth2AuthorizeIframeResp(rsp *http.Response) (*Oauth2AuthorizeIframeResp, error)

ParseOauth2AuthorizeIframeResp parses an HTTP response from a Oauth2AuthorizeIframeWithResponse call

func (Oauth2AuthorizeIframeResp) Status

func (r Oauth2AuthorizeIframeResp) Status() string

Status returns HTTPResponse.Status

func (Oauth2AuthorizeIframeResp) StatusCode

func (r Oauth2AuthorizeIframeResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Oauth2AuthorizeParams

type Oauth2AuthorizeParams struct {
	// ClientId The client ID
	ClientId string `form:"client_id" json:"client_id"`

	// RedirectUri The redirect URI
	RedirectUri string `form:"redirect_uri" json:"redirect_uri"`

	// State The state
	State string `form:"state" json:"state"`

	// Scope Space-separated list of scopes
	Scope string `form:"scope" json:"scope"`

	// ResponseType The response type
	ResponseType Oauth2AuthorizeParamsResponseType `form:"response_type" json:"response_type"`

	// ResponseMode The response mode
	ResponseMode *Oauth2AuthorizeParamsResponseMode `form:"response_mode,omitempty" json:"response_mode,omitempty"`

	// CodeChallenge The code challenge
	CodeChallenge *string `form:"code_challenge,omitempty" json:"code_challenge,omitempty"`

	// CodeChallengeMethod The code challenge method
	CodeChallengeMethod *Oauth2AuthorizeParamsCodeChallengeMethod `form:"code_challenge_method,omitempty" json:"code_challenge_method,omitempty"`

	// EmailHint The email hint
	EmailHint *openapi_types.Email `form:"email_hint,omitempty" json:"email_hint,omitempty"`

	// Template The template to use
	Template *string `form:"template,omitempty" json:"template,omitempty"`

	// Return The return URL
	Return *AuthorizeReturn `form:"return,omitempty" json:"return,omitempty"`
}

Oauth2AuthorizeParams defines parameters for Oauth2Authorize.

type Oauth2AuthorizeParamsCodeChallengeMethod

type Oauth2AuthorizeParamsCodeChallengeMethod string

Oauth2AuthorizeParamsCodeChallengeMethod defines parameters for Oauth2Authorize.

const (
	Oauth2AuthorizeParamsCodeChallengeMethodPlain Oauth2AuthorizeParamsCodeChallengeMethod = "plain"
	Oauth2AuthorizeParamsCodeChallengeMethodS256  Oauth2AuthorizeParamsCodeChallengeMethod = "S256"
)

Defines values for Oauth2AuthorizeParamsCodeChallengeMethod.

type Oauth2AuthorizeParamsResponseMode

type Oauth2AuthorizeParamsResponseMode string

Oauth2AuthorizeParamsResponseMode defines parameters for Oauth2Authorize.

const (
	Oauth2AuthorizeParamsResponseModeFragment Oauth2AuthorizeParamsResponseMode = "fragment"
)

Defines values for Oauth2AuthorizeParamsResponseMode.

type Oauth2AuthorizeParamsResponseType

type Oauth2AuthorizeParamsResponseType string

Oauth2AuthorizeParamsResponseType defines parameters for Oauth2Authorize.

const (
	Oauth2AuthorizeParamsResponseTypeCode Oauth2AuthorizeParamsResponseType = "code"
)

Defines values for Oauth2AuthorizeParamsResponseType.

type Oauth2AuthorizeResp

type Oauth2AuthorizeResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AuthorizeResponse
	JSON400      *AuthorizeResponse
}

func ParseOauth2AuthorizeResp

func ParseOauth2AuthorizeResp(rsp *http.Response) (*Oauth2AuthorizeResp, error)

ParseOauth2AuthorizeResp parses an HTTP response from a Oauth2AuthorizeWithResponse call

func (Oauth2AuthorizeResp) Status

func (r Oauth2AuthorizeResp) Status() string

Status returns HTTPResponse.Status

func (Oauth2AuthorizeResp) StatusCode

func (r Oauth2AuthorizeResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Oauth2AuthorizeWithExperienceParams

type Oauth2AuthorizeWithExperienceParams struct {
	// ClientId The client ID
	ClientId string `form:"client_id" json:"client_id"`

	// RedirectUri The redirect URI
	RedirectUri string `form:"redirect_uri" json:"redirect_uri"`

	// State The state
	State string `form:"state" json:"state"`

	// Scope Space-separated list of scopes
	Scope string `form:"scope" json:"scope"`

	// ResponseType The response type
	ResponseType Oauth2AuthorizeWithExperienceParamsResponseType `form:"response_type" json:"response_type"`

	// ResponseMode The response mode
	ResponseMode *Oauth2AuthorizeWithExperienceParamsResponseMode `form:"response_mode,omitempty" json:"response_mode,omitempty"`

	// CodeChallenge The code challenge
	CodeChallenge *string `form:"code_challenge,omitempty" json:"code_challenge,omitempty"`

	// CodeChallengeMethod The code challenge method
	CodeChallengeMethod *Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod `form:"code_challenge_method,omitempty" json:"code_challenge_method,omitempty"`

	// EmailHint The email hint
	EmailHint *openapi_types.Email `form:"email_hint,omitempty" json:"email_hint,omitempty"`

	// Template The template to use
	Template *string `form:"template,omitempty" json:"template,omitempty"`

	// Return The return URL
	Return *AuthorizeReturn `form:"return,omitempty" json:"return,omitempty"`
}

Oauth2AuthorizeWithExperienceParams defines parameters for Oauth2AuthorizeWithExperience.

type Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod

type Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod string

Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod defines parameters for Oauth2AuthorizeWithExperience.

Defines values for Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod.

type Oauth2AuthorizeWithExperienceParamsResponseMode

type Oauth2AuthorizeWithExperienceParamsResponseMode string

Oauth2AuthorizeWithExperienceParamsResponseMode defines parameters for Oauth2AuthorizeWithExperience.

const (
	Fragment Oauth2AuthorizeWithExperienceParamsResponseMode = "fragment"
)

Defines values for Oauth2AuthorizeWithExperienceParamsResponseMode.

type Oauth2AuthorizeWithExperienceParamsResponseType

type Oauth2AuthorizeWithExperienceParamsResponseType string

Oauth2AuthorizeWithExperienceParamsResponseType defines parameters for Oauth2AuthorizeWithExperience.

Defines values for Oauth2AuthorizeWithExperienceParamsResponseType.

type Oauth2AuthorizeWithExperienceResp

type Oauth2AuthorizeWithExperienceResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AuthorizeResponse
	JSON400      *AuthorizeResponse
}

func ParseOauth2AuthorizeWithExperienceResp

func ParseOauth2AuthorizeWithExperienceResp(rsp *http.Response) (*Oauth2AuthorizeWithExperienceResp, error)

ParseOauth2AuthorizeWithExperienceResp parses an HTTP response from a Oauth2AuthorizeWithExperienceWithResponse call

func (Oauth2AuthorizeWithExperienceResp) Status

Status returns HTTPResponse.Status

func (Oauth2AuthorizeWithExperienceResp) StatusCode

func (r Oauth2AuthorizeWithExperienceResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Oauth2AuthorizeWithRequestAndExperienceParams

type Oauth2AuthorizeWithRequestAndExperienceParams struct {
	// QuerySession The session token
	QuerySession *string `form:"session,omitempty" json:"session,omitempty"`

	// CookieSession The session token
	CookieSession *string `form:"session,omitempty" json:"session,omitempty"`
}

Oauth2AuthorizeWithRequestAndExperienceParams defines parameters for Oauth2AuthorizeWithRequestAndExperience.

type Oauth2AuthorizeWithRequestAndExperienceResp

type Oauth2AuthorizeWithRequestAndExperienceResp struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseOauth2AuthorizeWithRequestAndExperienceResp

func ParseOauth2AuthorizeWithRequestAndExperienceResp(rsp *http.Response) (*Oauth2AuthorizeWithRequestAndExperienceResp, error)

ParseOauth2AuthorizeWithRequestAndExperienceResp parses an HTTP response from a Oauth2AuthorizeWithRequestAndExperienceWithResponse call

func (Oauth2AuthorizeWithRequestAndExperienceResp) Status

Status returns HTTPResponse.Status

func (Oauth2AuthorizeWithRequestAndExperienceResp) StatusCode

StatusCode returns HTTPResponse.StatusCode

type Oauth2AuthorizeWithRequestParams

type Oauth2AuthorizeWithRequestParams struct {
	// QuerySession The session token
	QuerySession *string `form:"session,omitempty" json:"session,omitempty"`

	// CookieSession The session token
	CookieSession *string `form:"session,omitempty" json:"session,omitempty"`
}

Oauth2AuthorizeWithRequestParams defines parameters for Oauth2AuthorizeWithRequest.

type Oauth2AuthorizeWithRequestResp

type Oauth2AuthorizeWithRequestResp struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseOauth2AuthorizeWithRequestResp

func ParseOauth2AuthorizeWithRequestResp(rsp *http.Response) (*Oauth2AuthorizeWithRequestResp, error)

ParseOauth2AuthorizeWithRequestResp parses an HTTP response from a Oauth2AuthorizeWithRequestWithResponse call

func (Oauth2AuthorizeWithRequestResp) Status

Status returns HTTPResponse.Status

func (Oauth2AuthorizeWithRequestResp) StatusCode

func (r Oauth2AuthorizeWithRequestResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Oauth2CancelParams

type Oauth2CancelParams struct {
	// QuerySession The session token
	QuerySession *string `form:"session,omitempty" json:"session,omitempty"`

	// CookieSession The session token
	CookieSession *string `form:"session,omitempty" json:"session,omitempty"`
}

Oauth2CancelParams defines parameters for Oauth2Cancel.

type Oauth2CancelResp

type Oauth2CancelResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CancelResponse
}

func ParseOauth2CancelResp

func ParseOauth2CancelResp(rsp *http.Response) (*Oauth2CancelResp, error)

ParseOauth2CancelResp parses an HTTP response from a Oauth2CancelWithResponse call

func (Oauth2CancelResp) Status

func (r Oauth2CancelResp) Status() string

Status returns HTTPResponse.Status

func (Oauth2CancelResp) StatusCode

func (r Oauth2CancelResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Oauth2LogoutResp

type Oauth2LogoutResp struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseOauth2LogoutResp

func ParseOauth2LogoutResp(rsp *http.Response) (*Oauth2LogoutResp, error)

ParseOauth2LogoutResp parses an HTTP response from a Oauth2LogoutWithResponse call

func (Oauth2LogoutResp) Status

func (r Oauth2LogoutResp) Status() string

Status returns HTTPResponse.Status

func (Oauth2LogoutResp) StatusCode

func (r Oauth2LogoutResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Oauth2PollParams

type Oauth2PollParams struct {
	// QuerySession The session token
	QuerySession *string `form:"session,omitempty" json:"session,omitempty"`

	// CookieSession The session token
	CookieSession *string `form:"session,omitempty" json:"session,omitempty"`
}

Oauth2PollParams defines parameters for Oauth2Poll.

type Oauth2PollResp

type Oauth2PollResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PollResponse
}

func ParseOauth2PollResp

func ParseOauth2PollResp(rsp *http.Response) (*Oauth2PollResp, error)

ParseOauth2PollResp parses an HTTP response from a Oauth2PollWithResponse call

func (Oauth2PollResp) Status

func (r Oauth2PollResp) Status() string

Status returns HTTPResponse.Status

func (Oauth2PollResp) StatusCode

func (r Oauth2PollResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Oauth2TokenFormdataRequestBody

type Oauth2TokenFormdataRequestBody = TokenRequest

Oauth2TokenFormdataRequestBody defines body for Oauth2Token for application/x-www-form-urlencoded ContentType.

type Oauth2TokenResp

type Oauth2TokenResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TokenResponse
	JSON400      *TokenResponseError
}

func ParseOauth2TokenResp

func ParseOauth2TokenResp(rsp *http.Response) (*Oauth2TokenResp, error)

ParseOauth2TokenResp parses an HTTP response from a Oauth2TokenWithResponse call

func (Oauth2TokenResp) Status

func (r Oauth2TokenResp) Status() string

Status returns HTTPResponse.Status

func (Oauth2TokenResp) StatusCode

func (r Oauth2TokenResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Org

type Org struct {
	// Name The name of the organization, typically the name of your company
	Name string `json:"name"`
	Role Role   `json:"role"`

	// Envs A list of the environment IDs that you have access to.
	Envs []string `json:"envs"`
}

Org defines model for Org.

type OrgMember

type OrgMember struct {
	// MemberID A unique identifier of the member.
	MemberID string `json:"member_id"`
	Role     Role   `json:"role"`

	// Envs The list of environments the member has access to. If the list contains `*`, the member has access to all  environments.
	Envs []string `json:"envs"`

	// Name The name of the member.
	Name string `json:"name"`

	// Email The email address of the member.
	Email string `json:"email"`

	// ProfilePicture The URL of the profile picture of the member.
	ProfilePicture string `json:"profile_picture"`

	// InvitePending True if the member has been invited to the organization but has not  yet signed in.
	InvitePending bool `json:"invite_pending"`
}

OrgMember defines model for OrgMember.

type OrgUpdateRequest

type OrgUpdateRequest struct {
	// Name The name of the organization, typically the name of your company
	Name               *string   `json:"name,omitempty"`
	AllowedIPAddresses *[]string `json:"allowed_ip_addresses,omitempty"`
}

OrgUpdateRequest defines model for OrgUpdateRequest.

type PartialCredentials

type PartialCredentials struct {
	// Account * For Duo, the integration key
	// * For Okta, this field should be blank
	// * For Onelogin, the client ID, e.g. `98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4`
	Account string `json:"account"`

	// Partition * For Duo, the API hostname, e.g. `api-33091yc9.duosecurity.com`.
	// * For Okta, the service hostname, e.g. `your-company.okta.com`.
	// * For Onelogin, the subdomain, e.g. `example.onelogin.com`.
	Partition string `json:"partition"`
}

PartialCredentials defines model for PartialCredentials.

type PollResponse

type PollResponse struct {
	Status           AuthorizeStatus `json:"status"`
	RedirectURI      string          `json:"redirect_uri,omitempty"`
	WaitingForReview bool            `json:"waiting_for_review,omitempty"`
}

PollResponse defines model for PollResponse.

type PropertiesResponse

type PropertiesResponse struct {
	// Subject The subject of the request. This is the person whose properties are being requested.
	Subject string `json:"subject"`

	// Requests The requests that were made to get the properties.
	Requests []PropertyResponseRequest `json:"requests"`

	// Properties Properties of the person.
	Properties []PropertyResponse `json:"properties"`
}

PropertiesResponse defines model for PropertiesResponse.

type PropertyResponse

type PropertyResponse struct {
	// Expires When your access to this data expires
	Expires string `json:"expires,omitempty"`

	// Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you  must first define it in your environment and provide additional parameters, such as what type of data and how  long you need the data. This is done separately for each environment you manage in the developer console.
	Scope Scope `json:"scope"`

	// Value The value of the property. The type of this field varies depending on the scope. See [this table](#scopes).
	Value interface{} `json:"value,omitempty"`

	// Status A value that tells you the disposition of the property. The value `200` means the data was shared.  The value `403` means the data has not been shared, the person has revoked your access, or `410` meaning  the request has expired.
	Status int `json:"status"`
}

PropertyResponse defines model for PropertyResponse.

type PropertyResponseRequest

type PropertyResponseRequest struct {
	// ID A unique identifier for the request.
	ID string `json:"id"`

	// CreatedAt The time that the request was initiated
	CreatedAt time.Time `json:"created_at"`

	// Status The status of the request, 200 means accepted, 403 means rejected or canceled.
	Status int `json:"status"`

	// Scopes The scopes requested
	Scopes []Scope `json:"scopes"`
}

PropertyResponseRequest defines model for PropertyResponseRequest.

type RecoveryPolicy

type RecoveryPolicy string

RecoveryPolicy defines model for RecoveryPolicy.

const (
	RecoveryPolicyDisabled         RecoveryPolicy = "disabled"
	RecoveryPolicyNameAndBirthDate RecoveryPolicy = "name_and_birth_date"
	RecoveryPolicyNameMatch        RecoveryPolicy = "name_match"
	RecoveryPolicyPhoto            RecoveryPolicy = "photo"
)

Defines values for RecoveryPolicy.

type RecoveryPolicyRules

type RecoveryPolicyRules struct {
	// Groups A list of policies to apply based on an Account's group membership.
	// When Nametag evaluates policy, the first entry in this list that matches will be applied. If no group matches, then the default policy is applied.
	Groups  []GroupRecoveryPolicy `json:"groups"`
	Default RecoveryPolicy        `json:"default"`
}

RecoveryPolicyRules defines model for RecoveryPolicyRules.

type RemoveOrgMemberResp

type RemoveOrgMemberResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseRemoveOrgMemberResp

func ParseRemoveOrgMemberResp(rsp *http.Response) (*RemoveOrgMemberResp, error)

ParseRemoveOrgMemberResp parses an HTTP response from a RemoveOrgMemberWithResponse call

func (RemoveOrgMemberResp) Status

func (r RemoveOrgMemberResp) Status() string

Status returns HTTPResponse.Status

func (RemoveOrgMemberResp) StatusCode

func (r RemoveOrgMemberResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Request

type Request struct {
	// ID A unique identifier for this request
	ID string `json:"id"`

	// CreatedAt Timestamp of when this request was created
	CreatedAt time.Time `json:"created_at"`

	// UpdatedAt Timestamp of the last time this request was updated
	UpdatedAt time.Time `json:"updated_at"`

	// ExpiresAt Timestamp of when this request expires
	ExpiresAt time.Time `json:"expires_at"`

	// Ticket The request ticket (used to construct the link)
	Ticket string `json:"ticket"`

	// Link The URL which should be send to the user. This link launches the mobile app and prompts the user to verify their identity.
	Link string `json:"link"`

	// Phone The phone number that will receive an authorization link via SMS
	Phone *string `json:"phone,omitempty"`

	// Env The ID of the environment associated with the request
	Env      string `json:"env"`
	Template string `json:"template"`

	// Label The label for the request; can be empty
	Label    string          `json:"label"`
	Scopes   []Scope         `json:"scopes"`
	Status   RequestStatus   `json:"status"`
	Progress RequestProgress `json:"progress"`

	// Subject The subject of the request. Present only when `status` is `shared`. Use this as a parameter to [the properties endpoint](#get-properties) to fetch the data shared.
	Subject *string `json:"subject,omitempty"`

	// SubjectText A description of the subject (e.g. their name or email address) suitable for presentation in a user interface.
	SubjectText *string `json:"subject_text,omitempty"`

	// Requester The [member ID](#OrgMember) of the user that created this request. This field is absent for requests created via the API.
	Requester *string `json:"requester,omitempty"`

	// RequesterText A description of the requester suitable for presentation in a user interface (e.g. their name or email address)
	RequesterText *string              `json:"requester_text,omitempty"`
	Properties    RequestProperties    `json:"properties"`
	Mobile        *RequestMobileDevice `json:"mobile,omitempty"`
	Browser       *RequestBrowser      `json:"browser,omitempty"`
}

Request defines model for Request.

type RequestBrowser

type RequestBrowser struct {
	// UserAgent The browser's user agent
	UserAgent string `json:"user_agent"`

	// RemoteAddress The IP address of the browser  (This field is `null` unless the `nt:location:ip` scope is specified in the request)
	RemoteAddress         *string   `json:"remote_address,omitempty"`
	RemoteAddressLocation *Location `json:"remote_address_location,omitempty"`
}

RequestBrowser defines model for RequestBrowser.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RequestMobileDevice

type RequestMobileDevice struct {
	// OS The full operating system name and version of the mobile device
	OS string `json:"os"`

	// Version The version of the Nametag app
	Version string `json:"version"`

	// IOS `true` if the device is an iOS device, otherwise `false`
	IOS bool `json:"ios"`

	// Android `true` if the device is an Android device, otherwise `false`
	Android bool `json:"android"`

	// FullApp `true` if the request was completed in the full Nametag app, otherwise `false`
	FullApp bool `json:"full_app"`

	// AppClip `true` if the request was completed in the iOS app clip, otherwise `false`
	AppClip bool `json:"app_clip"`

	// InstantApp `true` if the request was completed in the Android instant app, otherwise `false`
	InstantApp bool `json:"instant_app"`

	// RemoteAddress The IP address of the mobile device (This field is `null` unless the `nt:location:ip` scope is specified in the request)
	RemoteAddress         *string   `json:"remote_address,omitempty"`
	RemoteAddressLocation *Location `json:"remote_address_location,omitempty"`
}

RequestMobileDevice defines model for RequestMobileDevice.

type RequestProgress

type RequestProgress string

RequestProgress defines model for RequestProgress.

const (
	RequestProgressAppOpened    RequestProgress = "app_opened"
	RequestProgressConsentGiven RequestProgress = "consent_given"
	RequestProgressFaceScanned  RequestProgress = "face_scanned"
	RequestProgressIDScanned    RequestProgress = "id_scanned"
	RequestProgressInit         RequestProgress = "created"
	RequestProgressLinkOpened   RequestProgress = "link_opened"
)

Defines values for RequestProgress.

type RequestProperties

type RequestProperties struct {
	// Phone The person's phone number
	Phone *string `json:"phone,omitempty"`

	// LegalName The person's name from their identity document
	LegalName *string `json:"legal_name,omitempty"`

	// LegalFirstName The given name (first name) from their identity document
	LegalFirstName *string `json:"legal_first_name,omitempty"`

	// LegalLastName The family name (last name) from their identity document
	LegalLastName *string `json:"legal_last_name,omitempty"`

	// Name The person's preferred name
	Name *string `json:"name,omitempty"`

	// FirstName The person's preferred given (first) name
	FirstName *string `json:"first_name,omitempty"`

	// LastName The person's preferred family (last) name
	LastName *string `json:"last_name,omitempty"`

	// BirthDate The person's date of birth
	BirthDate *openapi_types.Date `json:"birth_date,omitempty"`

	// Email Verified email address
	Email *openapi_types.Email `json:"email,omitempty"`

	// UnverifiedEmail The email address provided by a user but not verified
	UnverifiedEmail *openapi_types.Email `json:"unverified_email,omitempty"`

	// AgeOver18 `true` if the person is over 18 years old, otherwise `false`
	AgeOver18 *bool `json:"age_over_18,omitempty"`

	// AgeOver21 `true` if the person is over 21 years old, otherwise `false`
	AgeOver21 *bool `json:"age_over_21,omitempty"`

	// ProfilePicture A URL to the person's preferred profile picture. Nametag checks that the image provided is the same person as pictured on their identity document.
	ProfilePicture *string `json:"profile_picture,omitempty"`

	// Address Verified postal address
	Address       *string             `json:"address,omitempty"`
	GovtidDetails *GovtidDetailsValue `json:"govtid_details,omitempty"`
}

RequestProperties defines model for RequestProperties.

type RequestStatus

type RequestStatus string

RequestStatus defines model for RequestStatus.

const (
	RequestStatusCancelled        RequestStatus = "cancelled"
	RequestStatusExpired          RequestStatus = "expired"
	RequestStatusExpiredScopes    RequestStatus = "expired_scopes"
	RequestStatusInProgress       RequestStatus = "in_progress"
	RequestStatusPending          RequestStatus = "pending"
	RequestStatusPersonDeleted    RequestStatus = "person_deleted"
	RequestStatusRejectedFraud    RequestStatus = "rejected_fraud"
	RequestStatusRejectedInReview RequestStatus = "rejected_appealed"
	RequestStatusRejectedUnusable RequestStatus = "rejected_unusable"
	RequestStatusRevoked          RequestStatus = "revoked"
	RequestStatusShared           RequestStatus = "shared"
)

Defines values for RequestStatus.

type Role

type Role string

Role defines model for Role.

const (
	RoleAdmin       Role = "admin"
	RoleLimited     Role = "limited"
	RoleLimitedPlus Role = "limited_plus"
	RoleOwner       Role = "owner"
	RoleUser        Role = "user"
)

Defines values for Role.

type Scope

type Scope string

Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the developer console.

const (
	Login             Scope = "login"
	NtAddress         Scope = "nt:address"
	NtAgeOver18       Scope = "nt:age_over_18"
	NtAgeOver21       Scope = "nt:age_over_21"
	NtBirthDate       Scope = "nt:birth_date"
	NtEmail           Scope = "nt:email"
	NtEmailUnverified Scope = "nt:email:unverified"
	NtFirstName       Scope = "nt:first_name"
	NtGovtidDetails   Scope = "nt:govtid_details"
	NtLastName        Scope = "nt:last_name"
	NtLegalFirstName  Scope = "nt:legal_first_name"
	NtLegalLastName   Scope = "nt:legal_last_name"
	NtLegalName       Scope = "nt:legal_name"
	NtLocationIp      Scope = "nt:location:ip"
	NtName            Scope = "nt:name"
	NtPhone           Scope = "nt:phone"
	NtProfilePicture  Scope = "nt:profile_picture"
	Openid            Scope = "openid"
)

Defines values for Scope.

type SetDirectoryCredentialsJSONRequestBody

type SetDirectoryCredentialsJSONRequestBody = Credentials

SetDirectoryCredentialsJSONRequestBody defines body for SetDirectoryCredentials for application/json ContentType.

type SetDirectoryCredentialsResp

type SetDirectoryCredentialsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseSetDirectoryCredentialsResp

func ParseSetDirectoryCredentialsResp(rsp *http.Response) (*SetDirectoryCredentialsResp, error)

ParseSetDirectoryCredentialsResp parses an HTTP response from a SetDirectoryCredentialsWithResponse call

func (SetDirectoryCredentialsResp) Status

Status returns HTTPResponse.Status

func (SetDirectoryCredentialsResp) StatusCode

func (r SetDirectoryCredentialsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubjectComparisonRequest

type SubjectComparisonRequest struct {
	// Expectations A list of expectations to compare against the person's properties.
	Expectations []Expectation `json:"expectations"`
}

SubjectComparisonRequest defines model for SubjectComparisonRequest.

type SyncDirectoryResp

type SyncDirectoryResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseSyncDirectoryResp

func ParseSyncDirectoryResp(rsp *http.Response) (*SyncDirectoryResp, error)

ParseSyncDirectoryResp parses an HTTP response from a SyncDirectoryWithResponse call

func (SyncDirectoryResp) Status

func (r SyncDirectoryResp) Status() string

Status returns HTTPResponse.Status

func (SyncDirectoryResp) StatusCode

func (r SyncDirectoryResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Template

type Template struct {
	// ID A unique identifier for the template
	ID string `json:"id"`

	// CreatedAt When the template was created
	CreatedAt time.Time `json:"created_at"`

	// Name A descriptive name of the template
	Name string `json:"name"`

	// Headline The text that appears at the top of the mobile app when showing the request
	Headline string `json:"headline"`

	// QrHeadline The text that appears above the QR code when directing the user from desktop to mobile.
	QrHeadline string `json:"qr_headline"`

	// ExpirationText The text that describes when the request expires. This should include `{{.TTL}}` which is a placeholder  for the expiration of the data sharing authorization in human readable form, e.g. "3 hours"
	ExpirationText string `json:"expiration_text"`

	// AcceptText The text on the accept button in the mobile app.
	AcceptText string `json:"accept_text"`

	// AcceptedText The text that appears on the confirmation view after a request has been accepted.
	AcceptedText string `json:"accepted_text"`

	// InstallMessageSMS The contents of the SMS message sent to users to direct them to the mobile app. This must contain the  `{{.Link}}` which is a placeholder for the actual link.
	InstallMessageSMS string `json:"install_message_sms"`

	// IsDefault If true then this is the default template used when a template is not explicitly specified. There must be  exactly one default template.
	IsDefault bool `json:"is_default"`

	// ScopeDefinitions A list of scopes that are requested when requests are created with this template.
	ScopeDefinitions []TemplateScopeDefinition `json:"scope_definitions"`

	// ScopesExpireIn How long the data sharing authorization should last, in seconds.
	ScopesExpireIn int `json:"scopes_expire_in"`

	// Enabled If true, then this template is enabled for requests. The default template must be enabled.
	Enabled bool `json:"enabled"`

	// RequireSelfieReverification If true, existing users must provide a new selfie to validate their identity.
	RequireSelfieReverification bool `json:"require_selfie_reverification"`
}

Template defines model for Template.

type TemplateScopeDefinition

type TemplateScopeDefinition struct {
	// Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you  must first define it in your environment and provide additional parameters, such as what type of data and how  long you need the data. This is done separately for each environment you manage in the developer console.
	Scope Scope `json:"scope"`

	// RestrictEmailDomains If the scope definition is for nt:email or similar, require that the email domain match one of the provided values. If the scope definition is not for email, or if the list is empty, then emails from any domain are allowed.
	RestrictEmailDomains []string `json:"restrict_email_domains,omitempty"`
}

TemplateScopeDefinition defines model for TemplateScopeDefinition.

type TokenRequest

type TokenRequest struct {
	GrantType    TokenRequestGrantType `json:"grant_type"`
	ClientID     string                `json:"client_id"`
	ClientSecret string                `json:"client_secret"`
	RedirectURI  string                `json:"redirect_uri"`
	Code         string                `json:"code"`
	CodeVerifier *string               `json:"code_verifier,omitempty"`
}

TokenRequest defines model for TokenRequest.

type TokenRequestGrantType

type TokenRequestGrantType string

TokenRequestGrantType defines model for TokenRequest.GrantType.

const (
	AuthorizationCode TokenRequestGrantType = "authorization_code"
)

Defines values for TokenRequestGrantType.

type TokenResponse

type TokenResponse struct {
	AccessToken  string                 `json:"access_token"`
	RefreshToken string                 `json:"refresh_token"`
	IDToken      string                 `json:"id_token"`
	Scope        string                 `json:"scope"`
	ExpiresIn    int                    `json:"expires_in"`
	TokenType    TokenResponseTokenType `json:"token_type"`
	Subject      string                 `json:"subject"`
}

TokenResponse defines model for TokenResponse.

type TokenResponseError

type TokenResponseError struct {
	Code             string `json:"error"`
	ErrorDescription string `json:"error_description,omitempty"`
	URI              string `json:"uri,omitempty"`
}

TokenResponseError defines model for TokenResponseError.

type TokenResponseTokenType

type TokenResponseTokenType string

TokenResponseTokenType defines model for TokenResponse.TokenType.

const (
	TokenTypeBearer TokenResponseTokenType = "Bearer"
)

Defines values for TokenResponseTokenType.

type UpdateAPIKeyJSONRequestBody

type UpdateAPIKeyJSONRequestBody = APIKeyUpdateRequest

UpdateAPIKeyJSONRequestBody defines body for UpdateAPIKey for application/json ContentType.

type UpdateAPIKeyResp

type UpdateAPIKeyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseUpdateAPIKeyResp

func ParseUpdateAPIKeyResp(rsp *http.Response) (*UpdateAPIKeyResp, error)

ParseUpdateAPIKeyResp parses an HTTP response from a UpdateAPIKeyWithResponse call

func (UpdateAPIKeyResp) Status

func (r UpdateAPIKeyResp) Status() string

Status returns HTTPResponse.Status

func (UpdateAPIKeyResp) StatusCode

func (r UpdateAPIKeyResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateAccountJSONRequestBody

type UpdateAccountJSONRequestBody = AccountUpdateRequest

UpdateAccountJSONRequestBody defines body for UpdateAccount for application/json ContentType.

type UpdateAccountResp

type UpdateAccountResp struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseUpdateAccountResp

func ParseUpdateAccountResp(rsp *http.Response) (*UpdateAccountResp, error)

ParseUpdateAccountResp parses an HTTP response from a UpdateAccountWithResponse call

func (UpdateAccountResp) Status

func (r UpdateAccountResp) Status() string

Status returns HTTPResponse.Status

func (UpdateAccountResp) StatusCode

func (r UpdateAccountResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateEnvJSONRequestBody

type UpdateEnvJSONRequestBody = EnvUpdateRequest

UpdateEnvJSONRequestBody defines body for UpdateEnv for application/json ContentType.

type UpdateEnvResp

type UpdateEnvResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseUpdateEnvResp

func ParseUpdateEnvResp(rsp *http.Response) (*UpdateEnvResp, error)

ParseUpdateEnvResp parses an HTTP response from a UpdateEnvWithResponse call

func (UpdateEnvResp) Status

func (r UpdateEnvResp) Status() string

Status returns HTTPResponse.Status

func (UpdateEnvResp) StatusCode

func (r UpdateEnvResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateOrgJSONRequestBody

type UpdateOrgJSONRequestBody = OrgUpdateRequest

UpdateOrgJSONRequestBody defines body for UpdateOrg for application/json ContentType.

type UpdateOrgMemberJSONRequestBody

type UpdateOrgMemberJSONRequestBody = UpdateOrgMemberRequest

UpdateOrgMemberJSONRequestBody defines body for UpdateOrgMember for application/json ContentType.

type UpdateOrgMemberRequest

type UpdateOrgMemberRequest struct {
	// Envs The list of environments the member will have access to. If the list contains `*`, the member will have access
	// to all environments.
	Envs []string `json:"envs,omitempty"`
	Role *Role    `json:"role,omitempty"`
}

UpdateOrgMemberRequest defines model for UpdateOrgMemberRequest.

type UpdateOrgMemberResp

type UpdateOrgMemberResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseUpdateOrgMemberResp

func ParseUpdateOrgMemberResp(rsp *http.Response) (*UpdateOrgMemberResp, error)

ParseUpdateOrgMemberResp parses an HTTP response from a UpdateOrgMemberWithResponse call

func (UpdateOrgMemberResp) Status

func (r UpdateOrgMemberResp) Status() string

Status returns HTTPResponse.Status

func (UpdateOrgMemberResp) StatusCode

func (r UpdateOrgMemberResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateOrgResp

type UpdateOrgResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseUpdateOrgResp

func ParseUpdateOrgResp(rsp *http.Response) (*UpdateOrgResp, error)

ParseUpdateOrgResp parses an HTTP response from a UpdateOrgWithResponse call

func (UpdateOrgResp) Status

func (r UpdateOrgResp) Status() string

Status returns HTTPResponse.Status

func (UpdateOrgResp) StatusCode

func (r UpdateOrgResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateRequestJSONRequestBody

type UpdateRequestJSONRequestBody = UpdateRequestRequest

UpdateRequestJSONRequestBody defines body for UpdateRequest for application/json ContentType.

type UpdateRequestRequest

type UpdateRequestRequest struct {
	// Label An internal label for this request. You can use this field to help you track the request in your own systems. Nametag stores this field, but does not process it.
	Label *string `json:"label,omitempty"`
}

UpdateRequestRequest defines model for UpdateRequestRequest.

type UpdateRequestResp

type UpdateRequestResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseUpdateRequestResp

func ParseUpdateRequestResp(rsp *http.Response) (*UpdateRequestResp, error)

ParseUpdateRequestResp parses an HTTP response from a UpdateRequestWithResponse call

func (UpdateRequestResp) Status

func (r UpdateRequestResp) Status() string

Status returns HTTPResponse.Status

func (UpdateRequestResp) StatusCode

func (r UpdateRequestResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateTemplateJSONRequestBody

type UpdateTemplateJSONRequestBody = UpdateTemplateRequest

UpdateTemplateJSONRequestBody defines body for UpdateTemplate for application/json ContentType.

type UpdateTemplateRequest

type UpdateTemplateRequest struct {
	// Name A descriptive name of the template
	Name *string `json:"name,omitempty"`

	// Headline The text that appears at the top of the mobile app when showing the request
	Headline *string `json:"headline,omitempty"`

	// QrHeadline The text that appears above the QR code when directing the user from desktop to mobile.
	QrHeadline *string `json:"qr_headline,omitempty"`

	// ExpirationText The text that describes when the request expires. This should include `{{.TTL}}` which is a placeholder  for the expiration of the data sharing authorization in human readable form, e.g. "3 hours"
	ExpirationText *string `json:"expiration_text,omitempty"`

	// AcceptText The text on the accept button in the mobile app.
	AcceptText *string `json:"accept_text,omitempty"`

	// AcceptedText The text that appears on the confirmation view after a request has been accepted.
	AcceptedText *string `json:"accepted_text,omitempty"`

	// InstallMessageSMS The contents of the SMS message sent to users to direct them to the mobile app. This must contain the  `{{.Link}}` which is a placeholder for the actual link.
	InstallMessageSMS *string `json:"install_message_sms,omitempty"`

	// IsDefault If true then this is the default template used when a template is not explicitly specified. There must be  exactly one default template.
	IsDefault *bool `json:"is_default,omitempty"`

	// ScopeDefinitions A list of scopes that are requested when requests are created with this template.
	ScopeDefinitions []TemplateScopeDefinition `json:"scope_definitions,omitempty"`

	// ScopesExpireIn How long the data sharing authorization should last, in seconds.
	ScopesExpireIn *int `json:"scopes_expire_in,omitempty"`

	// Enabled If true, then this template is enabled for requests. The default template must be enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// RequireSelfieReverification If true, existing users must provide a new selfie to validate their identity.
	RequireSelfieReverification *bool `json:"require_selfie_reverification,omitempty"`
}

UpdateTemplateRequest defines model for UpdateTemplateRequest.

type UpdateTemplateResp

type UpdateTemplateResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseUpdateTemplateResp

func ParseUpdateTemplateResp(rsp *http.Response) (*UpdateTemplateResp, error)

ParseUpdateTemplateResp parses an HTTP response from a UpdateTemplateWithResponse call

func (UpdateTemplateResp) Status

func (r UpdateTemplateResp) Status() string

Status returns HTTPResponse.Status

func (UpdateTemplateResp) StatusCode

func (r UpdateTemplateResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UploadAccountPhotoResp

type UploadAccountPhotoResp struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseUploadAccountPhotoResp

func ParseUploadAccountPhotoResp(rsp *http.Response) (*UploadAccountPhotoResp, error)

ParseUploadAccountPhotoResp parses an HTTP response from a UploadAccountPhotoWithResponse call

func (UploadAccountPhotoResp) Status

func (r UploadAccountPhotoResp) Status() string

Status returns HTTPResponse.Status

func (UploadAccountPhotoResp) StatusCode

func (r UploadAccountPhotoResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UploadLogoMultipartBody

type UploadLogoMultipartBody struct {
}

UploadLogoMultipartBody defines parameters for UploadLogo.

type UploadLogoMultipartRequestBody

type UploadLogoMultipartRequestBody UploadLogoMultipartBody

UploadLogoMultipartRequestBody defines body for UploadLogo for multipart/form-data ContentType.

type UploadLogoParams

type UploadLogoParams struct {
	// Kind The kind of logo to upload
	Kind *LogoKind `form:"kind,omitempty" json:"kind,omitempty"`
}

UploadLogoParams defines parameters for UploadLogo.

type UploadLogoResp

type UploadLogoResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
}

func ParseUploadLogoResp

func ParseUploadLogoResp(rsp *http.Response) (*UploadLogoResp, error)

ParseUploadLogoResp parses an HTTP response from a UploadLogoWithResponse call

func (UploadLogoResp) Status

func (r UploadLogoResp) Status() string

Status returns HTTPResponse.Status

func (UploadLogoResp) StatusCode

func (r UploadLogoResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Webhook

type Webhook struct {
	ID            string           `json:"id"`
	Status        int              `json:"status"`
	URL           string           `json:"url"`
	Body          string           `json:"body"`
	RequestHeader []WebhookHeader  `json:"request_header"`
	Attempts      []WebhookAttempt `json:"attempts"`
}

Webhook defines model for Webhook.

type WebhookAttempt

type WebhookAttempt struct {
	StartTime time.Time       `json:"start_time"`
	EndTime   time.Time       `json:"end_time"`
	Status    int             `json:"status"`
	Header    []WebhookHeader `json:"header"`
	Body      string          `json:"body"`
	Error     string          `json:"error,omitempty"`
}

WebhookAttempt defines model for WebhookAttempt.

type WebhookDefinition

type WebhookDefinition struct {
	// ID A unique identifier for the webhook definition.
	ID string `json:"id"`

	// URL The URL in your service that should be called, e.g. `https://example.com/__callback`
	URL string `json:"url"`

	// Enabled If true, then calls to this webhook should be made.
	Enabled bool `json:"enabled"`

	// Events The names of the events that should be sent.
	Events []WebhookEventType `json:"events"`
}

WebhookDefinition defines model for WebhookDefinition.

type WebhookDefinitionUpdate

type WebhookDefinitionUpdate struct {
	ID      string             `json:"id"`
	URL     *string            `json:"url,omitempty"`
	Enabled *bool              `json:"enabled,omitempty"`
	Events  []WebhookEventType `json:"events,omitempty"`
}

WebhookDefinitionUpdate defines model for WebhookDefinitionUpdate.

type WebhookEventType

type WebhookEventType string

WebhookEventType defines model for WebhookEventType.

const (
	WebhookEventTypeRecover WebhookEventType = "recover"
	WebhookEventTypeReject  WebhookEventType = "reject"
	WebhookEventTypeRequest WebhookEventType = "request"
	WebhookEventTypeShare   WebhookEventType = "share"
)

Defines values for WebhookEventType.

type WebhookHeader

type WebhookHeader struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

WebhookHeader defines model for WebhookHeader.

Jump to

Keyboard shortcuts

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