Package io.tiledb.cloud.rest_api.api

Class InvitationApi

  • public class InvitationApi
extends java.lang.Object

    • 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 java.lang.String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(java.lang.String customBaseUrl)

      • acceptInvitationCall

        public okhttp3.Call acceptInvitationCall​(java.lang.String invitation,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for acceptInvitation
        Parameters:
        invitation - the ID of invitation about to be accepted (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • acceptInvitation

        public void acceptInvitation​(java.lang.String invitation)
                      throws ApiException
        Accepts invitation
        Parameters:
        invitation - the ID of invitation about to be accepted (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • acceptInvitationWithHttpInfo

        public ApiResponse<java.lang.Void> acceptInvitationWithHttpInfo​(java.lang.String invitation)
                                                         throws ApiException
        Accepts invitation
        Parameters:
        invitation - the ID of invitation about to be accepted (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • acceptInvitationAsync

        public okhttp3.Call acceptInvitationAsync​(java.lang.String invitation,
                                          ApiCallback<java.lang.Void> _callback)
                                   throws ApiException
        (asynchronously) Accepts invitation
        Parameters:
        invitation - the ID of invitation about to be accepted (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

      • cancelJoinOrganizationCall

        public okhttp3.Call cancelJoinOrganizationCall​(java.lang.String invitation,
                                               java.lang.String organization,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for cancelJoinOrganization
        Parameters:
        invitation - the ID of invitation about to be cancelled (required)
        organization - name or UUID of organization (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • cancelJoinOrganization

        public void cancelJoinOrganization​(java.lang.String invitation,
                                   java.lang.String organization)
                            throws ApiException
        Cancels join organization invitation
        Parameters:
        invitation - the ID of invitation about to be cancelled (required)
        organization - name or UUID of organization (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • cancelJoinOrganizationWithHttpInfo

        public ApiResponse<java.lang.Void> cancelJoinOrganizationWithHttpInfo​(java.lang.String invitation,
                                                                      java.lang.String organization)
                                                               throws ApiException
        Cancels join organization invitation
        Parameters:
        invitation - the ID of invitation about to be cancelled (required)
        organization - name or UUID of organization (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • cancelJoinOrganizationAsync

        public okhttp3.Call cancelJoinOrganizationAsync​(java.lang.String invitation,
                                                java.lang.String organization,
                                                ApiCallback<java.lang.Void> _callback)
                                         throws ApiException
        (asynchronously) Cancels join organization invitation
        Parameters:
        invitation - the ID of invitation about to be cancelled (required)
        organization - name or UUID of organization (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

      • cancelShareArrayByInviteCall

        public okhttp3.Call cancelShareArrayByInviteCall​(java.lang.String namespace,
                                                 java.lang.String invitation,
                                                 java.lang.String array,
                                                 ApiCallback _callback)
                                          throws ApiException
        Build call for cancelShareArrayByInvite
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        invitation - the ID of invitation about to be cancelled (required)
        array - name/uri of array that is url-encoded (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • cancelShareArrayByInvite

        public void cancelShareArrayByInvite​(java.lang.String namespace,
                                     java.lang.String invitation,
                                     java.lang.String array)
                              throws ApiException
        Cancels array sharing invitation
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        invitation - the ID of invitation about to be cancelled (required)
        array - name/uri of array that is url-encoded (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • cancelShareArrayByInviteWithHttpInfo

        public ApiResponse<java.lang.Void> cancelShareArrayByInviteWithHttpInfo​(java.lang.String namespace,
                                                                        java.lang.String invitation,
                                                                        java.lang.String array)
                                                                 throws ApiException
        Cancels array sharing invitation
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        invitation - the ID of invitation about to be cancelled (required)
        array - name/uri of array that is url-encoded (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • cancelShareArrayByInviteAsync

        public okhttp3.Call cancelShareArrayByInviteAsync​(java.lang.String namespace,
                                                  java.lang.String invitation,
                                                  java.lang.String array,
                                                  ApiCallback<java.lang.Void> _callback)
                                           throws ApiException
        (asynchronously) Cancels array sharing invitation
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        invitation - the ID of invitation about to be cancelled (required)
        array - name/uri of array that is url-encoded (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

      • cancelShareGroupByInviteCall

        public okhttp3.Call cancelShareGroupByInviteCall​(java.lang.String namespace,
                                                 java.lang.String invitation,
                                                 java.lang.String groupName,
                                                 ApiCallback _callback)
                                          throws ApiException
        Build call for cancelShareGroupByInvite
        Parameters:
        namespace - namespace group is in (an organization name or user's username) (required)
        invitation - the ID of invitation about to be cancelled (required)
        groupName - name/uuid of group that is url-encoded (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • cancelShareGroupByInvite

        public void cancelShareGroupByInvite​(java.lang.String namespace,
                                     java.lang.String invitation,
                                     java.lang.String groupName)
                              throws ApiException
        Cancels group sharing invitation
        Parameters:
        namespace - namespace group is in (an organization name or user's username) (required)
        invitation - the ID of invitation about to be cancelled (required)
        groupName - name/uuid of group that is url-encoded (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • cancelShareGroupByInviteWithHttpInfo

        public ApiResponse<java.lang.Void> cancelShareGroupByInviteWithHttpInfo​(java.lang.String namespace,
                                                                        java.lang.String invitation,
                                                                        java.lang.String groupName)
                                                                 throws ApiException
        Cancels group sharing invitation
        Parameters:
        namespace - namespace group is in (an organization name or user's username) (required)
        invitation - the ID of invitation about to be cancelled (required)
        groupName - name/uuid of group that is url-encoded (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • cancelShareGroupByInviteAsync

        public okhttp3.Call cancelShareGroupByInviteAsync​(java.lang.String namespace,
                                                  java.lang.String invitation,
                                                  java.lang.String groupName,
                                                  ApiCallback<java.lang.Void> _callback)
                                           throws ApiException
        (asynchronously) Cancels group sharing invitation
        Parameters:
        namespace - namespace group is in (an organization name or user's username) (required)
        invitation - the ID of invitation about to be cancelled (required)
        groupName - name/uuid of group that is url-encoded (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

      • fetchInvitationsCall

        public okhttp3.Call fetchInvitationsCall​(java.lang.String organization,
                                         java.lang.String array,
                                         java.lang.String group,
                                         java.lang.Integer start,
                                         java.lang.Integer end,
                                         java.lang.Integer page,
                                         java.lang.Integer perPage,
                                         java.lang.String type,
                                         java.lang.String status,
                                         java.lang.String orderby,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for fetchInvitations
        Parameters:
        organization - name or ID of organization to filter (optional)
        array - name/uri of array that is url-encoded to filter (optional)
        group - name or ID of group to filter (optional)
        start - start time for tasks to filter by (optional)
        end - end time for tasks to filter by (optional)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        type - invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" (optional)
        status - Filter to only return \"PENDING\", \"ACCEPTED\" (optional)
        orderby - sort by which field valid values include timestamp, array_name, organization_name (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • fetchInvitations

        public InvitationData fetchInvitations​(java.lang.String organization,
                                       java.lang.String array,
                                       java.lang.String group,
                                       java.lang.Integer start,
                                       java.lang.Integer end,
                                       java.lang.Integer page,
                                       java.lang.Integer perPage,
                                       java.lang.String type,
                                       java.lang.String status,
                                       java.lang.String orderby)
                                throws ApiException
        Fetch a list of invitations
        Parameters:
        organization - name or ID of organization to filter (optional)
        array - name/uri of array that is url-encoded to filter (optional)
        group - name or ID of group to filter (optional)
        start - start time for tasks to filter by (optional)
        end - end time for tasks to filter by (optional)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        type - invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" (optional)
        status - Filter to only return \"PENDING\", \"ACCEPTED\" (optional)
        orderby - sort by which field valid values include timestamp, array_name, organization_name (optional)
        Returns:
        InvitationData
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • fetchInvitationsWithHttpInfo

        public ApiResponse<InvitationData> fetchInvitationsWithHttpInfo​(java.lang.String organization,
                                                                java.lang.String array,
                                                                java.lang.String group,
                                                                java.lang.Integer start,
                                                                java.lang.Integer end,
                                                                java.lang.Integer page,
                                                                java.lang.Integer perPage,
                                                                java.lang.String type,
                                                                java.lang.String status,
                                                                java.lang.String orderby)
                                                         throws ApiException
        Fetch a list of invitations
        Parameters:
        organization - name or ID of organization to filter (optional)
        array - name/uri of array that is url-encoded to filter (optional)
        group - name or ID of group to filter (optional)
        start - start time for tasks to filter by (optional)
        end - end time for tasks to filter by (optional)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        type - invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" (optional)
        status - Filter to only return \"PENDING\", \"ACCEPTED\" (optional)
        orderby - sort by which field valid values include timestamp, array_name, organization_name (optional)
        Returns:
        ApiResponse<InvitationData>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • fetchInvitationsAsync

        public okhttp3.Call fetchInvitationsAsync​(java.lang.String organization,
                                          java.lang.String array,
                                          java.lang.String group,
                                          java.lang.Integer start,
                                          java.lang.Integer end,
                                          java.lang.Integer page,
                                          java.lang.Integer perPage,
                                          java.lang.String type,
                                          java.lang.String status,
                                          java.lang.String orderby,
                                          ApiCallback<InvitationData> _callback)
                                   throws ApiException
        (asynchronously) Fetch a list of invitations
        Parameters:
        organization - name or ID of organization to filter (optional)
        array - name/uri of array that is url-encoded to filter (optional)
        group - name or ID of group to filter (optional)
        start - start time for tasks to filter by (optional)
        end - end time for tasks to filter by (optional)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        type - invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" (optional)
        status - Filter to only return \"PENDING\", \"ACCEPTED\" (optional)
        orderby - sort by which field valid values include timestamp, array_name, organization_name (optional)
        _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

      • joinOrganizationCall

        public okhttp3.Call joinOrganizationCall​(java.lang.String organization,
                                         InvitationOrganizationJoinEmail emailInvite,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for joinOrganization
        Parameters:
        organization - name or UUID of organization (required)
        emailInvite - list of email recipients (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • joinOrganization

        public void joinOrganization​(java.lang.String organization,
                             InvitationOrganizationJoinEmail emailInvite)
                      throws ApiException
        Sends email to multiple recipients with joining information regarding an organization
        Parameters:
        organization - name or UUID of organization (required)
        emailInvite - list of email recipients (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • joinOrganizationWithHttpInfo

        public ApiResponse<java.lang.Void> joinOrganizationWithHttpInfo​(java.lang.String organization,
                                                                InvitationOrganizationJoinEmail emailInvite)
                                                         throws ApiException
        Sends email to multiple recipients with joining information regarding an organization
        Parameters:
        organization - name or UUID of organization (required)
        emailInvite - list of email recipients (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • joinOrganizationAsync

        public okhttp3.Call joinOrganizationAsync​(java.lang.String organization,
                                          InvitationOrganizationJoinEmail emailInvite,
                                          ApiCallback<java.lang.Void> _callback)
                                   throws ApiException
        (asynchronously) Sends email to multiple recipients with joining information regarding an organization
        Parameters:
        organization - name or UUID of organization (required)
        emailInvite - list of email recipients (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

      • shareArrayByInviteCall

        public okhttp3.Call shareArrayByInviteCall​(java.lang.String namespace,
                                           java.lang.String array,
                                           InvitationArrayShareEmail emailInvite,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for shareArrayByInvite
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        emailInvite - list of email recipients (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • shareArrayByInvite

        public void shareArrayByInvite​(java.lang.String namespace,
                               java.lang.String array,
                               InvitationArrayShareEmail emailInvite)
                        throws ApiException
        Sends email to multiple recipients with sharing information regarding an array
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        emailInvite - list of email recipients (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • shareArrayByInviteWithHttpInfo

        public ApiResponse<java.lang.Void> shareArrayByInviteWithHttpInfo​(java.lang.String namespace,
                                                                  java.lang.String array,
                                                                  InvitationArrayShareEmail emailInvite)
                                                           throws ApiException
        Sends email to multiple recipients with sharing information regarding an array
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        emailInvite - list of email recipients (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • shareArrayByInviteAsync

        public okhttp3.Call shareArrayByInviteAsync​(java.lang.String namespace,
                                            java.lang.String array,
                                            InvitationArrayShareEmail emailInvite,
                                            ApiCallback<java.lang.Void> _callback)
                                     throws ApiException
        (asynchronously) Sends email to multiple recipients with sharing information regarding an array
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        emailInvite - list of email recipients (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

      • shareGroupByInviteCall

        public okhttp3.Call shareGroupByInviteCall​(java.lang.String namespace,
                                           java.lang.String group,
                                           InvitationGroupShareEmail emailInvite,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for shareGroupByInvite
        Parameters:
        namespace - namespace group is in (an organization name or user's username) (required)
        group - name/uri of group that is url-encoded (required)
        emailInvite - list of email/namespace recipients (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • shareGroupByInvite

        public void shareGroupByInvite​(java.lang.String namespace,
                               java.lang.String group,
                               InvitationGroupShareEmail emailInvite)
                        throws ApiException
        Sends email to multiple recipients with sharing information regarding a group
        Parameters:
        namespace - namespace group is in (an organization name or user's username) (required)
        group - name/uri of group that is url-encoded (required)
        emailInvite - list of email/namespace recipients (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • shareGroupByInviteWithHttpInfo

        public ApiResponse<java.lang.Void> shareGroupByInviteWithHttpInfo​(java.lang.String namespace,
                                                                  java.lang.String group,
                                                                  InvitationGroupShareEmail emailInvite)
                                                           throws ApiException
        Sends email to multiple recipients with sharing information regarding a group
        Parameters:
        namespace - namespace group is in (an organization name or user's username) (required)
        group - name/uri of group that is url-encoded (required)
        emailInvite - list of email/namespace recipients (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • shareGroupByInviteAsync

        public okhttp3.Call shareGroupByInviteAsync​(java.lang.String namespace,
                                            java.lang.String group,
                                            InvitationGroupShareEmail emailInvite,
                                            ApiCallback<java.lang.Void> _callback)
                                     throws ApiException
        (asynchronously) Sends email to multiple recipients with sharing information regarding a group
        Parameters:
        namespace - namespace group is in (an organization name or user's username) (required)
        group - name/uri of group that is url-encoded (required)
        emailInvite - list of email/namespace recipients (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