Function InvitationsApiFactory

Returns {
    invitationsAccept(requestParameters, options?) => AxiosPromise<AcceptInvitationRead>;
    invitationsCreate(requestParameters, options?) => AxiosPromise<InvitationRead>;
    invitationsDestroy(requestParameters, options?) => AxiosPromise<void>;
    invitationsList(requestParameters?, options?) => AxiosPromise<PaginatedInvitationReadList>;
    invitationsPartialUpdate(requestParameters, options?) => AxiosPromise<InvitationRead>;
    invitationsResend(requestParameters, options?) => AxiosPromise<void>;
    invitationsRetrieve(requestParameters, options?) => AxiosPromise<InvitationRead>;
}

• invitationsAccept:function

  • invitationsAccept(requestParameters, options?): AxiosPromise<AcceptInvitationRead>

  • Parameters

    • requestParameters: InvitationsApiInvitationsAcceptRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AcceptInvitationRead>

    Summary

    Method registers user and accepts invitation to organization

    Throws

• invitationsCreate:function

  • invitationsCreate(requestParameters, options?): AxiosPromise<InvitationRead>

  • Parameters

    • requestParameters: InvitationsApiInvitationsCreateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<InvitationRead>

    Summary

    Method creates an invitation

    Throws

• invitationsDestroy:function

  • invitationsDestroy(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: InvitationsApiInvitationsDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes an invitation

    Throws

• invitationsList:function

  • invitationsList(requestParameters?, options?): AxiosPromise<PaginatedInvitationReadList>

  • Parameters

    • requestParameters: InvitationsApiInvitationsListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedInvitationReadList>

    Summary

    Method returns a paginated list of invitations

    Throws

• invitationsPartialUpdate:function

  • invitationsPartialUpdate(requestParameters, options?): AxiosPromise<InvitationRead>

  • Parameters

    • requestParameters: InvitationsApiInvitationsPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<InvitationRead>

    Summary

    Methods does a partial update of chosen fields in an invitation

    Throws

• invitationsResend:function

  • invitationsResend(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: InvitationsApiInvitationsResendRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method resends the invitation

    Throws

• invitationsRetrieve:function

  • invitationsRetrieve(requestParameters, options?): AxiosPromise<InvitationRead>

  • Parameters

    • requestParameters: InvitationsApiInvitationsRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<InvitationRead>

    Summary

    Method returns details of an invitation

    Throws