Package org.openapitools.client.api

Class OrganizationApi

  • public class OrganizationApi
extends Object

    • Constructor Detail

      • OrganizationApi

        public OrganizationApi()

      • OrganizationApi

        public OrganizationApi​(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)

      • createOrganizationCall

        public okhttp3.Call createOrganizationCall​(CreateOrganizationData createOrganizationData,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for createOrganization
        Parameters:
        createOrganizationData - The organization data that you want to create (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
        200 Created organization object -
        400 Service error relating to creating the organization -

      • createOrganization

        public Organization createOrganization​(CreateOrganizationData createOrganizationData)
                                throws ApiException
        Create Organization Create Organization Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
        Parameters:
        createOrganizationData - The organization data that you want to create (required)
        Returns:
        Organization
        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
        200 Created organization object -
        400 Service error relating to creating the organization -

      • createOrganizationWithHttpInfo

        public ApiResponse<Organization> createOrganizationWithHttpInfo​(@NotNull
                                                                @NotNull CreateOrganizationData createOrganizationData)
                                                         throws ApiException
        Create Organization Create Organization Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
        Parameters:
        createOrganizationData - The organization data that you want to create (required)
        Returns:
        ApiResponse<Organization>
        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
        200 Created organization object -
        400 Service error relating to creating the organization -

      • createOrganizationAsync

        public okhttp3.Call createOrganizationAsync​(CreateOrganizationData createOrganizationData,
                                            ApiCallback<Organization> _callback)
                                     throws ApiException
        Create Organization (asynchronously) Create Organization Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
        Parameters:
        createOrganizationData - The organization data that you want to create (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
        200 Created organization object -
        400 Service error relating to creating the organization -

      • deleteOrganizationByIdCall

        public okhttp3.Call deleteOrganizationByIdCall​(String trOrganization,
                                               UUID organizationId,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for deleteOrganizationById
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch. (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
        200 Confirmation that the organization was deleted -
        400 Service error relating to deleting the organization by id -

      • deleteOrganizationById

        public Organization deleteOrganizationById​(String trOrganization,
                                           UUID organizationId)
                                    throws ApiException
        Delete Organization Delete Organization Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch. (required)
        Returns:
        Organization
        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
        200 Confirmation that the organization was deleted -
        400 Service error relating to deleting the organization by id -

      • deleteOrganizationByIdWithHttpInfo

        public ApiResponse<Organization> deleteOrganizationByIdWithHttpInfo​(@NotNull
                                                                    @NotNull String trOrganization,
                                                                    @NotNull
                                                                    @NotNull UUID organizationId)
                                                             throws ApiException
        Delete Organization Delete Organization Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch. (required)
        Returns:
        ApiResponse<Organization>
        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
        200 Confirmation that the organization was deleted -
        400 Service error relating to deleting the organization by id -

      • deleteOrganizationByIdAsync

        public okhttp3.Call deleteOrganizationByIdAsync​(String trOrganization,
                                                UUID organizationId,
                                                ApiCallback<Organization> _callback)
                                         throws ApiException
        Delete Organization (asynchronously) Delete Organization Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch. (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
        200 Confirmation that the organization was deleted -
        400 Service error relating to deleting the organization by id -

      • getOrganizationByIdCall

        public okhttp3.Call getOrganizationByIdCall​(String trOrganization,
                                            UUID organizationId,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for getOrganizationById
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch. (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
        200 Organization with the id that was requested -
        400 Service error relating to finding the organization by id -

      • getOrganizationById

        public Organization getOrganizationById​(String trOrganization,
                                        UUID organizationId)
                                 throws ApiException
        Get Organization Get Organization Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch. (required)
        Returns:
        Organization
        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
        200 Organization with the id that was requested -
        400 Service error relating to finding the organization by id -

      • getOrganizationByIdWithHttpInfo

        public ApiResponse<Organization> getOrganizationByIdWithHttpInfo​(@NotNull
                                                                 @NotNull String trOrganization,
                                                                 @NotNull
                                                                 @NotNull UUID organizationId)
                                                          throws ApiException
        Get Organization Get Organization Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch. (required)
        Returns:
        ApiResponse<Organization>
        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
        200 Organization with the id that was requested -
        400 Service error relating to finding the organization by id -

      • getOrganizationByIdAsync

        public okhttp3.Call getOrganizationByIdAsync​(String trOrganization,
                                             UUID organizationId,
                                             ApiCallback<Organization> _callback)
                                      throws ApiException
        Get Organization (asynchronously) Get Organization Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch. (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
        200 Organization with the id that was requested -
        400 Service error relating to finding the organization by id -

      • getOrganizationUsageCall

        public okhttp3.Call getOrganizationUsageCall​(String trOrganization,
                                             UUID organizationId,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for getOrganizationUsage
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch the usage of. (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
        200 The current usage of the specified organization -
        400 Service error relating to finding the organization's usage by id -

      • getOrganizationUsage

        public OrganizationUsageCount getOrganizationUsage​(String trOrganization,
                                                   UUID organizationId)
                                            throws ApiException
        Get Organization Usage Get Organization Usage Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch the usage of. (required)
        Returns:
        OrganizationUsageCount
        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
        200 The current usage of the specified organization -
        400 Service error relating to finding the organization's usage by id -

      • getOrganizationUsageWithHttpInfo

        public ApiResponse<OrganizationUsageCount> getOrganizationUsageWithHttpInfo​(@NotNull
                                                                            @NotNull String trOrganization,
                                                                            @NotNull
                                                                            @NotNull UUID organizationId)
                                                                     throws ApiException
        Get Organization Usage Get Organization Usage Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch the usage of. (required)
        Returns:
        ApiResponse<OrganizationUsageCount>
        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
        200 The current usage of the specified organization -
        400 Service error relating to finding the organization's usage by id -

      • getOrganizationUsageAsync

        public okhttp3.Call getOrganizationUsageAsync​(String trOrganization,
                                              UUID organizationId,
                                              ApiCallback<OrganizationUsageCount> _callback)
                                       throws ApiException
        Get Organization Usage (asynchronously) Get Organization Usage Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch the usage of. (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
        200 The current usage of the specified organization -
        400 Service error relating to finding the organization's usage by id -

      • getOrganizationUsersCall

        public okhttp3.Call getOrganizationUsersCall​(String trOrganization,
                                             UUID organizationId,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for getOrganizationUsers
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch the users of. (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
        200 Array of users who belong to the specified by organization -
        400 Service error relating to finding the organization's users by id -

      • getOrganizationUsers

        public List<SlimUser> getOrganizationUsers​(String trOrganization,
                                           UUID organizationId)
                                    throws ApiException
        Get Organization Users Get Organization Users Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch the users of. (required)
        Returns:
        List<SlimUser>
        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
        200 Array of users who belong to the specified by organization -
        400 Service error relating to finding the organization's users by id -

      • getOrganizationUsersWithHttpInfo

        public ApiResponse<List<SlimUser>> getOrganizationUsersWithHttpInfo​(@NotNull
                                                                    @NotNull String trOrganization,
                                                                    @NotNull
                                                                    @NotNull UUID organizationId)
                                                             throws ApiException
        Get Organization Users Get Organization Users Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch the users of. (required)
        Returns:
        ApiResponse<List<SlimUser>>
        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
        200 Array of users who belong to the specified by organization -
        400 Service error relating to finding the organization's users by id -

      • getOrganizationUsersAsync

        public okhttp3.Call getOrganizationUsersAsync​(String trOrganization,
                                              UUID organizationId,
                                              ApiCallback<List<SlimUser>> _callback)
                                       throws ApiException
        Get Organization Users (asynchronously) Get Organization Users Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        organizationId - The id of the organization you want to fetch the users of. (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
        200 Array of users who belong to the specified by organization -
        400 Service error relating to finding the organization's users by id -

      • updateOrganizationCall

        public okhttp3.Call updateOrganizationCall​(String trOrganization,
                                           UpdateOrganizationData updateOrganizationData,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for updateOrganization
        Parameters:
        trOrganization - The organization id to use for the request (required)
        updateOrganizationData - The organization data that you want to update (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
        200 Updated organization object -
        400 Service error relating to updating the organization -

      • updateOrganization

        public Organization updateOrganization​(String trOrganization,
                                       UpdateOrganizationData updateOrganizationData)
                                throws ApiException
        Update Organization Update Organization Update an organization. Only the owner of the organization can update it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        updateOrganizationData - The organization data that you want to update (required)
        Returns:
        Organization
        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
        200 Updated organization object -
        400 Service error relating to updating the organization -

      • updateOrganizationWithHttpInfo

        public ApiResponse<Organization> updateOrganizationWithHttpInfo​(@NotNull
                                                                @NotNull String trOrganization,
                                                                @NotNull
                                                                @NotNull UpdateOrganizationData updateOrganizationData)
                                                         throws ApiException
        Update Organization Update Organization Update an organization. Only the owner of the organization can update it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        updateOrganizationData - The organization data that you want to update (required)
        Returns:
        ApiResponse<Organization>
        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
        200 Updated organization object -
        400 Service error relating to updating the organization -

      • updateOrganizationAsync

        public okhttp3.Call updateOrganizationAsync​(String trOrganization,
                                            UpdateOrganizationData updateOrganizationData,
                                            ApiCallback<Organization> _callback)
                                     throws ApiException
        Update Organization (asynchronously) Update Organization Update an organization. Only the owner of the organization can update it.
        Parameters:
        trOrganization - The organization id to use for the request (required)
        updateOrganizationData - The organization data that you want to update (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
        200 Updated organization object -
        400 Service error relating to updating the organization -