Invitation operations — InvitationApi • tiledbcloud

tiledbcloud.Invitation

Format

An R6Class generator object

Methods

AcceptInvitation Accepts invitation @param invitation character status code : 204 | Invitation was accepted successfully response headers :

status code : 404 | Could not find invitation identifier response headers :

status code : 0 | error response return type : Error response headers :

CancelJoinOrganization Cancels join organization invitation @param invitation character @param organization character status code : 204 | Invitation cancelled successfully response headers :

status code : 404 | No invitation was found to cancel response headers :

status code : 0 | error response return type : Error response headers :

CancelShareArrayByInvite Cancels array sharing invitation @param namespace character @param invitation character @param array character status code : 204 | Invitation cancelled successfully response headers :

status code : 404 | No invitation was found to cancel response headers :

status code : 0 | error response return type : Error response headers :

FetchInvitations Fetch a list of invitations @param organization character @param array character @param start integer @param end integer @param page integer @param per.page integer @param type character @param status character @param orderby character @returnType InvitationData
status code : 200 | List of invitations and pagination metadata return type : InvitationData response headers :

status code : 0 | error response return type : Error response headers :

JoinOrganization Sends email to multiple recipients with joining information regarding an organization @param organization character @param email.invite InvitationOrganizationJoinEmail status code : 204 | Email sent successfully to user for email confirmation link response headers :

status code : 404 | Could not reach one or more recipients return type : InvitationOrganizationJoinEmail response headers :

status code : 0 | error response return type : Error response headers :

ShareArrayByInvite Sends email to multiple recipients with sharing information regarding an array @param namespace character @param array character @param email.invite InvitationArrayShareEmail status code : 204 | Email sent successfully to user for email confirmation link response headers :

status code : 404 | Could not reach one or more recipients return type : InvitationArrayShareEmail response headers :

status code : 0 | error response return type : Error response headers :

Public fields

apiClient: Handles the client-server communication.

Methods

Public methods

InvitationApi$new()
InvitationApi$AcceptInvitation()
InvitationApi$AcceptInvitationWithHttpInfo()
InvitationApi$CancelJoinOrganization()
InvitationApi$CancelJoinOrganizationWithHttpInfo()
InvitationApi$CancelShareArrayByInvite()
InvitationApi$CancelShareArrayByInviteWithHttpInfo()
InvitationApi$FetchInvitations()
InvitationApi$FetchInvitationsWithHttpInfo()
InvitationApi$JoinOrganization()
InvitationApi$JoinOrganizationWithHttpInfo()
InvitationApi$ShareArrayByInvite()
InvitationApi$ShareArrayByInviteWithHttpInfo()
InvitationApi$clone()

Method `new()`

Usage

InvitationApi$new(apiClient)

Method `AcceptInvitation()`

Usage

InvitationApi$AcceptInvitation(invitation, ...)

Method `AcceptInvitationWithHttpInfo()`

Usage

InvitationApi$AcceptInvitationWithHttpInfo(invitation, ...)

Method `CancelJoinOrganization()`

Usage

InvitationApi$CancelJoinOrganization(invitation, organization, ...)

Method `CancelJoinOrganizationWithHttpInfo()`

Usage

InvitationApi$CancelJoinOrganizationWithHttpInfo(invitation, organization, ...)

Method `CancelShareArrayByInvite()`

Usage

InvitationApi$CancelShareArrayByInvite(namespace, invitation, array, ...)

Method `CancelShareArrayByInviteWithHttpInfo()`

Usage

InvitationApi$CancelShareArrayByInviteWithHttpInfo(
  namespace,
  invitation,
  array,
  ...
)

Method `FetchInvitations()`

Usage

InvitationApi$FetchInvitations(
  organization = NULL,
  array = NULL,
  start = NULL,
  end = NULL,
  page = NULL,
  per.page = NULL,
  type = NULL,
  status = NULL,
  orderby = NULL,
  ...
)

Method `FetchInvitationsWithHttpInfo()`

Usage

InvitationApi$FetchInvitationsWithHttpInfo(
  organization = NULL,
  array = NULL,
  start = NULL,
  end = NULL,
  page = NULL,
  per.page = NULL,
  type = NULL,
  status = NULL,
  orderby = NULL,
  ...
)

Method `JoinOrganization()`

Usage

InvitationApi$JoinOrganization(organization, email.invite, ...)

Method `JoinOrganizationWithHttpInfo()`

Usage

InvitationApi$JoinOrganizationWithHttpInfo(organization, email.invite, ...)

Method `ShareArrayByInvite()`

Usage

InvitationApi$ShareArrayByInvite(namespace, array, email.invite, ...)

Method `ShareArrayByInviteWithHttpInfo()`

Usage

InvitationApi$ShareArrayByInviteWithHttpInfo(
  namespace,
  array,
  email.invite,
  ...
)

Method `clone()`

The objects of this class are cloneable with this method.

Usage

InvitationApi$clone(deep = FALSE)

Arguments

deep: Whether to make a deep clone.

Examples

if (FALSE) { # \dontrun{
####################  AcceptInvitation  ####################

library(tiledbcloud)
var.invitation <- 'invitation_example' # character | the ID of invitation about to be accepted

api.instance <- InvitationApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$AcceptInvitation(var.invitation)


####################  CancelJoinOrganization  ####################

library(tiledbcloud)
var.invitation <- 'invitation_example' # character | the ID of invitation about to be cancelled
var.organization <- 'organization_example' # character | name or UUID of organization

api.instance <- InvitationApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$CancelJoinOrganization(var.invitation, var.organization)


####################  CancelShareArrayByInvite  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.invitation <- 'invitation_example' # character | the ID of invitation about to be cancelled
var.array <- 'array_example' # character | name/uri of array that is url-encoded

api.instance <- InvitationApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$CancelShareArrayByInvite(var.namespace, var.invitation, var.array)


####################  FetchInvitations  ####################

library(tiledbcloud)
var.organization <- 'organization_example' # character | name or ID of organization to filter
var.array <- 'array_example' # character | name/uri of array that is url-encoded to filter
var.start <- 56 # integer | start time for tasks to filter by
var.end <- 56 # integer | end time for tasks to filter by
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.type <- 'type_example' # character | invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\"
var.status <- 'status_example' # character | Filter to only return \"PENDING\", \"ACCEPTED\"
var.orderby <- 'orderby_example' # character | sort by which field valid values include timestamp, array_name, organization_name

api.instance <- InvitationApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$FetchInvitations(organization=var.organization, array=var.array, start=var.start, end=var.end, page=var.page, per.page=var.per.page, type=var.type, status=var.status, orderby=var.orderby)


####################  JoinOrganization  ####################

library(tiledbcloud)
var.organization <- 'organization_example' # character | name or UUID of organization
var.email.invite <- InvitationOrganizationJoinEmail$new() # InvitationOrganizationJoinEmail | list of email recipients

api.instance <- InvitationApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$JoinOrganization(var.organization, var.email.invite)


####################  ShareArrayByInvite  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.email.invite <- InvitationArrayShareEmail$new() # InvitationArrayShareEmail | list of email recipients

api.instance <- InvitationApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ShareArrayByInvite(var.namespace, var.array, var.email.invite)


} # }