Function InviteTokensApiFactory

InviteTokensApi - factory interface export

  • InviteTokensApiFactory(configuration?, basePath?, axios?): {
        apiInviteTokenDecryptGet(token?: string, options?: RawAxiosRequestConfig): AxiosPromise<InviteInfo>;
        apiInviteTokenSendPost(inviteSendDeets?: InviteSendDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

  • Parameters

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

    Returns {
        apiInviteTokenDecryptGet(token?: string, options?: RawAxiosRequestConfig): AxiosPromise<InviteInfo>;
        apiInviteTokenSendPost(inviteSendDeets?: InviteSendDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

    • apiInviteTokenDecryptGet:function
      • apiInviteTokenDecryptGet(token?, options?): AxiosPromise<InviteInfo>

      • summary Decrypt an invite token and return information for display

        Parameters

        • Optionaltoken: string

          The encrypted token value

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<InviteInfo>

        Throws

    • apiInviteTokenSendPost:function
      • apiInviteTokenSendPost(inviteSendDeets?, options?): AxiosPromise<void>

      • summary Send an invite token

        Parameters

        • OptionalinviteSendDeets: InviteSendDeets

          The invite details, including the token value

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

Settings

Member Visibility