InvitationApi

All URIs are relative to /v1

Method	HTTP request	Description
acceptInvitation	POST /invitations/{invitation}
cancelJoinOrganization	DELETE /invitations/{invitation}/{organization}/join
cancelShareArrayByInvite	DELETE /invitations/{invitation}/{namespace}/{array}/share
cancelShareGroupByInvite	DELETE /invitations/group/{invitation}/{namespace}/{group_name}/share
cancelSharePayment	DELETE /invitations/share_payment/{namespace}/{target}
fetchInvitations	GET /invitations
joinOrganization	POST /invitations/{organization}/join
shareArrayByInvite	POST /invitations/{namespace}/{array}/share
shareGroupByInvite	POST /invitations/group/{namespace}/{group}/share
sharePayment	POST /invitations/share_payment/{namespace}

acceptInvitation

acceptInvitation(invitation)

Accepts invitation

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String invitation = "invitation_example"; // String | the ID of invitation about to be accepted
    try {
      apiInstance.acceptInvitation(invitation);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#acceptInvitation");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
invitation	String	the ID of invitation about to be accepted

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Invitation was accepted successfully	-
404	Could not find invitation identifier	-
502	Bad Gateway	-
0	error response	-

cancelJoinOrganization

cancelJoinOrganization(invitation, organization)

Cancels join organization invitation

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String invitation = "invitation_example"; // String | the ID of invitation about to be cancelled
    String organization = "organization_example"; // String | name or UUID of organization
    try {
      apiInstance.cancelJoinOrganization(invitation, organization);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#cancelJoinOrganization");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
invitation	String	the ID of invitation about to be cancelled
organization	String	name or UUID of organization

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Invitation cancelled successfully	-
404	No invitation was found to cancel	-
502	Bad Gateway	-
0	error response	-

cancelShareArrayByInvite

cancelShareArrayByInvite(namespace, invitation, array)

Cancels array sharing invitation

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
    String invitation = "invitation_example"; // String | the ID of invitation about to be cancelled
    String array = "array_example"; // String | name/uri of array that is url-encoded
    try {
      apiInstance.cancelShareArrayByInvite(namespace, invitation, array);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#cancelShareArrayByInvite");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
namespace	String	namespace array is in (an organization name or user's username)
invitation	String	the ID of invitation about to be cancelled
array	String	name/uri of array that is url-encoded

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Invitation cancelled successfully	-
404	No invitation was found to cancel	-
502	Bad Gateway	-
0	error response	-

cancelShareGroupByInvite

cancelShareGroupByInvite(namespace, invitation, groupName)

Cancels group sharing invitation

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace group is in (an organization name or user's username)
    String invitation = "invitation_example"; // String | the ID of invitation about to be cancelled
    String groupName = "groupName_example"; // String | name/uuid of group that is url-encoded
    try {
      apiInstance.cancelShareGroupByInvite(namespace, invitation, groupName);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#cancelShareGroupByInvite");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
namespace	String	namespace group is in (an organization name or user's username)
invitation	String	the ID of invitation about to be cancelled
groupName	String	name/uuid of group that is url-encoded

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Invitation cancelled successfully	-
404	No invitation was found to cancel	-
502	Bad Gateway	-
0	error response	-

cancelSharePayment

cancelSharePayment(namespace, target)

Revokes invitation from the source namespace to the target.

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String namespace = "namespace_example"; // String | name or UUID of namespace sharing their payment info
    String target = "target_example"; // String | name or UUID of recipient namespace
    try {
      apiInstance.cancelSharePayment(namespace, target);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#cancelSharePayment");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
namespace	String	name or UUID of namespace sharing their payment info
target	String	name or UUID of recipient namespace

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Invitation cancelled successfully	-
404	No invitation was found to cancel	-
0	error response	-

fetchInvitations

InvitationData fetchInvitations(organization, array, group, start, end, page, perPage, type, status, orderby)

Fetch a list of invitations

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String organization = "organization_example"; // String | name or ID of organization to filter
    String array = "array_example"; // String | name/uri of array that is url-encoded to filter
    String group = "group_example"; // String | name or ID of group to filter
    Integer start = 56; // Integer | start time for tasks to filter by
    Integer end = 56; // Integer | end time for tasks to filter by
    Integer page = 56; // Integer | pagination offset
    Integer perPage = 56; // Integer | pagination limit
    String type = "type_example"; // String | invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\"
    String status = "status_example"; // String | Filter to only return \"PENDING\", \"ACCEPTED\"
    String orderby = "orderby_example"; // String | sort by which field valid values include timestamp, array_name, organization_name
    try {
      InvitationData result = apiInstance.fetchInvitations(organization, array, group, start, end, page, perPage, type, status, orderby);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#fetchInvitations");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
organization	String	name or ID of organization to filter	[optional]
array	String	name/uri of array that is url-encoded to filter	[optional]
group	String	name or ID of group to filter	[optional]
start	Integer	start time for tasks to filter by	[optional]
end	Integer	end time for tasks to filter by	[optional]
page	Integer	pagination offset	[optional]
perPage	Integer	pagination limit	[optional]
type	String	invitation type, "ARRAY_SHARE", "JOIN_ORGANIZATION"	[optional]
status	String	Filter to only return "PENDING", "ACCEPTED"	[optional]
orderby	String	sort by which field valid values include timestamp, array_name, organization_name	[optional]

Return type

InvitationData

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of invitations and pagination metadata	-
502	Bad Gateway	-
0	error response	-

joinOrganization

joinOrganization(organization, emailInvite)

Sends email to multiple recipients with joining information regarding an organization

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String organization = "organization_example"; // String | name or UUID of organization
    InvitationOrganizationJoinEmail emailInvite = new InvitationOrganizationJoinEmail(); // InvitationOrganizationJoinEmail | list of email recipients
    try {
      apiInstance.joinOrganization(organization, emailInvite);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#joinOrganization");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
organization	String	name or UUID of organization
emailInvite	InvitationOrganizationJoinEmail	list of email recipients

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Email sent successfully to user for email confirmation link	-
207	Only a portion of the invitations succeeded, some failed	-
500	Could not reach any recipients	-
502	Bad Gateway	-
0	error response	-

shareArrayByInvite

shareArrayByInvite(namespace, array, emailInvite)

Sends email to multiple recipients with sharing information regarding an array

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
    String array = "array_example"; // String | name/uri of array that is url-encoded
    InvitationArrayShareEmail emailInvite = new InvitationArrayShareEmail(); // InvitationArrayShareEmail | list of email recipients
    try {
      apiInstance.shareArrayByInvite(namespace, array, emailInvite);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#shareArrayByInvite");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
namespace	String	namespace array is in (an organization name or user's username)
array	String	name/uri of array that is url-encoded
emailInvite	InvitationArrayShareEmail	list of email recipients

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Email sent successfully to user for email confirmation link	-
207	Only a portion of the invitations succeeded, some failed	-
500	Could not reach any recipients	-
502	Bad Gateway	-
0	error response	-

shareGroupByInvite

shareGroupByInvite(namespace, group, emailInvite)

Sends email to multiple recipients with sharing information regarding a group

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace group is in (an organization name or user's username)
    String group = "group_example"; // String | name/uri of group that is url-encoded
    InvitationGroupShareEmail emailInvite = new InvitationGroupShareEmail(); // InvitationGroupShareEmail | list of email/namespace recipients
    try {
      apiInstance.shareGroupByInvite(namespace, group, emailInvite);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#shareGroupByInvite");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
namespace	String	namespace group is in (an organization name or user's username)
group	String	name/uri of group that is url-encoded
emailInvite	InvitationGroupShareEmail	list of email/namespace recipients

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Email sent successfully to user with an email confirmation link	-
207	Only a portion of the invitations succeeded, some failed	-
500	Could not reach any recipients	-
502	Bad Gateway	-
0	error response	-

sharePayment

sharePayment(namespace, emailInvite)

Sends email to multiple recipients allowing them to use the payment instrument provided by the source namespace.

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.InvitationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    InvitationApi apiInstance = new InvitationApi(defaultClient);
    String namespace = "namespace_example"; // String | name or UUID of namespace sharing their payment info
    SharePaymentRequest emailInvite = new SharePaymentRequest(); // SharePaymentRequest | Recipients of the invitation. These may only be namespaces, not email addresses. 
    try {
      apiInstance.sharePayment(namespace, emailInvite);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvitationApi#sharePayment");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
namespace	String	name or UUID of namespace sharing their payment info
emailInvite	SharePaymentRequest	Recipients of the invitation. These may only be namespaces, not email addresses.	[optional]

Return type

null (empty response body)

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Email sent successfully to user for email confirmation link	-
207	Only a portion of the invitations succeeded, some failed	-
500	Could not reach any recipients	-
502	Bad Gateway	-
0	error response	-

Files

InvitationApi.md

Latest commit

History

InvitationApi.md

File metadata and controls

InvitationApi

acceptInvitation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cancelJoinOrganization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cancelShareArrayByInvite

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cancelShareGroupByInvite

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cancelSharePayment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetchInvitations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

joinOrganization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

shareArrayByInvite

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

shareGroupByInvite

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

sharePayment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details