api

package
v0.1.28 Latest Latest
Warning

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

Go to latest
Published: Aug 26, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

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

Code generated by unknown module path version unknown version DO NOT EDIT.

Index

Constants

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

Variables

This section is empty.

Functions

func NewBulkUpdateAccountsRequest added in v0.1.12

func NewBulkUpdateAccountsRequest(server string, body BulkUpdateAccountsJSONRequestBody) (*http.Request, error)

NewBulkUpdateAccountsRequest calls the generic BulkUpdateAccounts builder with application/json body

func NewBulkUpdateAccountsRequestWithBody added in v0.1.12

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

NewBulkUpdateAccountsRequestWithBody generates requests for BulkUpdateAccounts with any type of body

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, body CreateDirectoryJSONRequestBody) (*http.Request, error)

NewCreateDirectoryRequest calls the generic CreateDirectory builder with application/json body

func NewCreateDirectoryRequestWithBody

func NewCreateDirectoryRequestWithBody(server 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 NewCreateWorkdayIntegrationRequest added in v0.1.20

func NewCreateWorkdayIntegrationRequest(server string, env string, body CreateWorkdayIntegrationJSONRequestBody) (*http.Request, error)

NewCreateWorkdayIntegrationRequest calls the generic CreateWorkdayIntegration builder with application/json body

func NewCreateWorkdayIntegrationRequestWithBody added in v0.1.20

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

NewCreateWorkdayIntegrationRequestWithBody generates requests for CreateWorkdayIntegration with any type of body

func NewCreateWorkdayRequestRequest added in v0.1.20

func NewCreateWorkdayRequestRequest(server string, body CreateWorkdayRequestJSONRequestBody) (*http.Request, error)

NewCreateWorkdayRequestRequest calls the generic CreateWorkdayRequest builder with application/json body

func NewCreateWorkdayRequestRequestWithBody added in v0.1.20

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

NewCreateWorkdayRequestRequestWithBody generates requests for CreateWorkdayRequest with any type of body

func NewDeleteAPIKeyRequest

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

NewDeleteAPIKeyRequest generates requests for DeleteAPIKey

func NewDeleteAshbyIntegrationRequest added in v0.1.23

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

NewDeleteAshbyIntegrationRequest generates requests for DeleteAshbyIntegration

func NewDeleteDirectoryLogoRequest added in v0.1.16

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

NewDeleteDirectoryLogoRequest generates requests for DeleteDirectoryLogo

func NewDeleteDirectoryRequest

func NewDeleteDirectoryRequest(server 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 NewDeleteGreenhouseIntegrationRequest added in v0.1.22

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

NewDeleteGreenhouseIntegrationRequest generates requests for DeleteGreenhouseIntegration

func NewDeleteIntercomIntegrationRequest added in v0.1.23

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

NewDeleteIntercomIntegrationRequest generates requests for DeleteIntercomIntegration

func NewDeleteJoinIntegrationRequest added in v0.1.24

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

NewDeleteJoinIntegrationRequest generates requests for DeleteJoinIntegration

func NewDeleteLeverIntegrationRequest added in v0.1.23

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

NewDeleteLeverIntegrationRequest generates requests for DeleteLeverIntegration

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 NewDeleteRecruiteeIntegrationRequest added in v0.1.23

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

NewDeleteRecruiteeIntegrationRequest generates requests for DeleteRecruiteeIntegration

func NewDeleteSharedDevicesRequest added in v0.1.22

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

NewDeleteSharedDevicesRequest generates requests for DeleteSharedDevices

func NewDeleteSlackIntegrationRequest added in v0.1.17

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

NewDeleteSlackIntegrationRequest generates requests for DeleteSlackIntegration

func NewDeleteSlateIntegrationRequest added in v0.1.24

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

NewDeleteSlateIntegrationRequest generates requests for DeleteSlateIntegration

func NewDeleteTemplateRequest

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

NewDeleteTemplateRequest generates requests for DeleteTemplate

func NewDeleteWorkableIntegrationRequest added in v0.1.23

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

NewDeleteWorkableIntegrationRequest generates requests for DeleteWorkableIntegration

func NewDeleteWorkdayIntegrationRequest added in v0.1.20

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

NewDeleteWorkdayIntegrationRequest generates requests for DeleteWorkdayIntegration

func NewDownloadRequestProofRequest added in v0.1.24

func NewDownloadRequestProofRequest(server string, requestID string, params *DownloadRequestProofParams) (*http.Request, error)

NewDownloadRequestProofRequest generates requests for DownloadRequestProof

func NewEncryptSecretRequest added in v0.1.18

func NewEncryptSecretRequest(server string, env string, body EncryptSecretJSONRequestBody) (*http.Request, error)

NewEncryptSecretRequest calls the generic EncryptSecret builder with application/json body

func NewEncryptSecretRequestWithBody added in v0.1.18

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

NewEncryptSecretRequestWithBody generates requests for EncryptSecret with any type of body

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 NewGetAshbyIntegrationRequest added in v0.1.23

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

NewGetAshbyIntegrationRequest generates requests for GetAshbyIntegration

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, directory string) (*http.Request, error)

NewGetDirectoryAuthorizationURLRequest generates requests for GetDirectoryAuthorizationURL

func NewGetDirectoryRequest

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

NewGetDirectoryRequest generates requests for GetDirectory

func NewGetEnvMicrometricsRequest added in v0.1.16

func NewGetEnvMicrometricsRequest(server string, env string, params *GetEnvMicrometricsParams) (*http.Request, error)

NewGetEnvMicrometricsRequest generates requests for GetEnvMicrometrics

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 NewGetGreenhouseIntegrationRequest added in v0.1.22

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

NewGetGreenhouseIntegrationRequest generates requests for GetGreenhouseIntegration

func NewGetIntercomIntegrationByIDRequest added in v0.1.23

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

NewGetIntercomIntegrationByIDRequest generates requests for GetIntercomIntegrationByID

func NewGetIntercomIntegrationRequest added in v0.1.23

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

NewGetIntercomIntegrationRequest generates requests for GetIntercomIntegration

func NewGetJoinIntegrationRequest added in v0.1.24

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

NewGetJoinIntegrationRequest generates requests for GetJoinIntegration

func NewGetLeverIntegrationRequest added in v0.1.23

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

NewGetLeverIntegrationRequest generates requests for GetLeverIntegration

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 NewGetRecruiteeIntegrationRequest added in v0.1.23

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

NewGetRecruiteeIntegrationRequest generates requests for GetRecruiteeIntegration

func NewGetRequestRequest

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

NewGetRequestRequest generates requests for GetRequest

func NewGetSharedDeviceRegistrationStatusRequest added in v0.1.22

func NewGetSharedDeviceRegistrationStatusRequest(server string, env string, params *GetSharedDeviceRegistrationStatusParams) (*http.Request, error)

NewGetSharedDeviceRegistrationStatusRequest generates requests for GetSharedDeviceRegistrationStatus

func NewGetSlackRequestDetailsRequest added in v0.1.17

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

NewGetSlackRequestDetailsRequest generates requests for GetSlackRequestDetails

func NewGetSlateIntegrationRequest added in v0.1.24

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

NewGetSlateIntegrationRequest generates requests for GetSlateIntegration

func NewGetWorkableIntegrationRequest added in v0.1.23

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

NewGetWorkableIntegrationRequest generates requests for GetWorkableIntegration

func NewGetWorkdayIntegrationRequest added in v0.1.20

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

NewGetWorkdayIntegrationRequest generates requests for GetWorkdayIntegration

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 NewListAshbyIntegrationsRequest added in v0.1.23

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

NewListAshbyIntegrationsRequest generates requests for ListAshbyIntegrations

func NewListAshbyStagesRequest added in v0.1.23

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

NewListAshbyStagesRequest generates requests for ListAshbyStages

func NewListAuditEventsRequest added in v0.1.15

func NewListAuditEventsRequest(server string, params *ListAuditEventsParams) (*http.Request, error)

NewListAuditEventsRequest generates requests for ListAuditEvents

func NewListDirectoriesRequest

func NewListDirectoriesRequest(server string) (*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 NewListGreenhouseIntegrationsRequest added in v0.1.22

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

NewListGreenhouseIntegrationsRequest generates requests for ListGreenhouseIntegrations

func NewListIntegrationsRequest added in v0.1.22

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

NewListIntegrationsRequest generates requests for ListIntegrations

func NewListJoinIntegrationsRequest added in v0.1.24

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

NewListJoinIntegrationsRequest generates requests for ListJoinIntegrations

func NewListLeverIntegrationsRequest added in v0.1.23

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

NewListLeverIntegrationsRequest generates requests for ListLeverIntegrations

func NewListOrgMembersRequest

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

NewListOrgMembersRequest generates requests for ListOrgMembers

func NewListRecruiteeIntegrationsRequest added in v0.1.23

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

NewListRecruiteeIntegrationsRequest generates requests for ListRecruiteeIntegrations

func NewListSharedDevicesRequest added in v0.1.22

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

NewListSharedDevicesRequest generates requests for ListSharedDevices

func NewListSlackIntegrationsRequest added in v0.1.17

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

NewListSlackIntegrationsRequest generates requests for ListSlackIntegrations

func NewListSlateIntegrationsRequest added in v0.1.24

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

NewListSlateIntegrationsRequest generates requests for ListSlateIntegrations

func NewListWebhooksRequest

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

NewListWebhooksRequest generates requests for ListWebhooks

func NewListWorkableIntegrationsRequest added in v0.1.23

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

NewListWorkableIntegrationsRequest generates requests for ListWorkableIntegrations

func NewListWorkableJobsRequest added in v0.1.23

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

NewListWorkableJobsRequest generates requests for ListWorkableJobs

func NewListWorkdayIntegrationsRequest added in v0.1.20

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

NewListWorkdayIntegrationsRequest generates requests for ListWorkdayIntegrations

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 NewPresignRecoveryMicrositeURLRequest added in v0.1.12

func NewPresignRecoveryMicrositeURLRequest(server string, env string, body PresignRecoveryMicrositeURLJSONRequestBody) (*http.Request, error)

NewPresignRecoveryMicrositeURLRequest calls the generic PresignRecoveryMicrositeURL builder with application/json body

func NewPresignRecoveryMicrositeURLRequestWithBody added in v0.1.12

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

NewPresignRecoveryMicrositeURLRequestWithBody generates requests for PresignRecoveryMicrositeURL with any type of body

func NewRefreshWebhookSecretRequest added in v0.1.12

func NewRefreshWebhookSecretRequest(server string, env string, body RefreshWebhookSecretJSONRequestBody) (*http.Request, error)

NewRefreshWebhookSecretRequest calls the generic RefreshWebhookSecret builder with application/json body

func NewRefreshWebhookSecretRequestWithBody added in v0.1.12

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

NewRefreshWebhookSecretRequestWithBody generates requests for RefreshWebhookSecret with any type of body

func NewRegenerateDirectoryAgentTokenRequest added in v0.1.16

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

NewRegenerateDirectoryAgentTokenRequest generates requests for RegenerateDirectoryAgentToken

func NewRegisterSharedDeviceRequest added in v0.1.22

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

NewRegisterSharedDeviceRequest generates requests for RegisterSharedDevice

func NewRemoveOrgMemberRequest

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

NewRemoveOrgMemberRequest generates requests for RemoveOrgMember

func NewSetDirectoryCredentialsRequest

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

NewSetDirectoryCredentialsRequest calls the generic SetDirectoryCredentials builder with application/json body

func NewSetDirectoryCredentialsRequestWithBody

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

NewSetDirectoryCredentialsRequestWithBody generates requests for SetDirectoryCredentials with any type of body

func NewSetPictureRequestWithBody added in v0.1.19

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

NewSetPictureRequestWithBody generates requests for SetPicture with any type of body

func NewSetPreferredNameRequest added in v0.1.19

func NewSetPreferredNameRequest(server string, subject string, body SetPreferredNameJSONRequestBody) (*http.Request, error)

NewSetPreferredNameRequest calls the generic SetPreferredName builder with application/json body

func NewSetPreferredNameRequestWithBody added in v0.1.19

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

NewSetPreferredNameRequestWithBody generates requests for SetPreferredName with any type of body

func NewSyncDirectoryRequest

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

NewSyncDirectoryRequest generates requests for SyncDirectory

func NewTestSlateIntegrationRequest added in v0.1.24

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

NewTestSlateIntegrationRequest generates requests for TestSlateIntegration

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 NewUpdateAshbyIntegrationRequest added in v0.1.23

func NewUpdateAshbyIntegrationRequest(server string, env string, integration string, body UpdateAshbyIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateAshbyIntegrationRequest calls the generic UpdateAshbyIntegration builder with application/json body

func NewUpdateAshbyIntegrationRequestWithBody added in v0.1.23

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

NewUpdateAshbyIntegrationRequestWithBody generates requests for UpdateAshbyIntegration with any type of body

func NewUpdateDirectoryRequest added in v0.1.12

func NewUpdateDirectoryRequest(server string, directory string, body UpdateDirectoryJSONRequestBody) (*http.Request, error)

NewUpdateDirectoryRequest calls the generic UpdateDirectory builder with application/json body

func NewUpdateDirectoryRequestWithBody added in v0.1.12

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

NewUpdateDirectoryRequestWithBody generates requests for UpdateDirectory 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 NewUpdateGreenhouseIntegrationRequest added in v0.1.22

func NewUpdateGreenhouseIntegrationRequest(server string, env string, integration string, body UpdateGreenhouseIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateGreenhouseIntegrationRequest calls the generic UpdateGreenhouseIntegration builder with application/json body

func NewUpdateGreenhouseIntegrationRequestWithBody added in v0.1.22

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

NewUpdateGreenhouseIntegrationRequestWithBody generates requests for UpdateGreenhouseIntegration with any type of body

func NewUpdateIntercomIntegrationRequest added in v0.1.23

func NewUpdateIntercomIntegrationRequest(server string, env string, integration string, body UpdateIntercomIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateIntercomIntegrationRequest calls the generic UpdateIntercomIntegration builder with application/json body

func NewUpdateIntercomIntegrationRequestWithBody added in v0.1.23

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

NewUpdateIntercomIntegrationRequestWithBody generates requests for UpdateIntercomIntegration with any type of body

func NewUpdateJoinIntegrationRequest added in v0.1.24

func NewUpdateJoinIntegrationRequest(server string, env string, integration string, body UpdateJoinIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateJoinIntegrationRequest calls the generic UpdateJoinIntegration builder with application/json body

func NewUpdateJoinIntegrationRequestWithBody added in v0.1.24

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

NewUpdateJoinIntegrationRequestWithBody generates requests for UpdateJoinIntegration with any type of body

func NewUpdateLeverIntegrationRequest added in v0.1.23

func NewUpdateLeverIntegrationRequest(server string, env string, integration string, body UpdateLeverIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateLeverIntegrationRequest calls the generic UpdateLeverIntegration builder with application/json body

func NewUpdateLeverIntegrationRequestWithBody added in v0.1.23

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

NewUpdateLeverIntegrationRequestWithBody generates requests for UpdateLeverIntegration 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 NewUpdateRecruiteeIntegrationRequest added in v0.1.23

func NewUpdateRecruiteeIntegrationRequest(server string, env string, integration string, body UpdateRecruiteeIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateRecruiteeIntegrationRequest calls the generic UpdateRecruiteeIntegration builder with application/json body

func NewUpdateRecruiteeIntegrationRequestWithBody added in v0.1.23

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

NewUpdateRecruiteeIntegrationRequestWithBody generates requests for UpdateRecruiteeIntegration 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 NewUpdateSlateIntegrationRequest added in v0.1.24

func NewUpdateSlateIntegrationRequest(server string, env string, integration string, body UpdateSlateIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateSlateIntegrationRequest calls the generic UpdateSlateIntegration builder with application/json body

func NewUpdateSlateIntegrationRequestWithBody added in v0.1.24

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

NewUpdateSlateIntegrationRequestWithBody generates requests for UpdateSlateIntegration 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 NewUpdateWorkableIntegrationRequest added in v0.1.23

func NewUpdateWorkableIntegrationRequest(server string, env string, integration string, body UpdateWorkableIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateWorkableIntegrationRequest calls the generic UpdateWorkableIntegration builder with application/json body

func NewUpdateWorkableIntegrationRequestWithBody added in v0.1.23

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

NewUpdateWorkableIntegrationRequestWithBody generates requests for UpdateWorkableIntegration with any type of body

func NewUpdateWorkdayIntegrationRequest added in v0.1.20

func NewUpdateWorkdayIntegrationRequest(server string, env string, integration string, body UpdateWorkdayIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateWorkdayIntegrationRequest calls the generic UpdateWorkdayIntegration builder with application/json body

func NewUpdateWorkdayIntegrationRequestWithBody added in v0.1.20

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

NewUpdateWorkdayIntegrationRequestWithBody generates requests for UpdateWorkdayIntegration 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 NewUploadDirectoryLogoRequestWithBody added in v0.1.16

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

NewUploadDirectoryLogoRequestWithBody generates requests for UploadDirectoryLogo 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

func NewValidateWorkdayIntegrationRequest added in v0.1.22

func NewValidateWorkdayIntegrationRequest(server string, env string, body ValidateWorkdayIntegrationJSONRequestBody) (*http.Request, error)

NewValidateWorkdayIntegrationRequest calls the generic ValidateWorkdayIntegration builder with application/json body

func NewValidateWorkdayIntegrationRequestWithBody added in v0.1.22

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

NewValidateWorkdayIntegrationRequestWithBody generates requests for ValidateWorkdayIntegration 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"`

	// CreatedBy The OrgMember ID that created this API key.
	CreatedBy *string `json:"created_by,omitempty"`

	// Enabled Whether the API key is enabled.
	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 The role assigned to the API key. The role determines what actions the  API key can perform.
	Role Role `json:"role"`

	// ExpiresAt The expiration date and time for the API key. If not provided, the key will not expire. Example: "2023-12-31T23:59:59Z"
	ExpiresAt *time.Time `json:"expires_at,omitempty"`

	// LastUsedAt The last time the API key was used. This is updated each time the key is used to make a request.
	LastUsedAt *time.Time `json:"last_used_at,omitempty"`
}

APIKey defines model for APIKey.

type APIKeyCreatedAuditEvent added in v0.1.15

type APIKeyCreatedAuditEvent struct {
	Request  CreateAPIKeyRequest  `json:"request"`
	Response CreateAPIKeyResponse `json:"response"`
}

APIKeyCreatedAuditEvent defines model for APIKeyCreatedAuditEvent.

type APIKeyDeletedAuditEvent added in v0.1.15

type APIKeyDeletedAuditEvent struct {
	Apikey string `json:"apikey"`
}

APIKeyDeletedAuditEvent defines model for APIKeyDeletedAuditEvent.

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 The role assigned to the API key. The role determines what actions the  API key can perform.
	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"`

	// ExpiresAt The expiration date and time for the API key. If the field is omitted, the expiration is left unchanged; if explicitly set to `null`, the expiration is cleared and the key will not expire. Example: "2023-12-31T23:59:59Z"
	ExpiresAt json.RawMessage `json:"expires_at,omitempty"`
}

APIKeyUpdateRequest defines model for APIKeyUpdateRequest.

type APIKeyUpdatedAuditEvent added in v0.1.15

type APIKeyUpdatedAuditEvent struct {
	Apikey  string              `json:"apikey"`
	Request APIKeyUpdateRequest `json:"request"`
}

APIKeyUpdatedAuditEvent defines model for APIKeyUpdatedAuditEvent.

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 a 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 A verified photo of the person that you provide. If this field is set prior to being bound to a `subject`, then the selfie must match this photo.
	Photo *AccountPhoto `json:"photo,omitempty"`
}

Account defines model for Account.

type AccountBulkUpdateRequest added in v0.1.12

type AccountBulkUpdateRequest struct {
	// Accounts A list of account update operations
	Accounts []AccountBulkUpdateRequestItem `json:"accounts"`
}

AccountBulkUpdateRequest defines model for AccountBulkUpdateRequest.

type AccountBulkUpdateRequestItem added in v0.1.12

type AccountBulkUpdateRequestItem 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 hash or HMAC of the person's birth date.  See [Birth date hashes](/docs/birth-date-hash) for details.
	BirthDate *string `json:"birth_date,omitempty"`

	// ID The unique identifier of the account. This can be the Nametag ID
	// for the account, the immutable ID of the account (e.g. the GUID in
	// Azure AD), or one of the identifiers associated with the account,
	// (e.g. the email address, username, or UPN).
	ID string `json:"id"`
}

AccountBulkUpdateRequestItem defines model for AccountBulkUpdateRequestItem.

type AccountBulkUpdateResponse added in v0.1.12

type AccountBulkUpdateResponse struct {
	Results []AccountBulkUpdateResponseItem `json:"results"`
}

AccountBulkUpdateResponse defines model for AccountBulkUpdateResponse.

type AccountBulkUpdateResponseItem added in v0.1.12

type AccountBulkUpdateResponseItem struct {
	// ID The account identifier provided in the request
	ID string `json:"id"`

	// Status A status code that describes whether the operation was successful
	Status AccountBulkUpdateStatus `json:"status"`

	// Error A description of the error that occurred.
	Error *string `json:"error,omitempty"`
}

AccountBulkUpdateResponseItem The status of each operation specified in the request

type AccountBulkUpdateStatus added in v0.1.12

type AccountBulkUpdateStatus int

AccountBulkUpdateStatus A status code that describes whether the operation was successful

const (
	AccountBulkUpdateItemStatusBadRequest AccountBulkUpdateStatus = 400
	AccountBulkUpdateItemStatusConflict   AccountBulkUpdateStatus = 409
	AccountBulkUpdateItemStatusNotFound   AccountBulkUpdateStatus = 404
	AccountBulkUpdateItemStatusOK         AccountBulkUpdateStatus = 204
)

Defines values for AccountBulkUpdateStatus.

func (AccountBulkUpdateStatus) Valid added in v0.1.22

func (e AccountBulkUpdateStatus) Valid() bool

Valid indicates whether the value is a known member of the AccountBulkUpdateStatus enum.

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 AccountPhotoUploadedAuditEvent added in v0.1.15

type AccountPhotoUploadedAuditEvent struct {
	Account   string `json:"account"`
	Directory string `json:"directory"`
}

AccountPhotoUploadedAuditEvent defines model for AccountPhotoUploadedAuditEvent.

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 hash or HMAC of the person's birth date. See [Birth date hashes](/docs/birth-date-hash) for details.
	BirthDate *string `json:"birth_date,omitempty"`
}

AccountUpdateRequest defines model for AccountUpdateRequest.

type AccountUpdatedAuditEvent added in v0.1.15

type AccountUpdatedAuditEvent struct {
	Account   string               `json:"account"`
	Directory string               `json:"directory"`
	Request   AccountUpdateRequest `json:"request"`
}

AccountUpdatedAuditEvent defines model for AccountUpdatedAuditEvent.

type AccountValue added in v0.1.18

type AccountValue struct {
	// ImmutableExternalId A GUID that uniquely identifies this entry in the directory, even if the external IDs change
	ImmutableExternalId *string `json:"immutable_external_id,omitempty"`

	// Ids The list of ID's associated with the account
	Ids *[]string `json:"ids,omitempty"`

	// BindingStrength The binding strength used to determine account info
	BindingStrength *string `json:"binding_strength,omitempty"`
}

AccountValue defines model for AccountValue.

type AccountsList

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

	// NextOffset A value for the offset query parameter for the next page of results
	NextOffset *int `json:"next_offset,omitempty"`
}

AccountsList defines model for AccountsList.

type AshbyConfig added in v0.1.23

type AshbyConfig struct {
	// Triggers Which Ashby events launch a Nametag check. For stage changes, `stage_ids`
	// limits the trigger to specific Ashby interview stage IDs.
	Triggers *AshbyTriggerConfig `json:"triggers,omitempty"`

	// Outputs Which write-back outputs are produced on a completed check.
	Outputs           *AshbyOutputConfig `json:"outputs,omitempty"`
	LocationIntegrity *bool              `json:"location_integrity,omitempty"`
	FlagPendingFailed *bool              `json:"flag_pending_failed,omitempty"`
}

AshbyConfig Per-tenant trigger and write-back configuration for an Ashby integration.

type AshbyIntegrationCreatedAuditEvent added in v0.1.23

type AshbyIntegrationCreatedAuditEvent struct {
	AshbyIntegration string `json:"ashby_integration"`
}

AshbyIntegrationCreatedAuditEvent defines model for AshbyIntegrationCreatedAuditEvent.

type AshbyIntegrationDeletedAuditEvent added in v0.1.23

type AshbyIntegrationDeletedAuditEvent struct {
	AshbyIntegration string `json:"ashby_integration"`
}

AshbyIntegrationDeletedAuditEvent defines model for AshbyIntegrationDeletedAuditEvent.

type AshbyIntegrationResponse added in v0.1.23

type AshbyIntegrationResponse struct {
	// ID The unique identifier for the Ashby integration
	ID string `json:"id"`

	// Name The friendly name of the Ashby account.
	Name string `json:"name"`

	// Connected Whether this integration can currently reach Ashby with a valid API key.
	Connected bool `json:"connected"`

	// MissingScopes API key scopes that are required but missing. When non-empty, the
	// integration is not fully functional and the key must be regenerated
	// with the listed scopes.
	MissingScopes *[]string `json:"missing_scopes,omitempty"`

	// Config Per-tenant trigger and write-back configuration for an Ashby integration.
	Config *AshbyConfig `json:"config,omitempty"`

	// SelectedTemplateID The Nametag template used when launching checks.
	SelectedTemplateID *string `json:"selected_template_id,omitempty"`

	// FraudStatusWriteback Whether to write decisions back to Ashby's native fraud status.
	FraudStatusWriteback *bool `json:"fraud_status_writeback,omitempty"`

	// AssessmentsEnabled Phase-2 Assessments Framework flag (persisted, not yet active).
	AssessmentsEnabled *bool `json:"assessments_enabled,omitempty"`
}

AshbyIntegrationResponse defines model for AshbyIntegrationResponse.

type AshbyIntegrationUpdateRequest added in v0.1.23

type AshbyIntegrationUpdateRequest struct {
	// Name The friendly name of the Ashby account.
	Name *string `json:"name,omitempty"`

	// APIKey A replacement Ashby API key. When set, the integration is reconnected:
	// the key is re-validated and custom fields, tags, and webhooks are repaired.
	APIKey *string `json:"api_key,omitempty"`

	// Config Per-tenant trigger and write-back configuration for an Ashby integration.
	Config               *AshbyConfig `json:"config,omitempty"`
	SelectedTemplateID   *string      `json:"selected_template_id,omitempty"`
	FraudStatusWriteback *bool        `json:"fraud_status_writeback,omitempty"`
	AssessmentsEnabled   *bool        `json:"assessments_enabled,omitempty"`
}

AshbyIntegrationUpdateRequest defines model for AshbyIntegrationUpdateRequest.

type AshbyIntegrationUpdatedAuditEvent added in v0.1.23

type AshbyIntegrationUpdatedAuditEvent struct {
	AshbyIntegration string                        `json:"ashby_integration"`
	Request          AshbyIntegrationUpdateRequest `json:"request"`
	Response         *AshbyIntegrationResponse     `json:"response,omitempty"`
}

AshbyIntegrationUpdatedAuditEvent defines model for AshbyIntegrationUpdatedAuditEvent.

type AshbyIntegrationsListResponse added in v0.1.23

type AshbyIntegrationsListResponse struct {
	// Integrations A list of Ashby integrations for this environment
	Integrations []AshbyIntegrationResponse `json:"integrations"`
}

AshbyIntegrationsListResponse defines model for AshbyIntegrationsListResponse.

type AshbyOutputConfig added in v0.1.23

type AshbyOutputConfig struct {
	CustomFields *bool `json:"custom_fields,omitempty"`
	Tags         *bool `json:"tags,omitempty"`
	Note         *bool `json:"note,omitempty"`
	Certificate  *bool `json:"certificate,omitempty"`
}

AshbyOutputConfig Which write-back outputs are produced on a completed check.

type AshbyStage added in v0.1.23

type AshbyStage struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

AshbyStage defines model for AshbyStage.

type AshbyStagesResponse added in v0.1.23

type AshbyStagesResponse struct {
	// Stages The interview stages configured in Ashby, for the stage picker.
	Stages []AshbyStage `json:"stages"`
}

AshbyStagesResponse defines model for AshbyStagesResponse.

type AshbyTriggerConfig added in v0.1.23

type AshbyTriggerConfig struct {
	ApplicationSubmit       *bool     `json:"application_submit,omitempty"`
	CandidateStageChange    *bool     `json:"candidate_stage_change,omitempty"`
	StageIDs                *[]string `json:"stage_ids,omitempty"`
	InterviewScheduleCreate *bool     `json:"interview_schedule_create,omitempty"`
	OfferCreate             *bool     `json:"offer_create,omitempty"`
	CandidateHire           *bool     `json:"candidate_hire,omitempty"`
}

AshbyTriggerConfig Which Ashby events launch a Nametag check. For stage changes, `stage_ids` limits the trigger to specific Ashby interview stage IDs.

type AuditEvent added in v0.1.15

type AuditEvent struct {
	// ID The unique identifier for the event.
	// The identifier is in [ULID format](https://github.com/ulid/spec) which  means that you can sort the events by time by sorting by ID.
	ID string `json:"id"`

	// Time The time the event occurred
	Time time.Time `json:"time"`

	// Kind Which type of event this is.
	Kind AuditEventKind `json:"kind"`

	// Trace A unique identifier for the event
	Trace string `json:"trace"`

	// Truncated True if the details of this record have been removed because the record would exceed the size limit for audit logs.
	Truncated *bool `json:"truncated,omitempty"`

	// RemoteAddr The IP address of the client that made the request
	RemoteAddr *string `json:"remote_addr,omitempty"`

	// UserAgent The remote user agent of the client that made the request
	UserAgent *string `json:"user_agent,omitempty"`

	// OrgID The ID of the organization for the actor performing the action. This will be the same for all your events.
	OrgID string `json:"org"`

	// EnvID The ID of the environment that this action refers to.
	EnvID *string `json:"env,omitempty"`

	// Principal The principal associated with the event
	Principal                               *Principal                                         `json:"principal,omitempty"`
	EnvCreated                              *EnvCreatedAuditEvent                              `json:"env_created,omitempty"`
	EnvUpdated                              *EnvUpdatedAuditEvent                              `json:"env_updated,omitempty"`
	EnvDeleted                              *EnvDeletedAuditEvent                              `json:"env_deleted,omitempty"`
	EnvLogoUploaded                         *EnvLogoUploadedAuditEvent                         `json:"env_logo_uploaded,omitempty"`
	EnvLogoDeleted                          *EnvLogoDeletedAuditEvent                          `json:"env_logo_deleted,omitempty"`
	TemplateCreated                         *TemplateCreatedAuditEvent                         `json:"template_created,omitempty"`
	TemplateUpdated                         *TemplateUpdatedAuditEvent                         `json:"template_updated,omitempty"`
	TemplateDeleted                         *TemplateDeletedAuditEvent                         `json:"template_deleted,omitempty"`
	EnvWebhookSecretUpdated                 *EnvWebhookSecretUpdatedAuditEvent                 `json:"env_webhook_secret_updated,omitempty"`
	OrgUpdated                              *OrgUpdatedAuditEvent                              `json:"org_updated,omitempty"`
	OrgMemberInvited                        *OrgMemberInvitedAuditEvent                        `json:"org_member_invited,omitempty"`
	OrgMemberRemoved                        *OrgMemberRemovedAuditEvent                        `json:"org_member_removed,omitempty"`
	OrgMemberUpdated                        *OrgMemberUpdatedAuditEvent                        `json:"org_member_updated,omitempty"`
	ApikeyCreated                           *APIKeyCreatedAuditEvent                           `json:"apikey_created,omitempty"`
	ApikeyUpdated                           *APIKeyUpdatedAuditEvent                           `json:"apikey_updated,omitempty"`
	ApikeyDeleted                           *APIKeyDeletedAuditEvent                           `json:"apikey_deleted,omitempty"`
	RequestCreated                          *RequestCreatedAuditEvent                          `json:"request_created,omitempty"`
	RequestUpdated                          *RequestUpdatedAuditEvent                          `json:"request_updated,omitempty"`
	RequestCanceled                         *RequestCanceledAuditEvent                         `json:"request_canceled,omitempty"`
	AccountUpdated                          *AccountUpdatedAuditEvent                          `json:"account_updated,omitempty"`
	AccountPhotoUploaded                    *AccountPhotoUploadedAuditEvent                    `json:"account_photo_uploaded,omitempty"`
	DirectoryCreated                        *DirectoryCreatedAuditEvent                        `json:"directory_created,omitempty"`
	DirectoryUpdated                        *DirectoryUpdatedAuditEvent                        `json:"directory_updated,omitempty"`
	DirectoryDeleted                        *DirectoryDeletedAuditEvent                        `json:"directory_deleted,omitempty"`
	DirectoryAuthorized                     *DirectoryAuthorizedAuditEvent                     `json:"directory_authorized,omitempty"`
	DirectorySetCredentials                 *DirectorySetCredentialsAuditEvent                 `json:"directory_set_credentials,omitempty"`
	DirectoryLogoUploaded                   *DirectoryLogoUploadedAuditEvent                   `json:"directory_logo_uploaded,omitempty"`
	DirectoryLogoDeleted                    *DirectoryLogoDeletedAuditEvent                    `json:"directory_logo_deleted,omitempty"`
	ConsoleSignin                           *ConsoleSigninAuditEvent                           `json:"console_signin,omitempty"`
	ConsoleSinginConfigureEmail             *ConsoleSinginConfigureEmailAuditEvent             `json:"console_singin_configure_email,omitempty"`
	ConsoleSinginConfigureSaml              *ConsoleSinginConfigureSAMLAuditEvent              `json:"console_singin_configure_saml,omitempty"`
	CliSignin                               *CLISigninAuditEvent                               `json:"cli_signin,omitempty"`
	Oauth2PushedAuthorizationRequest        *OAuth2PushedAuthorizationRequestAuditEvent        `json:"oauth2_pushed_authorization_request,omitempty"`
	Oauth2Authorize                         *OAuth2AuthorizeAuditEvent                         `json:"oauth2_authorize,omitempty"`
	Oauth2V2Authorize                       *OAuth2V2AuthorizeAuditEvent                       `json:"oauth2_v2_authorize,omitempty"`
	Oauth2RequestCanceled                   *OAuth2RequestCanceledAuditEvent                   `json:"oauth2_request_canceled,omitempty"`
	Oauth2Token                             *OAuth2TokenAuditEvent                             `json:"oauth2_token,omitempty"`
	EntraEamAuthorize                       *EntraEamAuthorizeAuditEvent                       `json:"entra_eam_authorize,omitempty"`
	EntraEamFinish                          *EntraEamFinishAuditEvent                          `json:"entra_eam_finish,omitempty"`
	OktaEamAuthorize                        *OktaEamAuthorizeAuditEvent                        `json:"okta_eam_authorize,omitempty"`
	OktaEamFinish                           *OktaEamFinishAuditEvent                           `json:"okta_eam_finish,omitempty"`
	PeopleCompare                           *PeopleCompareAuditEvent                           `json:"people_compare,omitempty"`
	PeopleSetPreferredName                  *PeopleSetPreferredNameAuditEvent                  `json:"people_set_preferred_name,omitempty"`
	PeopleSetPicture                        *PeopleSetPictureAuditEvent                        `json:"people_set_picture,omitempty"`
	SelfieCompare                           *SelfieCompareAuditEvent                           `json:"selfie_compare,omitempty"`
	SharingRevoked                          *SharingRevokedAuditEvent                          `json:"sharing_revoked,omitempty"`
	ExtensionInvoked                        *ExtensionInvokedAuditEvent                        `json:"extension_invoked,omitempty"`
	GreenhouseIntegrationCreated            *GreenhouseIntegrationCreatedAuditEvent            `json:"greenhouse_integration_created,omitempty"`
	GreenhouseIntegrationUpdated            *GreenhouseIntegrationUpdatedAuditEvent            `json:"greenhouse_integration_updated,omitempty"`
	GreenhouseIntegrationDeleted            *GreenhouseIntegrationDeletedAuditEvent            `json:"greenhouse_integration_deleted,omitempty"`
	GreenhouseIntegrationCredentialsUpdated *GreenhouseIntegrationCredentialsUpdatedAuditEvent `json:"greenhouse_integration_credentials_updated,omitempty"`
	InterviewCreated                        *InterviewCreatedAuditEvent                        `json:"interview_created,omitempty"`
	InterviewUpdated                        *InterviewUpdatedAuditEvent                        `json:"interview_updated,omitempty"`
	InterviewDeleted                        *InterviewDeletedAuditEvent                        `json:"interview_deleted,omitempty"`
	InterviewConfigUpdated                  *InterviewConfigUpdatedAuditEvent                  `json:"interview_config_updated,omitempty"`
	InterviewVerificationStarted            *InterviewVerificationStartedAuditEvent            `json:"interview_verification_started,omitempty"`
	InterviewOptedOut                       *InterviewOptedOutAuditEvent                       `json:"interview_opted_out,omitempty"`
	InterviewLinkFollowed                   *InterviewLinkFollowedAuditEvent                   `json:"interview_link_followed,omitempty"`
	AshbyIntegrationCreated                 *AshbyIntegrationCreatedAuditEvent                 `json:"ashby_integration_created,omitempty"`
	RecruiteeIntegrationCreated             *RecruiteeIntegrationCreatedAuditEvent             `json:"recruitee_integration_created,omitempty"`
	AshbyIntegrationUpdated                 *AshbyIntegrationUpdatedAuditEvent                 `json:"ashby_integration_updated,omitempty"`
	RecruiteeIntegrationUpdated             *RecruiteeIntegrationUpdatedAuditEvent             `json:"recruitee_integration_updated,omitempty"`
	AshbyIntegrationDeleted                 *AshbyIntegrationDeletedAuditEvent                 `json:"ashby_integration_deleted,omitempty"`
	RecruiteeIntegrationDeleted             *RecruiteeIntegrationDeletedAuditEvent             `json:"recruitee_integration_deleted,omitempty"`
	RecruiteeIntegrationCredentialsUpdated  *RecruiteeIntegrationCredentialsUpdatedAuditEvent  `json:"recruitee_integration_credentials_updated,omitempty"`
	WorkableIntegrationCreated              *WorkableIntegrationCreatedAuditEvent              `json:"workable_integration_created,omitempty"`
	WorkableIntegrationUpdated              *WorkableIntegrationUpdatedAuditEvent              `json:"workable_integration_updated,omitempty"`
	WorkableIntegrationDeleted              *WorkableIntegrationDeletedAuditEvent              `json:"workable_integration_deleted,omitempty"`
	WorkableIntegrationCredentialsUpdated   *WorkableIntegrationCredentialsUpdatedAuditEvent   `json:"workable_integration_credentials_updated,omitempty"`
	SafeCallSessionStarted                  *SafeCallSessionStartedAuditEvent                  `json:"safe_call_session_started,omitempty"`
	SafeCallCodeRejected                    *SafeCallCodeRejectedAuditEvent                    `json:"safe_call_code_rejected,omitempty"`
	SafeCallVerificationStarted             *SafeCallVerificationStartedAuditEvent             `json:"safe_call_verification_started,omitempty"`
	SafeCallVerified                        *SafeCallVerifiedAuditEvent                        `json:"safe_call_verified,omitempty"`
	SafeCallFailed                          *SafeCallFailedAuditEvent                          `json:"safe_call_failed,omitempty"`
	SafeCallExpired                         *SafeCallExpiredAuditEvent                         `json:"safe_call_expired,omitempty"`
	SlateIntegrationCreated                 *SlateIntegrationCreatedAuditEvent                 `json:"slate_integration_created,omitempty"`
	SlateIntegrationUpdated                 *SlateIntegrationUpdatedAuditEvent                 `json:"slate_integration_updated,omitempty"`
	SlateIntegrationDeleted                 *SlateIntegrationDeletedAuditEvent                 `json:"slate_integration_deleted,omitempty"`
	SlateIntegrationCredentialsUpdated      *SlateIntegrationCredentialsUpdatedAuditEvent      `json:"slate_integration_credentials_updated,omitempty"`
	CampaignCreated                         *CampaignCreatedAuditEvent                         `json:"campaign_created,omitempty"`
	CampaignUpdated                         *CampaignUpdatedAuditEvent                         `json:"campaign_updated,omitempty"`
	CampaignDeleted                         *CampaignDeletedAuditEvent                         `json:"campaign_deleted,omitempty"`
	CampaignDuplicated                      *CampaignDuplicatedAuditEvent                      `json:"campaign_duplicated,omitempty"`
	CampaignRosterImported                  *CampaignRosterImportedAuditEvent                  `json:"campaign_roster_imported,omitempty"`
	CampaignInvitationsSent                 *CampaignInvitationsSentAuditEvent                 `json:"campaign_invitations_sent,omitempty"`
	CampaignFollowupsSent                   *CampaignFollowupsSentAuditEvent                   `json:"campaign_followups_sent,omitempty"`
	CampaignInvitationResent                *CampaignInvitationResentAuditEvent                `json:"campaign_invitation_resent,omitempty"`
	DirectoryGroupPolicyRulesRemoved        *DirectoryGroupPolicyRulesRemovedAuditEvent        `json:"directory_group_policy_rules_removed,omitempty"`
}

AuditEvent defines model for AuditEvent.

type AuditEventKind added in v0.1.18

type AuditEventKind string

AuditEventKind defines model for AuditEventKind.

const (
	AuditEventKindAPIKeyCreated                           AuditEventKind = "apikey_created"
	AuditEventKindAPIKeyDeleted                           AuditEventKind = "apikey_deleted"
	AuditEventKindAPIKeyUpdated                           AuditEventKind = "apikey_updated"
	AuditEventKindAccountPhotoUploaded                    AuditEventKind = "account_photo_uploaded"
	AuditEventKindAccountUpdated                          AuditEventKind = "account_updated"
	AuditEventKindAshbyIntegrationCreated                 AuditEventKind = "ashby_integration_created"
	AuditEventKindAshbyIntegrationDeleted                 AuditEventKind = "ashby_integration_deleted"
	AuditEventKindAshbyIntegrationUpdated                 AuditEventKind = "ashby_integration_updated"
	AuditEventKindCLISignin                               AuditEventKind = "cli_signin"
	AuditEventKindCampaignCreated                         AuditEventKind = "campaign_created"
	AuditEventKindCampaignDeleted                         AuditEventKind = "campaign_deleted"
	AuditEventKindCampaignDuplicated                      AuditEventKind = "campaign_duplicated"
	AuditEventKindCampaignFollowupsSent                   AuditEventKind = "campaign_followups_sent"
	AuditEventKindCampaignInvitationResent                AuditEventKind = "campaign_invitation_resent"
	AuditEventKindCampaignInvitationsSent                 AuditEventKind = "campaign_invitations_sent"
	AuditEventKindCampaignRosterImported                  AuditEventKind = "campaign_roster_imported"
	AuditEventKindCampaignUpdated                         AuditEventKind = "campaign_updated"
	AuditEventKindConsoleSignin                           AuditEventKind = "console_signin"
	AuditEventKindConsoleSinginConfigureEmail             AuditEventKind = "console_singin_configure_email"
	AuditEventKindConsoleSinginConfigureSAML              AuditEventKind = "console_singin_configure_saml"
	AuditEventKindDirectoryAuthorized                     AuditEventKind = "directory_authorized"
	AuditEventKindDirectoryCreated                        AuditEventKind = "directory_created"
	AuditEventKindDirectoryDeleted                        AuditEventKind = "directory_deleted"
	AuditEventKindDirectoryGroupPolicyRulesRemoved        AuditEventKind = "directory_group_policy_rules_removed"
	AuditEventKindDirectoryLogoDeleted                    AuditEventKind = "directory_logo_deleted"
	AuditEventKindDirectoryLogoUploaded                   AuditEventKind = "directory_logo_uploaded"
	AuditEventKindDirectorySetCredentials                 AuditEventKind = "directory_set_credentials"
	AuditEventKindDirectoryUpdated                        AuditEventKind = "directory_updated"
	AuditEventKindEntraEamAuthorize                       AuditEventKind = "entra_eam_authorize"
	AuditEventKindEntraEamFinish                          AuditEventKind = "entra_eam_finish"
	AuditEventKindEnvCreated                              AuditEventKind = "env_created"
	AuditEventKindEnvDeleted                              AuditEventKind = "env_deleted"
	AuditEventKindEnvLogoDeleted                          AuditEventKind = "env_logo_deleted"
	AuditEventKindEnvLogoUploaded                         AuditEventKind = "env_logo_uploaded"
	AuditEventKindEnvUpdated                              AuditEventKind = "env_updated"
	AuditEventKindEnvWebhookSecretUpdated                 AuditEventKind = "env_webhook_secret_updated"
	AuditEventKindExtensionInvoked                        AuditEventKind = "extension_invoked"
	AuditEventKindGreenhouseIntegrationCreated            AuditEventKind = "greenhouse_integration_created"
	AuditEventKindGreenhouseIntegrationCredentialsUpdated AuditEventKind = "greenhouse_integration_credentials_updated"
	AuditEventKindGreenhouseIntegrationDeleted            AuditEventKind = "greenhouse_integration_deleted"
	AuditEventKindGreenhouseIntegrationUpdated            AuditEventKind = "greenhouse_integration_updated"
	AuditEventKindInterviewConfigUpdated                  AuditEventKind = "interview_config_updated"
	AuditEventKindInterviewCreated                        AuditEventKind = "interview_created"
	AuditEventKindInterviewDeleted                        AuditEventKind = "interview_deleted"
	AuditEventKindInterviewLinkFollowed                   AuditEventKind = "interview_link_followed"
	AuditEventKindInterviewOptedOut                       AuditEventKind = "interview_opted_out"
	AuditEventKindInterviewUpdated                        AuditEventKind = "interview_updated"
	AuditEventKindInterviewVerificationStarted            AuditEventKind = "interview_verification_started"
	AuditEventKindOAuth2Authorize                         AuditEventKind = "oauth2_authorize"
	AuditEventKindOAuth2PushedAuthorizationRequest        AuditEventKind = "oauth2_pushed_authorization_request"
	AuditEventKindOAuth2RequestCanceled                   AuditEventKind = "oauth2_request_canceled"
	AuditEventKindOAuth2Token                             AuditEventKind = "oauth2_token"
	AuditEventKindOAuth2V2Authorize                       AuditEventKind = "oauth2_v2_authorize"
	AuditEventKindOktaEamAuthorize                        AuditEventKind = "okta_eam_authorize"
	AuditEventKindOktaEamFinish                           AuditEventKind = "okta_eam_finish"
	AuditEventKindOrgMemberInvited                        AuditEventKind = "org_member_invited"
	AuditEventKindOrgMemberRemoved                        AuditEventKind = "org_member_removed"
	AuditEventKindOrgMemberUpdated                        AuditEventKind = "org_member_updated"
	AuditEventKindOrgUpdated                              AuditEventKind = "org_updated"
	AuditEventKindPeopleCompare                           AuditEventKind = "people_compare"
	AuditEventKindPeopleSetPicture                        AuditEventKind = "people_set_picture"
	AuditEventKindPeopleSetPreferredName                  AuditEventKind = "people_set_preferred_name"
	AuditEventKindRecruiteeIntegrationCreated             AuditEventKind = "recruitee_integration_created"
	AuditEventKindRecruiteeIntegrationCredentialsUpdated  AuditEventKind = "recruitee_integration_credentials_updated"
	AuditEventKindRecruiteeIntegrationDeleted             AuditEventKind = "recruitee_integration_deleted"
	AuditEventKindRecruiteeIntegrationUpdated             AuditEventKind = "recruitee_integration_updated"
	AuditEventKindRequestCanceled                         AuditEventKind = "request_canceled"
	AuditEventKindRequestCreated                          AuditEventKind = "request_created"
	AuditEventKindRequestUpdated                          AuditEventKind = "request_updated"
	AuditEventKindSafeCallCodeRejected                    AuditEventKind = "safe_call_code_rejected"
	AuditEventKindSafeCallExpired                         AuditEventKind = "safe_call_expired"
	AuditEventKindSafeCallFailed                          AuditEventKind = "safe_call_failed"
	AuditEventKindSafeCallSessionStarted                  AuditEventKind = "safe_call_session_started"
	AuditEventKindSafeCallVerificationStarted             AuditEventKind = "safe_call_verification_started"
	AuditEventKindSafeCallVerified                        AuditEventKind = "safe_call_verified"
	AuditEventKindSelfieCompare                           AuditEventKind = "selfie_compare"
	AuditEventKindSharingRevoked                          AuditEventKind = "sharing_revoked"
	AuditEventKindSlateIntegrationCreated                 AuditEventKind = "slate_integration_created"
	AuditEventKindSlateIntegrationCredentialsUpdated      AuditEventKind = "slate_integration_credentials_updated"
	AuditEventKindSlateIntegrationDeleted                 AuditEventKind = "slate_integration_deleted"
	AuditEventKindSlateIntegrationUpdated                 AuditEventKind = "slate_integration_updated"
	AuditEventKindTemplateCreated                         AuditEventKind = "template_created"
	AuditEventKindTemplateDeleted                         AuditEventKind = "template_deleted"
	AuditEventKindTemplateUpdated                         AuditEventKind = "template_updated"
	AuditEventKindWorkableIntegrationCreated              AuditEventKind = "workable_integration_created"
	AuditEventKindWorkableIntegrationCredentialsUpdated   AuditEventKind = "workable_integration_credentials_updated"
	AuditEventKindWorkableIntegrationDeleted              AuditEventKind = "workable_integration_deleted"
	AuditEventKindWorkableIntegrationUpdated              AuditEventKind = "workable_integration_updated"
)

Defines values for AuditEventKind.

func (AuditEventKind) Valid added in v0.1.22

func (e AuditEventKind) Valid() bool

Valid indicates whether the value is a known member of the AuditEventKind enum.

type AuthorizeRequest added in v0.1.15

type AuthorizeRequest struct {
	// Claim Space-separated list of claims
	Claim *[]Claim `json:"claim,omitempty"`

	// ClientId The client ID
	ClientId string `json:"client_id"`

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

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

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

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

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

	// ResponseType The response type
	ResponseType *AuthorizeRequestResponseType `json:"response_type,omitempty"`
	Return       *AuthorizeReturn              `json:"return,omitempty"`

	// Scope Space-separated list of scopes
	Scope *[]Scope `json:"scope,omitempty"`

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

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

AuthorizeRequest defines model for AuthorizeRequest.

type AuthorizeRequestCodeChallengeMethod added in v0.1.15

type AuthorizeRequestCodeChallengeMethod string

AuthorizeRequestCodeChallengeMethod The code challenge method

const (
	AuthorizeRequestCodeChallengeMethodPlain AuthorizeRequestCodeChallengeMethod = "plain"
	AuthorizeRequestCodeChallengeMethodS256  AuthorizeRequestCodeChallengeMethod = "S256"
)

Defines values for AuthorizeRequestCodeChallengeMethod.

func (AuthorizeRequestCodeChallengeMethod) Valid added in v0.1.22

Valid indicates whether the value is a known member of the AuthorizeRequestCodeChallengeMethod enum.

type AuthorizeRequestResponseMode added in v0.1.15

type AuthorizeRequestResponseMode string

AuthorizeRequestResponseMode The response mode

const (
	AuthorizeRequestResponseModeFragment AuthorizeRequestResponseMode = "fragment"
)

Defines values for AuthorizeRequestResponseMode.

func (AuthorizeRequestResponseMode) Valid added in v0.1.22

Valid indicates whether the value is a known member of the AuthorizeRequestResponseMode enum.

type AuthorizeRequestResponseType added in v0.1.15

type AuthorizeRequestResponseType string

AuthorizeRequestResponseType The response type

const (
	AuthorizeRequestResponseTypeCode AuthorizeRequestResponseType = "code"
)

Defines values for AuthorizeRequestResponseType.

func (AuthorizeRequestResponseType) Valid added in v0.1.22

Valid indicates whether the value is a known member of the AuthorizeRequestResponseType enum.

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.

func (AuthorizeReturn) Valid added in v0.1.22

func (e AuthorizeReturn) Valid() bool

Valid indicates whether the value is a known member of the AuthorizeReturn enum.

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.

func (AuthorizeStatus) Valid added in v0.1.22

func (e AuthorizeStatus) Valid() bool

Valid indicates whether the value is a known member of the AuthorizeStatus enum.

type AuthorizeV2Request added in v0.1.16

type AuthorizeV2Request struct {
	// RequestUri The request URI
	RequestUri string `json:"request_uri"`
}

AuthorizeV2Request defines model for AuthorizeV2Request.

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.

func (BadRequestResponseStatus) Valid added in v0.1.22

func (e BadRequestResponseStatus) Valid() bool

Valid indicates whether the value is a known member of the BadRequestResponseStatus enum.

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,omitempty"`

	// Claims Which claims you are requesting for this person.
	Claims []Claim `json:"claims"`
}

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 BulkUpdateAccountsJSONRequestBody added in v0.1.12

type BulkUpdateAccountsJSONRequestBody = AccountBulkUpdateRequest

BulkUpdateAccountsJSONRequestBody defines body for BulkUpdateAccounts for application/json ContentType.

type BulkUpdateAccountsResp added in v0.1.12

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

func ParseBulkUpdateAccountsResp added in v0.1.12

func ParseBulkUpdateAccountsResp(rsp *http.Response) (*BulkUpdateAccountsResp, error)

ParseBulkUpdateAccountsResp parses an HTTP response from a BulkUpdateAccountsWithResponse call

func (BulkUpdateAccountsResp) ContentType added in v0.1.24

func (r BulkUpdateAccountsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BulkUpdateAccountsResp) Status added in v0.1.12

func (r BulkUpdateAccountsResp) Status() string

Status returns HTTPResponse.Status

func (BulkUpdateAccountsResp) StatusCode added in v0.1.12

func (r BulkUpdateAccountsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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) ContentType added in v0.1.24

func (r BulkUploadAccountPhotosResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 a 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 CLISigninAuditEvent added in v0.1.15

type CLISigninAuditEvent struct {
	Session string `json:"session"`
}

CLISigninAuditEvent defines model for CLISigninAuditEvent.

type CampaignCreatedAuditEvent added in v0.1.24

type CampaignCreatedAuditEvent struct {
	// Campaign The ID of the created verification campaign.
	Campaign string `json:"campaign"`
}

CampaignCreatedAuditEvent defines model for CampaignCreatedAuditEvent.

type CampaignDeletedAuditEvent added in v0.1.24

type CampaignDeletedAuditEvent struct {
	// Campaign The ID of the deleted verification campaign.
	Campaign string `json:"campaign"`
}

CampaignDeletedAuditEvent defines model for CampaignDeletedAuditEvent.

type CampaignDuplicatedAuditEvent added in v0.1.24

type CampaignDuplicatedAuditEvent struct {
	// Campaign The ID of the new (duplicated) campaign.
	Campaign string `json:"campaign"`

	// Source The ID of the campaign that was duplicated.
	Source string `json:"source"`
}

CampaignDuplicatedAuditEvent defines model for CampaignDuplicatedAuditEvent.

type CampaignFollowupsSentAuditEvent added in v0.1.24

type CampaignFollowupsSentAuditEvent struct {
	// Campaign The ID of the campaign.
	Campaign string `json:"campaign"`

	// Count The number of recipients targeted by the follow-up send.
	Count int `json:"count"`
}

CampaignFollowupsSentAuditEvent defines model for CampaignFollowupsSentAuditEvent.

type CampaignInvitationResentAuditEvent added in v0.1.24

type CampaignInvitationResentAuditEvent struct {
	// Campaign The ID of the campaign.
	Campaign string `json:"campaign"`

	// Entry The ID of the roster entry the invitation was resent to.
	Entry string `json:"entry"`
}

CampaignInvitationResentAuditEvent defines model for CampaignInvitationResentAuditEvent.

type CampaignInvitationsSentAuditEvent added in v0.1.24

type CampaignInvitationsSentAuditEvent struct {
	// Campaign The ID of the campaign.
	Campaign string `json:"campaign"`

	// Count The number of recipients targeted by the invitation send.
	Count int `json:"count"`
}

CampaignInvitationsSentAuditEvent defines model for CampaignInvitationsSentAuditEvent.

type CampaignRosterImportedAuditEvent added in v0.1.24

type CampaignRosterImportedAuditEvent struct {
	// Campaign The ID of the campaign the roster was imported into.
	Campaign string `json:"campaign"`

	// Imported The number of new entries added.
	Imported int `json:"imported"`

	// Skipped The number of rows skipped (duplicate or invalid).
	Skipped int `json:"skipped"`
}

CampaignRosterImportedAuditEvent defines model for CampaignRosterImportedAuditEvent.

type CampaignUpdatedAuditEvent added in v0.1.24

type CampaignUpdatedAuditEvent struct {
	// Campaign The ID of the updated verification campaign.
	Campaign string `json:"campaign"`
}

CampaignUpdatedAuditEvent defines model for CampaignUpdatedAuditEvent.

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) ContentType added in v0.1.24

func (r CancelRequestResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 Claim added in v0.1.16

type Claim string

Claim Claims are used to describe the information you want people to share with you. In order to request a claim 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 Nametag console.

const (
	ClaimAccount       Claim = "account"
	ClaimAddress       Claim = "address"
	ClaimBirthDate     Claim = "birth_date"
	ClaimEmail         Claim = "email"
	ClaimFamilyName    Claim = "family_name"
	ClaimGivenName     Claim = "given_name"
	ClaimGovtid        Claim = "govtid"
	ClaimGovtidExpired Claim = "govtid_expired"
	ClaimGpsLocation   Claim = "gps_location"
	ClaimIpLocation    Claim = "ip_location"
	ClaimName          Claim = "name"
	ClaimPhoneNumber   Claim = "phone_number"
	ClaimPicture       Claim = "picture"
	ClaimPreferredName Claim = "preferred_name"
)

Defines values for Claim.

func (Claim) Valid added in v0.1.22

func (e Claim) Valid() bool

Valid indicates whether the value is a known member of the Claim enum.

type ClearedGroupPolicy added in v0.1.26

type ClearedGroupPolicy struct {
	// Groups The group rules that were removed.
	Groups []GroupRecoveryPolicy `json:"groups"`

	// Policy The name of the recovery policy field the rules were removed from, e.g. "mfa_policy".
	Policy string `json:"policy"`
}

ClearedGroupPolicy defines model for ClearedGroupPolicy.

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) BulkUpdateAccounts added in v0.1.12

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

func (*Client) BulkUpdateAccountsWithBody added in v0.1.12

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

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, body CreateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDirectoryWithBody

func (c *Client) CreateDirectoryWithBody(ctx context.Context, 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) CreateWorkdayIntegration added in v0.1.20

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

func (*Client) CreateWorkdayIntegrationWithBody added in v0.1.20

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

func (*Client) CreateWorkdayRequest added in v0.1.20

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

func (*Client) CreateWorkdayRequestWithBody added in v0.1.20

func (c *Client) CreateWorkdayRequestWithBody(ctx context.Context, 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) DeleteAshbyIntegration added in v0.1.23

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

func (*Client) DeleteDirectory

func (c *Client) DeleteDirectory(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
func (c *Client) DeleteDirectoryLogo(ctx context.Context, 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 (*Client) DeleteGreenhouseIntegration added in v0.1.22

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

func (*Client) DeleteIntercomIntegration added in v0.1.23

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

func (*Client) DeleteJoinIntegration added in v0.1.24

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

func (*Client) DeleteLeverIntegration added in v0.1.23

func (c *Client) DeleteLeverIntegration(ctx context.Context, env string, integration 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) DeleteRecruiteeIntegration added in v0.1.23

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

func (*Client) DeleteSharedDevices added in v0.1.22

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

func (*Client) DeleteSlackIntegration added in v0.1.17

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

func (*Client) DeleteSlateIntegration added in v0.1.24

func (c *Client) DeleteSlateIntegration(ctx context.Context, env string, integration string, 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) DeleteWorkableIntegration added in v0.1.23

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

func (*Client) DeleteWorkdayIntegration added in v0.1.20

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

func (*Client) DownloadRequestProof added in v0.1.24

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

func (*Client) EncryptSecret added in v0.1.18

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

func (*Client) EncryptSecretWithBody added in v0.1.18

func (c *Client) EncryptSecretWithBody(ctx context.Context, env string, contentType string, body io.Reader, 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) GetAshbyIntegration added in v0.1.23

func (c *Client) GetAshbyIntegration(ctx context.Context, env string, integration 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, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDirectoryAuthorizationURL

func (c *Client) GetDirectoryAuthorizationURL(ctx context.Context, 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) GetEnvMicrometrics added in v0.1.16

func (c *Client) GetEnvMicrometrics(ctx context.Context, env string, params *GetEnvMicrometricsParams, 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) GetGreenhouseIntegration added in v0.1.22

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

func (*Client) GetIntercomIntegration added in v0.1.23

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

func (*Client) GetIntercomIntegrationByID added in v0.1.23

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

func (*Client) GetJoinIntegration added in v0.1.24

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

func (*Client) GetLeverIntegration added in v0.1.23

func (c *Client) GetLeverIntegration(ctx context.Context, env string, integration 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) GetRecruiteeIntegration added in v0.1.23

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

func (*Client) GetRequest

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

func (*Client) GetSharedDeviceRegistrationStatus added in v0.1.22

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

func (*Client) GetSlackRequestDetails added in v0.1.17

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

func (*Client) GetSlateIntegration added in v0.1.24

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

func (*Client) GetWorkableIntegration added in v0.1.23

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

func (*Client) GetWorkdayIntegration added in v0.1.20

func (c *Client) GetWorkdayIntegration(ctx context.Context, env string, integration 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) ListAshbyIntegrations added in v0.1.23

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

func (*Client) ListAshbyStages added in v0.1.23

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

func (*Client) ListAuditEvents added in v0.1.15

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

func (*Client) ListDirectories

func (c *Client) ListDirectories(ctx context.Context, 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) ListGreenhouseIntegrations added in v0.1.22

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

func (*Client) ListIntegrations added in v0.1.22

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

func (*Client) ListJoinIntegrations added in v0.1.24

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

func (*Client) ListLeverIntegrations added in v0.1.23

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

func (*Client) ListOrgMembers

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

func (*Client) ListRecruiteeIntegrations added in v0.1.23

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

func (*Client) ListSharedDevices added in v0.1.22

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

func (*Client) ListSlackIntegrations added in v0.1.17

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

func (*Client) ListSlateIntegrations added in v0.1.24

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

func (*Client) ListWebhooks

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

func (*Client) ListWorkableIntegrations added in v0.1.23

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

func (*Client) ListWorkableJobs added in v0.1.23

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

func (*Client) ListWorkdayIntegrations added in v0.1.20

func (c *Client) ListWorkdayIntegrations(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) PresignRecoveryMicrositeURL added in v0.1.12

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

func (*Client) PresignRecoveryMicrositeURLWithBody added in v0.1.12

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

func (*Client) RefreshWebhookSecret added in v0.1.12

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

func (*Client) RefreshWebhookSecretWithBody added in v0.1.12

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

func (*Client) RegenerateDirectoryAgentToken added in v0.1.16

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

func (*Client) RegisterSharedDevice added in v0.1.22

func (c *Client) RegisterSharedDevice(ctx context.Context, env string, 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, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetDirectoryCredentialsWithBody

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

func (*Client) SetPictureWithBody added in v0.1.19

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

func (*Client) SetPreferredName added in v0.1.19

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

func (*Client) SetPreferredNameWithBody added in v0.1.19

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

func (*Client) SyncDirectory

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

func (*Client) TestSlateIntegration added in v0.1.24

func (c *Client) TestSlateIntegration(ctx context.Context, env string, integration 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) UpdateAshbyIntegration added in v0.1.23

func (c *Client) UpdateAshbyIntegration(ctx context.Context, env string, integration string, body UpdateAshbyIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAshbyIntegrationWithBody added in v0.1.23

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

func (*Client) UpdateDirectory added in v0.1.12

func (c *Client) UpdateDirectory(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDirectoryWithBody added in v0.1.12

func (c *Client) UpdateDirectoryWithBody(ctx context.Context, directory 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) UpdateGreenhouseIntegration added in v0.1.22

func (c *Client) UpdateGreenhouseIntegration(ctx context.Context, env string, integration string, body UpdateGreenhouseIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateGreenhouseIntegrationWithBody added in v0.1.22

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

func (*Client) UpdateIntercomIntegration added in v0.1.23

func (c *Client) UpdateIntercomIntegration(ctx context.Context, env string, integration string, body UpdateIntercomIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateIntercomIntegrationWithBody added in v0.1.23

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

func (*Client) UpdateJoinIntegration added in v0.1.24

func (c *Client) UpdateJoinIntegration(ctx context.Context, env string, integration string, body UpdateJoinIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateJoinIntegrationWithBody added in v0.1.24

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

func (*Client) UpdateLeverIntegration added in v0.1.23

func (c *Client) UpdateLeverIntegration(ctx context.Context, env string, integration string, body UpdateLeverIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateLeverIntegrationWithBody added in v0.1.23

func (c *Client) UpdateLeverIntegrationWithBody(ctx context.Context, env string, integration 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) UpdateRecruiteeIntegration added in v0.1.23

func (c *Client) UpdateRecruiteeIntegration(ctx context.Context, env string, integration string, body UpdateRecruiteeIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateRecruiteeIntegrationWithBody added in v0.1.23

func (c *Client) UpdateRecruiteeIntegrationWithBody(ctx context.Context, env string, integration string, 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) UpdateSlateIntegration added in v0.1.24

func (c *Client) UpdateSlateIntegration(ctx context.Context, env string, integration string, body UpdateSlateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateSlateIntegrationWithBody added in v0.1.24

func (c *Client) UpdateSlateIntegrationWithBody(ctx context.Context, env string, integration 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) UpdateWorkableIntegration added in v0.1.23

func (c *Client) UpdateWorkableIntegration(ctx context.Context, env string, integration string, body UpdateWorkableIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateWorkableIntegrationWithBody added in v0.1.23

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

func (*Client) UpdateWorkdayIntegration added in v0.1.20

func (c *Client) UpdateWorkdayIntegration(ctx context.Context, env string, integration string, body UpdateWorkdayIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateWorkdayIntegrationWithBody added in v0.1.20

func (c *Client) UpdateWorkdayIntegrationWithBody(ctx context.Context, env string, integration 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) UploadDirectoryLogoWithBody added in v0.1.16

func (c *Client) UploadDirectoryLogoWithBody(ctx context.Context, directory 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)

func (*Client) ValidateWorkdayIntegration added in v0.1.22

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

func (*Client) ValidateWorkdayIntegrationWithBody added in v0.1.22

func (c *Client) ValidateWorkdayIntegrationWithBody(ctx context.Context, env string, 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)

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

	BulkUpdateAccounts(ctx context.Context, body BulkUpdateAccountsJSONRequestBody, 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)

	// ListAuditEvents request
	ListAuditEvents(ctx context.Context, params *ListAuditEventsParams, 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)

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

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

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

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

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

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

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

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

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

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

	UpdateDirectory(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	DeleteDirectoryLogo(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	// SyncDirectory request
	SyncDirectory(ctx context.Context, directory string, 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)

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

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

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

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

	UpdateAshbyIntegration(ctx context.Context, env string, integration string, body UpdateAshbyIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

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

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

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

	UpdateGreenhouseIntegration(ctx context.Context, env string, integration string, body UpdateGreenhouseIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

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

	UpdateIntercomIntegration(ctx context.Context, env string, integration string, body UpdateIntercomIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

	UpdateJoinIntegration(ctx context.Context, env string, integration string, body UpdateJoinIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

	UpdateLeverIntegration(ctx context.Context, env string, integration string, body UpdateLeverIntegrationJSONRequestBody, 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)

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

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

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

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

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

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

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

	UpdateRecruiteeIntegration(ctx context.Context, env string, integration string, body UpdateRecruiteeIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	RefreshWebhookSecret(ctx context.Context, env string, body RefreshWebhookSecretJSONRequestBody, 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)

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

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

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

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

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

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

	UpdateSlateIntegration(ctx context.Context, env string, integration string, body UpdateSlateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TestSlateIntegration request
	TestSlateIntegration(ctx context.Context, env string, integration 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)

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

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

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

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

	UpdateWorkableIntegration(ctx context.Context, env string, integration string, body UpdateWorkableIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

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

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

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

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

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

	UpdateWorkdayIntegration(ctx context.Context, env string, integration string, body UpdateWorkdayIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateWorkdayRequest(ctx context.Context, body CreateWorkdayRequestJSONRequestBody, 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)

	// DownloadRequestProof request
	DownloadRequestProof(ctx context.Context, requestID string, params *DownloadRequestProofParams, 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)

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

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

	SetPreferredName(ctx context.Context, subject string, body SetPreferredNameJSONRequestBody, 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) BulkUpdateAccountsWithBodyWithResponse added in v0.1.12

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

BulkUpdateAccountsWithBodyWithResponse request with arbitrary body returning *BulkUpdateAccountsResp

func (*ClientWithResponses) BulkUpdateAccountsWithResponse added in v0.1.12

func (c *ClientWithResponses) BulkUpdateAccountsWithResponse(ctx context.Context, body BulkUpdateAccountsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpdateAccountsResp, error)

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, 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, 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) CreateWorkdayIntegrationWithBodyWithResponse added in v0.1.20

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

CreateWorkdayIntegrationWithBodyWithResponse request with arbitrary body returning *CreateWorkdayIntegrationResp

func (*ClientWithResponses) CreateWorkdayIntegrationWithResponse added in v0.1.20

func (c *ClientWithResponses) CreateWorkdayIntegrationWithResponse(ctx context.Context, env string, body CreateWorkdayIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorkdayIntegrationResp, error)

func (*ClientWithResponses) CreateWorkdayRequestWithBodyWithResponse added in v0.1.20

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

CreateWorkdayRequestWithBodyWithResponse request with arbitrary body returning *CreateWorkdayRequestResp

func (*ClientWithResponses) CreateWorkdayRequestWithResponse added in v0.1.20

func (c *ClientWithResponses) CreateWorkdayRequestWithResponse(ctx context.Context, body CreateWorkdayRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorkdayRequestResp, error)

func (*ClientWithResponses) DeleteAPIKeyWithResponse

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

DeleteAPIKeyWithResponse request returning *DeleteAPIKeyResp

func (*ClientWithResponses) DeleteAshbyIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) DeleteAshbyIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteAshbyIntegrationResp, error)

DeleteAshbyIntegrationWithResponse request returning *DeleteAshbyIntegrationResp

func (*ClientWithResponses) DeleteDirectoryLogoWithResponse added in v0.1.16

func (c *ClientWithResponses) DeleteDirectoryLogoWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryLogoResp, error)

DeleteDirectoryLogoWithResponse request returning *DeleteDirectoryLogoResp

func (*ClientWithResponses) DeleteDirectoryWithResponse

func (c *ClientWithResponses) DeleteDirectoryWithResponse(ctx context.Context, 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) DeleteGreenhouseIntegrationWithResponse added in v0.1.22

func (c *ClientWithResponses) DeleteGreenhouseIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteGreenhouseIntegrationResp, error)

DeleteGreenhouseIntegrationWithResponse request returning *DeleteGreenhouseIntegrationResp

func (*ClientWithResponses) DeleteIntercomIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) DeleteIntercomIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteIntercomIntegrationResp, error)

DeleteIntercomIntegrationWithResponse request returning *DeleteIntercomIntegrationResp

func (*ClientWithResponses) DeleteJoinIntegrationWithResponse added in v0.1.24

func (c *ClientWithResponses) DeleteJoinIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteJoinIntegrationResp, error)

DeleteJoinIntegrationWithResponse request returning *DeleteJoinIntegrationResp

func (*ClientWithResponses) DeleteLeverIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) DeleteLeverIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteLeverIntegrationResp, error)

DeleteLeverIntegrationWithResponse request returning *DeleteLeverIntegrationResp

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) DeleteRecruiteeIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) DeleteRecruiteeIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteRecruiteeIntegrationResp, error)

DeleteRecruiteeIntegrationWithResponse request returning *DeleteRecruiteeIntegrationResp

func (*ClientWithResponses) DeleteSharedDevicesWithResponse added in v0.1.22

func (c *ClientWithResponses) DeleteSharedDevicesWithResponse(ctx context.Context, env string, id string, reqEditors ...RequestEditorFn) (*DeleteSharedDevicesResp, error)

DeleteSharedDevicesWithResponse request returning *DeleteSharedDevicesResp

func (*ClientWithResponses) DeleteSlackIntegrationWithResponse added in v0.1.17

func (c *ClientWithResponses) DeleteSlackIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteSlackIntegrationResp, error)

DeleteSlackIntegrationWithResponse request returning *DeleteSlackIntegrationResp

func (*ClientWithResponses) DeleteSlateIntegrationWithResponse added in v0.1.24

func (c *ClientWithResponses) DeleteSlateIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteSlateIntegrationResp, error)

DeleteSlateIntegrationWithResponse request returning *DeleteSlateIntegrationResp

func (*ClientWithResponses) DeleteTemplateWithResponse

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

DeleteTemplateWithResponse request returning *DeleteTemplateResp

func (*ClientWithResponses) DeleteWorkableIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) DeleteWorkableIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteWorkableIntegrationResp, error)

DeleteWorkableIntegrationWithResponse request returning *DeleteWorkableIntegrationResp

func (*ClientWithResponses) DeleteWorkdayIntegrationWithResponse added in v0.1.20

func (c *ClientWithResponses) DeleteWorkdayIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteWorkdayIntegrationResp, error)

DeleteWorkdayIntegrationWithResponse request returning *DeleteWorkdayIntegrationResp

func (*ClientWithResponses) DownloadRequestProofWithResponse added in v0.1.24

func (c *ClientWithResponses) DownloadRequestProofWithResponse(ctx context.Context, requestID string, params *DownloadRequestProofParams, reqEditors ...RequestEditorFn) (*DownloadRequestProofResp, error)

DownloadRequestProofWithResponse request returning *DownloadRequestProofResp

func (*ClientWithResponses) EncryptSecretWithBodyWithResponse added in v0.1.18

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

EncryptSecretWithBodyWithResponse request with arbitrary body returning *EncryptSecretResp

func (*ClientWithResponses) EncryptSecretWithResponse added in v0.1.18

func (c *ClientWithResponses) EncryptSecretWithResponse(ctx context.Context, env string, body EncryptSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*EncryptSecretResp, error)

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) GetAshbyIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) GetAshbyIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetAshbyIntegrationResp, error)

GetAshbyIntegrationWithResponse request returning *GetAshbyIntegrationResp

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, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryAuthorizationURLResp, error)

GetDirectoryAuthorizationURLWithResponse request returning *GetDirectoryAuthorizationURLResp

func (*ClientWithResponses) GetDirectoryWithResponse

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

GetDirectoryWithResponse request returning *GetDirectoryResp

func (*ClientWithResponses) GetEnvMicrometricsWithResponse added in v0.1.16

func (c *ClientWithResponses) GetEnvMicrometricsWithResponse(ctx context.Context, env string, params *GetEnvMicrometricsParams, reqEditors ...RequestEditorFn) (*GetEnvMicrometricsResp, error)

GetEnvMicrometricsWithResponse request returning *GetEnvMicrometricsResp

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) GetGreenhouseIntegrationWithResponse added in v0.1.22

func (c *ClientWithResponses) GetGreenhouseIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetGreenhouseIntegrationResp, error)

GetGreenhouseIntegrationWithResponse request returning *GetGreenhouseIntegrationResp

func (*ClientWithResponses) GetIntercomIntegrationByIDWithResponse added in v0.1.23

func (c *ClientWithResponses) GetIntercomIntegrationByIDWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetIntercomIntegrationByIDResp, error)

GetIntercomIntegrationByIDWithResponse request returning *GetIntercomIntegrationByIDResp

func (*ClientWithResponses) GetIntercomIntegrationWithResponse added in v0.1.23

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

GetIntercomIntegrationWithResponse request returning *GetIntercomIntegrationResp

func (*ClientWithResponses) GetJoinIntegrationWithResponse added in v0.1.24

func (c *ClientWithResponses) GetJoinIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetJoinIntegrationResp, error)

GetJoinIntegrationWithResponse request returning *GetJoinIntegrationResp

func (*ClientWithResponses) GetLeverIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) GetLeverIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetLeverIntegrationResp, error)

GetLeverIntegrationWithResponse request returning *GetLeverIntegrationResp

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) GetRecruiteeIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) GetRecruiteeIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetRecruiteeIntegrationResp, error)

GetRecruiteeIntegrationWithResponse request returning *GetRecruiteeIntegrationResp

func (*ClientWithResponses) GetRequestWithResponse

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

GetRequestWithResponse request returning *GetRequestResp

func (*ClientWithResponses) GetSharedDeviceRegistrationStatusWithResponse added in v0.1.22

func (c *ClientWithResponses) GetSharedDeviceRegistrationStatusWithResponse(ctx context.Context, env string, params *GetSharedDeviceRegistrationStatusParams, reqEditors ...RequestEditorFn) (*GetSharedDeviceRegistrationStatusResp, error)

GetSharedDeviceRegistrationStatusWithResponse request returning *GetSharedDeviceRegistrationStatusResp

func (*ClientWithResponses) GetSlackRequestDetailsWithResponse added in v0.1.17

func (c *ClientWithResponses) GetSlackRequestDetailsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSlackRequestDetailsResp, error)

GetSlackRequestDetailsWithResponse request returning *GetSlackRequestDetailsResp

func (*ClientWithResponses) GetSlateIntegrationWithResponse added in v0.1.24

func (c *ClientWithResponses) GetSlateIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetSlateIntegrationResp, error)

GetSlateIntegrationWithResponse request returning *GetSlateIntegrationResp

func (*ClientWithResponses) GetWorkableIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) GetWorkableIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetWorkableIntegrationResp, error)

GetWorkableIntegrationWithResponse request returning *GetWorkableIntegrationResp

func (*ClientWithResponses) GetWorkdayIntegrationWithResponse added in v0.1.20

func (c *ClientWithResponses) GetWorkdayIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetWorkdayIntegrationResp, error)

GetWorkdayIntegrationWithResponse request returning *GetWorkdayIntegrationResp

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) ListAshbyIntegrationsWithResponse added in v0.1.23

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

ListAshbyIntegrationsWithResponse request returning *ListAshbyIntegrationsResp

func (*ClientWithResponses) ListAshbyStagesWithResponse added in v0.1.23

func (c *ClientWithResponses) ListAshbyStagesWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*ListAshbyStagesResp, error)

ListAshbyStagesWithResponse request returning *ListAshbyStagesResp

func (*ClientWithResponses) ListAuditEventsWithResponse added in v0.1.15

func (c *ClientWithResponses) ListAuditEventsWithResponse(ctx context.Context, params *ListAuditEventsParams, reqEditors ...RequestEditorFn) (*ListAuditEventsResp, error)

ListAuditEventsWithResponse request returning *ListAuditEventsResp

func (*ClientWithResponses) ListDirectoriesWithResponse

func (c *ClientWithResponses) ListDirectoriesWithResponse(ctx context.Context, 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) ListGreenhouseIntegrationsWithResponse added in v0.1.22

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

ListGreenhouseIntegrationsWithResponse request returning *ListGreenhouseIntegrationsResp

func (*ClientWithResponses) ListIntegrationsWithResponse added in v0.1.22

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

ListIntegrationsWithResponse request returning *ListIntegrationsResp

func (*ClientWithResponses) ListJoinIntegrationsWithResponse added in v0.1.24

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

ListJoinIntegrationsWithResponse request returning *ListJoinIntegrationsResp

func (*ClientWithResponses) ListLeverIntegrationsWithResponse added in v0.1.23

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

ListLeverIntegrationsWithResponse request returning *ListLeverIntegrationsResp

func (*ClientWithResponses) ListOrgMembersWithResponse

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

ListOrgMembersWithResponse request returning *ListOrgMembersResp

func (*ClientWithResponses) ListRecruiteeIntegrationsWithResponse added in v0.1.23

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

ListRecruiteeIntegrationsWithResponse request returning *ListRecruiteeIntegrationsResp

func (*ClientWithResponses) ListSharedDevicesWithResponse added in v0.1.22

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

ListSharedDevicesWithResponse request returning *ListSharedDevicesResp

func (*ClientWithResponses) ListSlackIntegrationsWithResponse added in v0.1.17

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

ListSlackIntegrationsWithResponse request returning *ListSlackIntegrationsResp

func (*ClientWithResponses) ListSlateIntegrationsWithResponse added in v0.1.24

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

ListSlateIntegrationsWithResponse request returning *ListSlateIntegrationsResp

func (*ClientWithResponses) ListWebhooksWithResponse

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

ListWebhooksWithResponse request returning *ListWebhooksResp

func (*ClientWithResponses) ListWorkableIntegrationsWithResponse added in v0.1.23

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

ListWorkableIntegrationsWithResponse request returning *ListWorkableIntegrationsResp

func (*ClientWithResponses) ListWorkableJobsWithResponse added in v0.1.23

func (c *ClientWithResponses) ListWorkableJobsWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*ListWorkableJobsResp, error)

ListWorkableJobsWithResponse request returning *ListWorkableJobsResp

func (*ClientWithResponses) ListWorkdayIntegrationsWithResponse added in v0.1.20

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

ListWorkdayIntegrationsWithResponse request returning *ListWorkdayIntegrationsResp

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) PresignRecoveryMicrositeURLWithBodyWithResponse added in v0.1.12

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

PresignRecoveryMicrositeURLWithBodyWithResponse request with arbitrary body returning *PresignRecoveryMicrositeURLResp

func (*ClientWithResponses) PresignRecoveryMicrositeURLWithResponse added in v0.1.12

func (c *ClientWithResponses) PresignRecoveryMicrositeURLWithResponse(ctx context.Context, env string, body PresignRecoveryMicrositeURLJSONRequestBody, reqEditors ...RequestEditorFn) (*PresignRecoveryMicrositeURLResp, error)

func (*ClientWithResponses) RefreshWebhookSecretWithBodyWithResponse added in v0.1.12

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

RefreshWebhookSecretWithBodyWithResponse request with arbitrary body returning *RefreshWebhookSecretResp

func (*ClientWithResponses) RefreshWebhookSecretWithResponse added in v0.1.12

func (c *ClientWithResponses) RefreshWebhookSecretWithResponse(ctx context.Context, env string, body RefreshWebhookSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshWebhookSecretResp, error)

func (*ClientWithResponses) RegenerateDirectoryAgentTokenWithResponse added in v0.1.16

func (c *ClientWithResponses) RegenerateDirectoryAgentTokenWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*RegenerateDirectoryAgentTokenResp, error)

RegenerateDirectoryAgentTokenWithResponse request returning *RegenerateDirectoryAgentTokenResp

func (*ClientWithResponses) RegisterSharedDeviceWithResponse added in v0.1.22

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

RegisterSharedDeviceWithResponse request returning *RegisterSharedDeviceResp

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, 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, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*SetDirectoryCredentialsResp, error)

func (*ClientWithResponses) SetPictureWithBodyWithResponse added in v0.1.19

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

SetPictureWithBodyWithResponse request with arbitrary body returning *SetPictureResp

func (*ClientWithResponses) SetPreferredNameWithBodyWithResponse added in v0.1.19

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

SetPreferredNameWithBodyWithResponse request with arbitrary body returning *SetPreferredNameResp

func (*ClientWithResponses) SetPreferredNameWithResponse added in v0.1.19

func (c *ClientWithResponses) SetPreferredNameWithResponse(ctx context.Context, subject string, body SetPreferredNameJSONRequestBody, reqEditors ...RequestEditorFn) (*SetPreferredNameResp, error)

func (*ClientWithResponses) SyncDirectoryWithResponse

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

SyncDirectoryWithResponse request returning *SyncDirectoryResp

func (*ClientWithResponses) TestSlateIntegrationWithResponse added in v0.1.24

func (c *ClientWithResponses) TestSlateIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*TestSlateIntegrationResp, error)

TestSlateIntegrationWithResponse request returning *TestSlateIntegrationResp

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) UpdateAshbyIntegrationWithBodyWithResponse added in v0.1.23

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

UpdateAshbyIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateAshbyIntegrationResp

func (*ClientWithResponses) UpdateAshbyIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) UpdateAshbyIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateAshbyIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAshbyIntegrationResp, error)

func (*ClientWithResponses) UpdateDirectoryWithBodyWithResponse added in v0.1.12

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

UpdateDirectoryWithBodyWithResponse request with arbitrary body returning *UpdateDirectoryResp

func (*ClientWithResponses) UpdateDirectoryWithResponse added in v0.1.12

func (c *ClientWithResponses) UpdateDirectoryWithResponse(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDirectoryResp, 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) UpdateGreenhouseIntegrationWithBodyWithResponse added in v0.1.22

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

UpdateGreenhouseIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateGreenhouseIntegrationResp

func (*ClientWithResponses) UpdateGreenhouseIntegrationWithResponse added in v0.1.22

func (c *ClientWithResponses) UpdateGreenhouseIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateGreenhouseIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateGreenhouseIntegrationResp, error)

func (*ClientWithResponses) UpdateIntercomIntegrationWithBodyWithResponse added in v0.1.23

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

UpdateIntercomIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateIntercomIntegrationResp

func (*ClientWithResponses) UpdateIntercomIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) UpdateIntercomIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateIntercomIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateIntercomIntegrationResp, error)

func (*ClientWithResponses) UpdateJoinIntegrationWithBodyWithResponse added in v0.1.24

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

UpdateJoinIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateJoinIntegrationResp

func (*ClientWithResponses) UpdateJoinIntegrationWithResponse added in v0.1.24

func (c *ClientWithResponses) UpdateJoinIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateJoinIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateJoinIntegrationResp, error)

func (*ClientWithResponses) UpdateLeverIntegrationWithBodyWithResponse added in v0.1.23

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

UpdateLeverIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateLeverIntegrationResp

func (*ClientWithResponses) UpdateLeverIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) UpdateLeverIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateLeverIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateLeverIntegrationResp, 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) UpdateRecruiteeIntegrationWithBodyWithResponse added in v0.1.23

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

UpdateRecruiteeIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateRecruiteeIntegrationResp

func (*ClientWithResponses) UpdateRecruiteeIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) UpdateRecruiteeIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateRecruiteeIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRecruiteeIntegrationResp, 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) UpdateSlateIntegrationWithBodyWithResponse added in v0.1.24

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

UpdateSlateIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateSlateIntegrationResp

func (*ClientWithResponses) UpdateSlateIntegrationWithResponse added in v0.1.24

func (c *ClientWithResponses) UpdateSlateIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateSlateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSlateIntegrationResp, 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) UpdateWorkableIntegrationWithBodyWithResponse added in v0.1.23

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

UpdateWorkableIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateWorkableIntegrationResp

func (*ClientWithResponses) UpdateWorkableIntegrationWithResponse added in v0.1.23

func (c *ClientWithResponses) UpdateWorkableIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateWorkableIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWorkableIntegrationResp, error)

func (*ClientWithResponses) UpdateWorkdayIntegrationWithBodyWithResponse added in v0.1.20

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

UpdateWorkdayIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateWorkdayIntegrationResp

func (*ClientWithResponses) UpdateWorkdayIntegrationWithResponse added in v0.1.20

func (c *ClientWithResponses) UpdateWorkdayIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateWorkdayIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWorkdayIntegrationResp, 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) UploadDirectoryLogoWithBodyWithResponse added in v0.1.16

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

UploadDirectoryLogoWithBodyWithResponse request with arbitrary body returning *UploadDirectoryLogoResp

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

func (*ClientWithResponses) ValidateWorkdayIntegrationWithBodyWithResponse added in v0.1.22

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

ValidateWorkdayIntegrationWithBodyWithResponse request with arbitrary body returning *ValidateWorkdayIntegrationResp

func (*ClientWithResponses) ValidateWorkdayIntegrationWithResponse added in v0.1.22

func (c *ClientWithResponses) ValidateWorkdayIntegrationWithResponse(ctx context.Context, env string, body ValidateWorkdayIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*ValidateWorkdayIntegrationResp, error)

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)

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

	BulkUpdateAccountsWithResponse(ctx context.Context, body BulkUpdateAccountsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpdateAccountsResp, 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)

	// ListAuditEventsWithResponse request
	ListAuditEventsWithResponse(ctx context.Context, params *ListAuditEventsParams, reqEditors ...RequestEditorFn) (*ListAuditEventsResp, 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)

	// ListSharedDevicesWithResponse request
	ListSharedDevicesWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListSharedDevicesResp, error)

	// RegisterSharedDeviceWithResponse request
	RegisterSharedDeviceWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*RegisterSharedDeviceResp, error)

	// GetSharedDeviceRegistrationStatusWithResponse request
	GetSharedDeviceRegistrationStatusWithResponse(ctx context.Context, env string, params *GetSharedDeviceRegistrationStatusParams, reqEditors ...RequestEditorFn) (*GetSharedDeviceRegistrationStatusResp, error)

	// DeleteSharedDevicesWithResponse request
	DeleteSharedDevicesWithResponse(ctx context.Context, env string, id string, reqEditors ...RequestEditorFn) (*DeleteSharedDevicesResp, error)

	// ListDirectoriesWithResponse request
	ListDirectoriesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListDirectoriesResp, error)

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

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

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

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

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

	UpdateDirectoryWithResponse(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDirectoryResp, error)

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

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

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

	// DeleteDirectoryLogoWithResponse request
	DeleteDirectoryLogoWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryLogoResp, error)

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

	// RegenerateDirectoryAgentTokenWithResponse request
	RegenerateDirectoryAgentTokenWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*RegenerateDirectoryAgentTokenResp, error)

	// SyncDirectoryWithResponse request
	SyncDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*SyncDirectoryResp, 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)

	// ListAshbyIntegrationsWithResponse request
	ListAshbyIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListAshbyIntegrationsResp, error)

	// DeleteAshbyIntegrationWithResponse request
	DeleteAshbyIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteAshbyIntegrationResp, error)

	// GetAshbyIntegrationWithResponse request
	GetAshbyIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetAshbyIntegrationResp, error)

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

	UpdateAshbyIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateAshbyIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAshbyIntegrationResp, error)

	// ListAshbyStagesWithResponse request
	ListAshbyStagesWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*ListAshbyStagesResp, error)

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

	EncryptSecretWithResponse(ctx context.Context, env string, body EncryptSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*EncryptSecretResp, error)

	// ListGreenhouseIntegrationsWithResponse request
	ListGreenhouseIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListGreenhouseIntegrationsResp, error)

	// DeleteGreenhouseIntegrationWithResponse request
	DeleteGreenhouseIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteGreenhouseIntegrationResp, error)

	// GetGreenhouseIntegrationWithResponse request
	GetGreenhouseIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetGreenhouseIntegrationResp, error)

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

	UpdateGreenhouseIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateGreenhouseIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateGreenhouseIntegrationResp, error)

	// ListIntegrationsWithResponse request
	ListIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListIntegrationsResp, error)

	// GetIntercomIntegrationWithResponse request
	GetIntercomIntegrationWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*GetIntercomIntegrationResp, error)

	// DeleteIntercomIntegrationWithResponse request
	DeleteIntercomIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteIntercomIntegrationResp, error)

	// GetIntercomIntegrationByIDWithResponse request
	GetIntercomIntegrationByIDWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetIntercomIntegrationByIDResp, error)

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

	UpdateIntercomIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateIntercomIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateIntercomIntegrationResp, error)

	// ListJoinIntegrationsWithResponse request
	ListJoinIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListJoinIntegrationsResp, error)

	// DeleteJoinIntegrationWithResponse request
	DeleteJoinIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteJoinIntegrationResp, error)

	// GetJoinIntegrationWithResponse request
	GetJoinIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetJoinIntegrationResp, error)

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

	UpdateJoinIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateJoinIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateJoinIntegrationResp, error)

	// ListLeverIntegrationsWithResponse request
	ListLeverIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListLeverIntegrationsResp, error)

	// DeleteLeverIntegrationWithResponse request
	DeleteLeverIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteLeverIntegrationResp, error)

	// GetLeverIntegrationWithResponse request
	GetLeverIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetLeverIntegrationResp, error)

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

	UpdateLeverIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateLeverIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateLeverIntegrationResp, 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)

	// GetEnvMicrometricsWithResponse request
	GetEnvMicrometricsWithResponse(ctx context.Context, env string, params *GetEnvMicrometricsParams, reqEditors ...RequestEditorFn) (*GetEnvMicrometricsResp, error)

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

	PresignRecoveryMicrositeURLWithResponse(ctx context.Context, env string, body PresignRecoveryMicrositeURLJSONRequestBody, reqEditors ...RequestEditorFn) (*PresignRecoveryMicrositeURLResp, error)

	// ListRecruiteeIntegrationsWithResponse request
	ListRecruiteeIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListRecruiteeIntegrationsResp, error)

	// DeleteRecruiteeIntegrationWithResponse request
	DeleteRecruiteeIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteRecruiteeIntegrationResp, error)

	// GetRecruiteeIntegrationWithResponse request
	GetRecruiteeIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetRecruiteeIntegrationResp, error)

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

	UpdateRecruiteeIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateRecruiteeIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRecruiteeIntegrationResp, error)

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

	RefreshWebhookSecretWithResponse(ctx context.Context, env string, body RefreshWebhookSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshWebhookSecretResp, 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)

	// ListSlackIntegrationsWithResponse request
	ListSlackIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListSlackIntegrationsResp, error)

	// DeleteSlackIntegrationWithResponse request
	DeleteSlackIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteSlackIntegrationResp, error)

	// ListSlateIntegrationsWithResponse request
	ListSlateIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListSlateIntegrationsResp, error)

	// DeleteSlateIntegrationWithResponse request
	DeleteSlateIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteSlateIntegrationResp, error)

	// GetSlateIntegrationWithResponse request
	GetSlateIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetSlateIntegrationResp, error)

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

	UpdateSlateIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateSlateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSlateIntegrationResp, error)

	// TestSlateIntegrationWithResponse request
	TestSlateIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*TestSlateIntegrationResp, 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)

	// ListWorkableIntegrationsWithResponse request
	ListWorkableIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListWorkableIntegrationsResp, error)

	// DeleteWorkableIntegrationWithResponse request
	DeleteWorkableIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteWorkableIntegrationResp, error)

	// GetWorkableIntegrationWithResponse request
	GetWorkableIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetWorkableIntegrationResp, error)

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

	UpdateWorkableIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateWorkableIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWorkableIntegrationResp, error)

	// ListWorkableJobsWithResponse request
	ListWorkableJobsWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*ListWorkableJobsResp, error)

	// ListWorkdayIntegrationsWithResponse request
	ListWorkdayIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListWorkdayIntegrationsResp, error)

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

	CreateWorkdayIntegrationWithResponse(ctx context.Context, env string, body CreateWorkdayIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorkdayIntegrationResp, error)

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

	ValidateWorkdayIntegrationWithResponse(ctx context.Context, env string, body ValidateWorkdayIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*ValidateWorkdayIntegrationResp, error)

	// DeleteWorkdayIntegrationWithResponse request
	DeleteWorkdayIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteWorkdayIntegrationResp, error)

	// GetWorkdayIntegrationWithResponse request
	GetWorkdayIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*GetWorkdayIntegrationResp, error)

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

	UpdateWorkdayIntegrationWithResponse(ctx context.Context, env string, integration string, body UpdateWorkdayIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWorkdayIntegrationResp, error)

	// GetSlackRequestDetailsWithResponse request
	GetSlackRequestDetailsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSlackRequestDetailsResp, error)

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

	CreateWorkdayRequestWithResponse(ctx context.Context, body CreateWorkdayRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorkdayRequestResp, 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)

	// DownloadRequestProofWithResponse request
	DownloadRequestProofWithResponse(ctx context.Context, requestID string, params *DownloadRequestProofParams, reqEditors ...RequestEditorFn) (*DownloadRequestProofResp, 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)

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

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

	SetPreferredNameWithResponse(ctx context.Context, subject string, body SetPreferredNameJSONRequestBody, reqEditors ...RequestEditorFn) (*SetPreferredNameResp, 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) ContentType added in v0.1.24

func (r ComparePeopleResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r CompareSelfieResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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"`

	// NoFace The photo provided does not contain a person's face.
	NoFace *bool `json:"no_face,omitempty"`

	// NotMatched The face in the photo provided does not match any of the selfies on file for this person.
	NotMatched *bool `json:"not_matched,omitempty"`

	// MultipleFaces The photo provided contains more than one face.
	MultipleFaces *bool                          `json:"multiple_faces,omitempty"`
	EmployeeBadge *EmployeeBadgeValidationResult `json:"employee_badge,omitempty"`
}

CompareSelfieResult defines model for CompareSelfieResult.

type Comparison

type Comparison struct {
	// Scope The scope being compared.
	Scope *Scope `json:"scope,omitempty"`

	// Claim The claim being compared.
	Claim Claim `json:"claim"`

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

	// Actual The actual value for this claim.
	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 ConsoleSigninAuditEvent added in v0.1.15

type ConsoleSigninAuditEvent struct {
	// Email True if the user authenticated via email
	Email *bool `json:"email,omitempty"`

	// Nametag True if the user authenticated via Nametag (deprecated)
	Nametag *bool `json:"nametag,omitempty"`

	// RelayState If the user authenticated via SAML, the RelayState parameter
	RelayState *string `json:"relay_state,omitempty"`

	// SAML True if the user authenticated via SAML
	SAML *bool `json:"saml,omitempty"`

	// SAMLResponse If the user authenticated via SAML, the RelayState parameter
	SAMLResponse *string `json:"saml_response,omitempty"`
}

ConsoleSigninAuditEvent defines model for ConsoleSigninAuditEvent.

type ConsoleSinginConfigureEmailAuditEvent added in v0.1.15

type ConsoleSinginConfigureEmailAuditEvent struct {
	Empty *bool `json:"empty,omitempty"`
}

ConsoleSinginConfigureEmailAuditEvent defines model for ConsoleSinginConfigureEmailAuditEvent.

type ConsoleSinginConfigureSAMLAuditEvent added in v0.1.15

type ConsoleSinginConfigureSAMLAuditEvent struct {
	Empty *bool `json:"empty,omitempty"`
}

ConsoleSinginConfigureSAMLAuditEvent defines model for ConsoleSinginConfigureSAMLAuditEvent.

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 The role to be associated with the API key. The role determines what actions the  API key can perform.
	Role Role `json:"role,omitempty"`

	// ExpiresAt The expiration date and time for the API key. If not provided, the key will not expire. Example: "2023-12-31T23:59:59Z"
	ExpiresAt *time.Time `json:"expires_at,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) ContentType added in v0.1.24

func (r CreateAPIKeyResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 {
	// Env The ID of the environment to create this directory for
	Env string `json:"env"`

	// Kind The type of directory to create
	Kind DirectoryKind `json:"kind"`

	// Credentials Credentials to access the directory.
	//
	// Provide credentials for directories that require it
	// (`"okta"`, `"duo"`, `"onelogin"`, `"beyond-identity"`, `"auth0"`, `"authentik"`). Omit for `"azure-ad"`.
	Credentials *Credentials `json:"credentials,omitempty"`

	// Provisioning The provisioning mode. Defaults to `pull`.
	Provisioning *DirectoryProvisioning `json:"provisioning,omitempty"`
}

CreateDirectoryRequest defines model for CreateDirectoryRequest.

type CreateDirectoryResp

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

func ParseCreateDirectoryResp

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

ParseCreateDirectoryResp parses an HTTP response from a CreateDirectoryWithResponse call

func (CreateDirectoryResp) ContentType added in v0.1.24

func (r CreateDirectoryResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 {
	AgentToken *string `json:"agent_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) ContentType added in v0.1.24

func (r CreateEnvResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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"`

	// Claims A list of the information (claims) that the request is asking for.
	// > **Note**: This field is required unless `template` is specified.
	Claims []Claim `json:"claims,omitempty"`

	// Template The name of a template that customizes how the request is presented to the user.
	//
	// Because a template contains its own claim definitions, you can provide either `claims` or `template`; providing both results in an amalgamation of the two.
	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 all.
	Label string `json:"label,omitempty"`

	// MaxUsages The maximum number of times this request can be used to start a scan. A value of 0 means unlimited uses. When omitted, the template's max_usages value (if any) is used.
	MaxUsages *int `json:"max_usages,omitempty"`

	// Constraints Constraints the verified identity must satisfy (e.g. the name must match "Jane Smith", or the subject must bind to a directory account). When a constraint does not match, the request finishes in the constraints_unmatched state. The evaluation is reflected back on the request's `constraint_evaluation`.
	Constraints *RequestConstraint `json:"constraints,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) ContentType added in v0.1.24

func (r CreateRequestResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 The status code for the request. Always `"pending"` when the request is initially created.
	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"`

	// Claims A list of the information (claims) that the request is asking for.
	Claims []Claim `json:"claims"`

	// 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.164 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 all.
	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"`

	// 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"`

	// 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"`

	// ClaimDefinitions A list of claims that are requested when requests are created with this template.
	ClaimDefinitions []TemplateClaimDefinition `json:"claim_definitions,omitempty"`

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

	// MaxUsages The maximum number of times requests created from this template can be used to start a scan. A value of 0 means unlimited uses.
	MaxUsages *int `json:"max_usages,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"`

	// QRCustomText The text that appears below the desktop QR page headline.
	QRCustomText *string `json:"qr_custom_text,omitempty"`

	// EnableSelfieOnly If true, existing users only need to scan a selfie to complete a scan.  Not compatible with all scopes.
	EnableSelfieOnly *bool `json:"enable_selfie_only,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) ContentType added in v0.1.24

func (r CreateTemplateResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 CreateWorkdayIntegrationJSONRequestBody added in v0.1.20

type CreateWorkdayIntegrationJSONRequestBody = WorkdayIntegrationRequest

CreateWorkdayIntegrationJSONRequestBody defines body for CreateWorkdayIntegration for application/json ContentType.

type CreateWorkdayIntegrationResp added in v0.1.20

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

func ParseCreateWorkdayIntegrationResp added in v0.1.20

func ParseCreateWorkdayIntegrationResp(rsp *http.Response) (*CreateWorkdayIntegrationResp, error)

ParseCreateWorkdayIntegrationResp parses an HTTP response from a CreateWorkdayIntegrationWithResponse call

func (CreateWorkdayIntegrationResp) ContentType added in v0.1.24

func (r CreateWorkdayIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateWorkdayIntegrationResp) Status added in v0.1.20

Status returns HTTPResponse.Status

func (CreateWorkdayIntegrationResp) StatusCode added in v0.1.20

func (r CreateWorkdayIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateWorkdayRequestJSONRequestBody added in v0.1.20

type CreateWorkdayRequestJSONRequestBody = WorkdayIDVRequestRequest

CreateWorkdayRequestJSONRequestBody defines body for CreateWorkdayRequest for application/json ContentType.

type CreateWorkdayRequestResp added in v0.1.20

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

func ParseCreateWorkdayRequestResp added in v0.1.20

func ParseCreateWorkdayRequestResp(rsp *http.Response) (*CreateWorkdayRequestResp, error)

ParseCreateWorkdayRequestResp parses an HTTP response from a CreateWorkdayRequestWithResponse call

func (CreateWorkdayRequestResp) ContentType added in v0.1.24

func (r CreateWorkdayRequestResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateWorkdayRequestResp) Status added in v0.1.20

func (r CreateWorkdayRequestResp) Status() string

Status returns HTTPResponse.Status

func (CreateWorkdayRequestResp) StatusCode added in v0.1.20

func (r CreateWorkdayRequestResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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`
	// * For BeyondIdentity, the client ID, e.g. `Tf9IGY976IqEjEHJrYSJW7JF`
	// * For Auth0, the machine-to-machine application client ID
	// * For CyberArk Workforce Identity, the OAuth2 confidential client ID
	Account string `json:"account,omitempty"`

	// ApplicationID * For Duo, this field should be blank
	// * For Okta, this field should be blank
	// * For Onelogin, this field should be blank
	// * For BeyondIdentity, the application ID, e.g. `9f6b7c1e-2d44-4c2b-8c9f-3ab59e92c123`
	ApplicationID string `json:"application_id,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`.
	// * For BeyondIdentity, the BaseURL, e.g. `https://api-us.beyondidentity.com`.
	// * For Auth0, the tenant domain, e.g. `example.us.auth0.com`.
	// * For CyberArk Workforce Identity, the tenant URL, e.g. `example.id.cyberark.cloud`.
	Partition string `json:"partition"`

	// RealmID * For Duo, this field should be blank
	// * For Okta, this field should be blank
	// * For Onelogin, this field should be blank
	// * For BeyondIdentity, the realm ID, e.g. `8b4e3oxk01qwu19`
	RealmID string `json:"realm_id,omitempty"`

	// 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`
	// * For BeyondIdentity, the client secret, e.g. `Y0p8Q~a1Bx3K-4lHnV9zYt2sA7jRkLmF5gS9xTqW`
	// * For CyberArk Workforce Identity, the OAuth2 confidential client secret
	Secret string `json:"secret"`

	// TenantID * For Duo, this field should be blank
	// * For Okta, this field should be blank
	// * For Onelogin, this field should be blank
	// * For BeyondIdentity, the tenant ID, e.g. `1124mn2az1yglqq`
	TenantID string `json:"tenant_id,omitempty"`
}

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) ContentType added in v0.1.24

func (r DeleteAPIKeyResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 DeleteAshbyIntegrationResp added in v0.1.23

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

func ParseDeleteAshbyIntegrationResp added in v0.1.23

func ParseDeleteAshbyIntegrationResp(rsp *http.Response) (*DeleteAshbyIntegrationResp, error)

ParseDeleteAshbyIntegrationResp parses an HTTP response from a DeleteAshbyIntegrationWithResponse call

func (DeleteAshbyIntegrationResp) ContentType added in v0.1.24

func (r DeleteAshbyIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteAshbyIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (DeleteAshbyIntegrationResp) StatusCode added in v0.1.23

func (r DeleteAshbyIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteDirectoryLogoResp added in v0.1.16

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

func ParseDeleteDirectoryLogoResp added in v0.1.16

func ParseDeleteDirectoryLogoResp(rsp *http.Response) (*DeleteDirectoryLogoResp, error)

ParseDeleteDirectoryLogoResp parses an HTTP response from a DeleteDirectoryLogoWithResponse call

func (DeleteDirectoryLogoResp) ContentType added in v0.1.24

func (r DeleteDirectoryLogoResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteDirectoryLogoResp) Status added in v0.1.16

func (r DeleteDirectoryLogoResp) Status() string

Status returns HTTPResponse.Status

func (DeleteDirectoryLogoResp) StatusCode added in v0.1.16

func (r DeleteDirectoryLogoResp) 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) ContentType added in v0.1.24

func (r DeleteDirectoryResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r DeleteEnvResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 DeleteGreenhouseIntegrationResp added in v0.1.22

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

func ParseDeleteGreenhouseIntegrationResp added in v0.1.22

func ParseDeleteGreenhouseIntegrationResp(rsp *http.Response) (*DeleteGreenhouseIntegrationResp, error)

ParseDeleteGreenhouseIntegrationResp parses an HTTP response from a DeleteGreenhouseIntegrationWithResponse call

func (DeleteGreenhouseIntegrationResp) ContentType added in v0.1.24

func (r DeleteGreenhouseIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteGreenhouseIntegrationResp) Status added in v0.1.22

Status returns HTTPResponse.Status

func (DeleteGreenhouseIntegrationResp) StatusCode added in v0.1.22

func (r DeleteGreenhouseIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteIntercomIntegrationResp added in v0.1.23

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

func ParseDeleteIntercomIntegrationResp added in v0.1.23

func ParseDeleteIntercomIntegrationResp(rsp *http.Response) (*DeleteIntercomIntegrationResp, error)

ParseDeleteIntercomIntegrationResp parses an HTTP response from a DeleteIntercomIntegrationWithResponse call

func (DeleteIntercomIntegrationResp) ContentType added in v0.1.24

func (r DeleteIntercomIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteIntercomIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (DeleteIntercomIntegrationResp) StatusCode added in v0.1.23

func (r DeleteIntercomIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteJoinIntegrationResp added in v0.1.24

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

func ParseDeleteJoinIntegrationResp added in v0.1.24

func ParseDeleteJoinIntegrationResp(rsp *http.Response) (*DeleteJoinIntegrationResp, error)

ParseDeleteJoinIntegrationResp parses an HTTP response from a DeleteJoinIntegrationWithResponse call

func (DeleteJoinIntegrationResp) ContentType added in v0.1.24

func (r DeleteJoinIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteJoinIntegrationResp) Status added in v0.1.24

func (r DeleteJoinIntegrationResp) Status() string

Status returns HTTPResponse.Status

func (DeleteJoinIntegrationResp) StatusCode added in v0.1.24

func (r DeleteJoinIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteLeverIntegrationResp added in v0.1.23

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

func ParseDeleteLeverIntegrationResp added in v0.1.23

func ParseDeleteLeverIntegrationResp(rsp *http.Response) (*DeleteLeverIntegrationResp, error)

ParseDeleteLeverIntegrationResp parses an HTTP response from a DeleteLeverIntegrationWithResponse call

func (DeleteLeverIntegrationResp) ContentType added in v0.1.24

func (r DeleteLeverIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteLeverIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (DeleteLeverIntegrationResp) StatusCode added in v0.1.23

func (r DeleteLeverIntegrationResp) 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) ContentType added in v0.1.24

func (r DeleteLogoResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r DeletePersonPropertiesResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeletePersonPropertiesResp) Status

Status returns HTTPResponse.Status

func (DeletePersonPropertiesResp) StatusCode

func (r DeletePersonPropertiesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteRecruiteeIntegrationResp added in v0.1.23

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

func ParseDeleteRecruiteeIntegrationResp added in v0.1.23

func ParseDeleteRecruiteeIntegrationResp(rsp *http.Response) (*DeleteRecruiteeIntegrationResp, error)

ParseDeleteRecruiteeIntegrationResp parses an HTTP response from a DeleteRecruiteeIntegrationWithResponse call

func (DeleteRecruiteeIntegrationResp) ContentType added in v0.1.24

func (r DeleteRecruiteeIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteRecruiteeIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (DeleteRecruiteeIntegrationResp) StatusCode added in v0.1.23

func (r DeleteRecruiteeIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSharedDevicesResp added in v0.1.22

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

func ParseDeleteSharedDevicesResp added in v0.1.22

func ParseDeleteSharedDevicesResp(rsp *http.Response) (*DeleteSharedDevicesResp, error)

ParseDeleteSharedDevicesResp parses an HTTP response from a DeleteSharedDevicesWithResponse call

func (DeleteSharedDevicesResp) ContentType added in v0.1.24

func (r DeleteSharedDevicesResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteSharedDevicesResp) Status added in v0.1.22

func (r DeleteSharedDevicesResp) Status() string

Status returns HTTPResponse.Status

func (DeleteSharedDevicesResp) StatusCode added in v0.1.22

func (r DeleteSharedDevicesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSlackIntegrationResp added in v0.1.17

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

func ParseDeleteSlackIntegrationResp added in v0.1.17

func ParseDeleteSlackIntegrationResp(rsp *http.Response) (*DeleteSlackIntegrationResp, error)

ParseDeleteSlackIntegrationResp parses an HTTP response from a DeleteSlackIntegrationWithResponse call

func (DeleteSlackIntegrationResp) ContentType added in v0.1.24

func (r DeleteSlackIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteSlackIntegrationResp) Status added in v0.1.17

Status returns HTTPResponse.Status

func (DeleteSlackIntegrationResp) StatusCode added in v0.1.17

func (r DeleteSlackIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSlateIntegrationResp added in v0.1.24

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

func ParseDeleteSlateIntegrationResp added in v0.1.24

func ParseDeleteSlateIntegrationResp(rsp *http.Response) (*DeleteSlateIntegrationResp, error)

ParseDeleteSlateIntegrationResp parses an HTTP response from a DeleteSlateIntegrationWithResponse call

func (DeleteSlateIntegrationResp) ContentType added in v0.1.24

func (r DeleteSlateIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteSlateIntegrationResp) Status added in v0.1.24

Status returns HTTPResponse.Status

func (DeleteSlateIntegrationResp) StatusCode added in v0.1.24

func (r DeleteSlateIntegrationResp) 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) ContentType added in v0.1.24

func (r DeleteTemplateResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 DeleteWorkableIntegrationResp added in v0.1.23

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

func ParseDeleteWorkableIntegrationResp added in v0.1.23

func ParseDeleteWorkableIntegrationResp(rsp *http.Response) (*DeleteWorkableIntegrationResp, error)

ParseDeleteWorkableIntegrationResp parses an HTTP response from a DeleteWorkableIntegrationWithResponse call

func (DeleteWorkableIntegrationResp) ContentType added in v0.1.24

func (r DeleteWorkableIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteWorkableIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (DeleteWorkableIntegrationResp) StatusCode added in v0.1.23

func (r DeleteWorkableIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteWorkdayIntegrationResp added in v0.1.20

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

func ParseDeleteWorkdayIntegrationResp added in v0.1.20

func ParseDeleteWorkdayIntegrationResp(rsp *http.Response) (*DeleteWorkdayIntegrationResp, error)

ParseDeleteWorkdayIntegrationResp parses an HTTP response from a DeleteWorkdayIntegrationWithResponse call

func (DeleteWorkdayIntegrationResp) ContentType added in v0.1.24

func (r DeleteWorkdayIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteWorkdayIntegrationResp) Status added in v0.1.20

Status returns HTTPResponse.Status

func (DeleteWorkdayIntegrationResp) StatusCode added in v0.1.20

func (r DeleteWorkdayIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeviceOperatingSystem added in v0.1.22

type DeviceOperatingSystem string

DeviceOperatingSystem defines model for DeviceOperatingSystem.

const (
	DeviceOperatingSystemAndroid DeviceOperatingSystem = "Android"
	DeviceOperatingSystemIOS     DeviceOperatingSystem = "iOS"
	DeviceOperatingSystemUnknown DeviceOperatingSystem = "unknown"
)

Defines values for DeviceOperatingSystem.

func (DeviceOperatingSystem) Valid added in v0.1.22

func (e DeviceOperatingSystem) Valid() bool

Valid indicates whether the value is a known member of the DeviceOperatingSystem enum.

type DeviceRegistrationStatus added in v0.1.22

type DeviceRegistrationStatus string

DeviceRegistrationStatus defines model for DeviceRegistrationStatus.

const (
	DeviceRegistrationStatusExpired    DeviceRegistrationStatus = "expired"
	DeviceRegistrationStatusInProgress DeviceRegistrationStatus = "in_progress"
	DeviceRegistrationStatusSuccess    DeviceRegistrationStatus = "success"
)

Defines values for DeviceRegistrationStatus.

func (DeviceRegistrationStatus) Valid added in v0.1.22

func (e DeviceRegistrationStatus) Valid() bool

Valid indicates whether the value is a known member of the DeviceRegistrationStatus enum.

type Directory

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

	// Env The environment this directory belongs to.
	Env string `json:"env"`

	// Kind The kind of directory this is
	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 help you identify the directory.
	Name string `json:"name"`

	// AuthenticatePolicy The policy governing using Nametag as an authentication factor
	AuthenticatePolicy RecoveryPolicyRules `json:"authenticate_policy"`

	// MfaPolicy The policy governing MFA reset
	MfaPolicy RecoveryPolicyRules `json:"mfa_policy"`

	// PasswordPolicy The policy governing password reset
	PasswordPolicy RecoveryPolicyRules `json:"password_policy"`

	// TemporaryAccessPassPolicy The policy governing generating a temporary access pass.
	TemporaryAccessPassPolicy RecoveryPolicyRules `json:"temporary_access_pass_policy"`

	// UnlockPolicy The policy governing account unlock
	UnlockPolicy RecoveryPolicyRules `json:"unlock_policy"`

	// TemporaryAccessPassLifetimeMinutes The validity period of a temporary access pass in minutes.
	// For Entra ID, this value must be between 10 and 43200 (equivalent to 30 days).  If not specified, the defaultLifetimeInMinutes setting in the  [Temporary Access Pass authentication method policy](https://learn.microsoft.com/en-us/graph/api/resources/temporaryaccesspassauthenticationmethodconfiguration?view=graph-rest-1.0) is applied.
	TemporaryAccessPassLifetimeMinutes *int `json:"temporary_access_pass_lifetime_minutes,omitempty"`

	// TemporaryAccessPassReusable True if temporary access passes can be used more than once. If unspecified,  temporary access passes are usable only once.
	TemporaryAccessPassReusable *bool `json:"temporary_access_pass_reusable,omitempty"`

	// Credentials The directory credentials used, not including any secret values.
	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"`

	// BirthDateHMACSecretExists true if a shared secret for birth date HMACs has been set
	BirthDateHMACSecretExists bool `json:"birth_date_hmac_secret_exists"`

	// DirectorySecret the directory secret used by external clients for integration scenarios
	DirectorySecret []byte `json:"directory_secret,omitempty"`

	// CanGetMFABypassCode true if the directory supports generating an MFA bypass code
	CanGetMFABypassCode *bool `json:"can_get_mfa_bypass_code,omitempty"`

	// CanGetMFALink true if the directory supports issuing a pre-authenticated MFA reset link
	CanGetMFALink *bool `json:"can_get_mfa_link,omitempty"`

	// CanGetPasswordLink true if the directory supports issuing a pre-authenticated password reset link
	CanGetPasswordLink *bool `json:"can_get_password_link,omitempty"`

	// CanGetTemporaryAccessPass true if the directory supports issuing a temporary access pass
	CanGetTemporaryAccessPass *bool `json:"can_get_temporary_access_pass,omitempty"`

	// CanGetTemporaryPassword true if the directory supports issuing a temporary password
	CanGetTemporaryPassword *bool `json:"can_get_temporary_password,omitempty"`

	// CanRemoveAllMFA true if the directory supports removing all MFA devices
	CanRemoveAllMFA *bool `json:"can_remove_all_mfa,omitempty"`

	// CanUnlock true if the directory supports unlocking a locked account
	CanUnlock *bool `json:"can_unlock,omitempty"`

	// CanUpdateAccountsList true if the directory supports progressive updates to the list of accounts
	CanUpdateAccountsList *bool `json:"can_update_accounts_list,omitempty"`

	// LogoURL The URL of the logo image for this directory.
	LogoURL *string `json:"logo_url,omitempty"`

	// Provisioning The current provisioning mode.
	Provisioning               *DirectoryProvisioning      `json:"provisioning,omitempty"`
	RecoveryOperationRateLimit *RecoveryOperationRateLimit `json:"recovery_operation_rate_limit,omitempty"`
}

Directory defines model for Directory.

type DirectoryAuthorizedAuditEvent added in v0.1.15

type DirectoryAuthorizedAuditEvent struct {
	Directory string `json:"directory"`
}

DirectoryAuthorizedAuditEvent defines model for DirectoryAuthorizedAuditEvent.

type DirectoryCreatedAuditEvent added in v0.1.15

type DirectoryCreatedAuditEvent struct {
	Request  CreateDirectoryRequest  `json:"request"`
	Response CreateDirectoryResponse `json:"response"`
}

DirectoryCreatedAuditEvent defines model for DirectoryCreatedAuditEvent.

type DirectoryDeletedAuditEvent added in v0.1.15

type DirectoryDeletedAuditEvent struct {
	Directory string `json:"directory"`
}

DirectoryDeletedAuditEvent defines model for DirectoryDeletedAuditEvent.

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 DirectoryGroupPolicyRulesRemovedAuditEvent added in v0.1.28

type DirectoryGroupPolicyRulesRemovedAuditEvent struct {
	Directory string `json:"directory"`

	// Group The SCIM group that was deleted. A recovery policy rule names a local provisioned group, so deleting the group removes the rules that name it.
	Group DirectoryGroup `json:"group"`

	// Removed The group policy rules that were removed, by policy field. The affected operations now fall through to the next matching rule or to the policy's default, which may be less restrictive than the rule that was removed. Recorded with each rule's policy so an administrator can rebuild it.
	Removed []ClearedGroupPolicy `json:"removed"`
}

DirectoryGroupPolicyRulesRemovedAuditEvent defines model for DirectoryGroupPolicyRulesRemovedAuditEvent.

type DirectoryKind

type DirectoryKind string

DirectoryKind The type of the directory connection.

const (
	DirectoryKindAuth0            DirectoryKind = "auth0"
	DirectoryKindAuthentik        DirectoryKind = "authentik"
	DirectoryKindAzureAD          DirectoryKind = "azure-ad"
	DirectoryKindBeyondIdentity   DirectoryKind = "beyond-identity"
	DirectoryKindClerk            DirectoryKind = "clerk"
	DirectoryKindCustom           DirectoryKind = "custom"
	DirectoryKindCyberArkIdentity DirectoryKind = "cyberarkidentity"
	DirectoryKindDuo              DirectoryKind = "duo"
	DirectoryKindGusto            DirectoryKind = "gusto"
	DirectoryKindOkta             DirectoryKind = "okta"
	DirectoryKindOnelogin         DirectoryKind = "onelogin"
	DirectoryKindWorkOS           DirectoryKind = "workos"
)

Defines values for DirectoryKind.

func (DirectoryKind) Valid added in v0.1.22

func (e DirectoryKind) Valid() bool

Valid indicates whether the value is a known member of the DirectoryKind enum.

type DirectoryLogoDeletedAuditEvent added in v0.1.16

type DirectoryLogoDeletedAuditEvent struct {
	Directory string `json:"directory"`
}

DirectoryLogoDeletedAuditEvent defines model for DirectoryLogoDeletedAuditEvent.

type DirectoryLogoUploadedAuditEvent added in v0.1.16

type DirectoryLogoUploadedAuditEvent struct {
	Directory string `json:"directory"`
}

DirectoryLogoUploadedAuditEvent defines model for DirectoryLogoUploadedAuditEvent.

type DirectoryProvisioning added in v0.1.24

type DirectoryProvisioning string

DirectoryProvisioning How directory accounts are provisioned: provider pull or SCIM push.

const (
	DirectoryProvisioningPull DirectoryProvisioning = "pull"
	DirectoryProvisioningSCIM DirectoryProvisioning = "scim"
)

Defines values for DirectoryProvisioning.

func (DirectoryProvisioning) Valid added in v0.1.24

func (e DirectoryProvisioning) Valid() bool

Valid indicates whether the value is a known member of the DirectoryProvisioning enum.

type DirectorySetCredentialsAuditEvent added in v0.1.15

type DirectorySetCredentialsAuditEvent struct {
	Directory string `json:"directory"`
}

DirectorySetCredentialsAuditEvent defines model for DirectorySetCredentialsAuditEvent.

type DirectoryUpdatedAuditEvent added in v0.1.15

type DirectoryUpdatedAuditEvent struct {
	// ClearedGroupPolicies The group policy rules that were discarded because the directory's provisioning mode changed, which invalidates every group reference. The affected operations were disabled at the same time. Recorded so an administrator can see what they had and rebuild it.
	ClearedGroupPolicies *[]ClearedGroupPolicy  `json:"cleared_group_policies,omitempty"`
	Directory            string                 `json:"directory"`
	Request              UpdateDirectoryRequest `json:"request"`
}

DirectoryUpdatedAuditEvent defines model for DirectoryUpdatedAuditEvent.

type DownloadRequestProofParams added in v0.1.24

type DownloadRequestProofParams struct {
	// Tz IANA time zone name (e.g. `America/New_York`) used to format the
	// dates shown on the certificate. Defaults to UTC.
	Tz *string `form:"tz,omitempty" json:"tz,omitempty"`
}

DownloadRequestProofParams defines parameters for DownloadRequestProof.

type DownloadRequestProofResp added in v0.1.24

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

func ParseDownloadRequestProofResp added in v0.1.24

func ParseDownloadRequestProofResp(rsp *http.Response) (*DownloadRequestProofResp, error)

ParseDownloadRequestProofResp parses an HTTP response from a DownloadRequestProofWithResponse call

func (DownloadRequestProofResp) ContentType added in v0.1.24

func (r DownloadRequestProofResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DownloadRequestProofResp) Status added in v0.1.24

func (r DownloadRequestProofResp) Status() string

Status returns HTTPResponse.Status

func (DownloadRequestProofResp) StatusCode added in v0.1.24

func (r DownloadRequestProofResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EmployeeBadgeValidationResult added in v0.1.18

type EmployeeBadgeValidationResult struct {
	// Valid True if the photo is appropriate for use as an employee badge, false otherwise.
	Valid bool `json:"valid"`

	// Reason If the photo is not appropriate for use as an employee badge, a human-readable explanation of why the photo is not valid.
	Reason *string `json:"reason,omitempty"`
}

EmployeeBadgeValidationResult defines model for EmployeeBadgeValidationResult.

type EncryptSecretJSONRequestBody added in v0.1.18

type EncryptSecretJSONRequestBody = EncryptSecretRequest

EncryptSecretJSONRequestBody defines body for EncryptSecret for application/json ContentType.

type EncryptSecretRequest added in v0.1.18

type EncryptSecretRequest struct {
	// Plaintext The secret to encrypt
	Plaintext string `json:"plaintext"`
}

EncryptSecretRequest defines model for EncryptSecretRequest.

type EncryptSecretResp added in v0.1.18

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

func ParseEncryptSecretResp added in v0.1.18

func ParseEncryptSecretResp(rsp *http.Response) (*EncryptSecretResp, error)

ParseEncryptSecretResp parses an HTTP response from a EncryptSecretWithResponse call

func (EncryptSecretResp) ContentType added in v0.1.24

func (r EncryptSecretResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EncryptSecretResp) Status added in v0.1.18

func (r EncryptSecretResp) Status() string

Status returns HTTPResponse.Status

func (EncryptSecretResp) StatusCode added in v0.1.18

func (r EncryptSecretResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EncryptSecretResponse added in v0.1.18

type EncryptSecretResponse struct {
	// Ciphertext The encrypted secret value
	Ciphertext string `json:"ciphertext"`
}

EncryptSecretResponse defines model for EncryptSecretResponse.

type EntraEamAuthorizeAuditEvent added in v0.1.15

type EntraEamAuthorizeAuditEvent struct {
	Directory string                    `json:"directory"`
	Request   EntraEamAuthorizeRequest  `json:"request"`
	Response  EntraEamAuthorizeResponse `json:"response"`
}

EntraEamAuthorizeAuditEvent defines model for EntraEamAuthorizeAuditEvent.

type EntraEamAuthorizeRequest added in v0.1.15

type EntraEamAuthorizeRequest struct {
	Claims          string `json:"claims"`
	ClientId        string `json:"client_id"`
	ClientRequestId string `json:"client_request_id"`
	IdTokenHint     string `json:"id_token_hint"`
	Nonce           string `json:"nonce"`
	RedirectUri     string `json:"redirect_uri"`
	ResponseMode    string `json:"response_mode"`
	ResponseType    string `json:"response_type"`
	Scope           string `json:"scope"`
	State           string `json:"state"`
}

EntraEamAuthorizeRequest defines model for EntraEamAuthorizeRequest.

type EntraEamAuthorizeResponse added in v0.1.15

type EntraEamAuthorizeResponse struct {
	Oauth2ClientId    string `json:"oauth2_client_id"`
	Oauth2RedirectUri string `json:"oauth2_redirect_uri"`
	Oauth2Server      string `json:"oauth2_server"`
	Oauth2Template    string `json:"oauth2_template"`
	State             string `json:"state"`
}

EntraEamAuthorizeResponse defines model for EntraEamAuthorizeResponse.

type EntraEamFinishAuditEvent added in v0.1.15

type EntraEamFinishAuditEvent struct {
	Directory string                 `json:"directory"`
	Request   EntraEamFinishRequest  `json:"request"`
	Response  EntraEamFinishResponse `json:"response"`
}

EntraEamFinishAuditEvent defines model for EntraEamFinishAuditEvent.

type EntraEamFinishRequest added in v0.1.15

type EntraEamFinishRequest struct {
	Code  *string `json:"code,omitempty"`
	Error *string `json:"error,omitempty"`
	State string  `json:"state"`
}

EntraEamFinishRequest defines model for EntraEamFinishRequest.

type EntraEamFinishResponse added in v0.1.15

type EntraEamFinishResponse struct {
	BindingFailed *bool   `json:"binding_failed,omitempty"`
	Error         *string `json:"error,omitempty"`
	IDToken       *string `json:"id_token,omitempty"`
	Oauth2State   *string `json:"oauth2_state,omitempty"`
	RedirectUri   *string `json:"redirect_uri,omitempty"`
}

EntraEamFinishResponse defines model for EntraEamFinishResponse.

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: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	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"`

	// OidcDelegates A list of OIDC Delegates.
	OidcDelegates []OIDCDelegate `json:"oidc_delegates"`

	// MicrositeSAMLDirectories A list of directory ID's that back the SAML verify flow.
	MicrositeSAMLDirectories []string `json:"microsite_saml_directories"`
}

Env defines model for Env.

type EnvCreatedAuditEvent added in v0.1.15

type EnvCreatedAuditEvent struct {
	Request  CreateEnvRequest  `json:"request"`
	Response CreateEnvResponse `json:"response"`
}

EnvCreatedAuditEvent defines model for EnvCreatedAuditEvent.

type EnvDeletedAuditEvent added in v0.1.15

type EnvDeletedAuditEvent struct {
	Empty *bool `json:"empty,omitempty"`
}

EnvDeletedAuditEvent defines model for EnvDeletedAuditEvent.

type EnvLogoDeletedAuditEvent added in v0.1.15

type EnvLogoDeletedAuditEvent struct {
	Kind string `json:"kind"`
}

EnvLogoDeletedAuditEvent defines model for EnvLogoDeletedAuditEvent.

type EnvLogoUploadedAuditEvent added in v0.1.15

type EnvLogoUploadedAuditEvent struct {
	Kind string `json:"kind"`
}

EnvLogoUploadedAuditEvent defines model for EnvLogoUploadedAuditEvent.

type EnvStatusFilterParams added in v0.1.16

type EnvStatusFilterParams string

EnvStatusFilterParams defines model for EnvStatusFilterParams.

const (
	EnvStatusFilterParamsActive               EnvStatusFilterParams = "active"
	EnvStatusFilterParamsExpired              EnvStatusFilterParams = "expired"
	EnvStatusFilterParamsHideExpired          EnvStatusFilterParams = "hideExpired"
	EnvStatusFilterParamsRejectedAll          EnvStatusFilterParams = "rejectedAll"
	EnvStatusFilterParamsRejectedFraud        EnvStatusFilterParams = "rejectedFraud"
	EnvStatusFilterParamsScheduledForDeletion EnvStatusFilterParams = "scheduledForDeletion"
)

Defines values for EnvStatusFilterParams.

func (EnvStatusFilterParams) Valid added in v0.1.22

func (e EnvStatusFilterParams) Valid() bool

Valid indicates whether the value is a known member of the EnvStatusFilterParams enum.

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"`

	// S3BucketIN The S3 bucket for data stored in India. Must be in the ap-south-1 AWS region.
	S3BucketIN *string `json:"s3_bucket_in,omitempty"`

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

	// AzureBlobSasUS Azure Blob Storage presigned (SAS) URL. Should be in the eastus region.
	AzureBlobSasUS *string `json:"azure_blob_us,omitempty"`

	// AzureBlobSasEU Azure Blob Storage presigned (SAS) URL. Should be in the northeurope region.
	AzureBlobSasEU *string `json:"azure_blob_eu,omitempty"`

	// AzureBlobSasIN Azure Blob Storage presigned (SAS) URL. Should be in the centralindia region.
	AzureBlobSasIN *string `json:"azure_blob_in,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: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	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"`

	// RemoveOidcDelegates Remove OIDC delegate from the environment (IDs of the delegates to remove)
	RemoveOidcDelegates []string `json:"remove_oidc_delegates,omitempty"`

	// AddOidcDelegates Add OIDC delegates to the environment
	AddOidcDelegates   []OIDCDelegate      `json:"add_oidc_delegates,omitempty"`
	UpdateOidcDelegate *OIDCDelegateUpdate `json:"update_oidc_delegate,omitempty"`
}

EnvUpdateRequest defines model for EnvUpdateRequest.

type EnvUpdatedAtFilterParams added in v0.1.16

type EnvUpdatedAtFilterParams string

EnvUpdatedAtFilterParams defines model for EnvUpdatedAtFilterParams.

const (
	All       EnvUpdatedAtFilterParams = "all"
	Lastmonth EnvUpdatedAtFilterParams = "lastmonth"
	Month     EnvUpdatedAtFilterParams = "month"
	Today     EnvUpdatedAtFilterParams = "today"
	Week      EnvUpdatedAtFilterParams = "week"
	Year      EnvUpdatedAtFilterParams = "year"
)

Defines values for EnvUpdatedAtFilterParams.

func (EnvUpdatedAtFilterParams) Valid added in v0.1.22

func (e EnvUpdatedAtFilterParams) Valid() bool

Valid indicates whether the value is a known member of the EnvUpdatedAtFilterParams enum.

type EnvUpdatedAuditEvent added in v0.1.15

type EnvUpdatedAuditEvent struct {
	Request EnvUpdateRequest `json:"request"`
}

EnvUpdatedAuditEvent defines model for EnvUpdatedAuditEvent.

type EnvWebhookSecretUpdatedAuditEvent added in v0.1.15

type EnvWebhookSecretUpdatedAuditEvent struct {
	Empty *bool `json:"empty,omitempty"`
}

EnvWebhookSecretUpdatedAuditEvent defines model for EnvWebhookSecretUpdatedAuditEvent.

type Expectation

type Expectation struct {
	// Scope The scope you are comparing against.
	Scope *Scope `json:"scope,omitempty"`

	// Claim The claim you are comparing against.
	Claim Claim `json:"claim"`

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

Expectation defines model for Expectation.

type ExtensionInvokedAuditEvent added in v0.1.18

type ExtensionInvokedAuditEvent struct {
	// Method The extension method name
	Method string `json:"method"`

	// Logs Messages that are emitted by console logs during the execution of the extension  function.
	Logs []string `json:"logs,omitempty"`

	// Error If the extension method returned an error, this will contain the error message. Otherwise, it will be empty.
	Error *string `json:"error,omitempty"`
}

ExtensionInvokedAuditEvent defines model for ExtensionInvokedAuditEvent.

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) ContentType added in v0.1.24

func (r GetAPIKeyResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r GetAccountResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 GetAshbyIntegrationResp added in v0.1.23

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

func ParseGetAshbyIntegrationResp added in v0.1.23

func ParseGetAshbyIntegrationResp(rsp *http.Response) (*GetAshbyIntegrationResp, error)

ParseGetAshbyIntegrationResp parses an HTTP response from a GetAshbyIntegrationWithResponse call

func (GetAshbyIntegrationResp) ContentType added in v0.1.24

func (r GetAshbyIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetAshbyIntegrationResp) Status added in v0.1.23

func (r GetAshbyIntegrationResp) Status() string

Status returns HTTPResponse.Status

func (GetAshbyIntegrationResp) StatusCode added in v0.1.23

func (r GetAshbyIntegrationResp) 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) ContentType added in v0.1.24

func (r GetBulkPeoplePropertiesResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r GetDirectoryAuthorizationURLResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r GetDirectoryResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 GetEnvMicrometricsParams added in v0.1.16

type GetEnvMicrometricsParams struct {
	Requestor    *string                   `form:"requestor,omitempty" json:"requestor,omitempty"`
	StatusFilter *EnvStatusFilterParams    `form:"statusFilter,omitempty" json:"statusFilter,omitempty"`
	UpdatedAt    *EnvUpdatedAtFilterParams `form:"updatedAt,omitempty" json:"updatedAt,omitempty"`
}

GetEnvMicrometricsParams defines parameters for GetEnvMicrometrics.

type GetEnvMicrometricsResp added in v0.1.16

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

func ParseGetEnvMicrometricsResp added in v0.1.16

func ParseGetEnvMicrometricsResp(rsp *http.Response) (*GetEnvMicrometricsResp, error)

ParseGetEnvMicrometricsResp parses an HTTP response from a GetEnvMicrometricsWithResponse call

func (GetEnvMicrometricsResp) ContentType added in v0.1.24

func (r GetEnvMicrometricsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetEnvMicrometricsResp) Status added in v0.1.16

func (r GetEnvMicrometricsResp) Status() string

Status returns HTTPResponse.Status

func (GetEnvMicrometricsResp) StatusCode added in v0.1.16

func (r GetEnvMicrometricsResp) 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) ContentType added in v0.1.24

func (r GetEnvRequestResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r GetEnvResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 GetGreenhouseIntegrationResp added in v0.1.22

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

func ParseGetGreenhouseIntegrationResp added in v0.1.22

func ParseGetGreenhouseIntegrationResp(rsp *http.Response) (*GetGreenhouseIntegrationResp, error)

ParseGetGreenhouseIntegrationResp parses an HTTP response from a GetGreenhouseIntegrationWithResponse call

func (GetGreenhouseIntegrationResp) ContentType added in v0.1.24

func (r GetGreenhouseIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetGreenhouseIntegrationResp) Status added in v0.1.22

Status returns HTTPResponse.Status

func (GetGreenhouseIntegrationResp) StatusCode added in v0.1.22

func (r GetGreenhouseIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIntercomIntegrationByIDResp added in v0.1.23

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

func ParseGetIntercomIntegrationByIDResp added in v0.1.23

func ParseGetIntercomIntegrationByIDResp(rsp *http.Response) (*GetIntercomIntegrationByIDResp, error)

ParseGetIntercomIntegrationByIDResp parses an HTTP response from a GetIntercomIntegrationByIDWithResponse call

func (GetIntercomIntegrationByIDResp) ContentType added in v0.1.24

func (r GetIntercomIntegrationByIDResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetIntercomIntegrationByIDResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (GetIntercomIntegrationByIDResp) StatusCode added in v0.1.23

func (r GetIntercomIntegrationByIDResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIntercomIntegrationResp added in v0.1.23

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

func ParseGetIntercomIntegrationResp added in v0.1.23

func ParseGetIntercomIntegrationResp(rsp *http.Response) (*GetIntercomIntegrationResp, error)

ParseGetIntercomIntegrationResp parses an HTTP response from a GetIntercomIntegrationWithResponse call

func (GetIntercomIntegrationResp) ContentType added in v0.1.24

func (r GetIntercomIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetIntercomIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (GetIntercomIntegrationResp) StatusCode added in v0.1.23

func (r GetIntercomIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetJoinIntegrationResp added in v0.1.24

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

func ParseGetJoinIntegrationResp added in v0.1.24

func ParseGetJoinIntegrationResp(rsp *http.Response) (*GetJoinIntegrationResp, error)

ParseGetJoinIntegrationResp parses an HTTP response from a GetJoinIntegrationWithResponse call

func (GetJoinIntegrationResp) ContentType added in v0.1.24

func (r GetJoinIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetJoinIntegrationResp) Status added in v0.1.24

func (r GetJoinIntegrationResp) Status() string

Status returns HTTPResponse.Status

func (GetJoinIntegrationResp) StatusCode added in v0.1.24

func (r GetJoinIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLeverIntegrationResp added in v0.1.23

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

func ParseGetLeverIntegrationResp added in v0.1.23

func ParseGetLeverIntegrationResp(rsp *http.Response) (*GetLeverIntegrationResp, error)

ParseGetLeverIntegrationResp parses an HTTP response from a GetLeverIntegrationWithResponse call

func (GetLeverIntegrationResp) ContentType added in v0.1.24

func (r GetLeverIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetLeverIntegrationResp) Status added in v0.1.23

func (r GetLeverIntegrationResp) Status() string

Status returns HTTPResponse.Status

func (GetLeverIntegrationResp) StatusCode added in v0.1.23

func (r GetLeverIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMicrometricsResponse added in v0.1.16

type GetMicrometricsResponse struct {
	// SelfServiceCount Number of self-service requests
	SelfServiceCount int64 `json:"self_service_count"`

	// VerificationCount Total number of verification requests
	VerificationCount int64 `json:"verification_count"`

	// FraudCount Number of fraud requests
	FraudCount int64 `json:"fraud_count"`

	// HumansVerifiedCount Number of humans verified
	HumansVerifiedCount int64 `json:"humans_verified_count"`

	// ApiRequestsCount Number of API requests
	ApiRequestsCount int64 `json:"api_requests_count"`

	// CopilotCount Number of Copilot requests
	CopilotCount int64 `json:"copilot_count"`
}

GetMicrometricsResponse defines model for GetMicrometricsResponse.

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) ContentType added in v0.1.24

func (r GetOrgResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r GetPersonPropertiesResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 GetRecruiteeIntegrationResp added in v0.1.23

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

func ParseGetRecruiteeIntegrationResp added in v0.1.23

func ParseGetRecruiteeIntegrationResp(rsp *http.Response) (*GetRecruiteeIntegrationResp, error)

ParseGetRecruiteeIntegrationResp parses an HTTP response from a GetRecruiteeIntegrationWithResponse call

func (GetRecruiteeIntegrationResp) ContentType added in v0.1.24

func (r GetRecruiteeIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetRecruiteeIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (GetRecruiteeIntegrationResp) StatusCode added in v0.1.23

func (r GetRecruiteeIntegrationResp) 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) ContentType added in v0.1.24

func (r GetRequestResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 {
	Requests         []Request `json:"requests"`
	NextOffset       int       `json:"next_offset"`
	TotalResultCount int64     `json:"total_result_count"`
}

GetRequestsResponse defines model for GetRequestsResponse.

type GetSharedDeviceRegistrationStatusParams added in v0.1.22

type GetSharedDeviceRegistrationStatusParams struct {
	// RegistrationToken Registration token to retrieve the status for.
	RegistrationToken string `form:"registration_token" json:"registration_token"`
}

GetSharedDeviceRegistrationStatusParams defines parameters for GetSharedDeviceRegistrationStatus.

type GetSharedDeviceRegistrationStatusResp added in v0.1.22

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

func ParseGetSharedDeviceRegistrationStatusResp added in v0.1.22

func ParseGetSharedDeviceRegistrationStatusResp(rsp *http.Response) (*GetSharedDeviceRegistrationStatusResp, error)

ParseGetSharedDeviceRegistrationStatusResp parses an HTTP response from a GetSharedDeviceRegistrationStatusWithResponse call

func (GetSharedDeviceRegistrationStatusResp) ContentType added in v0.1.24

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetSharedDeviceRegistrationStatusResp) Status added in v0.1.22

Status returns HTTPResponse.Status

func (GetSharedDeviceRegistrationStatusResp) StatusCode added in v0.1.22

StatusCode returns HTTPResponse.StatusCode

type GetSharedDeviceRegistrationStatusResponse added in v0.1.22

type GetSharedDeviceRegistrationStatusResponse struct {
	// Status The status of the device registration.
	Status DeviceRegistrationStatus `json:"status"`
}

GetSharedDeviceRegistrationStatusResponse defines model for GetSharedDeviceRegistrationStatusResponse.

type GetSlackRequestDetailsResp added in v0.1.17

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

func ParseGetSlackRequestDetailsResp added in v0.1.17

func ParseGetSlackRequestDetailsResp(rsp *http.Response) (*GetSlackRequestDetailsResp, error)

ParseGetSlackRequestDetailsResp parses an HTTP response from a GetSlackRequestDetailsWithResponse call

func (GetSlackRequestDetailsResp) ContentType added in v0.1.24

func (r GetSlackRequestDetailsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetSlackRequestDetailsResp) Status added in v0.1.17

Status returns HTTPResponse.Status

func (GetSlackRequestDetailsResp) StatusCode added in v0.1.17

func (r GetSlackRequestDetailsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSlateIntegrationResp added in v0.1.24

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

func ParseGetSlateIntegrationResp added in v0.1.24

func ParseGetSlateIntegrationResp(rsp *http.Response) (*GetSlateIntegrationResp, error)

ParseGetSlateIntegrationResp parses an HTTP response from a GetSlateIntegrationWithResponse call

func (GetSlateIntegrationResp) ContentType added in v0.1.24

func (r GetSlateIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetSlateIntegrationResp) Status added in v0.1.24

func (r GetSlateIntegrationResp) Status() string

Status returns HTTPResponse.Status

func (GetSlateIntegrationResp) StatusCode added in v0.1.24

func (r GetSlateIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkableIntegrationResp added in v0.1.23

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

func ParseGetWorkableIntegrationResp added in v0.1.23

func ParseGetWorkableIntegrationResp(rsp *http.Response) (*GetWorkableIntegrationResp, error)

ParseGetWorkableIntegrationResp parses an HTTP response from a GetWorkableIntegrationWithResponse call

func (GetWorkableIntegrationResp) ContentType added in v0.1.24

func (r GetWorkableIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetWorkableIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (GetWorkableIntegrationResp) StatusCode added in v0.1.23

func (r GetWorkableIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkdayIntegrationResp added in v0.1.20

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

func ParseGetWorkdayIntegrationResp added in v0.1.20

func ParseGetWorkdayIntegrationResp(rsp *http.Response) (*GetWorkdayIntegrationResp, error)

ParseGetWorkdayIntegrationResp parses an HTTP response from a GetWorkdayIntegrationWithResponse call

func (GetWorkdayIntegrationResp) ContentType added in v0.1.24

func (r GetWorkdayIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetWorkdayIntegrationResp) Status added in v0.1.20

func (r GetWorkdayIntegrationResp) Status() string

Status returns HTTPResponse.Status

func (GetWorkdayIntegrationResp) StatusCode added in v0.1.20

func (r GetWorkdayIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GovtidType

type GovtidType string

GovtidType defines model for GovtidType.

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

Defines values for GovtidType.

func (GovtidType) Valid added in v0.1.22

func (e GovtidType) Valid() bool

Valid indicates whether the value is a known member of the GovtidType enum.

type GovtidValue added in v0.1.16

type GovtidValue struct {
	// Type The type of the identity document. Possible values are `passport`, `driver_license`, or `other`
	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"`

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

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

GovtidValue defines model for GovtidValue.

type GreenhouseIntegrationCreatedAuditEvent added in v0.1.22

type GreenhouseIntegrationCreatedAuditEvent struct {
	GreenhouseIntegration string `json:"greenhouse_integration"`
}

GreenhouseIntegrationCreatedAuditEvent defines model for GreenhouseIntegrationCreatedAuditEvent.

type GreenhouseIntegrationCredentialsUpdatedAuditEvent added in v0.1.22

type GreenhouseIntegrationCredentialsUpdatedAuditEvent struct {
	GreenhouseIntegration string `json:"greenhouse_integration"`
}

GreenhouseIntegrationCredentialsUpdatedAuditEvent defines model for GreenhouseIntegrationCredentialsUpdatedAuditEvent.

type GreenhouseIntegrationDeletedAuditEvent added in v0.1.22

type GreenhouseIntegrationDeletedAuditEvent struct {
	GreenhouseIntegration string `json:"greenhouse_integration"`
}

GreenhouseIntegrationDeletedAuditEvent defines model for GreenhouseIntegrationDeletedAuditEvent.

type GreenhouseIntegrationResponse added in v0.1.22

type GreenhouseIntegrationResponse struct {
	// ID The unique identifier for the Greenhouse integration
	ID string `json:"id"`

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

	// Connected Whether or not this integration is connected to Nametag.  If this is `false`, there may be issues with the auth token that Nametag has that can be solved by reconnecting this workspace.
	Connected bool `json:"connected"`

	// AutoMoveOnVerificationSuccess Whether or not to automatically move candidates in Greenhouse to a different stage upon successful verification in Nametag.
	AutoMoveOnVerificationSuccess bool `json:"auto_move_on_verification_success"`

	// LinkTemplate The URL template to configure in Greenhouse for sending candidates to Nametag for verification.
	// The `{{CANDIDATE_ID}}` and `{{APPLICATION_ID}}` tokens are Greenhouse template variables.
	LinkTemplate *string `json:"link_template,omitempty"`

	// SelectedTemplateIDs A list of template IDs selected for generating template-specific verification links.
	SelectedTemplateIDs *[]string `json:"selected_template_ids,omitempty"`
}

GreenhouseIntegrationResponse defines model for GreenhouseIntegrationResponse.

type GreenhouseIntegrationUpdateRequest added in v0.1.22

type GreenhouseIntegrationUpdateRequest struct {
	// Name The name of the Greenhouse account.
	Name *string `json:"name,omitempty"`

	// AutoMoveOnVerificationSuccess Whether or not to automatically move candidates in Greenhouse to a different stage upon successful verification in Nametag.
	AutoMoveOnVerificationSuccess *bool `json:"auto_move_on_verification_success,omitempty"`

	// SelectedTemplateIDs A list of template IDs to select for generating template-specific verification links.
	SelectedTemplateIDs *[]string `json:"selected_template_ids,omitempty"`
}

GreenhouseIntegrationUpdateRequest defines model for GreenhouseIntegrationUpdateRequest.

type GreenhouseIntegrationUpdatedAuditEvent added in v0.1.22

type GreenhouseIntegrationUpdatedAuditEvent struct {
	GreenhouseIntegration string                             `json:"greenhouse_integration"`
	Request               GreenhouseIntegrationUpdateRequest `json:"request"`
	Response              *GreenhouseIntegrationResponse     `json:"response,omitempty"`
}

GreenhouseIntegrationUpdatedAuditEvent defines model for GreenhouseIntegrationUpdatedAuditEvent.

type GreenhouseIntegrationsListResponse added in v0.1.22

type GreenhouseIntegrationsListResponse struct {
	// Integrations A list of Greenhouse integrations for this environment
	Integrations []GreenhouseIntegrationResponse `json:"integrations"`
}

GreenhouseIntegrationsListResponse defines model for GreenhouseIntegrationsListResponse.

type GroupRecoveryPolicy

type GroupRecoveryPolicy struct {
	// Group The group to which this policy applies.
	Group DirectoryGroup `json:"group"`

	// Policy The policy to apply when the account is a member of the 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 IntegrationListItem added in v0.1.22

type IntegrationListItem struct {
	// ID The unique identifier for the integration
	ID string `json:"id"`

	// Name The friendly name of the integration
	Name string `json:"name"`

	// IntegrationKind The type of integration
	IntegrationKind IntegrationListItemKind `json:"kind"`

	// Connected Whether the integration is currently connected to Nametag
	Connected *bool `json:"connected,omitempty"`

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

IntegrationListItem defines model for IntegrationListItem.

type IntegrationListItemKind added in v0.1.22

type IntegrationListItemKind string

IntegrationListItemKind The type of integration

const (
	Apereocas  IntegrationListItemKind = "apereocas"
	Ashby      IntegrationListItemKind = "ashby"
	Breezy     IntegrationListItemKind = "breezy"
	Catsone    IntegrationListItemKind = "catsone"
	Docusign   IntegrationListItemKind = "docusign"
	Dover      IntegrationListItemKind = "dover"
	Freshdesk  IntegrationListItemKind = "freshdesk"
	Greenhouse IntegrationListItemKind = "greenhouse"
	Intercom   IntegrationListItemKind = "intercom"
	Jira       IntegrationListItemKind = "jira"
	Join       IntegrationListItemKind = "join"
	Lever      IntegrationListItemKind = "lever"
	Polymer    IntegrationListItemKind = "polymer"
	Recruitee  IntegrationListItemKind = "recruitee"
	Servicenow IntegrationListItemKind = "servicenow"
	Slack      IntegrationListItemKind = "slack"
	Slate      IntegrationListItemKind = "slate"
	Stytch     IntegrationListItemKind = "stytch"
	Talentlyft IntegrationListItemKind = "talentlyft"
	Workable   IntegrationListItemKind = "workable"
	Workday    IntegrationListItemKind = "workday"
	Zoom       IntegrationListItemKind = "zoom"
)

Defines values for IntegrationListItemKind.

func (IntegrationListItemKind) Valid added in v0.1.22

func (e IntegrationListItemKind) Valid() bool

Valid indicates whether the value is a known member of the IntegrationListItemKind enum.

type IntegrationsListResponse added in v0.1.22

type IntegrationsListResponse struct {
	// Integrations A list of integrations for this environment
	Integrations []IntegrationListItem `json:"integrations"`
}

IntegrationsListResponse defines model for IntegrationsListResponse.

type IntercomIntegrationResponse added in v0.1.23

type IntercomIntegrationResponse struct {
	// ID The unique identifier for the Intercom integration
	ID string `json:"id"`

	// WorkspaceID The Intercom workspace identifier (app_id) resolved from the OAuth flow.
	WorkspaceID string `json:"workspace_id"`

	// Connected Whether or not this integration is currently connected to Intercom. If
	// this is `false`, the Intercom OAuth authorization is unhealthy and the
	// admin should reconnect.
	Connected bool `json:"connected"`

	// Enabled Whether the integration has been activated. When `false`, agents are not
	// offered the Nametag card in any conversation even if OAuth is connected.
	Enabled bool `json:"enabled"`

	// Coverage Which Intercom conversations the Nametag card is offered on.
	Coverage IntercomIntegrationResponseCoverage `json:"coverage"`

	// TeamIDs When coverage is `teams`, the Intercom team IDs the card is offered on.
	TeamIDs *[]string `json:"team_ids,omitempty"`

	// TriggerMode How verification is initiated for a covered conversation.
	TriggerMode IntercomIntegrationResponseTriggerMode `json:"trigger_mode"`

	// CreatedAt When the integration was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
}

IntercomIntegrationResponse defines model for IntercomIntegrationResponse.

type IntercomIntegrationResponseCoverage added in v0.1.23

type IntercomIntegrationResponseCoverage string

IntercomIntegrationResponseCoverage Which Intercom conversations the Nametag card is offered on.

const (
	IntercomIntegrationResponseCoverageAllInboxes IntercomIntegrationResponseCoverage = "all_inboxes"
	IntercomIntegrationResponseCoverageTeams      IntercomIntegrationResponseCoverage = "teams"
)

Defines values for IntercomIntegrationResponseCoverage.

func (IntercomIntegrationResponseCoverage) Valid added in v0.1.23

Valid indicates whether the value is a known member of the IntercomIntegrationResponseCoverage enum.

type IntercomIntegrationResponseTriggerMode added in v0.1.23

type IntercomIntegrationResponseTriggerMode string

IntercomIntegrationResponseTriggerMode How verification is initiated for a covered conversation.

const (
	IntercomIntegrationResponseTriggerModeManual IntercomIntegrationResponseTriggerMode = "manual"
)

Defines values for IntercomIntegrationResponseTriggerMode.

func (IntercomIntegrationResponseTriggerMode) Valid added in v0.1.23

Valid indicates whether the value is a known member of the IntercomIntegrationResponseTriggerMode enum.

type IntercomIntegrationUpdateRequest added in v0.1.23

type IntercomIntegrationUpdateRequest struct {
	// Coverage Which Intercom conversations the Nametag card is offered on.
	Coverage *IntercomIntegrationUpdateRequestCoverage `json:"coverage,omitempty"`

	// TeamIDs When coverage is `teams`, the Intercom team IDs to cover.
	TeamIDs *[]string `json:"team_ids,omitempty"`

	// TriggerMode How verification is initiated for a covered conversation.
	TriggerMode *IntercomIntegrationUpdateRequestTriggerMode `json:"trigger_mode,omitempty"`

	// Enabled Whether the integration is activated. Set on the Review & activate step
	// of the setup wizard.
	Enabled *bool `json:"enabled,omitempty"`
}

IntercomIntegrationUpdateRequest defines model for IntercomIntegrationUpdateRequest.

type IntercomIntegrationUpdateRequestCoverage added in v0.1.23

type IntercomIntegrationUpdateRequestCoverage string

IntercomIntegrationUpdateRequestCoverage Which Intercom conversations the Nametag card is offered on.

const (
	IntercomIntegrationUpdateRequestCoverageAllInboxes IntercomIntegrationUpdateRequestCoverage = "all_inboxes"
	IntercomIntegrationUpdateRequestCoverageTeams      IntercomIntegrationUpdateRequestCoverage = "teams"
)

Defines values for IntercomIntegrationUpdateRequestCoverage.

func (IntercomIntegrationUpdateRequestCoverage) Valid added in v0.1.23

Valid indicates whether the value is a known member of the IntercomIntegrationUpdateRequestCoverage enum.

type IntercomIntegrationUpdateRequestTriggerMode added in v0.1.23

type IntercomIntegrationUpdateRequestTriggerMode string

IntercomIntegrationUpdateRequestTriggerMode How verification is initiated for a covered conversation.

const (
	IntercomIntegrationUpdateRequestTriggerModeManual IntercomIntegrationUpdateRequestTriggerMode = "manual"
)

Defines values for IntercomIntegrationUpdateRequestTriggerMode.

func (IntercomIntegrationUpdateRequestTriggerMode) Valid added in v0.1.23

Valid indicates whether the value is a known member of the IntercomIntegrationUpdateRequestTriggerMode enum.

type InterviewConfig added in v0.1.22

type InterviewConfig struct {
	// HasSlackWebhook Whether a Slack webhook URL is configured for interview notifications.
	HasSlackWebhook bool `json:"has_slack_webhook"`
}

InterviewConfig defines model for InterviewConfig.

type InterviewConfigUpdatedAuditEvent added in v0.1.22

type InterviewConfigUpdatedAuditEvent struct {
	InterviewConfig InterviewConfig `json:"interview_config"`
}

InterviewConfigUpdatedAuditEvent defines model for InterviewConfigUpdatedAuditEvent.

type InterviewCreatedAuditEvent added in v0.1.22

type InterviewCreatedAuditEvent struct {
	// Interview The ID of the created interview.
	Interview string `json:"interview"`
}

InterviewCreatedAuditEvent defines model for InterviewCreatedAuditEvent.

type InterviewDeletedAuditEvent added in v0.1.22

type InterviewDeletedAuditEvent struct {
	// Interview The ID of the deleted interview.
	Interview string `json:"interview"`
}

InterviewDeletedAuditEvent defines model for InterviewDeletedAuditEvent.

type InterviewLinkFollowedAuditEvent added in v0.1.22

type InterviewLinkFollowedAuditEvent struct {
	// Interview The ID of the interview.
	Interview string `json:"interview"`

	// LinkType Which link was followed — "conference" or "workspace".
	LinkType InterviewLinkFollowedAuditEventLinkType `json:"link_type"`
}

InterviewLinkFollowedAuditEvent defines model for InterviewLinkFollowedAuditEvent.

type InterviewLinkFollowedAuditEventLinkType added in v0.1.22

type InterviewLinkFollowedAuditEventLinkType string

InterviewLinkFollowedAuditEventLinkType Which link was followed — "conference" or "workspace".

const (
	Conference InterviewLinkFollowedAuditEventLinkType = "conference"
	Workspace  InterviewLinkFollowedAuditEventLinkType = "workspace"
)

Defines values for InterviewLinkFollowedAuditEventLinkType.

func (InterviewLinkFollowedAuditEventLinkType) Valid added in v0.1.22

Valid indicates whether the value is a known member of the InterviewLinkFollowedAuditEventLinkType enum.

type InterviewOptedOutAuditEvent added in v0.1.22

type InterviewOptedOutAuditEvent struct {
	// Interview The ID of the interview.
	Interview string `json:"interview"`
}

InterviewOptedOutAuditEvent defines model for InterviewOptedOutAuditEvent.

type InterviewUpdatedAuditEvent added in v0.1.22

type InterviewUpdatedAuditEvent struct {
	// Interview The ID of the updated interview.
	Interview string `json:"interview"`
}

InterviewUpdatedAuditEvent defines model for InterviewUpdatedAuditEvent.

type InterviewVerificationStartedAuditEvent added in v0.1.22

type InterviewVerificationStartedAuditEvent struct {
	// Interview The ID of the interview.
	Interview string `json:"interview"`
}

InterviewVerificationStartedAuditEvent defines model for InterviewVerificationStartedAuditEvent.

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 The role to be assigned to the new member.
	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) ContentType added in v0.1.24

func (r InviteOrgMemberResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 JoinConfig added in v0.1.24

type JoinConfig struct {
	// TriggerStage The JOIN pipeline stage whose entry launches a Nametag check.
	TriggerStage *string `json:"trigger_stage,omitempty"`

	// JobScope "all" to cover every job, or "selected" for specific jobs.
	JobScope *string `json:"job_scope,omitempty"`

	// SelectedJobs JOIN job IDs covered when job_scope is "selected".
	SelectedJobs *[]string `json:"selected_jobs,omitempty"`

	// WriteBackMode How results are written back: "custom_field", "note", or "none" ("tag" is planned).
	WriteBackMode *string `json:"write_back_mode,omitempty"`
}

JoinConfig Per-tenant trigger and write-back configuration for a JOIN integration.

type JoinIntegrationResponse added in v0.1.24

type JoinIntegrationResponse struct {
	// ID The unique identifier for the JOIN integration.
	ID string `json:"id"`

	// Name The friendly name of the JOIN connection.
	Name string `json:"name"`

	// Connected Whether this integration can currently reach JOIN with its stored credential.
	Connected bool `json:"connected"`

	// Mode The connection mode: "token" (JOIN API token) or "oauth".
	Mode *string `json:"mode,omitempty"`

	// Config Per-tenant trigger and write-back configuration for a JOIN integration.
	Config *JoinConfig `json:"config,omitempty"`
}

JoinIntegrationResponse defines model for JoinIntegrationResponse.

type JoinIntegrationUpdateRequest added in v0.1.24

type JoinIntegrationUpdateRequest struct {
	// Name The friendly name of the JOIN connection.
	Name *string `json:"name,omitempty"`

	// APIToken A replacement JOIN API token. When set, the integration is reconnected.
	APIToken *string `json:"api_token,omitempty"`

	// Config Per-tenant trigger and write-back configuration for a JOIN integration.
	Config *JoinConfig `json:"config,omitempty"`
}

JoinIntegrationUpdateRequest defines model for JoinIntegrationUpdateRequest.

type JoinIntegrationsListResponse added in v0.1.24

type JoinIntegrationsListResponse struct {
	// Integrations A list of JOIN integrations for this environment.
	Integrations []JoinIntegrationResponse `json:"integrations"`
}

JoinIntegrationsListResponse defines model for JoinIntegrationsListResponse.

type LeverIntegrationResponse added in v0.1.23

type LeverIntegrationResponse struct {
	// ID The unique identifier for the Lever integration
	ID string `json:"id"`

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

	// Connected Whether or not this integration is connected to Nametag. If this is `false`, the auth token may need to be refreshed by reconnecting this workspace.
	Connected bool `json:"connected"`

	// AutoMoveOnVerificationSuccess Whether to advance the opportunity to the next Lever stage upon successful verification in Nametag.
	AutoMoveOnVerificationSuccess bool `json:"auto_move_on_verification_success"`

	// TriggerStageID The Lever stage whose entry triggers verification.
	TriggerStageID *string `json:"trigger_stage_id,omitempty"`

	// NextStageID The Lever stage to advance to on success (auto-move only).
	NextStageID *string `json:"next_stage_id,omitempty"`

	// BaseTemplateID The Lever feedback template referenced when writing a structured verification result.
	BaseTemplateID *string `json:"base_template_id,omitempty"`

	// ServiceUserEmail The email of the Lever user that verification write-back actions are performed as (perform_as).
	ServiceUserEmail *string `json:"service_user_email,omitempty"`

	// PerformAsResolved Whether the service user email resolved to a Lever user id. Write-back fails closed until this is true.
	PerformAsResolved bool `json:"perform_as_resolved"`

	// LinkTemplate The URL template for sending candidates to Nametag for verification.
	// The `{{OPPORTUNITY_ID}}` and `{{APPLICATION_ID}}` tokens are Lever template variables.
	LinkTemplate *string `json:"link_template,omitempty"`

	// SelectedTemplateIDs A list of template IDs selected for generating template-specific verification links.
	SelectedTemplateIDs *[]string `json:"selected_template_ids,omitempty"`
}

LeverIntegrationResponse defines model for LeverIntegrationResponse.

type LeverIntegrationUpdateRequest added in v0.1.23

type LeverIntegrationUpdateRequest struct {
	// Name The name of the Lever account.
	Name *string `json:"name,omitempty"`

	// AutoMoveOnVerificationSuccess Whether to advance the opportunity to the next Lever stage upon successful verification in Nametag.
	AutoMoveOnVerificationSuccess *bool `json:"auto_move_on_verification_success,omitempty"`

	// TriggerStageID The Lever stage whose entry triggers verification.
	TriggerStageID *string `json:"trigger_stage_id,omitempty"`

	// NextStageID The Lever stage to advance to on success (auto-move only).
	NextStageID *string `json:"next_stage_id,omitempty"`

	// BaseTemplateID The Lever feedback template referenced when writing results.
	BaseTemplateID *string `json:"base_template_id,omitempty"`

	// ServiceUserEmail The email of the Lever user write-back is performed as.
	ServiceUserEmail *string `json:"service_user_email,omitempty"`

	// SelectedTemplateIDs A list of template IDs to select for generating template-specific verification links.
	SelectedTemplateIDs *[]string `json:"selected_template_ids,omitempty"`
}

LeverIntegrationUpdateRequest defines model for LeverIntegrationUpdateRequest.

type LeverIntegrationsListResponse added in v0.1.23

type LeverIntegrationsListResponse struct {
	// Integrations A list of Lever integrations for this environment
	Integrations []LeverIntegrationResponse `json:"integrations"`
}

LeverIntegrationsListResponse defines model for LeverIntegrationsListResponse.

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) ContentType added in v0.1.24

func (r ListAPIKeysResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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"`
}

ListAccountsParams defines parameters for ListAccounts.

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) ContentType added in v0.1.24

func (r ListAccountsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 ListAshbyIntegrationsResp added in v0.1.23

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

func ParseListAshbyIntegrationsResp added in v0.1.23

func ParseListAshbyIntegrationsResp(rsp *http.Response) (*ListAshbyIntegrationsResp, error)

ParseListAshbyIntegrationsResp parses an HTTP response from a ListAshbyIntegrationsWithResponse call

func (ListAshbyIntegrationsResp) ContentType added in v0.1.24

func (r ListAshbyIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListAshbyIntegrationsResp) Status added in v0.1.23

func (r ListAshbyIntegrationsResp) Status() string

Status returns HTTPResponse.Status

func (ListAshbyIntegrationsResp) StatusCode added in v0.1.23

func (r ListAshbyIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAshbyStagesResp added in v0.1.23

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

func ParseListAshbyStagesResp added in v0.1.23

func ParseListAshbyStagesResp(rsp *http.Response) (*ListAshbyStagesResp, error)

ParseListAshbyStagesResp parses an HTTP response from a ListAshbyStagesWithResponse call

func (ListAshbyStagesResp) ContentType added in v0.1.24

func (r ListAshbyStagesResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListAshbyStagesResp) Status added in v0.1.23

func (r ListAshbyStagesResp) Status() string

Status returns HTTPResponse.Status

func (ListAshbyStagesResp) StatusCode added in v0.1.23

func (r ListAshbyStagesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAuditEventsParams added in v0.1.15

type ListAuditEventsParams struct {
	// Start Show records created at or after this time
	Start *time.Time `form:"start,omitempty" json:"start,omitempty"`

	// End Show records created before this time
	End *time.Time `form:"end,omitempty" json:"end,omitempty"`

	// Reverse If false (the default), logs are emitted newest to oldest. If this parameter is true, logs are emitted  oldest to newest.
	Reverse *bool `form:"reverse,omitempty" json:"reverse,omitempty"`

	// Count The number of items to return. Note that the API may return fewer items than specified (even zero) and there  still may be more records available if the forward_cursor or backward_cursor response fields are set.
	Count *int `form:"count,omitempty" json:"count,omitempty"`

	// Env Limit audit events to those relating to the specified environment (or environments)
	Env *[]string `form:"env,omitempty" json:"env,omitempty"`

	// Kind Limit audit events to those matching the specified kind.
	Kind *[]AuditEventKind `form:"kind,omitempty" json:"kind,omitempty"`

	// Query Show only results containing the specified query string.
	Query *string `form:"query,omitempty" json:"query,omitempty"`

	// Cursor Continue a paginated query that previously returned a  cursor.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListAuditEventsParams defines parameters for ListAuditEvents.

type ListAuditEventsResp added in v0.1.15

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

func ParseListAuditEventsResp added in v0.1.15

func ParseListAuditEventsResp(rsp *http.Response) (*ListAuditEventsResp, error)

ParseListAuditEventsResp parses an HTTP response from a ListAuditEventsWithResponse call

func (ListAuditEventsResp) ContentType added in v0.1.24

func (r ListAuditEventsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListAuditEventsResp) Status added in v0.1.15

func (r ListAuditEventsResp) Status() string

Status returns HTTPResponse.Status

func (ListAuditEventsResp) StatusCode added in v0.1.15

func (r ListAuditEventsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAuditEventsResponse added in v0.1.15

type ListAuditEventsResponse struct {
	// Events A list of audit events
	Events         []AuditEvent `json:"events"`
	BackwardCursor *string      `json:"backward_cursor,omitempty"`
	ForwardCursor  *string      `json:"forward_cursor,omitempty"`
}

ListAuditEventsResponse defines model for ListAuditEventsResponse.

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) ContentType added in v0.1.24

func (r ListDirectoriesResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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       *int                       `form:"offset,omitempty" json:"offset,omitempty"`
	Sort         *ListEnvRequestsParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
	StatusFilter *EnvStatusFilterParams     `form:"statusFilter,omitempty" json:"statusFilter,omitempty"`
	UpdatedAt    *EnvUpdatedAtFilterParams  `form:"updatedAt,omitempty" json:"updatedAt,omitempty"`
}

ListEnvRequestsParams defines parameters for ListEnvRequests.

type ListEnvRequestsParamsSort

type ListEnvRequestsParamsSort string

ListEnvRequestsParamsSort defines parameters for ListEnvRequests.

const (
	LastCreated      ListEnvRequestsParamsSort = "last_created"
	LastUpdated      ListEnvRequestsParamsSort = "last_updated"
	MinusLastCreated ListEnvRequestsParamsSort = "-last_created"
	MinusLastUpdated ListEnvRequestsParamsSort = "-last_updated"
)

Defines values for ListEnvRequestsParamsSort.

func (ListEnvRequestsParamsSort) Valid added in v0.1.22

func (e ListEnvRequestsParamsSort) Valid() bool

Valid indicates whether the value is a known member of the ListEnvRequestsParamsSort enum.

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) ContentType added in v0.1.24

func (r ListEnvRequestsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r ListEnvsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 ListGreenhouseIntegrationsResp added in v0.1.22

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

func ParseListGreenhouseIntegrationsResp added in v0.1.22

func ParseListGreenhouseIntegrationsResp(rsp *http.Response) (*ListGreenhouseIntegrationsResp, error)

ParseListGreenhouseIntegrationsResp parses an HTTP response from a ListGreenhouseIntegrationsWithResponse call

func (ListGreenhouseIntegrationsResp) ContentType added in v0.1.24

func (r ListGreenhouseIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListGreenhouseIntegrationsResp) Status added in v0.1.22

Status returns HTTPResponse.Status

func (ListGreenhouseIntegrationsResp) StatusCode added in v0.1.22

func (r ListGreenhouseIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListIntegrationsResp added in v0.1.22

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

func ParseListIntegrationsResp added in v0.1.22

func ParseListIntegrationsResp(rsp *http.Response) (*ListIntegrationsResp, error)

ParseListIntegrationsResp parses an HTTP response from a ListIntegrationsWithResponse call

func (ListIntegrationsResp) ContentType added in v0.1.24

func (r ListIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListIntegrationsResp) Status added in v0.1.22

func (r ListIntegrationsResp) Status() string

Status returns HTTPResponse.Status

func (ListIntegrationsResp) StatusCode added in v0.1.22

func (r ListIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListJoinIntegrationsResp added in v0.1.24

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

func ParseListJoinIntegrationsResp added in v0.1.24

func ParseListJoinIntegrationsResp(rsp *http.Response) (*ListJoinIntegrationsResp, error)

ParseListJoinIntegrationsResp parses an HTTP response from a ListJoinIntegrationsWithResponse call

func (ListJoinIntegrationsResp) ContentType added in v0.1.24

func (r ListJoinIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListJoinIntegrationsResp) Status added in v0.1.24

func (r ListJoinIntegrationsResp) Status() string

Status returns HTTPResponse.Status

func (ListJoinIntegrationsResp) StatusCode added in v0.1.24

func (r ListJoinIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListLeverIntegrationsResp added in v0.1.23

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

func ParseListLeverIntegrationsResp added in v0.1.23

func ParseListLeverIntegrationsResp(rsp *http.Response) (*ListLeverIntegrationsResp, error)

ParseListLeverIntegrationsResp parses an HTTP response from a ListLeverIntegrationsWithResponse call

func (ListLeverIntegrationsResp) ContentType added in v0.1.24

func (r ListLeverIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListLeverIntegrationsResp) Status added in v0.1.23

func (r ListLeverIntegrationsResp) Status() string

Status returns HTTPResponse.Status

func (ListLeverIntegrationsResp) StatusCode added in v0.1.23

func (r ListLeverIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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) ContentType added in v0.1.24

func (r ListOrgMembersResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 ListRecruiteeIntegrationsResp added in v0.1.23

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

func ParseListRecruiteeIntegrationsResp added in v0.1.23

func ParseListRecruiteeIntegrationsResp(rsp *http.Response) (*ListRecruiteeIntegrationsResp, error)

ParseListRecruiteeIntegrationsResp parses an HTTP response from a ListRecruiteeIntegrationsWithResponse call

func (ListRecruiteeIntegrationsResp) ContentType added in v0.1.24

func (r ListRecruiteeIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListRecruiteeIntegrationsResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (ListRecruiteeIntegrationsResp) StatusCode added in v0.1.23

func (r ListRecruiteeIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSharedDevicesResp added in v0.1.22

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

func ParseListSharedDevicesResp added in v0.1.22

func ParseListSharedDevicesResp(rsp *http.Response) (*ListSharedDevicesResp, error)

ParseListSharedDevicesResp parses an HTTP response from a ListSharedDevicesWithResponse call

func (ListSharedDevicesResp) ContentType added in v0.1.24

func (r ListSharedDevicesResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSharedDevicesResp) Status added in v0.1.22

func (r ListSharedDevicesResp) Status() string

Status returns HTTPResponse.Status

func (ListSharedDevicesResp) StatusCode added in v0.1.22

func (r ListSharedDevicesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSharedDevicesResponse added in v0.1.22

type ListSharedDevicesResponse struct {
	// SharedDevices A list of each shared device for this env.
	SharedDevices []SharedDevice `json:"shared_devices"`
}

ListSharedDevicesResponse defines model for ListSharedDevicesResponse.

type ListSlackIntegrationsResp added in v0.1.17

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

func ParseListSlackIntegrationsResp added in v0.1.17

func ParseListSlackIntegrationsResp(rsp *http.Response) (*ListSlackIntegrationsResp, error)

ParseListSlackIntegrationsResp parses an HTTP response from a ListSlackIntegrationsWithResponse call

func (ListSlackIntegrationsResp) ContentType added in v0.1.24

func (r ListSlackIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSlackIntegrationsResp) Status added in v0.1.17

func (r ListSlackIntegrationsResp) Status() string

Status returns HTTPResponse.Status

func (ListSlackIntegrationsResp) StatusCode added in v0.1.17

func (r ListSlackIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSlackIntegrationsResponse added in v0.1.17

type ListSlackIntegrationsResponse struct {
	// Integrations A list of Slack integrations for this environment
	Integrations []SlackIntegration `json:"integrations"`
}

ListSlackIntegrationsResponse defines model for ListSlackIntegrationsResponse.

type ListSlateIntegrationsResp added in v0.1.24

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

func ParseListSlateIntegrationsResp added in v0.1.24

func ParseListSlateIntegrationsResp(rsp *http.Response) (*ListSlateIntegrationsResp, error)

ParseListSlateIntegrationsResp parses an HTTP response from a ListSlateIntegrationsWithResponse call

func (ListSlateIntegrationsResp) ContentType added in v0.1.24

func (r ListSlateIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSlateIntegrationsResp) Status added in v0.1.24

func (r ListSlateIntegrationsResp) Status() string

Status returns HTTPResponse.Status

func (ListSlateIntegrationsResp) StatusCode added in v0.1.24

func (r ListSlateIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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) ContentType added in v0.1.24

func (r ListWebhooksResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 ListWorkableIntegrationsResp added in v0.1.23

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

func ParseListWorkableIntegrationsResp added in v0.1.23

func ParseListWorkableIntegrationsResp(rsp *http.Response) (*ListWorkableIntegrationsResp, error)

ParseListWorkableIntegrationsResp parses an HTTP response from a ListWorkableIntegrationsWithResponse call

func (ListWorkableIntegrationsResp) ContentType added in v0.1.24

func (r ListWorkableIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListWorkableIntegrationsResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (ListWorkableIntegrationsResp) StatusCode added in v0.1.23

func (r ListWorkableIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListWorkableJobsResp added in v0.1.23

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

func ParseListWorkableJobsResp added in v0.1.23

func ParseListWorkableJobsResp(rsp *http.Response) (*ListWorkableJobsResp, error)

ParseListWorkableJobsResp parses an HTTP response from a ListWorkableJobsWithResponse call

func (ListWorkableJobsResp) ContentType added in v0.1.24

func (r ListWorkableJobsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListWorkableJobsResp) Status added in v0.1.23

func (r ListWorkableJobsResp) Status() string

Status returns HTTPResponse.Status

func (ListWorkableJobsResp) StatusCode added in v0.1.23

func (r ListWorkableJobsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListWorkdayIntegrationsResp added in v0.1.20

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

func ParseListWorkdayIntegrationsResp added in v0.1.20

func ParseListWorkdayIntegrationsResp(rsp *http.Response) (*ListWorkdayIntegrationsResp, error)

ParseListWorkdayIntegrationsResp parses an HTTP response from a ListWorkdayIntegrationsWithResponse call

func (ListWorkdayIntegrationsResp) ContentType added in v0.1.24

func (r ListWorkdayIntegrationsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListWorkdayIntegrationsResp) Status added in v0.1.20

Status returns HTTPResponse.Status

func (ListWorkdayIntegrationsResp) StatusCode added in v0.1.20

func (r ListWorkdayIntegrationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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.

func (LogoKind) Valid added in v0.1.22

func (e LogoKind) Valid() bool

Valid indicates whether the value is a known member of the LogoKind enum.

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.

func (NumericRequestStatus) Valid added in v0.1.22

func (e NumericRequestStatus) Valid() bool

Valid indicates whether the value is a known member of the NumericRequestStatus enum.

type OAuth2AuthorizeAuditEvent added in v0.1.15

type OAuth2AuthorizeAuditEvent struct {
	Request  AuthorizeRequest  `json:"request"`
	Response AuthorizeResponse `json:"response"`
}

OAuth2AuthorizeAuditEvent defines model for OAuth2AuthorizeAuditEvent.

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 OAuth2PushedAuthorizationRequestAuditEvent added in v0.1.16

type OAuth2PushedAuthorizationRequestAuditEvent struct {
	Request  PushedAuthorizationRequest  `json:"request"`
	Response PushedAuthorizationResponse `json:"response"`
}

OAuth2PushedAuthorizationRequestAuditEvent defines model for OAuth2PushedAuthorizationRequestAuditEvent.

type OAuth2RequestCanceledAuditEvent added in v0.1.15

type OAuth2RequestCanceledAuditEvent struct {
	Request string `json:"request"`
}

OAuth2RequestCanceledAuditEvent defines model for OAuth2RequestCanceledAuditEvent.

type OAuth2TokenAuditEvent added in v0.1.15

type OAuth2TokenAuditEvent struct {
	Request  TokenRequest  `json:"request"`
	Response TokenResponse `json:"response"`
}

OAuth2TokenAuditEvent defines model for OAuth2TokenAuditEvent.

type OAuth2V2AuthorizeAuditEvent added in v0.1.16

type OAuth2V2AuthorizeAuditEvent struct {
	Request  AuthorizeV2Request `json:"request"`
	Response AuthorizeResponse  `json:"response"`
}

OAuth2V2AuthorizeAuditEvent defines model for OAuth2V2AuthorizeAuditEvent.

type OIDCDelegate added in v0.1.18

type OIDCDelegate struct {
	// ID A unique identifier for the OIDC delegate.
	ID string `json:"id"`

	// Name The name of the delegate
	Name string `json:"name"`

	// ClientID The client ID for the OAuth delegate.
	ClientID *string `json:"client_id,omitempty"`

	// ClientSecret The client secret for the OAuth delegate.
	ClientSecret *string `json:"client_secret,omitempty"`

	// Issuer The URL of the issuer for the OIDC delegate.
	Issuer string `json:"issuer"`
}

OIDCDelegate defines model for OIDCDelegate.

type OIDCDelegateUpdate added in v0.1.18

type OIDCDelegateUpdate struct {
	ID           string  `json:"id"`
	Name         *string `json:"name,omitempty"`
	ClientID     *string `json:"client_id,omitempty"`
	ClientSecret *string `json:"client_secret,omitempty"`
	Issuer       *string `json:"issuer,omitempty"`
}

OIDCDelegateUpdate defines model for OIDCDelegateUpdate.

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"`

	// ThemeColor The QR code color
	ThemeColor *string `form:"theme_color,omitempty" json:"theme_color,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.

func (Oauth2AuthorizeIframeParamsCodeChallengeMethod) Valid added in v0.1.22

Valid indicates whether the value is a known member of the Oauth2AuthorizeIframeParamsCodeChallengeMethod enum.

type Oauth2AuthorizeIframeParamsResponseMode

type Oauth2AuthorizeIframeParamsResponseMode string

Oauth2AuthorizeIframeParamsResponseMode defines parameters for Oauth2AuthorizeIframe.

const (
	Oauth2AuthorizeIframeParamsResponseModeFragment Oauth2AuthorizeIframeParamsResponseMode = "fragment"
)

Defines values for Oauth2AuthorizeIframeParamsResponseMode.

func (Oauth2AuthorizeIframeParamsResponseMode) Valid added in v0.1.22

Valid indicates whether the value is a known member of the Oauth2AuthorizeIframeParamsResponseMode enum.

type Oauth2AuthorizeIframeParamsResponseType

type Oauth2AuthorizeIframeParamsResponseType string

Oauth2AuthorizeIframeParamsResponseType defines parameters for Oauth2AuthorizeIframe.

const (
	Oauth2AuthorizeIframeParamsResponseTypeCode Oauth2AuthorizeIframeParamsResponseType = "code"
)

Defines values for Oauth2AuthorizeIframeParamsResponseType.

func (Oauth2AuthorizeIframeParamsResponseType) Valid added in v0.1.22

Valid indicates whether the value is a known member of the Oauth2AuthorizeIframeParamsResponseType enum.

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) ContentType added in v0.1.24

func (r Oauth2AuthorizeIframeResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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.

func (Oauth2AuthorizeParamsCodeChallengeMethod) Valid added in v0.1.22

Valid indicates whether the value is a known member of the Oauth2AuthorizeParamsCodeChallengeMethod enum.

type Oauth2AuthorizeParamsResponseMode

type Oauth2AuthorizeParamsResponseMode string

Oauth2AuthorizeParamsResponseMode defines parameters for Oauth2Authorize.

const (
	Oauth2AuthorizeParamsResponseModeFragment Oauth2AuthorizeParamsResponseMode = "fragment"
)

Defines values for Oauth2AuthorizeParamsResponseMode.

func (Oauth2AuthorizeParamsResponseMode) Valid added in v0.1.22

Valid indicates whether the value is a known member of the Oauth2AuthorizeParamsResponseMode enum.

type Oauth2AuthorizeParamsResponseType

type Oauth2AuthorizeParamsResponseType string

Oauth2AuthorizeParamsResponseType defines parameters for Oauth2Authorize.

const (
	Oauth2AuthorizeParamsResponseTypeCode Oauth2AuthorizeParamsResponseType = "code"
)

Defines values for Oauth2AuthorizeParamsResponseType.

func (Oauth2AuthorizeParamsResponseType) Valid added in v0.1.22

Valid indicates whether the value is a known member of the Oauth2AuthorizeParamsResponseType enum.

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) ContentType added in v0.1.24

func (r Oauth2AuthorizeResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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.

func (Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod) Valid added in v0.1.22

Valid indicates whether the value is a known member of the Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod enum.

type Oauth2AuthorizeWithExperienceParamsResponseMode

type Oauth2AuthorizeWithExperienceParamsResponseMode string

Oauth2AuthorizeWithExperienceParamsResponseMode defines parameters for Oauth2AuthorizeWithExperience.

const (
	Fragment Oauth2AuthorizeWithExperienceParamsResponseMode = "fragment"
)

Defines values for Oauth2AuthorizeWithExperienceParamsResponseMode.

func (Oauth2AuthorizeWithExperienceParamsResponseMode) Valid added in v0.1.22

Valid indicates whether the value is a known member of the Oauth2AuthorizeWithExperienceParamsResponseMode enum.

type Oauth2AuthorizeWithExperienceParamsResponseType

type Oauth2AuthorizeWithExperienceParamsResponseType string

Oauth2AuthorizeWithExperienceParamsResponseType defines parameters for Oauth2AuthorizeWithExperience.

Defines values for Oauth2AuthorizeWithExperienceParamsResponseType.

func (Oauth2AuthorizeWithExperienceParamsResponseType) Valid added in v0.1.22

Valid indicates whether the value is a known member of the Oauth2AuthorizeWithExperienceParamsResponseType enum.

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) ContentType added in v0.1.24

func (r Oauth2AuthorizeWithExperienceResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r Oauth2AuthorizeWithRequestResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r Oauth2CancelResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r Oauth2LogoutResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r Oauth2PollResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r Oauth2TokenResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 OktaEamAuthorizeAuditEvent added in v0.1.15

type OktaEamAuthorizeAuditEvent struct {
	Directory string                   `json:"directory"`
	Request   OktaEamAuthorizeRequest  `json:"request"`
	Response  OktaEamAuthorizeResponse `json:"response"`
}

OktaEamAuthorizeAuditEvent defines model for OktaEamAuthorizeAuditEvent.

type OktaEamAuthorizeRequest added in v0.1.15

type OktaEamAuthorizeRequest struct {
	Claims       string `json:"claims"`
	ClientId     string `json:"client_id"`
	LoginHint    string `json:"login_hint"`
	RedirectUri  string `json:"redirect_uri"`
	ResponseType string `json:"response_type"`
	Scope        string `json:"scope"`
	State        string `json:"state"`
}

OktaEamAuthorizeRequest defines model for OktaEamAuthorizeRequest.

type OktaEamAuthorizeResponse added in v0.1.15

type OktaEamAuthorizeResponse struct {
	Oauth2ClientId    string `json:"oauth2_client_id"`
	Oauth2RedirectUri string `json:"oauth2_redirect_uri"`
	Oauth2Server      string `json:"oauth2_server"`
	Oauth2Template    string `json:"oauth2_template"`
	State             string `json:"state"`
}

OktaEamAuthorizeResponse defines model for OktaEamAuthorizeResponse.

type OktaEamFinishAuditEvent added in v0.1.15

type OktaEamFinishAuditEvent struct {
	Directory string                `json:"directory"`
	Request   OktaEamFinishRequest  `json:"request"`
	Response  OktaEamFinishResponse `json:"response"`
}

OktaEamFinishAuditEvent defines model for OktaEamFinishAuditEvent.

type OktaEamFinishRequest added in v0.1.15

type OktaEamFinishRequest struct {
	Code  *string `json:"code,omitempty"`
	Error *string `json:"error,omitempty"`
	State string  `json:"state"`
}

OktaEamFinishRequest defines model for OktaEamFinishRequest.

type OktaEamFinishResponse added in v0.1.15

type OktaEamFinishResponse struct {
	BindingFailed  *bool   `json:"binding_failed,omitempty"`
	Code           *string `json:"code,omitempty"`
	Error          *string `json:"error,omitempty"`
	IDToken        *string `json:"id_token,omitempty"`
	Oauth2State    *string `json:"oauth2_state,omitempty"`
	RedirectUri    *string `json:"redirect_uri,omitempty"`
	RequestTimeout *bool   `json:"request_timeout,omitempty"`
}

OktaEamFinishResponse defines model for OktaEamFinishResponse.

type Org

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

	// Role Your role in the organization.
	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 The person's role in the organization. One of `limited`, `limited_plus`, `user`, `admin`, or `owner`.
	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"`

	// RequestsCount The number of requests the member has sent.
	RequestsCount *int `json:"requests_count,omitempty"`

	// Principal The principal of this org member
	Principal string `json:"principal"`
}

OrgMember defines model for OrgMember.

type OrgMemberInvitedAuditEvent added in v0.1.15

type OrgMemberInvitedAuditEvent struct {
	Request InviteOrgMemberRequest `json:"request"`
}

OrgMemberInvitedAuditEvent defines model for OrgMemberInvitedAuditEvent.

type OrgMemberRemovedAuditEvent added in v0.1.18

type OrgMemberRemovedAuditEvent struct {
	OrgMember string `json:"org_member"`
}

OrgMemberRemovedAuditEvent defines model for OrgMemberRemovedAuditEvent.

type OrgMemberUpdatedAuditEvent added in v0.1.15

type OrgMemberUpdatedAuditEvent struct {
	OrgMember string                 `json:"org_member"`
	Request   UpdateOrgMemberRequest `json:"request"`
}

OrgMemberUpdatedAuditEvent defines model for OrgMemberUpdatedAuditEvent.

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 OrgUpdatedAuditEvent added in v0.1.15

type OrgUpdatedAuditEvent struct {
	Request OrgUpdateRequest `json:"request"`
}

OrgUpdatedAuditEvent defines model for OrgUpdatedAuditEvent.

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 PeopleCompareAuditEvent added in v0.1.15

type PeopleCompareAuditEvent struct {
	Request  SubjectComparisonRequest `json:"request"`
	Response ComparisonResult         `json:"response"`
}

PeopleCompareAuditEvent defines model for PeopleCompareAuditEvent.

type PeopleSetPictureAuditEvent added in v0.1.19

type PeopleSetPictureAuditEvent struct {
	// Error An error that occurred when setting a person's profile picture.
	Error *SetPictureError `json:"error,omitempty"`

	// ImageHash The SHA256 hash of the image that was uploaded
	ImageHash *string `json:"image_hash,omitempty"`

	// ImageSize The size of the image that was uploaded, in bytes
	ImageSize *int   `json:"image_size,omitempty"`
	Subject   string `json:"subject"`
}

PeopleSetPictureAuditEvent defines model for PeopleSetPictureAuditEvent.

type PeopleSetPreferredNameAuditEvent added in v0.1.19

type PeopleSetPreferredNameAuditEvent struct {
	Request SetPreferredNameRequest `json:"request"`
	Subject string                  `json:"subject"`
}

PeopleSetPreferredNameAuditEvent defines model for PeopleSetPreferredNameAuditEvent.

type PollResponse

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

PollResponse defines model for PollResponse.

type PresignRecoveryMicrositeURLJSONRequestBody added in v0.1.12

type PresignRecoveryMicrositeURLJSONRequestBody = RecoveryMicrositePresignRequest

PresignRecoveryMicrositeURLJSONRequestBody defines body for PresignRecoveryMicrositeURL for application/json ContentType.

type PresignRecoveryMicrositeURLResp added in v0.1.12

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

func ParsePresignRecoveryMicrositeURLResp added in v0.1.12

func ParsePresignRecoveryMicrositeURLResp(rsp *http.Response) (*PresignRecoveryMicrositeURLResp, error)

ParsePresignRecoveryMicrositeURLResp parses an HTTP response from a PresignRecoveryMicrositeURLWithResponse call

func (PresignRecoveryMicrositeURLResp) ContentType added in v0.1.24

func (r PresignRecoveryMicrositeURLResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PresignRecoveryMicrositeURLResp) Status added in v0.1.12

Status returns HTTPResponse.Status

func (PresignRecoveryMicrositeURLResp) StatusCode added in v0.1.12

func (r PresignRecoveryMicrositeURLResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Principal added in v0.1.15

type Principal struct {
	// Role The role associated with the OrgMember or API key
	Role Role `json:"role"`

	// OrgMember The ID of the OrgMember for the console user performing the action
	OrgMember *string `json:"org_member,omitempty"`

	// OrgMemberEmail The email address associated with the OrgMember
	OrgMemberEmail *string `json:"org_member_email,omitempty"`

	// APIKeyID The ID of the APIKey for the actor performing the action.
	APIKeyID *string `json:"api_key,omitempty"`

	// Impersonator Present if the request was made by a Nametag administrator on behalf of the  user. The value is the email address of the Nametag administrator performing  the action.
	Impersonator *string `json:"impersonator,omitempty"`

	// Subject If the request was authenticated using an ID token, then this is the subject of the ID token.
	Subject *string `json:"subject,omitempty"`
}

Principal defines model for Principal.

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 The [Scope](#scopes) you requested.
	Scope *Scope `json:"scope,omitempty"`

	// Claim The [Claim](#claims) you requested.
	Claim Claim `json:"claim"`

	// Value The value of the property. The type of this field varies depending on the claim. 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,omitempty"`

	// Claims The claims requested
	Claims []Claim `json:"claims"`
}

PropertyResponseRequest defines model for PropertyResponseRequest.

type PushedAuthorizationRequest added in v0.1.16

type PushedAuthorizationRequest struct {
	// Claim Space-separated list of claims
	Claim *[]Claim `json:"claim,omitempty"`

	// ClientId The client ID
	ClientId string `json:"client_id"`

	// ClientSecret The client secret
	ClientSecret string `json:"client_secret"`

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

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

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

	// ExpirySeconds The expiration time in seconds for the PAR
	ExpirySeconds *int `json:"expiry_seconds,omitempty"`

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

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

	// ResponseType The response type
	ResponseType *PushedAuthorizationRequestResponseType `json:"response_type,omitempty"`
	Return       *AuthorizeReturn                        `json:"return,omitempty"`

	// Scope Space-separated list of scopes
	Scope *[]Scope `json:"scope,omitempty"`

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

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

PushedAuthorizationRequest defines model for PushedAuthorizationRequest.

type PushedAuthorizationRequestCodeChallengeMethod added in v0.1.16

type PushedAuthorizationRequestCodeChallengeMethod string

PushedAuthorizationRequestCodeChallengeMethod The code challenge method

const (
	PushedAuthorizationRequestCodeChallengeMethodPlain PushedAuthorizationRequestCodeChallengeMethod = "plain"
	PushedAuthorizationRequestCodeChallengeMethodS256  PushedAuthorizationRequestCodeChallengeMethod = "S256"
)

Defines values for PushedAuthorizationRequestCodeChallengeMethod.

func (PushedAuthorizationRequestCodeChallengeMethod) Valid added in v0.1.22

Valid indicates whether the value is a known member of the PushedAuthorizationRequestCodeChallengeMethod enum.

type PushedAuthorizationRequestResponseMode added in v0.1.16

type PushedAuthorizationRequestResponseMode string

PushedAuthorizationRequestResponseMode The response mode

const (
	PushedAuthorizationRequestResponseModeFragment PushedAuthorizationRequestResponseMode = "fragment"
)

Defines values for PushedAuthorizationRequestResponseMode.

func (PushedAuthorizationRequestResponseMode) Valid added in v0.1.22

Valid indicates whether the value is a known member of the PushedAuthorizationRequestResponseMode enum.

type PushedAuthorizationRequestResponseType added in v0.1.16

type PushedAuthorizationRequestResponseType string

PushedAuthorizationRequestResponseType The response type

const (
	PushedAuthorizationRequestResponseTypeCode PushedAuthorizationRequestResponseType = "code"
)

Defines values for PushedAuthorizationRequestResponseType.

func (PushedAuthorizationRequestResponseType) Valid added in v0.1.22

Valid indicates whether the value is a known member of the PushedAuthorizationRequestResponseType enum.

type PushedAuthorizationResponse added in v0.1.16

type PushedAuthorizationResponse struct {
	RequestURI string `json:"request_uri"`
	ExpiresIn  int    `json:"expires_in"`
}

PushedAuthorizationResponse defines model for PushedAuthorizationResponse.

type RecoveryMicrositeFlow added in v0.1.12

type RecoveryMicrositeFlow string

RecoveryMicrositeFlow defines model for RecoveryMicrositeFlow.

const (
	MicrositeFlowBadge           RecoveryMicrositeFlow = "badge"
	RecoveryMicrositeFlowEnroll  RecoveryMicrositeFlow = "enroll"
	RecoveryMicrositeFlowRecover RecoveryMicrositeFlow = "recover"
)

Defines values for RecoveryMicrositeFlow.

func (RecoveryMicrositeFlow) Valid added in v0.1.22

func (e RecoveryMicrositeFlow) Valid() bool

Valid indicates whether the value is a known member of the RecoveryMicrositeFlow enum.

type RecoveryMicrositeOperation added in v0.1.12

type RecoveryMicrositeOperation string

RecoveryMicrositeOperation defines model for RecoveryMicrositeOperation.

const (
	Mfa                 RecoveryMicrositeOperation = "mfa"
	Password            RecoveryMicrositeOperation = "password"
	TemporaryAccessPass RecoveryMicrositeOperation = "temporary-access-pass"
	Unlock              RecoveryMicrositeOperation = "unlock"
)

Defines values for RecoveryMicrositeOperation.

func (RecoveryMicrositeOperation) Valid added in v0.1.22

func (e RecoveryMicrositeOperation) Valid() bool

Valid indicates whether the value is a known member of the RecoveryMicrositeOperation enum.

type RecoveryMicrositePresignRequest added in v0.1.12

type RecoveryMicrositePresignRequest struct {
	// Email The email address or identifier of the account. Use `*` to allow the presigned URL
	// to apply to any account.
	Email *string `json:"email,omitempty"`

	// Ttl The duration for which the presigned URL is valid. The duration is specified as a string
	// in the format `1h30m` for 1 hour and 30 minutes, or `1m20s` for 1 minute and 20 seconds.
	Ttl jsonx.Duration `json:"ttl"`

	// Operations The operations that the presigned URL should allow.
	Operations *[]RecoveryMicrositeOperation `json:"operations,omitempty"`

	// Directories The identifiers of the directories that the presigned URL should apply to.
	Directories *[]string `json:"directories,omitempty"`

	// Flow The flow that the presigned URL should apply to. This doesn't generally affect
	// functionality, but changes some text during the process to be more appropriate for
	// either onboarding or account recovery flows.
	Flow *RecoveryMicrositeFlow `json:"flow,omitempty"`

	// RecoveryPolicy A map of operation names to recovery policies to embed in the presigned URL.
	RecoveryPolicy *map[string]RecoveryPolicy `json:"recovery_policy,omitempty"`
}

RecoveryMicrositePresignRequest defines model for RecoveryMicrositePresignRequest.

type RecoveryMicrositePresignResponse added in v0.1.12

type RecoveryMicrositePresignResponse struct {
	Url string `json:"url"`
}

RecoveryMicrositePresignResponse defines model for RecoveryMicrositePresignResponse.

type RecoveryOperationRateLimit added in v0.1.18

type RecoveryOperationRateLimit struct {
	// Count The number of operations allowed in the window.
	Count int `json:"count"`

	// Window The duration of the window. The duration is specified as a string
	// in the format `1h30m` for 1 hour and 30 minutes, or `1m20s` for 1 minute and 20 seconds.
	Window jsonx.Duration `json:"window"`
}

RecoveryOperationRateLimit defines model for RecoveryOperationRateLimit.

type RecoveryPolicy

type RecoveryPolicy string

RecoveryPolicy defines model for RecoveryPolicy.

const (
	RecoveryPolicyDisabled         RecoveryPolicy = "disabled"
	RecoveryPolicyNameAndBirthDate RecoveryPolicy = "name_and_birth_date"
	RecoveryPolicyNameMatch        RecoveryPolicy = "name_match"
	RecoveryPolicyNone             RecoveryPolicy = "none"
	RecoveryPolicyPhoto            RecoveryPolicy = "photo"
	RecoveryPolicyWeakNameMatch    RecoveryPolicy = "weak_name_match"
)

Defines values for RecoveryPolicy.

func (RecoveryPolicy) Valid added in v0.1.22

func (e RecoveryPolicy) Valid() bool

Valid indicates whether the value is a known member of the RecoveryPolicy enum.

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 The default policy when the account is not a member of any  of the groups in the `groups` field.
	Default RecoveryPolicy `json:"default"`
}

RecoveryPolicyRules defines model for RecoveryPolicyRules.

type RecruiteeIntegrationCreatedAuditEvent added in v0.1.23

type RecruiteeIntegrationCreatedAuditEvent struct {
	RecruiteeIntegration string `json:"recruitee_integration"`
}

RecruiteeIntegrationCreatedAuditEvent defines model for RecruiteeIntegrationCreatedAuditEvent.

type RecruiteeIntegrationCredentialsUpdatedAuditEvent added in v0.1.23

type RecruiteeIntegrationCredentialsUpdatedAuditEvent struct {
	RecruiteeIntegration string `json:"recruitee_integration"`
}

RecruiteeIntegrationCredentialsUpdatedAuditEvent defines model for RecruiteeIntegrationCredentialsUpdatedAuditEvent.

type RecruiteeIntegrationDeletedAuditEvent added in v0.1.23

type RecruiteeIntegrationDeletedAuditEvent struct {
	RecruiteeIntegration string `json:"recruitee_integration"`
}

RecruiteeIntegrationDeletedAuditEvent defines model for RecruiteeIntegrationDeletedAuditEvent.

type RecruiteeIntegrationResponse added in v0.1.23

type RecruiteeIntegrationResponse struct {
	// ID The unique identifier for the Recruitee integration
	ID string `json:"id"`

	// Name A friendly name for the Recruitee connection.
	Name string `json:"name"`

	// CompanyID The Recruitee company id, required on every Recruitee ATS API call.
	CompanyID string `json:"company_id"`

	// Mode The credential direction. `pilot` uses a Recruitee personal API
	// token; `partner` uses a Tellent Partner API grant (production).
	Mode RecruiteeIntegrationResponseMode `json:"mode"`

	// Status Whether the connection is active. Nothing fires while paused.
	Status RecruiteeIntegrationResponseStatus `json:"status"`

	// Connected Whether Nametag can currently reach Recruitee with the stored
	// credential. If `false`, the credential may need to be re-authorized.
	Connected bool `json:"connected"`

	// Trigger When verification fires. Defaults to `stage_move`.
	Trigger *RecruiteeIntegrationResponseTrigger `json:"trigger,omitempty"`

	// StageID The target Recruitee stage id for the `stage_move` trigger. Empty
	// means any stage move within scope.
	StageID *string `json:"stage_id,omitempty"`

	// StageCategory Optional target stage category for the `stage_move` trigger.
	StageCategory *string `json:"stage_category,omitempty"`

	// ReinviteOnExpiry Whether to re-invite candidates whose verification request expired.
	ReinviteOnExpiry *bool `json:"reinvite_on_expiry,omitempty"`

	// OfferIDs The Recruitee offer ids in scope. Empty means all offers.
	OfferIDs *[]string `json:"offer_ids,omitempty"`

	// DepartmentIDs The Recruitee department ids in scope. Empty means all departments.
	DepartmentIDs *[]string `json:"department_ids,omitempty"`
}

RecruiteeIntegrationResponse defines model for RecruiteeIntegrationResponse.

type RecruiteeIntegrationResponseMode added in v0.1.23

type RecruiteeIntegrationResponseMode string

RecruiteeIntegrationResponseMode The credential direction. `pilot` uses a Recruitee personal API token; `partner` uses a Tellent Partner API grant (production).

const (
	Partner RecruiteeIntegrationResponseMode = "partner"
	Pilot   RecruiteeIntegrationResponseMode = "pilot"
)

Defines values for RecruiteeIntegrationResponseMode.

func (RecruiteeIntegrationResponseMode) Valid added in v0.1.23

Valid indicates whether the value is a known member of the RecruiteeIntegrationResponseMode enum.

type RecruiteeIntegrationResponseStatus added in v0.1.23

type RecruiteeIntegrationResponseStatus string

RecruiteeIntegrationResponseStatus Whether the connection is active. Nothing fires while paused.

const (
	RecruiteeIntegrationResponseStatusActive RecruiteeIntegrationResponseStatus = "active"
	RecruiteeIntegrationResponseStatusPaused RecruiteeIntegrationResponseStatus = "paused"
)

Defines values for RecruiteeIntegrationResponseStatus.

func (RecruiteeIntegrationResponseStatus) Valid added in v0.1.23

Valid indicates whether the value is a known member of the RecruiteeIntegrationResponseStatus enum.

type RecruiteeIntegrationResponseTrigger added in v0.1.23

type RecruiteeIntegrationResponseTrigger string

RecruiteeIntegrationResponseTrigger When verification fires. Defaults to `stage_move`.

const (
	RecruiteeIntegrationResponseTriggerOnApply   RecruiteeIntegrationResponseTrigger = "on_apply"
	RecruiteeIntegrationResponseTriggerStageMove RecruiteeIntegrationResponseTrigger = "stage_move"
)

Defines values for RecruiteeIntegrationResponseTrigger.

func (RecruiteeIntegrationResponseTrigger) Valid added in v0.1.23

Valid indicates whether the value is a known member of the RecruiteeIntegrationResponseTrigger enum.

type RecruiteeIntegrationUpdateRequest added in v0.1.23

type RecruiteeIntegrationUpdateRequest struct {
	// Name A friendly name for the Recruitee connection.
	Name *string `json:"name,omitempty"`

	// Status Whether the connection is active.
	Status *RecruiteeIntegrationUpdateRequestStatus `json:"status,omitempty"`

	// Credential A replacement Recruitee credential (re-authorize the target). Never
	// a Nametag key.
	Credential *string `json:"credential,omitempty"`

	// WebhookSecret A replacement webhook secret.
	WebhookSecret *string `json:"webhook_secret,omitempty"`

	// Trigger When verification fires.
	Trigger *RecruiteeIntegrationUpdateRequestTrigger `json:"trigger,omitempty"`

	// StageID The target Recruitee stage id for the stage_move trigger.
	StageID *string `json:"stage_id,omitempty"`

	// StageCategory Optional target stage category.
	StageCategory *string `json:"stage_category,omitempty"`

	// ReinviteOnExpiry Whether to re-invite candidates whose request expired.
	ReinviteOnExpiry *bool `json:"reinvite_on_expiry,omitempty"`

	// OfferIDs The Recruitee offer ids in scope. Empty means all offers.
	OfferIDs *[]string `json:"offer_ids,omitempty"`

	// DepartmentIDs The Recruitee department ids in scope. Empty means all.
	DepartmentIDs *[]string `json:"department_ids,omitempty"`
}

RecruiteeIntegrationUpdateRequest defines model for RecruiteeIntegrationUpdateRequest.

type RecruiteeIntegrationUpdateRequestStatus added in v0.1.23

type RecruiteeIntegrationUpdateRequestStatus string

RecruiteeIntegrationUpdateRequestStatus Whether the connection is active.

const (
	RecruiteeIntegrationUpdateRequestStatusActive RecruiteeIntegrationUpdateRequestStatus = "active"
	RecruiteeIntegrationUpdateRequestStatusPaused RecruiteeIntegrationUpdateRequestStatus = "paused"
)

Defines values for RecruiteeIntegrationUpdateRequestStatus.

func (RecruiteeIntegrationUpdateRequestStatus) Valid added in v0.1.23

Valid indicates whether the value is a known member of the RecruiteeIntegrationUpdateRequestStatus enum.

type RecruiteeIntegrationUpdateRequestTrigger added in v0.1.23

type RecruiteeIntegrationUpdateRequestTrigger string

RecruiteeIntegrationUpdateRequestTrigger When verification fires.

const (
	RecruiteeIntegrationUpdateRequestTriggerOnApply   RecruiteeIntegrationUpdateRequestTrigger = "on_apply"
	RecruiteeIntegrationUpdateRequestTriggerStageMove RecruiteeIntegrationUpdateRequestTrigger = "stage_move"
)

Defines values for RecruiteeIntegrationUpdateRequestTrigger.

func (RecruiteeIntegrationUpdateRequestTrigger) Valid added in v0.1.23

Valid indicates whether the value is a known member of the RecruiteeIntegrationUpdateRequestTrigger enum.

type RecruiteeIntegrationUpdatedAuditEvent added in v0.1.23

type RecruiteeIntegrationUpdatedAuditEvent struct {
	RecruiteeIntegration string                            `json:"recruitee_integration"`
	Request              RecruiteeIntegrationUpdateRequest `json:"request"`
	Response             *RecruiteeIntegrationResponse     `json:"response,omitempty"`
}

RecruiteeIntegrationUpdatedAuditEvent defines model for RecruiteeIntegrationUpdatedAuditEvent.

type RecruiteeIntegrationsListResponse added in v0.1.23

type RecruiteeIntegrationsListResponse struct {
	// Integrations A list of Recruitee integrations for this environment
	Integrations []RecruiteeIntegrationResponse `json:"integrations"`
}

RecruiteeIntegrationsListResponse defines model for RecruiteeIntegrationsListResponse.

type RefreshWebhookSecretJSONRequestBody added in v0.1.12

type RefreshWebhookSecretJSONRequestBody = RefreshWebhookSecretRequest

RefreshWebhookSecretJSONRequestBody defines body for RefreshWebhookSecret for application/json ContentType.

type RefreshWebhookSecretRequest added in v0.1.12

type RefreshWebhookSecretRequest struct {
	// EnvID The environment identifier for which the webhook secret is to be refreshed
	EnvID string `json:"envID"`
}

RefreshWebhookSecretRequest defines model for RefreshWebhookSecretRequest.

type RefreshWebhookSecretResp added in v0.1.12

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

func ParseRefreshWebhookSecretResp added in v0.1.12

func ParseRefreshWebhookSecretResp(rsp *http.Response) (*RefreshWebhookSecretResp, error)

ParseRefreshWebhookSecretResp parses an HTTP response from a RefreshWebhookSecretWithResponse call

func (RefreshWebhookSecretResp) ContentType added in v0.1.24

func (r RefreshWebhookSecretResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RefreshWebhookSecretResp) Status added in v0.1.12

func (r RefreshWebhookSecretResp) Status() string

Status returns HTTPResponse.Status

func (RefreshWebhookSecretResp) StatusCode added in v0.1.12

func (r RefreshWebhookSecretResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RefreshWebhookSecretResponse added in v0.1.12

type RefreshWebhookSecretResponse struct {
	// WebhookSharedSecret The new webhook shared secret
	WebhookSharedSecret string `json:"webhook_shared_secret"`
}

RefreshWebhookSecretResponse defines model for RefreshWebhookSecretResponse.

type RegenerateDirectoryAgentTokenResp added in v0.1.16

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

func ParseRegenerateDirectoryAgentTokenResp added in v0.1.16

func ParseRegenerateDirectoryAgentTokenResp(rsp *http.Response) (*RegenerateDirectoryAgentTokenResp, error)

ParseRegenerateDirectoryAgentTokenResp parses an HTTP response from a RegenerateDirectoryAgentTokenWithResponse call

func (RegenerateDirectoryAgentTokenResp) ContentType added in v0.1.24

func (r RegenerateDirectoryAgentTokenResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RegenerateDirectoryAgentTokenResp) Status added in v0.1.16

Status returns HTTPResponse.Status

func (RegenerateDirectoryAgentTokenResp) StatusCode added in v0.1.16

func (r RegenerateDirectoryAgentTokenResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RegenerateDirectoryAgentTokenResponse added in v0.1.16

type RegenerateDirectoryAgentTokenResponse struct {
	AgentToken string `json:"agent_token"`

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

RegenerateDirectoryAgentTokenResponse defines model for RegenerateDirectoryAgentTokenResponse.

type RegisterSharedDeviceResp added in v0.1.22

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

func ParseRegisterSharedDeviceResp added in v0.1.22

func ParseRegisterSharedDeviceResp(rsp *http.Response) (*RegisterSharedDeviceResp, error)

ParseRegisterSharedDeviceResp parses an HTTP response from a RegisterSharedDeviceWithResponse call

func (RegisterSharedDeviceResp) ContentType added in v0.1.24

func (r RegisterSharedDeviceResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RegisterSharedDeviceResp) Status added in v0.1.22

func (r RegisterSharedDeviceResp) Status() string

Status returns HTTPResponse.Status

func (RegisterSharedDeviceResp) StatusCode added in v0.1.22

func (r RegisterSharedDeviceResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RegisterSharedDeviceResponse added in v0.1.22

type RegisterSharedDeviceResponse struct {
	// QR The QR code to generate for the mobile app to scan.
	QR string `json:"qr"`

	// RegistrationToken Token used to check the status of registration.
	RegistrationToken string `json:"registration_token"`
}

RegisterSharedDeviceResponse defines model for RegisterSharedDeviceResponse.

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) ContentType added in v0.1.24

func (r RemoveOrgMemberResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 sent 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"`
	Claims []Claim `json:"claims"`

	// Status The status of the request, e.g. `in_progress` or `shared`.
	Status RequestStatus `json:"status"`

	// Progress Indicates the user's progress through the scanning process, e.g. `link_opened` or `id_scanned`.
	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 The properties that were shared with you.
	Properties RequestProperties `json:"properties"`

	// Mobile Details of the end-user's mobile device
	Mobile *RequestMobileDevice `json:"mobile,omitempty"`

	// Browser Details of the browser used to pivot to the mobile app (present only for some flows).
	Browser *RequestBrowser `json:"browser,omitempty"`

	// IsKnownUser If the user is known as an account
	IsKnownUser *bool `json:"is_known_user,omitempty"`

	// Photo The photo associated with this person
	Photo *string `json:"photo,omitempty"`

	// ExternalIds External IDs for accounts if the user is known
	ExternalIds *[]string `json:"external_ids,omitempty"`

	// MarkedForDeletionAfter Indicates whether the person associated with this request has asked for their data to be deleted and the earliest time that will occur at.
	MarkedForDeletionAfter *time.Time `json:"marked_for_deletion_after,omitempty"`

	// PIIRemoved Indicates that the person's PII has been removed. The scan history and result are still visible, but the PII fields will be empty and inaccessible.
	PIIRemoved *bool `json:"pii_removed,omitempty"`

	// VerificationSource Indicates how the user completed this request.  This field is only present if the request has been shared.
	VerificationSource *RequestVerificationSource `json:"verification_source,omitempty"`

	// SelfieOnly Indicates whether this request requires full IDV or only a selfie
	SelfieOnly bool `json:"selfie_only"`

	// UnmaskedAt Indicates when the user's data was unmasked for fraud.
	UnmaskedAt *time.Time `json:"unmasked_at,omitempty"`
}

Request defines model for Request.

type RequestAccountConstraint added in v0.1.28

type RequestAccountConstraint struct {
	// BindingStrength The requested account-binding strength (name_match, name_and_birth_date, or photo). Omit for the default (name match).
	BindingStrength *string `json:"binding_strength,omitempty"`

	// DirectoryId Restrict the binding to a single directory. Omit to bind against any directory in the request's environment.
	DirectoryId *string `json:"directory_id,omitempty"`

	// ImmutableExternalId The acceptable immutable account identifier; the located account must match it. To accept more than one account, combine several account-constraint leaves under an `or`.
	ImmutableExternalId *string `json:"immutable_external_id,omitempty"`

	// ExternalId The acceptable account identifier; the located account must match it. To accept more than one account, combine several account-constraint leaves under an `or`.
	ExternalId *string `json:"external_id,omitempty"`
}

RequestAccountConstraint defines model for RequestAccountConstraint.

type RequestBirthDateConstraint added in v0.1.28

type RequestBirthDateConstraint struct {
	// Value The asserted birth date, as a single string. Either a plain ISO-8601 date (YYYY-MM-DD), or a salted SHA-256 date hash ("$sha256$...") so the birth date can be asserted without disclosing it. (Keyed HMAC "$hs256$..." expressions are not accepted here — they require a directory HMAC key that a bare constraint does not carry.) To accept more than one date, combine several birth-date-constraint leaves under an `or`.
	Value *string `json:"value,omitempty"`
}

RequestBirthDateConstraint defines model for RequestBirthDateConstraint.

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 `location:ip` claim is specified in the request)
	RemoteAddress *string `json:"remote_address,omitempty"`

	// RemoteAddressLocation The location of the browser based on its IP address  (This field is `null` unless the `location:ip` claim is specified in the request)
	RemoteAddressLocation *Location `json:"remote_address_location,omitempty"`
}

RequestBrowser defines model for RequestBrowser.

type RequestCanceledAuditEvent added in v0.1.15

type RequestCanceledAuditEvent struct {
	RequestID string `json:"request_id"`
}

RequestCanceledAuditEvent defines model for RequestCanceledAuditEvent.

type RequestConstraint added in v0.1.28

type RequestConstraint struct {
	// And Matches when every child constraint matches.
	And *[]RequestConstraint `json:"and,omitempty"`

	// Or Matches when at least one child constraint matches.
	Or *[]RequestConstraint `json:"or,omitempty"`

	// Not A constraint (or boolean tree of constraints) the request must satisfy against the verified identity. A node is EITHER a boolean combinator (`and`/`or`/`not` over child constraints) OR a leaf asserting a single typed constraint (`name`/`birth_date`/`account`). Exactly one of those fields may be set on a node. Only name, birth date, and account can be constrained. A constraint is always a hard requirement: if it does not match, the request finishes in the constraints_unmatched state.
	Not *RequestConstraint `json:"not,omitempty"`

	// Name Asserts the subject's full name (fuzzy match).
	Name *RequestNameConstraint `json:"name,omitempty"`

	// BirthDate Asserts the subject's date of birth (calendar-date match).
	BirthDate *RequestBirthDateConstraint `json:"birth_date,omitempty"`

	// Account Asserts the subject binds to a directory account.
	Account *RequestAccountConstraint `json:"account,omitempty"`
}

RequestConstraint A constraint (or boolean tree of constraints) the request must satisfy against the verified identity. A node is EITHER a boolean combinator (`and`/`or`/`not` over child constraints) OR a leaf asserting a single typed constraint (`name`/`birth_date`/`account`). Exactly one of those fields may be set on a node. Only name, birth date, and account can be constrained. A constraint is always a hard requirement: if it does not match, the request finishes in the constraints_unmatched state.

type RequestCreatedAuditEvent added in v0.1.15

type RequestCreatedAuditEvent struct {
	Request  CreateRequestRequest  `json:"request"`
	Response CreateRequestResponse `json:"response"`
}

RequestCreatedAuditEvent defines model for RequestCreatedAuditEvent.

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 `location:ip` claim is specified in the request)
	RemoteAddress *string `json:"remote_address,omitempty"`

	// RemoteAddressLocation The location of the mobile device based on its IP address (This field is `null` unless the `location:ip` claim is specified in the request)
	RemoteAddressLocation *Location `json:"remote_address_location,omitempty"`
}

RequestMobileDevice defines model for RequestMobileDevice.

type RequestNameConstraint added in v0.1.28

type RequestNameConstraint struct {
	// Value The asserted name. To accept more than one name, combine several name-constraint leaves under an `or`.
	Value *string `json:"value,omitempty"`
}

RequestNameConstraint defines model for RequestNameConstraint.

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.

func (RequestProgress) Valid added in v0.1.22

func (e RequestProgress) Valid() bool

Valid indicates whether the value is a known member of the RequestProgress enum.

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 name from their identity document
	Name *string `json:"name,omitempty"`

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

	// LastName The person's family (last) name from their identity document
	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"`

	// Govtid Additional information about the identity document presented by the user
	Govtid *GovtidValue `json:"govtid,omitempty"`

	// GovtidExpired `true` if we have a govtid expiration date and it is past that date; `false` if we either can't get an expiration date or it is not expired.
	GovtidExpired *bool `json:"govtid_Expired,omitempty"`

	// Account The person's Nametag account information
	Account *AccountValue `json:"account,omitempty"`
}

RequestProperties defines model for RequestProperties.

type RequestStatus

type RequestStatus string

RequestStatus defines model for RequestStatus.

const (
	RequestStatusCancelled            RequestStatus = "cancelled"
	RequestStatusConstraintsUnmatched RequestStatus = "constraints_unmatched"
	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.

func (RequestStatus) Valid added in v0.1.22

func (e RequestStatus) Valid() bool

Valid indicates whether the value is a known member of the RequestStatus enum.

type RequestUpdatedAuditEvent added in v0.1.15

type RequestUpdatedAuditEvent struct {
	RequestID string               `json:"request_id"`
	Request   UpdateRequestRequest `json:"request"`
}

RequestUpdatedAuditEvent defines model for RequestUpdatedAuditEvent.

type RequestVerificationSource added in v0.1.18

type RequestVerificationSource string

RequestVerificationSource defines model for RequestVerificationSource.

const (
	RequestVerificationSourceExpressReverification RequestVerificationSource = "express_reverification"
	RequestVerificationSourceFullIDV               RequestVerificationSource = "full_idv"
	RequestVerificationSourceSelfieOnly            RequestVerificationSource = "selfie_only"
)

Defines values for RequestVerificationSource.

func (RequestVerificationSource) Valid added in v0.1.22

func (e RequestVerificationSource) Valid() bool

Valid indicates whether the value is a known member of the RequestVerificationSource enum.

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.

func (Role) Valid added in v0.1.22

func (e Role) Valid() bool

Valid indicates whether the value is a known member of the Role enum.

type SafeCallCodeRejectedAuditEvent added in v0.1.24

type SafeCallCodeRejectedAuditEvent struct {
	// Session The ID of the Safe Call session, if a matching session was found.
	Session *string `json:"session,omitempty"`
}

SafeCallCodeRejectedAuditEvent defines model for SafeCallCodeRejectedAuditEvent.

type SafeCallExpiredAuditEvent added in v0.1.24

type SafeCallExpiredAuditEvent struct {
	// Session The ID of the Safe Call session.
	Session string `json:"session"`
}

SafeCallExpiredAuditEvent defines model for SafeCallExpiredAuditEvent.

type SafeCallFailedAuditEvent added in v0.1.24

type SafeCallFailedAuditEvent struct {
	// Reason A short reason the verification did not pass.
	Reason *string `json:"reason,omitempty"`

	// Session The ID of the Safe Call session.
	Session string `json:"session"`
}

SafeCallFailedAuditEvent defines model for SafeCallFailedAuditEvent.

type SafeCallSessionStartedAuditEvent added in v0.1.24

type SafeCallSessionStartedAuditEvent struct {
	// Session The ID of the Safe Call session.
	Session string `json:"session"`
}

SafeCallSessionStartedAuditEvent defines model for SafeCallSessionStartedAuditEvent.

type SafeCallVerificationStartedAuditEvent added in v0.1.24

type SafeCallVerificationStartedAuditEvent struct {
	// Session The ID of the Safe Call session.
	Session string `json:"session"`
}

SafeCallVerificationStartedAuditEvent defines model for SafeCallVerificationStartedAuditEvent.

type SafeCallVerifiedAuditEvent added in v0.1.24

type SafeCallVerifiedAuditEvent struct {
	// Session The ID of the Safe Call session.
	Session string `json:"session"`
}

SafeCallVerifiedAuditEvent defines model for SafeCallVerifiedAuditEvent.

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 Nametag console.

const (
	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"
	NtLocationGps     Scope = "nt:location:gps"
	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.

func (Scope) Valid added in v0.1.22

func (e Scope) Valid() bool

Valid indicates whether the value is a known member of the Scope enum.

type SelfieCompareAuditEvent added in v0.1.15

type SelfieCompareAuditEvent struct {
	Response CompareSelfieResult `json:"response"`
	Subject  string              `json:"subject"`
}

SelfieCompareAuditEvent defines model for SelfieCompareAuditEvent.

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) ContentType added in v0.1.24

func (r SetDirectoryCredentialsResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SetDirectoryCredentialsResp) Status

Status returns HTTPResponse.Status

func (SetDirectoryCredentialsResp) StatusCode

func (r SetDirectoryCredentialsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SetPictureError added in v0.1.19

type SetPictureError string

SetPictureError An error that occurred when setting a person's profile picture.

const (
	SetPictureErrorInvalidFormat SetPictureError = "invalid_format"
	SetPictureErrorNoFace        SetPictureError = "no_face"
	SetPictureErrorNoReference   SetPictureError = "no_reference"
	SetPictureErrorNotMatched    SetPictureError = "not_matched"
	SetPictureErrorTooLarge      SetPictureError = "too_large"
	SetPictureErrorTooManyFaces  SetPictureError = "too_many_faces"
)

Defines values for SetPictureError.

func (SetPictureError) Valid added in v0.1.22

func (e SetPictureError) Valid() bool

Valid indicates whether the value is a known member of the SetPictureError enum.

type SetPictureErrorResponse added in v0.1.19

type SetPictureErrorResponse struct {
	// OK always false
	OK bool `json:"ok"`

	// Error Details about why the picture could not be set.
	Error SetPictureError `json:"error"`
}

SetPictureErrorResponse defines model for SetPictureErrorResponse.

type SetPictureResp added in v0.1.19

type SetPictureResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SetPictureResponse
	JSON400      *SetPictureErrorResponse
}

func ParseSetPictureResp added in v0.1.19

func ParseSetPictureResp(rsp *http.Response) (*SetPictureResp, error)

ParseSetPictureResp parses an HTTP response from a SetPictureWithResponse call

func (SetPictureResp) ContentType added in v0.1.24

func (r SetPictureResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SetPictureResp) Status added in v0.1.19

func (r SetPictureResp) Status() string

Status returns HTTPResponse.Status

func (SetPictureResp) StatusCode added in v0.1.19

func (r SetPictureResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SetPictureResponse added in v0.1.19

type SetPictureResponse struct {
	// OK always true
	OK bool `json:"ok"`

	// URL The URL of the newly set profile picture.
	URL string `json:"url"`
}

SetPictureResponse defines model for SetPictureResponse.

type SetPreferredNameJSONRequestBody added in v0.1.19

type SetPreferredNameJSONRequestBody = SetPreferredNameRequest

SetPreferredNameJSONRequestBody defines body for SetPreferredName for application/json ContentType.

type SetPreferredNameRequest added in v0.1.19

type SetPreferredNameRequest struct {
	// PreferredName The preferred name to set for the person.
	PreferredName string `json:"preferred_name"`
}

SetPreferredNameRequest defines model for SetPreferredNameRequest.

type SetPreferredNameResp added in v0.1.19

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

func ParseSetPreferredNameResp added in v0.1.19

func ParseSetPreferredNameResp(rsp *http.Response) (*SetPreferredNameResp, error)

ParseSetPreferredNameResp parses an HTTP response from a SetPreferredNameWithResponse call

func (SetPreferredNameResp) ContentType added in v0.1.24

func (r SetPreferredNameResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SetPreferredNameResp) Status added in v0.1.19

func (r SetPreferredNameResp) Status() string

Status returns HTTPResponse.Status

func (SetPreferredNameResp) StatusCode added in v0.1.19

func (r SetPreferredNameResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SharedDevice added in v0.1.22

type SharedDevice struct {
	// AppOutdated True if the app present on the device is not the latest version of the application.
	AppOutdated bool `json:"app_outdated"`

	// AppVersion The version of the application on the device.
	AppVersion string `json:"app_version"`

	// DeviceModel The model of the device.
	DeviceModel string `json:"device_model"`

	// DeviceName The name of the device.
	DeviceName string `json:"device_name"`

	// ID The unique identifier of the shared device.
	ID string `json:"id"`

	// LastSeen The timestamp when this device last authenticated with the Nametag server.
	LastSeen time.Time `json:"last_seen"`

	// OS The operating system of the device.
	OS DeviceOperatingSystem `json:"os"`

	// OSVersion The version of the operating system on the device.
	OSVersion string `json:"os_version"`
}

SharedDevice defines model for SharedDevice.

type SharingRevokedAuditEvent added in v0.1.15

type SharingRevokedAuditEvent struct {
	Claims  []Claim  `json:"claims"`
	Scopes  *[]Scope `json:"scopes,omitempty"`
	Subject string   `json:"subject"`
}

SharingRevokedAuditEvent defines model for SharingRevokedAuditEvent.

type SlackIntegration added in v0.1.17

type SlackIntegration struct {
	// ID The unique identifier for the Slack integration
	ID string `json:"id"`

	// Name The name of the Slack workspace associated with this integration.
	Name string `json:"name"`

	// Icon The URL for the icon of the Slack workspace associated with this integration.
	Icon string `json:"icon"`

	// Connected Whether or not this integration is connected to Nametag.  If this is `false`, there may be issues with the auth token that Nametag has that can be solved by reconnecting this workspace.
	Connected bool `json:"connected"`
}

SlackIntegration defines model for SlackIntegration.

type SlackRequestDetailsResponse added in v0.1.17

type SlackRequestDetailsResponse struct {
	// OrgMember The org member associated with the request
	OrgMember OrgMember `json:"orgMember"`

	// Request The request and attached details
	Request Request `json:"request"`
}

SlackRequestDetailsResponse defines model for SlackRequestDetailsResponse.

type SlateIntegrationCreatedAuditEvent added in v0.1.24

type SlateIntegrationCreatedAuditEvent struct {
	SlateIntegration string `json:"slate_integration"`
}

SlateIntegrationCreatedAuditEvent defines model for SlateIntegrationCreatedAuditEvent.

type SlateIntegrationCredentialsUpdatedAuditEvent added in v0.1.24

type SlateIntegrationCredentialsUpdatedAuditEvent struct {
	SlateIntegration string `json:"slate_integration"`
}

SlateIntegrationCredentialsUpdatedAuditEvent defines model for SlateIntegrationCredentialsUpdatedAuditEvent.

type SlateIntegrationDeletedAuditEvent added in v0.1.24

type SlateIntegrationDeletedAuditEvent struct {
	SlateIntegration string `json:"slate_integration"`
}

SlateIntegrationDeletedAuditEvent defines model for SlateIntegrationDeletedAuditEvent.

type SlateIntegrationResponse added in v0.1.24

type SlateIntegrationResponse struct {
	// ID The unique identifier for the Slate integration.
	ID string `json:"id"`

	// Name A human-readable name for this Slate connection.
	Name string `json:"name"`

	// Host The institution's Slate host (e.g. `https://slate.university.edu`).
	Host string `json:"host"`

	// Status The lifecycle state of the connection.
	Status SlateIntegrationResponseStatus `json:"status"`

	// Connected Whether Nametag can currently reach the Slate Open API with the stored credential.
	Connected bool `json:"connected"`

	// Region The data-residency region matching the institution's Slate instance.
	Region SlateIntegrationResponseRegion `json:"region"`

	// TriggerMode How applicants are delivered into verification.
	TriggerMode *SlateIntegrationResponseTriggerMode `json:"trigger_mode,omitempty"`

	// WriteMode Which Slate web service the signal is written back through.
	WriteMode *SlateIntegrationResponseWriteMode `json:"write_mode,omitempty"`

	// SourceFormatURL The institution's Source Format web-service URL used for write-back.
	SourceFormatURL *string `json:"source_format_url,omitempty"`

	// Population The population this connection covers (display only, no PII).
	Population *string `json:"population,omitempty"`

	// Round The Slate round/term this connection covers.
	Round *string `json:"round,omitempty"`

	// DecisionStage The decision stage that requires verification.
	DecisionStage *string `json:"decision_stage,omitempty"`

	// StatusField The Slate custom field that receives the verification status.
	StatusField *string `json:"status_field,omitempty"`

	// VerificationIDField The Slate custom field that receives the Nametag verification reference.
	VerificationIDField *string `json:"verification_id_field,omitempty"`

	// VerifiedAtField The Slate custom field that receives the verification timestamp.
	VerifiedAtField *string `json:"verified_at_field,omitempty"`

	// ChecklistItem The Slate checklist item/material updated on verification.
	ChecklistItem *string `json:"checklist_item,omitempty"`

	// Counts Aggregate verification counts for the connected detail view. Contains no PII.
	Counts *SlateVerificationCounts `json:"counts,omitempty"`
}

SlateIntegrationResponse defines model for SlateIntegrationResponse.

type SlateIntegrationResponseRegion added in v0.1.24

type SlateIntegrationResponseRegion string

SlateIntegrationResponseRegion The data-residency region matching the institution's Slate instance.

Defines values for SlateIntegrationResponseRegion.

func (SlateIntegrationResponseRegion) Valid added in v0.1.24

Valid indicates whether the value is a known member of the SlateIntegrationResponseRegion enum.

type SlateIntegrationResponseStatus added in v0.1.24

type SlateIntegrationResponseStatus string

SlateIntegrationResponseStatus The lifecycle state of the connection.

const (
	SlateIntegrationResponseStatusActive       SlateIntegrationResponseStatus = "active"
	SlateIntegrationResponseStatusDisabled     SlateIntegrationResponseStatus = "disabled"
	SlateIntegrationResponseStatusPendingScope SlateIntegrationResponseStatus = "pending_scope"
)

Defines values for SlateIntegrationResponseStatus.

func (SlateIntegrationResponseStatus) Valid added in v0.1.24

Valid indicates whether the value is a known member of the SlateIntegrationResponseStatus enum.

type SlateIntegrationResponseTriggerMode added in v0.1.24

type SlateIntegrationResponseTriggerMode string

SlateIntegrationResponseTriggerMode How applicants are delivered into verification.

const (
	SlateIntegrationResponseTriggerModeEmailLink SlateIntegrationResponseTriggerMode = "email_link"
	SlateIntegrationResponseTriggerModeEvent     SlateIntegrationResponseTriggerMode = "event"
)

Defines values for SlateIntegrationResponseTriggerMode.

func (SlateIntegrationResponseTriggerMode) Valid added in v0.1.24

Valid indicates whether the value is a known member of the SlateIntegrationResponseTriggerMode enum.

type SlateIntegrationResponseWriteMode added in v0.1.24

type SlateIntegrationResponseWriteMode string

SlateIntegrationResponseWriteMode Which Slate web service the signal is written back through.

const (
	SlateIntegrationResponseWriteModeSourceFormat SlateIntegrationResponseWriteMode = "source_format"
	SlateIntegrationResponseWriteModeUpload       SlateIntegrationResponseWriteMode = "upload"
)

Defines values for SlateIntegrationResponseWriteMode.

func (SlateIntegrationResponseWriteMode) Valid added in v0.1.24

Valid indicates whether the value is a known member of the SlateIntegrationResponseWriteMode enum.

type SlateIntegrationUpdateRequest added in v0.1.24

type SlateIntegrationUpdateRequest struct {
	Name                *string                                   `json:"name,omitempty"`
	Population          *string                                   `json:"population,omitempty"`
	Round               *string                                   `json:"round,omitempty"`
	DecisionStage       *string                                   `json:"decision_stage,omitempty"`
	TriggerMode         *SlateIntegrationUpdateRequestTriggerMode `json:"trigger_mode,omitempty"`
	WriteMode           *SlateIntegrationUpdateRequestWriteMode   `json:"write_mode,omitempty"`
	SourceFormatURL     *string                                   `json:"source_format_url,omitempty"`
	StatusField         *string                                   `json:"status_field,omitempty"`
	VerificationIDField *string                                   `json:"verification_id_field,omitempty"`
	VerifiedAtField     *string                                   `json:"verified_at_field,omitempty"`
	ChecklistItem       *string                                   `json:"checklist_item,omitempty"`
}

SlateIntegrationUpdateRequest Update the connection's name, scope, trigger/write mode, and Slate element name overrides. Only the provided fields are changed.

type SlateIntegrationUpdateRequestTriggerMode added in v0.1.24

type SlateIntegrationUpdateRequestTriggerMode string

SlateIntegrationUpdateRequestTriggerMode defines model for SlateIntegrationUpdateRequest.TriggerMode.

const (
	SlateIntegrationUpdateRequestTriggerModeEmailLink SlateIntegrationUpdateRequestTriggerMode = "email_link"
	SlateIntegrationUpdateRequestTriggerModeEvent     SlateIntegrationUpdateRequestTriggerMode = "event"
)

Defines values for SlateIntegrationUpdateRequestTriggerMode.

func (SlateIntegrationUpdateRequestTriggerMode) Valid added in v0.1.24

Valid indicates whether the value is a known member of the SlateIntegrationUpdateRequestTriggerMode enum.

type SlateIntegrationUpdateRequestWriteMode added in v0.1.24

type SlateIntegrationUpdateRequestWriteMode string

SlateIntegrationUpdateRequestWriteMode defines model for SlateIntegrationUpdateRequest.WriteMode.

const (
	SlateIntegrationUpdateRequestWriteModeSourceFormat SlateIntegrationUpdateRequestWriteMode = "source_format"
	SlateIntegrationUpdateRequestWriteModeUpload       SlateIntegrationUpdateRequestWriteMode = "upload"
)

Defines values for SlateIntegrationUpdateRequestWriteMode.

func (SlateIntegrationUpdateRequestWriteMode) Valid added in v0.1.24

Valid indicates whether the value is a known member of the SlateIntegrationUpdateRequestWriteMode enum.

type SlateIntegrationUpdatedAuditEvent added in v0.1.24

type SlateIntegrationUpdatedAuditEvent struct {
	// Request Update the connection's name, scope, trigger/write mode, and Slate element name
	// overrides. Only the provided fields are changed.
	Request          SlateIntegrationUpdateRequest `json:"request"`
	Response         *SlateIntegrationResponse     `json:"response,omitempty"`
	SlateIntegration string                        `json:"slate_integration"`
}

SlateIntegrationUpdatedAuditEvent defines model for SlateIntegrationUpdatedAuditEvent.

type SlateIntegrationsListResponse added in v0.1.24

type SlateIntegrationsListResponse struct {
	// Integrations A list of Slate integrations for this environment.
	Integrations []SlateIntegrationResponse `json:"integrations"`
}

SlateIntegrationsListResponse defines model for SlateIntegrationsListResponse.

type SlateTestResponse added in v0.1.24

type SlateTestResponse struct {
	// OK Whether the live Slate Open API read succeeded.
	OK bool `json:"ok"`

	// Detail A human-readable detail message (redacted; never contains credentials).
	Detail *string `json:"detail,omitempty"`
}

SlateTestResponse defines model for SlateTestResponse.

type SlateVerificationCounts added in v0.1.24

type SlateVerificationCounts struct {
	Failed   int `json:"failed"`
	Pending  int `json:"pending"`
	Review   int `json:"review"`
	Verified int `json:"verified"`
}

SlateVerificationCounts Aggregate verification counts for the connected detail view. Contains no PII.

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) ContentType added in v0.1.24

func (r SyncDirectoryResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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"`

	// 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"`

	// 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"`

	// ClaimDefinitions A list of claims that are requested when requests are created with this template.
	ClaimDefinitions []TemplateClaimDefinition `json:"claim_definitions"`

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

	// MaxUsages The maximum number of times requests created from this template can be used to start a scan. A value of 0 means unlimited uses.
	MaxUsages *int `json:"max_usages,omitempty"`

	// 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"`

	// QRCustomText The text that appears below the desktop QR page headline.
	QRCustomText string `json:"qr_custom_text"`

	// EnableSelfieOnly If true, existing users only need to scan a selfie to complete a scan.  Not compatible with all scopes.
	EnableSelfieOnly bool `json:"enable_selfie_only"`
}

Template defines model for Template.

type TemplateClaimDefinition added in v0.1.16

type TemplateClaimDefinition struct {
	// Claim The name of the claim that is requested
	Claim Claim `json:"claim"`
}

TemplateClaimDefinition defines model for TemplateClaimDefinition.

type TemplateCreatedAuditEvent added in v0.1.15

type TemplateCreatedAuditEvent struct {
	Request  CreateTemplateRequest  `json:"request"`
	Response CreateTemplateResponse `json:"response"`
}

TemplateCreatedAuditEvent defines model for TemplateCreatedAuditEvent.

type TemplateDeletedAuditEvent added in v0.1.15

type TemplateDeletedAuditEvent struct {
	Template string `json:"template"`
}

TemplateDeletedAuditEvent defines model for TemplateDeletedAuditEvent.

type TemplateScopeDefinition

type TemplateScopeDefinition struct {
	// Scope The name of the scope that is requested
	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 TemplateUpdatedAuditEvent added in v0.1.15

type TemplateUpdatedAuditEvent struct {
	Request  UpdateTemplateRequest `json:"request"`
	Template string                `json:"template"`
}

TemplateUpdatedAuditEvent defines model for TemplateUpdatedAuditEvent.

type TestSlateIntegrationResp added in v0.1.24

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

func ParseTestSlateIntegrationResp added in v0.1.24

func ParseTestSlateIntegrationResp(rsp *http.Response) (*TestSlateIntegrationResp, error)

ParseTestSlateIntegrationResp parses an HTTP response from a TestSlateIntegrationWithResponse call

func (TestSlateIntegrationResp) ContentType added in v0.1.24

func (r TestSlateIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (TestSlateIntegrationResp) Status added in v0.1.24

func (r TestSlateIntegrationResp) Status() string

Status returns HTTPResponse.Status

func (TestSlateIntegrationResp) StatusCode added in v0.1.24

func (r TestSlateIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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"
	ClientCredentials TokenRequestGrantType = "client_credentials"
)

Defines values for TokenRequestGrantType.

func (TokenRequestGrantType) Valid added in v0.1.22

func (e TokenRequestGrantType) Valid() bool

Valid indicates whether the value is a known member of the TokenRequestGrantType enum.

type TokenResponse

type TokenResponse struct {
	AccessToken  string                 `json:"access_token"`
	RefreshToken string                 `json:"refresh_token"`
	IDToken      string                 `json:"id_token"`
	Scope        string                 `json:"scope"`
	Claims       string                 `json:"claims"`
	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.

func (TokenResponseTokenType) Valid added in v0.1.22

func (e TokenResponseTokenType) Valid() bool

Valid indicates whether the value is a known member of the TokenResponseTokenType enum.

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) ContentType added in v0.1.24

func (r UpdateAPIKeyResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r UpdateAccountResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 UpdateAshbyIntegrationJSONRequestBody added in v0.1.23

type UpdateAshbyIntegrationJSONRequestBody = AshbyIntegrationUpdateRequest

UpdateAshbyIntegrationJSONRequestBody defines body for UpdateAshbyIntegration for application/json ContentType.

type UpdateAshbyIntegrationResp added in v0.1.23

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

func ParseUpdateAshbyIntegrationResp added in v0.1.23

func ParseUpdateAshbyIntegrationResp(rsp *http.Response) (*UpdateAshbyIntegrationResp, error)

ParseUpdateAshbyIntegrationResp parses an HTTP response from a UpdateAshbyIntegrationWithResponse call

func (UpdateAshbyIntegrationResp) ContentType added in v0.1.24

func (r UpdateAshbyIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateAshbyIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (UpdateAshbyIntegrationResp) StatusCode added in v0.1.23

func (r UpdateAshbyIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateDirectoryJSONRequestBody added in v0.1.12

type UpdateDirectoryJSONRequestBody = UpdateDirectoryRequest

UpdateDirectoryJSONRequestBody defines body for UpdateDirectory for application/json ContentType.

type UpdateDirectoryRequest added in v0.1.12

type UpdateDirectoryRequest struct {
	AuthenticatePolicy        *RecoveryPolicyRules `json:"authenticate_policy,omitempty"`
	PasswordPolicy            *RecoveryPolicyRules `json:"password_policy,omitempty"`
	MFAPolicy                 *RecoveryPolicyRules `json:"mfa_policy,omitempty"`
	UnlockPolicy              *RecoveryPolicyRules `json:"unlock_policy,omitempty"`
	TemporaryAccessPassPolicy *RecoveryPolicyRules `json:"temporary_access_pass_policy,omitempty"`

	// TemporaryAccessPassLifetimeMinutes The validity period of a temporary access pass in minutes
	TemporaryAccessPassLifetimeMinutes *int `json:"temporary_access_pass_lifetime_minutes,omitempty"`

	// TemporaryAccessPassReusable True if temporary access passes can be used more than once
	TemporaryAccessPassReusable *bool `json:"temporary_access_pass_reusable,omitempty"`

	// BirthDateHMACSecret A shared secret for hashed birth dates in the directory
	BirthDateHMACSecret        []byte                      `json:"birth_date_hmac_secret,omitempty"`
	RecoveryOperationRateLimit *RecoveryOperationRateLimit `json:"recovery_operation_rate_limit,omitempty"`

	// Provisioning The new provisioning mode.
	Provisioning *DirectoryProvisioning `json:"provisioning,omitempty"`
}

UpdateDirectoryRequest defines model for UpdateDirectoryRequest.

type UpdateDirectoryResp added in v0.1.12

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

func ParseUpdateDirectoryResp added in v0.1.12

func ParseUpdateDirectoryResp(rsp *http.Response) (*UpdateDirectoryResp, error)

ParseUpdateDirectoryResp parses an HTTP response from a UpdateDirectoryWithResponse call

func (UpdateDirectoryResp) ContentType added in v0.1.24

func (r UpdateDirectoryResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateDirectoryResp) Status added in v0.1.12

func (r UpdateDirectoryResp) Status() string

Status returns HTTPResponse.Status

func (UpdateDirectoryResp) StatusCode added in v0.1.12

func (r UpdateDirectoryResp) 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) ContentType added in v0.1.24

func (r UpdateEnvResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 UpdateGreenhouseIntegrationJSONRequestBody added in v0.1.22

type UpdateGreenhouseIntegrationJSONRequestBody = GreenhouseIntegrationUpdateRequest

UpdateGreenhouseIntegrationJSONRequestBody defines body for UpdateGreenhouseIntegration for application/json ContentType.

type UpdateGreenhouseIntegrationResp added in v0.1.22

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

func ParseUpdateGreenhouseIntegrationResp added in v0.1.22

func ParseUpdateGreenhouseIntegrationResp(rsp *http.Response) (*UpdateGreenhouseIntegrationResp, error)

ParseUpdateGreenhouseIntegrationResp parses an HTTP response from a UpdateGreenhouseIntegrationWithResponse call

func (UpdateGreenhouseIntegrationResp) ContentType added in v0.1.24

func (r UpdateGreenhouseIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateGreenhouseIntegrationResp) Status added in v0.1.22

Status returns HTTPResponse.Status

func (UpdateGreenhouseIntegrationResp) StatusCode added in v0.1.22

func (r UpdateGreenhouseIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateIntercomIntegrationJSONRequestBody added in v0.1.23

type UpdateIntercomIntegrationJSONRequestBody = IntercomIntegrationUpdateRequest

UpdateIntercomIntegrationJSONRequestBody defines body for UpdateIntercomIntegration for application/json ContentType.

type UpdateIntercomIntegrationResp added in v0.1.23

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

func ParseUpdateIntercomIntegrationResp added in v0.1.23

func ParseUpdateIntercomIntegrationResp(rsp *http.Response) (*UpdateIntercomIntegrationResp, error)

ParseUpdateIntercomIntegrationResp parses an HTTP response from a UpdateIntercomIntegrationWithResponse call

func (UpdateIntercomIntegrationResp) ContentType added in v0.1.24

func (r UpdateIntercomIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateIntercomIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (UpdateIntercomIntegrationResp) StatusCode added in v0.1.23

func (r UpdateIntercomIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateJoinIntegrationJSONRequestBody added in v0.1.24

type UpdateJoinIntegrationJSONRequestBody = JoinIntegrationUpdateRequest

UpdateJoinIntegrationJSONRequestBody defines body for UpdateJoinIntegration for application/json ContentType.

type UpdateJoinIntegrationResp added in v0.1.24

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

func ParseUpdateJoinIntegrationResp added in v0.1.24

func ParseUpdateJoinIntegrationResp(rsp *http.Response) (*UpdateJoinIntegrationResp, error)

ParseUpdateJoinIntegrationResp parses an HTTP response from a UpdateJoinIntegrationWithResponse call

func (UpdateJoinIntegrationResp) ContentType added in v0.1.24

func (r UpdateJoinIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateJoinIntegrationResp) Status added in v0.1.24

func (r UpdateJoinIntegrationResp) Status() string

Status returns HTTPResponse.Status

func (UpdateJoinIntegrationResp) StatusCode added in v0.1.24

func (r UpdateJoinIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateLeverIntegrationJSONRequestBody added in v0.1.23

type UpdateLeverIntegrationJSONRequestBody = LeverIntegrationUpdateRequest

UpdateLeverIntegrationJSONRequestBody defines body for UpdateLeverIntegration for application/json ContentType.

type UpdateLeverIntegrationResp added in v0.1.23

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

func ParseUpdateLeverIntegrationResp added in v0.1.23

func ParseUpdateLeverIntegrationResp(rsp *http.Response) (*UpdateLeverIntegrationResp, error)

ParseUpdateLeverIntegrationResp parses an HTTP response from a UpdateLeverIntegrationWithResponse call

func (UpdateLeverIntegrationResp) ContentType added in v0.1.24

func (r UpdateLeverIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateLeverIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (UpdateLeverIntegrationResp) StatusCode added in v0.1.23

func (r UpdateLeverIntegrationResp) 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 The role to be assigned to the member.
	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) ContentType added in v0.1.24

func (r UpdateOrgMemberResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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) ContentType added in v0.1.24

func (r UpdateOrgResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 UpdateRecruiteeIntegrationJSONRequestBody added in v0.1.23

type UpdateRecruiteeIntegrationJSONRequestBody = RecruiteeIntegrationUpdateRequest

UpdateRecruiteeIntegrationJSONRequestBody defines body for UpdateRecruiteeIntegration for application/json ContentType.

type UpdateRecruiteeIntegrationResp added in v0.1.23

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

func ParseUpdateRecruiteeIntegrationResp added in v0.1.23

func ParseUpdateRecruiteeIntegrationResp(rsp *http.Response) (*UpdateRecruiteeIntegrationResp, error)

ParseUpdateRecruiteeIntegrationResp parses an HTTP response from a UpdateRecruiteeIntegrationWithResponse call

func (UpdateRecruiteeIntegrationResp) ContentType added in v0.1.24

func (r UpdateRecruiteeIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateRecruiteeIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (UpdateRecruiteeIntegrationResp) StatusCode added in v0.1.23

func (r UpdateRecruiteeIntegrationResp) 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) ContentType added in v0.1.24

func (r UpdateRequestResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 UpdateSlateIntegrationJSONRequestBody added in v0.1.24

type UpdateSlateIntegrationJSONRequestBody = SlateIntegrationUpdateRequest

UpdateSlateIntegrationJSONRequestBody defines body for UpdateSlateIntegration for application/json ContentType.

type UpdateSlateIntegrationResp added in v0.1.24

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

func ParseUpdateSlateIntegrationResp added in v0.1.24

func ParseUpdateSlateIntegrationResp(rsp *http.Response) (*UpdateSlateIntegrationResp, error)

ParseUpdateSlateIntegrationResp parses an HTTP response from a UpdateSlateIntegrationWithResponse call

func (UpdateSlateIntegrationResp) ContentType added in v0.1.24

func (r UpdateSlateIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateSlateIntegrationResp) Status added in v0.1.24

Status returns HTTPResponse.Status

func (UpdateSlateIntegrationResp) StatusCode added in v0.1.24

func (r UpdateSlateIntegrationResp) 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"`

	// 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"`

	// 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"`

	// ClaimDefinitions A list of scopes that are requested when requests are created with this template.
	ClaimDefinitions []TemplateClaimDefinition `json:"claim_definitions,omitempty"`

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

	// MaxUsages The maximum number of times requests created from this template can be used to start a scan. A value of 0 means unlimited uses.
	MaxUsages *int `json:"max_usages,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"`

	// QRCustomText The text that appears below the desktop QR page headline.
	QRCustomText *string `json:"qr_custom_text,omitempty"`

	// EnableSelfieOnly If true, existing users only need to scan a selfie to complete a scan.  Not compatible with all scopes.
	EnableSelfieOnly *bool `json:"enable_selfie_only,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) ContentType added in v0.1.24

func (r UpdateTemplateResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 UpdateWorkableIntegrationJSONRequestBody added in v0.1.23

type UpdateWorkableIntegrationJSONRequestBody = WorkableIntegrationUpdateRequest

UpdateWorkableIntegrationJSONRequestBody defines body for UpdateWorkableIntegration for application/json ContentType.

type UpdateWorkableIntegrationResp added in v0.1.23

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

func ParseUpdateWorkableIntegrationResp added in v0.1.23

func ParseUpdateWorkableIntegrationResp(rsp *http.Response) (*UpdateWorkableIntegrationResp, error)

ParseUpdateWorkableIntegrationResp parses an HTTP response from a UpdateWorkableIntegrationWithResponse call

func (UpdateWorkableIntegrationResp) ContentType added in v0.1.24

func (r UpdateWorkableIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateWorkableIntegrationResp) Status added in v0.1.23

Status returns HTTPResponse.Status

func (UpdateWorkableIntegrationResp) StatusCode added in v0.1.23

func (r UpdateWorkableIntegrationResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateWorkdayIntegrationJSONRequestBody added in v0.1.20

type UpdateWorkdayIntegrationJSONRequestBody = WorkdayIntegrationRequest

UpdateWorkdayIntegrationJSONRequestBody defines body for UpdateWorkdayIntegration for application/json ContentType.

type UpdateWorkdayIntegrationResp added in v0.1.20

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

func ParseUpdateWorkdayIntegrationResp added in v0.1.20

func ParseUpdateWorkdayIntegrationResp(rsp *http.Response) (*UpdateWorkdayIntegrationResp, error)

ParseUpdateWorkdayIntegrationResp parses an HTTP response from a UpdateWorkdayIntegrationWithResponse call

func (UpdateWorkdayIntegrationResp) ContentType added in v0.1.24

func (r UpdateWorkdayIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateWorkdayIntegrationResp) Status added in v0.1.20

Status returns HTTPResponse.Status

func (UpdateWorkdayIntegrationResp) StatusCode added in v0.1.20

func (r UpdateWorkdayIntegrationResp) 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) ContentType added in v0.1.24

func (r UploadAccountPhotoResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 UploadDirectoryLogoMultipartBody added in v0.1.16

type UploadDirectoryLogoMultipartBody struct {
}

UploadDirectoryLogoMultipartBody defines parameters for UploadDirectoryLogo.

type UploadDirectoryLogoMultipartRequestBody added in v0.1.16

type UploadDirectoryLogoMultipartRequestBody UploadDirectoryLogoMultipartBody

UploadDirectoryLogoMultipartRequestBody defines body for UploadDirectoryLogo for multipart/form-data ContentType.

type UploadDirectoryLogoResp added in v0.1.16

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

func ParseUploadDirectoryLogoResp added in v0.1.16

func ParseUploadDirectoryLogoResp(rsp *http.Response) (*UploadDirectoryLogoResp, error)

ParseUploadDirectoryLogoResp parses an HTTP response from a UploadDirectoryLogoWithResponse call

func (UploadDirectoryLogoResp) ContentType added in v0.1.24

func (r UploadDirectoryLogoResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UploadDirectoryLogoResp) Status added in v0.1.16

func (r UploadDirectoryLogoResp) Status() string

Status returns HTTPResponse.Status

func (UploadDirectoryLogoResp) StatusCode added in v0.1.16

func (r UploadDirectoryLogoResp) 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) ContentType added in v0.1.24

func (r UploadLogoResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

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 ValidateWorkdayIntegrationJSONRequestBody added in v0.1.22

type ValidateWorkdayIntegrationJSONRequestBody = WorkdayIntegrationValidateRequest

ValidateWorkdayIntegrationJSONRequestBody defines body for ValidateWorkdayIntegration for application/json ContentType.

type ValidateWorkdayIntegrationResp added in v0.1.22

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

func ParseValidateWorkdayIntegrationResp added in v0.1.22

func ParseValidateWorkdayIntegrationResp(rsp *http.Response) (*ValidateWorkdayIntegrationResp, error)

ParseValidateWorkdayIntegrationResp parses an HTTP response from a ValidateWorkdayIntegrationWithResponse call

func (ValidateWorkdayIntegrationResp) ContentType added in v0.1.24

func (r ValidateWorkdayIntegrationResp) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ValidateWorkdayIntegrationResp) Status added in v0.1.22

Status returns HTTPResponse.Status

func (ValidateWorkdayIntegrationResp) StatusCode added in v0.1.22

func (r ValidateWorkdayIntegrationResp) 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"`

	// AuthorizationHeader The value of the Authorization header to include in the webhook request.
	AuthorizationHeader *string `json:"authorization_header,omitempty"`

	// Internal If true, this webhook is managed by the system and should not be shown in the console.
	Internal *bool `json:"internal,omitempty"`
}

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"`

	// AuthorizationHeader The value of the Authorization header to include in the webhook request.
	AuthorizationHeader *string `json:"authorization_header,omitempty"`
}

WebhookDefinitionUpdate defines model for WebhookDefinitionUpdate.

type WebhookEventType

type WebhookEventType string

WebhookEventType defines model for WebhookEventType.

const (
	WebhookEventTypeAudit                WebhookEventType = "audit"
	WebhookEventTypeDirectoryProviderErr WebhookEventType = "directory_provider_err"
	WebhookEventTypePicture              WebhookEventType = "picture"
	WebhookEventTypeRecover              WebhookEventType = "recover"
	WebhookEventTypeReject               WebhookEventType = "reject"
	WebhookEventTypeRequest              WebhookEventType = "request"
	WebhookEventTypeShare                WebhookEventType = "share"
)

Defines values for WebhookEventType.

func (WebhookEventType) Valid added in v0.1.22

func (e WebhookEventType) Valid() bool

Valid indicates whether the value is a known member of the WebhookEventType enum.

type WebhookHeader

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

WebhookHeader defines model for WebhookHeader.

type WorkableIntegrationCreatedAuditEvent added in v0.1.23

type WorkableIntegrationCreatedAuditEvent struct {
	WorkableIntegration string `json:"workable_integration"`
}

WorkableIntegrationCreatedAuditEvent defines model for WorkableIntegrationCreatedAuditEvent.

type WorkableIntegrationCredentialsUpdatedAuditEvent added in v0.1.23

type WorkableIntegrationCredentialsUpdatedAuditEvent struct {
	WorkableIntegration string `json:"workable_integration"`
}

WorkableIntegrationCredentialsUpdatedAuditEvent defines model for WorkableIntegrationCredentialsUpdatedAuditEvent.

type WorkableIntegrationDeletedAuditEvent added in v0.1.23

type WorkableIntegrationDeletedAuditEvent struct {
	WorkableIntegration string `json:"workable_integration"`
}

WorkableIntegrationDeletedAuditEvent defines model for WorkableIntegrationDeletedAuditEvent.

type WorkableIntegrationResponse added in v0.1.23

type WorkableIntegrationResponse struct {
	// ID The unique identifier for the Workable integration.
	ID string `json:"id"`

	// Name A human-readable name for this Workable connection.
	Name string `json:"name"`

	// Subdomain The Workable account subdomain (e.g. `acme-corp` for acme-corp.workable.com).
	Subdomain string `json:"subdomain"`

	// Status The lifecycle state of the connection.
	Status WorkableIntegrationResponseStatus `json:"status"`

	// Connected Whether Nametag can currently reach the Workable API with the stored credential.
	Connected bool `json:"connected"`

	// ConnectMethod How Nametag authenticates to Workable.
	ConnectMethod WorkableIntegrationResponseConnectMethod `json:"connect_method"`

	// TriggerJobs Workable job shortcodes that fire verification. `["*"]` means all jobs.
	TriggerJobs *[]string `json:"trigger_jobs,omitempty"`

	// TriggerStages Pipeline stage names that trigger verification when a candidate is moved into them.
	TriggerStages *[]string `json:"trigger_stages,omitempty"`

	// CustomAttrID The Workable custom attribute that receives the verification status write-back.
	CustomAttrID *string `json:"custom_attr_id,omitempty"`

	// CommentOnResult Post a timeline comment on the candidate when a verification completes.
	CommentOnResult *bool `json:"comment_on_result,omitempty"`

	// TagOnPass Add a "Nametag Verified" tag to the candidate on a passing verification.
	TagOnPass *bool `json:"tag_on_pass,omitempty"`

	// MoveOnPass Advance the candidate to the next stage on a passing verification (opt-in).
	MoveOnPass *bool `json:"move_on_pass,omitempty"`

	// DisqualifyOnFail Disqualify the candidate on a failing verification. Off by default (legal/fairness risk).
	DisqualifyOnFail *bool `json:"disqualify_on_fail,omitempty"`

	// Counts Aggregate verification counts for the connected detail view. Contains no PII.
	Counts *WorkableVerificationCounts `json:"counts,omitempty"`
}

WorkableIntegrationResponse defines model for WorkableIntegrationResponse.

type WorkableIntegrationResponseConnectMethod added in v0.1.23

type WorkableIntegrationResponseConnectMethod string

WorkableIntegrationResponseConnectMethod How Nametag authenticates to Workable.

const (
	AccountToken WorkableIntegrationResponseConnectMethod = "account_token"
	Oauth        WorkableIntegrationResponseConnectMethod = "oauth"
)

Defines values for WorkableIntegrationResponseConnectMethod.

func (WorkableIntegrationResponseConnectMethod) Valid added in v0.1.23

Valid indicates whether the value is a known member of the WorkableIntegrationResponseConnectMethod enum.

type WorkableIntegrationResponseStatus added in v0.1.23

type WorkableIntegrationResponseStatus string

WorkableIntegrationResponseStatus The lifecycle state of the connection.

const (
	Active       WorkableIntegrationResponseStatus = "active"
	Disabled     WorkableIntegrationResponseStatus = "disabled"
	PendingScope WorkableIntegrationResponseStatus = "pending_scope"
)

Defines values for WorkableIntegrationResponseStatus.

func (WorkableIntegrationResponseStatus) Valid added in v0.1.23

Valid indicates whether the value is a known member of the WorkableIntegrationResponseStatus enum.

type WorkableIntegrationUpdateRequest added in v0.1.23

type WorkableIntegrationUpdateRequest struct {
	Name             *string   `json:"name,omitempty"`
	TriggerJobs      *[]string `json:"trigger_jobs,omitempty"`
	TriggerStages    *[]string `json:"trigger_stages,omitempty"`
	CustomAttrID     *string   `json:"custom_attr_id,omitempty"`
	CommentOnResult  *bool     `json:"comment_on_result,omitempty"`
	TagOnPass        *bool     `json:"tag_on_pass,omitempty"`
	MoveOnPass       *bool     `json:"move_on_pass,omitempty"`
	DisqualifyOnFail *bool     `json:"disqualify_on_fail,omitempty"`
}

WorkableIntegrationUpdateRequest Update the connection's name, trigger scope, and write-back rules. Only the provided fields are changed.

type WorkableIntegrationUpdatedAuditEvent added in v0.1.23

type WorkableIntegrationUpdatedAuditEvent struct {
	// Request Update the connection's name, trigger scope, and write-back rules. Only the provided
	// fields are changed.
	Request             WorkableIntegrationUpdateRequest `json:"request"`
	Response            *WorkableIntegrationResponse     `json:"response,omitempty"`
	WorkableIntegration string                           `json:"workable_integration"`
}

WorkableIntegrationUpdatedAuditEvent defines model for WorkableIntegrationUpdatedAuditEvent.

type WorkableIntegrationsListResponse added in v0.1.23

type WorkableIntegrationsListResponse struct {
	// Integrations A list of Workable integrations for this environment.
	Integrations []WorkableIntegrationResponse `json:"integrations"`
}

WorkableIntegrationsListResponse defines model for WorkableIntegrationsListResponse.

type WorkableJob added in v0.1.23

type WorkableJob struct {
	Shortcode string    `json:"shortcode"`
	Title     string    `json:"title"`
	Stages    *[]string `json:"stages,omitempty"`
}

WorkableJob defines model for WorkableJob.

type WorkableJobsResponse added in v0.1.23

type WorkableJobsResponse struct {
	Jobs []WorkableJob `json:"jobs"`
}

WorkableJobsResponse defines model for WorkableJobsResponse.

type WorkableVerificationCounts added in v0.1.23

type WorkableVerificationCounts struct {
	Failed   int `json:"failed"`
	Pending  int `json:"pending"`
	Verified int `json:"verified"`
}

WorkableVerificationCounts Aggregate verification counts for the connected detail view. Contains no PII.

type WorkdayIDVRequestRequest added in v0.1.20

type WorkdayIDVRequestRequest struct {
	// IntegrationID Nametag's Workday Integration ID.
	IntegrationID string `json:"integration_id"`

	// WorkdayObjectType The target Workday object type for which the IDV is being requested.
	WorkdayObjectType WorkdayObjectType `json:"workday_object_type"`

	// WorkdayObjectID The Workday ID (WID) of the target Workday object of type specified in workday_object_type.
	WorkdayObjectID string `json:"workday_object_id"`

	// CandidateIDForJobApplication The ID of the Candidate associated with the Job Application. This is accepted only if workday_object_type is JobApplication.
	CandidateIDForJobApplication string `json:"candidate_id_for_job_application,omitempty"`

	// Label An internal label for this request. Nametag stores this field, but does not process it.
	Label string `json:"label,omitempty"`

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

WorkdayIDVRequestRequest defines model for WorkdayIDVRequestRequest.

type WorkdayIDVRequestResponse added in v0.1.20

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

	// Status The status code for the request. Always `"pending"` when the request is initially created.
	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"`

	// Claims A list of the information (claims) that the request is asking for.
	Claims []Claim `json:"claims"`

	// 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"`

	// Label An internal label for this request. Nametag stores this field, but does not process it at all.
	Label string `json:"label,omitempty"`

	// ExpiresAt The last time this request will be valid.
	ExpiresAt *time.Time `json:"expires_at,omitempty"`

	// IntegrationID Nametag's Workday Integration ID.
	IntegrationID string `json:"integration_id"`

	// WorkdayObjectType The target Workday object type for which the IDV is being requested.
	WorkdayObjectType WorkdayObjectType `json:"workday_object_type"`

	// WorkdayObjectID The Workday ID (WID) of the target Workday object of type specified in workday_object_type.
	WorkdayObjectID string `json:"workday_object_id"`

	// CandidateIDForJobApplication The ID of the Candidate associated with the Job Application. This is accepted only if workday_object_type is JobApplication.
	CandidateIDForJobApplication string `json:"candidate_id_for_job_application,omitempty"`
}

WorkdayIDVRequestResponse A response to Workday after creating an IDV request. This is not the update to Workday with the results of the IDV, but rather only the response to the initial request to create the IDV.

type WorkdayIntegrationRequest added in v0.1.20

type WorkdayIntegrationRequest struct {
	// Name Friendly name for the Workday integration.
	Name *string `json:"name,omitempty"`

	// HumanResourcesSOAPBindAddress The SOAP bind address for Workday Public Web Services > Human Resources.
	HumanResourcesSOAPBindAddress *string `json:"human_resources_soap_bind_address,omitempty"`

	// RecruitingSOAPBindAddress The SOAP bind address for Workday Public Web Services > Recruiting.
	RecruitingSOAPBindAddress *string `json:"recruiting_soap_bind_address,omitempty"`

	// RESTAPIEndpoint The Workday REST API endpoint.
	RESTAPIEndpoint *string `json:"rest_api_endpoint,omitempty"`

	// OAuth2TokenEndpoint The OAuth2 token endpoint used for Workday Public Web Services authentication.
	OAuth2TokenEndpoint *string `json:"oauth2_token_endpoint,omitempty"`

	// OAuth2ClientID The OAuth2 client ID used for Workday Public Web Services authentication.
	OAuth2ClientID *string `json:"oauth2_client_id,omitempty"`

	// OAuth2ClientSecret The OAuth2 client secret used for Workday Public Web Services authentication.
	OAuth2ClientSecret *string `json:"oauth2_client_secret,omitempty"`

	// OAuth2NonExpiringRefreshToken The non-expiring refresh token used for Workday Public Web Services authentication.
	OAuth2NonExpiringRefreshToken *string `json:"oauth2_non_expiring_refresh_token,omitempty"`
}

WorkdayIntegrationRequest defines model for WorkdayIntegrationRequest.

type WorkdayIntegrationResponse added in v0.1.20

type WorkdayIntegrationResponse struct {
	// ID Nametag's unique identifier for the Workday integration.
	ID string `json:"id"`

	// Name Friendly name for the Workday integration.
	Name string `json:"name"`

	// HumanResourcesSOAPBindAddress The SOAP bind address for Workday Public Web Services > Human Resources.
	HumanResourcesSOAPBindAddress string `json:"human_resources_soap_bind_address"`

	// RecruitingSOAPBindAddress The SOAP bind address for Workday Public Web Services > Recruiting.
	RecruitingSOAPBindAddress string `json:"recruiting_soap_bind_address"`

	// RESTAPIEndpoint The Workday REST API endpoint.
	RESTAPIEndpoint string `json:"rest_api_endpoint"`

	// OAuth2TokenEndpoint The OAuth2 token endpoint used for Workday Public Web Services authentication.
	OAuth2TokenEndpoint string `json:"oauth2_token_endpoint"`

	// OAuth2ClientID The OAuth2 client ID used for Workday Public Web Services authentication.
	OAuth2ClientID string `json:"oauth2_client_id"`
}

WorkdayIntegrationResponse defines model for WorkdayIntegrationResponse.

type WorkdayIntegrationValidateRequest added in v0.1.22

type WorkdayIntegrationValidateRequest struct {
	// HumanResourcesSOAPBindAddress The SOAP bind address for Workday Public Web Services > Human Resources.
	HumanResourcesSOAPBindAddress string `json:"human_resources_soap_bind_address"`

	// RecruitingSOAPBindAddress The SOAP bind address for Workday Public Web Services > Recruiting.
	RecruitingSOAPBindAddress string `json:"recruiting_soap_bind_address"`

	// RESTAPIEndpoint The Workday REST API endpoint.
	RESTAPIEndpoint string `json:"rest_api_endpoint"`

	// OAuth2TokenEndpoint The OAuth2 token endpoint used for Workday Public Web Services authentication.
	OAuth2TokenEndpoint string `json:"oauth2_token_endpoint"`

	// OAuth2ClientID The OAuth2 client ID used for Workday Public Web Services authentication.
	OAuth2ClientID string `json:"oauth2_client_id"`

	// OAuth2ClientSecret The OAuth2 client secret. Optional when integration_id is provided.
	OAuth2ClientSecret *string `json:"oauth2_client_secret,omitempty"`

	// OAuth2NonExpiringRefreshToken The non-expiring refresh token. Optional when integration_id is provided.
	OAuth2NonExpiringRefreshToken *string `json:"oauth2_non_expiring_refresh_token,omitempty"`

	// IntegrationID The ID of an existing integration. When provided and secrets are omitted, the saved secrets will be used for validation.
	IntegrationID *string `json:"integration_id,omitempty"`
}

WorkdayIntegrationValidateRequest defines model for WorkdayIntegrationValidateRequest.

type WorkdayIntegrationValidationResponse added in v0.1.22

type WorkdayIntegrationValidationResponse struct {
	// OAuth2TokenEndpoint Error message for the OAuth2 token endpoint, if any.
	OAuth2TokenEndpoint *string `json:"oauth2_token_endpoint,omitempty"`

	// OAuth2ClientID Error message for the OAuth2 client ID, if any.
	OAuth2ClientID *string `json:"oauth2_client_id,omitempty"`

	// OAuth2ClientSecret Error message for the OAuth2 client secret, if any.
	OAuth2ClientSecret *string `json:"oauth2_client_secret,omitempty"`

	// OAuth2NonExpiringRefreshToken Error message for the OAuth2 non-expiring refresh token, if any.
	OAuth2NonExpiringRefreshToken *string `json:"oauth2_non_expiring_refresh_token,omitempty"`

	// HumanResourcesSOAPBindAddress Error message for the HR SOAP bind address, if any.
	HumanResourcesSOAPBindAddress *string `json:"human_resources_soap_bind_address,omitempty"`

	// RecruitingSOAPBindAddress Error message for the Recruiting SOAP bind address, if any.
	RecruitingSOAPBindAddress *string `json:"recruiting_soap_bind_address,omitempty"`

	// RESTAPIEndpoint Error message for the REST API endpoint, if any.
	RESTAPIEndpoint *string `json:"rest_api_endpoint,omitempty"`
}

WorkdayIntegrationValidationResponse defines model for WorkdayIntegrationValidationResponse.

type WorkdayIntegrationsListResponse added in v0.1.20

type WorkdayIntegrationsListResponse struct {
	// Integrations A list of Workday integrations for this environment
	Integrations []WorkdayIntegrationResponse `json:"integrations"`
}

WorkdayIntegrationsListResponse defines model for WorkdayIntegrationsListResponse.

type WorkdayObjectType added in v0.1.20

type WorkdayObjectType string

WorkdayObjectType The type of Workday Business Object (Worker, PreHire, or JobApplication).

const (
	JobApplication WorkdayObjectType = "JobApplication"
	PreHire        WorkdayObjectType = "PreHire"
	Worker         WorkdayObjectType = "Worker"
)

Defines values for WorkdayObjectType.

func (WorkdayObjectType) Valid added in v0.1.22

func (e WorkdayObjectType) Valid() bool

Valid indicates whether the value is a known member of the WorkdayObjectType enum.

type WorkdayRequestData added in v0.1.20

type WorkdayRequestData struct {
	// IntegrationID Nametag's Workday Integration ID.
	IntegrationID string `json:"integration_id"`

	// WorkdayObjectType The target Workday object type for which the IDV is being requested.
	WorkdayObjectType WorkdayObjectType `json:"workday_object_type"`

	// WorkdayObjectID The Workday ID (WID) of the target Workday object of type specified in workday_object_type.
	WorkdayObjectID string `json:"workday_object_id"`

	// CandidateIDForJobApplication The ID of the Candidate associated with the Job Application. This is accepted only if workday_object_type is JobApplication.
	CandidateIDForJobApplication string `json:"candidate_id_for_job_application,omitempty"`
}

WorkdayRequestData The data structure for an IDV request originating from Workday.

Jump to

Keyboard shortcuts

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