Function WaitlistApiFp

WaitlistApi - functional programming interface export

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

  • Parameters

    Returns {
        waitlistDeleteContact(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        waitlistGetContact(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<HubSpotContact>)>;
        waitlistPostContact(waitlistDeets?: WaitlistDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<HubSpotContact>)>;
    }

    • waitlistDeleteContact:function
      • waitlistDeleteContact(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • summary Deletes the current user from the hubspot waitlist.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Throws

    • waitlistGetContact:function
      • waitlistGetContact(options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<HubSpotContact>)>

        Throws

    • waitlistPostContact:function
      • waitlistPostContact(waitlistDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<HubSpotContact>)>

      • summary Add a contact to a waitlist.

        Parameters

        • OptionalwaitlistDeets: WaitlistDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<HubSpotContact>)>

        Throws

Settings

Member Visibility