WaitlistApi - axios parameter creator export

  • Parameters

    Returns {
        waitlistDeleteContact: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        waitlistGetContact: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        waitlistPostContact: ((waitlistDeets?: WaitlistDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • waitlistDeleteContact: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Deletes the current user from the hubspot waitlist.

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • waitlistGetContact: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      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.

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • waitlistPostContact: ((waitlistDeets?: WaitlistDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Add a contact to a waitlist.

        • (waitlistDeets?, options?): Promise<RequestArgs>
        • Parameters

          • OptionalwaitlistDeets: WaitlistDeets
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>