Class WaitlistApi

WaitlistApi - object-oriented interface export WaitlistApi

Hierarchy (view full)

BaseAPI
- WaitlistApi

Index

Constructors

Properties

axios basePath configuration

Methods

waitlistDeleteContact waitlistGetContact waitlistPostContact

Constructors

constructor

new WaitlistApi(configuration?, basePath?, axios?): WaitlistApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns WaitlistApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

waitlistDeleteContact

waitlistDeleteContact(options?): Promise<AxiosResponse<void, any>>
summary Deletes the current user from the hubspot waitlist.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof WaitlistApi
- Defined in src/api/api.ts:28724

waitlistGetContact

waitlistGetContact(options?): Promise<AxiosResponse<HubSpotContact, any>>
summary Gets the contact record of the current user if it exists. Can be used to check if a user is on a waitlist at application login. It cannot return which waitlist the user is currently on.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HubSpotContact, any>>
Throws
memberof WaitlistApi
- Defined in src/api/api.ts:28735

waitlistPostContact

waitlistPostContact(waitlistDeets?, options?): Promise<AxiosResponse<HubSpotContact, any>>
summary Add a contact to a waitlist.
Parameters
- OptionalwaitlistDeets: WaitlistDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HubSpotContact, any>>
Throws
memberof WaitlistApi
- Defined in src/api/api.ts:28747