Class OAuthConnectionApi

Hierarchy

BaseAPI
- OAuthConnectionApi

Index

Constructors

Properties

Methods

createOAuthConnection createOAuthConnectionRaw exchangeAuthorizationTokenAndCreateOrUpdateInbox exchangeAuthorizationTokenAndCreateOrUpdateInboxRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createOAuthConnection

createOAuthConnection(requestParameters: CreateOAuthConnectionRequest, initOverrides?: RequestInit): Promise<CreateOAuthConnectionResult>
Configure an inbox for OAuth sync with MailSlurp Create an OAuth connection
Parameters
- requestParameters: CreateOAuthConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<CreateOAuthConnectionResult>

createOAuthConnectionRaw

createOAuthConnectionRaw(requestParameters: CreateOAuthConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreateOAuthConnectionResult>>
Configure an inbox for OAuth sync with MailSlurp Create an OAuth connection
Parameters
- requestParameters: CreateOAuthConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreateOAuthConnectionResult>>

exchangeAuthorizationTokenAndCreateOrUpdateInbox

exchangeAuthorizationTokenAndCreateOrUpdateInbox(requestParameters: ExchangeAuthorizationTokenAndCreateOrUpdateInboxRequest, initOverrides?: RequestInit): Promise<CreateOAuthExchangeResult>
Exchange an OAuth code for an access token and create an inbox connection in MailSlurp Exchange authorization code for access token and create inbox
Parameters
- requestParameters: ExchangeAuthorizationTokenAndCreateOrUpdateInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<CreateOAuthExchangeResult>

exchangeAuthorizationTokenAndCreateOrUpdateInboxRaw

exchangeAuthorizationTokenAndCreateOrUpdateInboxRaw(requestParameters: ExchangeAuthorizationTokenAndCreateOrUpdateInboxRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreateOAuthExchangeResult>>
Exchange an OAuth code for an access token and create an inbox connection in MailSlurp Exchange authorization code for access token and create inbox
Parameters
- requestParameters: ExchangeAuthorizationTokenAndCreateOrUpdateInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreateOAuthExchangeResult>>

`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

Class OAuthConnectionApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns OAuthConnectionApi

Properties

Protected configuration

Methods

createOAuthConnection

Parameters

requestParameters: CreateOAuthConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<CreateOAuthConnectionResult>

createOAuthConnectionRaw

Parameters

requestParameters: CreateOAuthConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<CreateOAuthConnectionResult>>

exchangeAuthorizationTokenAndCreateOrUpdateInbox

Parameters

requestParameters: ExchangeAuthorizationTokenAndCreateOrUpdateInboxRequest

Optional initOverrides: RequestInit

Returns Promise<CreateOAuthExchangeResult>

exchangeAuthorizationTokenAndCreateOrUpdateInboxRaw

Parameters

requestParameters: ExchangeAuthorizationTokenAndCreateOrUpdateInboxRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<CreateOAuthExchangeResult>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit

Returns Promise<Response>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

Returns T

withPreMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]

Returns T

Settings

Member Visibility

Theme

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]