Package org.openapitools.client.api

Class InvitationApi

java.lang.Object

org.openapitools.client.api.InvitationApi

public class InvitationApi
extends Object

Constructor Summary

Constructors

Constructor	Description
InvitationApi()
InvitationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	postInvitation(String trOrganization, InvitationData invitationData)	Send Invitation Send Invitation Invitations act as a way to invite users to join an organization.
okhttp3.Call	postInvitationAsync(String trOrganization, InvitationData invitationData, ApiCallback<Void> _callback)	Send Invitation (asynchronously) Send Invitation Invitations act as a way to invite users to join an organization.
okhttp3.Call	postInvitationCall(String trOrganization, InvitationData invitationData, ApiCallback _callback)	Build call for postInvitation
ApiResponse<Void>	postInvitationWithHttpInfo(@NotNull String trOrganization, @NotNull InvitationData invitationData)	Send Invitation Send Invitation Invitations act as a way to invite users to join an organization.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InvitationApi

public InvitationApi()

InvitationApi

public InvitationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

postInvitationCall

public okhttp3.Call postInvitationCall(String trOrganization,
                                       InvitationData invitationData,
                                       ApiCallback _callback)
                                throws ApiException

Build call for postInvitation

Parameters:

trOrganization - The organization id to use for the request (required)

invitationData - JSON request payload to send an invitation (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Ok response. Indicates that invitation email was sent correctly.	-
400	Invalid email or some other error	-

postInvitation

public void postInvitation(String trOrganization,
                           InvitationData invitationData)
                    throws ApiException

Send Invitation Send Invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.

Parameters:

trOrganization - The organization id to use for the request (required)

invitationData - JSON request payload to send an invitation (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Ok response. Indicates that invitation email was sent correctly.	-
400	Invalid email or some other error	-

postInvitationWithHttpInfo

public ApiResponse<Void> postInvitationWithHttpInfo(@NotNull
                                                    @NotNull String trOrganization,
                                                    @NotNull
                                                    @NotNull InvitationData invitationData)
                                             throws ApiException

Send Invitation Send Invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.

Parameters:

trOrganization - The organization id to use for the request (required)

invitationData - JSON request payload to send an invitation (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Ok response. Indicates that invitation email was sent correctly.	-
400	Invalid email or some other error	-

postInvitationAsync

public okhttp3.Call postInvitationAsync(String trOrganization,
                                        InvitationData invitationData,
                                        ApiCallback<Void> _callback)
                                 throws ApiException

Send Invitation (asynchronously) Send Invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.

Parameters:

trOrganization - The organization id to use for the request (required)

invitationData - JSON request payload to send an invitation (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Ok response. Indicates that invitation email was sent correctly.	-
400	Invalid email or some other error	-