com.docusign.admin.api

Class BulkImportsApi

java.lang.Object

com.docusign.admin.api.BulkImportsApi

public class BulkImportsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BulkImportsApi()
BulkImportsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
OrganizationAccountSettingsImportResponse	addBulkAccountSettingsImport(UUID organizationId, byte[] fileCsv) Creates a new account settings import request.
OrganizationImportResponse	createBulkImportAddUsersRequest(UUID organizationId, byte[] fileCsv) Import request for adding users to accounts within the organization.
OrganizationImportResponse	createBulkImportCloseUsersRequest(UUID organizationId) Closes the Bulk User Import request Required scopes: user_write
OrganizationImportResponse	createBulkImportExternalCloseUsersRequest(UUID organizationId) 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
OrganizationImportResponse	createBulkImportSingleAccountAddUsersRequest(UUID organizationId, UUID accountId, byte[] fileCsv) Import request for adding user to a single account within the organization.
OrganizationImportResponse	createBulkImportSingleAccountUpdateUsersRequest(UUID organizationId, UUID accountId, byte[] fileCsv) Import request for updating users for a single account within the organization.
OrganizationImportResponse	createBulkImportUpdateUsersRequest(UUID organizationId, byte[] fileCsv) Import request for updating users to accounts within the organization.
Object	deleteBulkAccountSettingsImport(UUID organizationId, UUID importId) Deletes a Bulk Account Settings Import request Required scopes: account_write
Object	deleteBulkUserImport(UUID organizationId, UUID importId) Deletes a User Import request Required scopes: user_write
ApiClient	getApiClient()
OrganizationAccountSettingsImportResponse	getBulkAccountSettingsImport(UUID organizationId, UUID importId) Returns the details/metadata for a Bulk Account Settings Import request Required scopes: account_read
List<OrganizationAccountSettingsImportResponse>	getBulkAccountSettingsImports(UUID organizationId) Returns the details/metadata for Bulk Account Settings Import requests in the organization Required scopes: account_read
Object	getBulkUserImportCSV(UUID organizationId, UUID importId) Returns a text/csv file with user details for a User Import request Required scopes: user_read
OrganizationImportResponse	getBulkUserImportRequest(UUID organizationId, UUID importId) Returns the details/metadata for a User Import request Required scopes: user_read
OrganizationImportsResponse	getBulkUserImportRequests(UUID organizationId) Returns the details/metadata for Bulk User Import requests in the organization Required scopes: user_read
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BulkImportsApi

public BulkImportsApi()

BulkImportsApi

public BulkImportsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

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

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

createBulkImportCloseUsersRequest

public OrganizationImportResponse createBulkImportCloseUsersRequest(UUID organizationId)
                                                             throws ApiException

Closes the Bulk User Import request Required scopes: user_write

Parameters:

organizationId - The organization ID Guid (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

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

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

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

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

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

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

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

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

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

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