Class AuthV2Api

Hierarchy

BaseAPI
- AuthV2Api

Constructors

constructor

new AuthV2Api(configuration?: Configuration): AuthV2Api
Parameters
- configuration: Configuration = ...
Returns AuthV2Api

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

authV2AccountSwitch

authV2AccountSwitch(requestParameters: AuthV2AccountSwitchRequest, initOverrides?: RequestInit): Promise<AuthV2BootstrapDto>
Switch the account bound to an Auth v2 session
Parameters
- requestParameters: AuthV2AccountSwitchRequest
- Optional initOverrides: RequestInit
Returns Promise<AuthV2BootstrapDto>

authV2AccountSwitchRaw

authV2AccountSwitchRaw(requestParameters: AuthV2AccountSwitchRequest, initOverrides?: RequestInit): Promise<ApiResponse<AuthV2BootstrapDto>>
Switch the account bound to an Auth v2 session
Parameters
- requestParameters: AuthV2AccountSwitchRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AuthV2BootstrapDto>>

authV2Bootstrap

authV2Bootstrap(requestParameters: AuthV2BootstrapRequest, initOverrides?: RequestInit): Promise<AuthV2BootstrapDto>
Bootstrap an existing Auth v2 session
Parameters
- requestParameters: AuthV2BootstrapRequest
- Optional initOverrides: RequestInit
Returns Promise<AuthV2BootstrapDto>

authV2BootstrapRaw

authV2BootstrapRaw(requestParameters: AuthV2BootstrapRequest, initOverrides?: RequestInit): Promise<ApiResponse<AuthV2BootstrapDto>>
Bootstrap an existing Auth v2 session
Parameters
- requestParameters: AuthV2BootstrapRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AuthV2BootstrapDto>>

authV2EnvironmentSwitch

authV2EnvironmentSwitch(requestParameters: AuthV2EnvironmentSwitchRequest, initOverrides?: RequestInit): Promise<AuthV2BootstrapDto>
Switch the environment bound to an Auth v2 session
Parameters
- requestParameters: AuthV2EnvironmentSwitchRequest
- Optional initOverrides: RequestInit
Returns Promise<AuthV2BootstrapDto>

authV2EnvironmentSwitchRaw

authV2EnvironmentSwitchRaw(requestParameters: AuthV2EnvironmentSwitchRequest, initOverrides?: RequestInit): Promise<ApiResponse<AuthV2BootstrapDto>>
Switch the environment bound to an Auth v2 session
Parameters
- requestParameters: AuthV2EnvironmentSwitchRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AuthV2BootstrapDto>>

authV2Logout

authV2Logout(initOverrides?: RequestInit): Promise<void>
Revoke an Auth v2 session
Parameters
- Optional initOverrides: RequestInit
Returns Promise<void>

authV2LogoutRaw

authV2LogoutRaw(initOverrides?: RequestInit): Promise<ApiResponse<void>>
Revoke an Auth v2 session
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

authV2PasswordLogin

authV2PasswordLogin(requestParameters: AuthV2PasswordLoginRequest, initOverrides?: RequestInit): Promise<AuthV2BootstrapDto>
Create an Auth v2 session using a password
Parameters
- requestParameters: AuthV2PasswordLoginRequest
- Optional initOverrides: RequestInit
Returns Promise<AuthV2BootstrapDto>

authV2PasswordLoginRaw

authV2PasswordLoginRaw(requestParameters: AuthV2PasswordLoginRequest, initOverrides?: RequestInit): Promise<ApiResponse<AuthV2BootstrapDto>>
Create an Auth v2 session using a password
Parameters
- requestParameters: AuthV2PasswordLoginRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AuthV2BootstrapDto>>

authV2ProviderCallback

authV2ProviderCallback(requestParameters: AuthV2ProviderCallbackRequest, initOverrides?: RequestInit): Promise<void>
Redeem a staging provider handoff and continue to the app
Parameters
- requestParameters: AuthV2ProviderCallbackRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

authV2ProviderCallbackRaw

authV2ProviderCallbackRaw(requestParameters: AuthV2ProviderCallbackRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Redeem a staging provider handoff and continue to the app
Parameters
- requestParameters: AuthV2ProviderCallbackRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

emailCallback

emailCallback(requestParameters: EmailCallbackRequest, initOverrides?: RequestInit): Promise<void>
Parameters
- requestParameters: EmailCallbackRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

emailCallbackComplete

emailCallbackComplete(requestParameters: EmailCallbackCompleteRequest, initOverrides?: RequestInit): Promise<void>
Parameters
- requestParameters: EmailCallbackCompleteRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

emailCallbackCompleteRaw

emailCallbackCompleteRaw(requestParameters: EmailCallbackCompleteRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Parameters
- requestParameters: EmailCallbackCompleteRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

emailCallbackContinue

emailCallbackContinue(requestParameters: EmailCallbackContinueRequest, initOverrides?: RequestInit): Promise<string>
Parameters
- requestParameters: EmailCallbackContinueRequest
- Optional initOverrides: RequestInit
Returns Promise<string>

emailCallbackContinueRaw

emailCallbackContinueRaw(requestParameters: EmailCallbackContinueRequest, initOverrides?: RequestInit): Promise<ApiResponse<string>>
Parameters
- requestParameters: EmailCallbackContinueRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>

emailCallbackContinueScript

emailCallbackContinueScript(initOverrides?: RequestInit): Promise<string>
Parameters
- Optional initOverrides: RequestInit
Returns Promise<string>

emailCallbackContinueScriptRaw

emailCallbackContinueScriptRaw(initOverrides?: RequestInit): Promise<ApiResponse<string>>
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>

emailCallbackHead

emailCallbackHead(initOverrides?: RequestInit): Promise<void>
Parameters
- Optional initOverrides: RequestInit
Returns Promise<void>

emailCallbackHeadRaw

emailCallbackHeadRaw(initOverrides?: RequestInit): Promise<ApiResponse<void>>
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

emailCallbackRaw

emailCallbackRaw(requestParameters: EmailCallbackRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Parameters
- requestParameters: EmailCallbackRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware