Function WaitlistApiFactory

WaitlistApi - factory interface export

  • WaitlistApiFactory(configuration?, basePath?, axios?): {
        waitlistDeleteContact(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        waitlistGetContact(options?: RawAxiosRequestConfig): AxiosPromise<HubSpotContact>;
        waitlistPostContact(waitlistDeets?: WaitlistDeets, options?: RawAxiosRequestConfig): AxiosPromise<HubSpotContact>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        waitlistDeleteContact(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        waitlistGetContact(options?: RawAxiosRequestConfig): AxiosPromise<HubSpotContact>;
        waitlistPostContact(waitlistDeets?: WaitlistDeets, options?: RawAxiosRequestConfig): AxiosPromise<HubSpotContact>;
    }

    • waitlistDeleteContact:function
      • waitlistDeleteContact(options?): AxiosPromise<void>

      • summary Deletes the current user from the hubspot waitlist.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • waitlistGetContact:function
      • waitlistGetContact(options?): AxiosPromise<HubSpotContact>

      • 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 AxiosPromise<HubSpotContact>

        Throws

    • waitlistPostContact:function

Settings

Member Visibility