Package com.docusign.admin.api

Class BulkImportsApi

  • public class BulkImportsApi
extends Object
    BulkImportsApi class.

    • Constructor Detail

      • BulkImportsApi

        public BulkImportsApi()
        BulkImportsApi.

      • BulkImportsApi

        public BulkImportsApi​(ApiClient apiClient)
        BulkImportsApi.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        getApiClient Method.
        Returns:
        ApiClient

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        setApiClient Method.

      • addBulkAccountSettingsImport

        public OrganizationAccountSettingsImportResponse addBulkAccountSettingsImport​(UUID organizationId,
                                                                              byte[] fileCsv)
                                                                       throws ApiException
        Creates a new account settings import request.. Required scopes: account_write
        Parameters:
        organizationId - The organization ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationAccountSettingsImportResponse
        Throws:
        ApiException - if fails to make API call

      • addBulkAccountSettingsImportWithHttpInfo

        public ApiResponse<OrganizationAccountSettingsImportResponse> addBulkAccountSettingsImportWithHttpInfo​(UUID organizationId,
                                                                                                       byte[] fileCsv)
                                                                                                throws ApiException
        Creates a new account settings import request. Required scopes: account_write
        Parameters:
        organizationId - The organization ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationAccountSettingsImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportAddUsersRequest

        public OrganizationImportResponse createBulkImportAddUsersRequest​(UUID organizationId,
                                                                  byte[] fileCsv)
                                                           throws ApiException
        Import request for adding users to accounts within the organization.. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportAddUsersRequestWithHttpInfo

        public ApiResponse<OrganizationImportResponse> createBulkImportAddUsersRequestWithHttpInfo​(UUID organizationId,
                                                                                           byte[] fileCsv)
                                                                                    throws ApiException
        Import request for adding users to accounts within the organization. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportCloseUsersRequest

        public OrganizationImportResponse createBulkImportCloseUsersRequest​(UUID organizationId,
                                                                    byte[] fileCsv)
                                                             throws ApiException
        Closes the Bulk User Import request. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportCloseUsersRequestWithHttpInfo

        public ApiResponse<OrganizationImportResponse> createBulkImportCloseUsersRequestWithHttpInfo​(UUID organizationId,
                                                                                             byte[] fileCsv)
                                                                                      throws ApiException
        Closes the Bulk User Import request Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportExternalCloseUsersRequest

        public OrganizationImportResponse createBulkImportExternalCloseUsersRequest​(UUID organizationId)
                                                                     throws ApiException
        Closes memberships which are not in an account which is part of the organization, but which do have email addresses which are @ a verified reserved web domain which belongs to the organization. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportExternalCloseUsersRequestWithHttpInfo

        public ApiResponse<OrganizationImportResponse> createBulkImportExternalCloseUsersRequestWithHttpInfo​(UUID organizationId)
                                                                                              throws ApiException
        Closes memberships which are not in an account which is part of the organization, but which do have email addresses which are @ a verified reserved web domain which belongs to the organization Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportSingleAccountAddUsersRequest

        public OrganizationImportResponse createBulkImportSingleAccountAddUsersRequest​(UUID organizationId,
                                                                               UUID accountId,
                                                                               byte[] fileCsv)
                                                                        throws ApiException
        Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId column. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        accountId - The account ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportSingleAccountAddUsersRequestWithHttpInfo

        public ApiResponse<OrganizationImportResponse> createBulkImportSingleAccountAddUsersRequestWithHttpInfo​(UUID organizationId,
                                                                                                        UUID accountId,
                                                                                                        byte[] fileCsv)
                                                                                                 throws ApiException
        Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId column Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        accountId - The account ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportSingleAccountUpdateUsersRequest

        public OrganizationImportResponse createBulkImportSingleAccountUpdateUsersRequest​(UUID organizationId,
                                                                                  UUID accountId,
                                                                                  byte[] fileCsv)
                                                                           throws ApiException
        Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId column. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        accountId - The account ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportSingleAccountUpdateUsersRequestWithHttpInfo

        public ApiResponse<OrganizationImportResponse> createBulkImportSingleAccountUpdateUsersRequestWithHttpInfo​(UUID organizationId,
                                                                                                           UUID accountId,
                                                                                                           byte[] fileCsv)
                                                                                                    throws ApiException
        Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId column Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        accountId - The account ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportUpdateUsersRequest

        public OrganizationImportResponse createBulkImportUpdateUsersRequest​(UUID organizationId,
                                                                     byte[] fileCsv)
                                                              throws ApiException
        Import request for updating users to accounts within the organization.. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • createBulkImportUpdateUsersRequestWithHttpInfo

        public ApiResponse<OrganizationImportResponse> createBulkImportUpdateUsersRequestWithHttpInfo​(UUID organizationId,
                                                                                              byte[] fileCsv)
                                                                                       throws ApiException
        Import request for updating users to accounts within the organization. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        fileCsv - CSV file. (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • deleteBulkAccountSettingsImport

        public Object deleteBulkAccountSettingsImport​(UUID organizationId,
                                              UUID importId)
                                       throws ApiException
        Deletes a Bulk Account Settings Import request. Required scopes: account_write
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        Object
        Throws:
        ApiException - if fails to make API call

      • deleteBulkAccountSettingsImportWithHttpInfo

        public ApiResponse<Object> deleteBulkAccountSettingsImportWithHttpInfo​(UUID organizationId,
                                                                       UUID importId)
                                                                throws ApiException
        Deletes a Bulk Account Settings Import request Required scopes: account_write
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        Object
        Throws:
        ApiException - if fails to make API call

      • deleteBulkUserImport

        public Object deleteBulkUserImport​(UUID organizationId,
                                   UUID importId)
                            throws ApiException
        Deletes a User Import request. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        Object
        Throws:
        ApiException - if fails to make API call

      • deleteBulkUserImportWithHttpInfo

        public ApiResponse<Object> deleteBulkUserImportWithHttpInfo​(UUID organizationId,
                                                            UUID importId)
                                                     throws ApiException
        Deletes a User Import request Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        Object
        Throws:
        ApiException - if fails to make API call

      • getBulkAccountSettingsImport

        public OrganizationAccountSettingsImportResponse getBulkAccountSettingsImport​(UUID organizationId,
                                                                              UUID importId)
                                                                       throws ApiException
        Returns the details/metadata for a Bulk Account Settings Import request. Required scopes: account_read
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        OrganizationAccountSettingsImportResponse
        Throws:
        ApiException - if fails to make API call

      • getBulkAccountSettingsImportWithHttpInfo

        public ApiResponse<OrganizationAccountSettingsImportResponse> getBulkAccountSettingsImportWithHttpInfo​(UUID organizationId,
                                                                                                       UUID importId)
                                                                                                throws ApiException
        Returns the details/metadata for a Bulk Account Settings Import request Required scopes: account_read
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        OrganizationAccountSettingsImportResponse
        Throws:
        ApiException - if fails to make API call

      • getBulkAccountSettingsImports

        public List<OrganizationAccountSettingsImportResponse> getBulkAccountSettingsImports​(UUID organizationId)
                                                                              throws ApiException
        Returns the details/metadata for Bulk Account Settings Import requests in the organization. Required scopes: account_read
        Parameters:
        organizationId - The organization ID Guid (required)
        Returns:
        java.util.List<OrganizationAccountSettingsImportResponse>
        Throws:
        ApiException - if fails to make API call

      • getBulkAccountSettingsImportsWithHttpInfo

        public ApiResponse<List<OrganizationAccountSettingsImportResponse>> getBulkAccountSettingsImportsWithHttpInfo​(UUID organizationId)
                                                                                                       throws ApiException
        Returns the details/metadata for Bulk Account Settings Import requests in the organization Required scopes: account_read
        Parameters:
        organizationId - The organization ID Guid (required)
        Returns:
        java.util.List<OrganizationAccountSettingsImportResponse>
        Throws:
        ApiException - if fails to make API call

      • getBulkUserImportCSV

        public Object getBulkUserImportCSV​(UUID organizationId,
                                   UUID importId)
                            throws ApiException
        Returns a text/csv file with user details for a User Import request. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        Object
        Throws:
        ApiException - if fails to make API call

      • getBulkUserImportCSVWithHttpInfo

        public ApiResponse<Object> getBulkUserImportCSVWithHttpInfo​(UUID organizationId,
                                                            UUID importId)
                                                     throws ApiException
        Returns a text/csv file with user details for a User Import request Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        Object
        Throws:
        ApiException - if fails to make API call

      • getBulkUserImportRequest

        public OrganizationImportResponse getBulkUserImportRequest​(UUID organizationId,
                                                           UUID importId)
                                                    throws ApiException
        Returns the details/metadata for a User Import request. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • getBulkUserImportRequestWithHttpInfo

        public ApiResponse<OrganizationImportResponse> getBulkUserImportRequestWithHttpInfo​(UUID organizationId,
                                                                                    UUID importId)
                                                                             throws ApiException
        Returns the details/metadata for a User Import request Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        importId - The import ID Guid for the request (required)
        Returns:
        OrganizationImportResponse
        Throws:
        ApiException - if fails to make API call

      • getBulkUserImportRequests

        public OrganizationImportsResponse getBulkUserImportRequests​(UUID organizationId)
                                                      throws ApiException
        Returns the details/metadata for Bulk User Import requests in the organization. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        Returns:
        OrganizationImportsResponse
        Throws:
        ApiException - if fails to make API call

      • getBulkUserImportRequestsWithHttpInfo

        public ApiResponse<OrganizationImportsResponse> getBulkUserImportRequestsWithHttpInfo​(UUID organizationId)
                                                                               throws ApiException
        Returns the details/metadata for Bulk User Import requests in the organization Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        Returns:
        OrganizationImportsResponse
        Throws:
        ApiException - if fails to make API call