com.docusign.admin.api

Class BulkExportsApi

java.lang.Object

com.docusign.admin.api.BulkExportsApi

public class BulkExportsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BulkExportsApi()
BulkExportsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
OrganizationExportResponse	createAccountSettingsExport(UUID organizationId, OrganizationAccountsRequest request) Creates a new Account Setting Export request.
OrganizationExportResponse	createUserListExport(UUID organizationId, OrganizationExportRequest request) Creates a new User List Export request.
Object	deleteAccountSettingsExport(UUID organizationId, UUID exportId) Deletes a single Account Settings Export request Required scopes: account_read
Object	deleteUserListExport(UUID organizationId, UUID exportId) Deletes a single User List Export request Required scopes: user_read
OrganizationExportResponse	getAccountSettingsExport(UUID organizationId, UUID exportId) Returns the details/metadata for a single Account Setting Export request Required scopes: account_read
OrganizationExportsResponse	getAccountSettingsExports(UUID organizationId) Returns the details/metadata for Account Setting Export requests Required scopes: account_read
ApiClient	getApiClient()
OrganizationExportResponse	getUserListExport(UUID organizationId, UUID exportId) Returns the details/metadata for a single User List Export request Required scopes: user_read
OrganizationExportsResponse	getUserListExports(UUID organizationId) Returns a list of existing User List Exports (requests and completed exports) and their details/metadata 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

BulkExportsApi

public BulkExportsApi()

BulkExportsApi

public BulkExportsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createAccountSettingsExport

public OrganizationExportResponse createAccountSettingsExport(UUID organizationId,
                                                              OrganizationAccountsRequest request)
                                                       throws ApiException

Creates a new Account Setting Export request. Required scopes: account_read

Parameters:

organizationId - The organization ID Guid (required)

request - Request body containing details about the accounts be compared (required)

Returns:

OrganizationExportResponse

Throws:

ApiException - if fails to make API call

createUserListExport

public OrganizationExportResponse createUserListExport(UUID organizationId,
                                                       OrganizationExportRequest request)
                                                throws ApiException

Creates a new User List Export request. Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

request - Request body containing details about what is to be exported (required)

Returns:

OrganizationExportResponse

Throws:

ApiException - if fails to make API call

deleteAccountSettingsExport

public Object deleteAccountSettingsExport(UUID organizationId,
                                          UUID exportId)
                                   throws ApiException

Deletes a single Account Settings Export request Required scopes: account_read

Parameters:

organizationId - The organization ID Guid (required)

exportId - The export ID Guid for the request (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

deleteUserListExport

public Object deleteUserListExport(UUID organizationId,
                                   UUID exportId)
                            throws ApiException

Deletes a single User List Export request Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

exportId - The export ID Guid for the request (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

getAccountSettingsExport

public OrganizationExportResponse getAccountSettingsExport(UUID organizationId,
                                                           UUID exportId)
                                                    throws ApiException

Returns the details/metadata for a single Account Setting Export request Required scopes: account_read

Parameters:

organizationId - The organization ID Guid (required)

exportId - The export ID Guid for the request (required)

Returns:

OrganizationExportResponse

Throws:

ApiException - if fails to make API call

getAccountSettingsExports

public OrganizationExportsResponse getAccountSettingsExports(UUID organizationId)
                                                      throws ApiException

Returns the details/metadata for Account Setting Export requests Required scopes: account_read

Parameters:

organizationId - The organization ID Guid (required)

Returns:

OrganizationExportsResponse

Throws:

ApiException - if fails to make API call

getUserListExport

public OrganizationExportResponse getUserListExport(UUID organizationId,
                                                    UUID exportId)
                                             throws ApiException

Returns the details/metadata for a single User List Export request Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

exportId - The export ID Guid for the request (required)

Returns:

OrganizationExportResponse

Throws:

ApiException - if fails to make API call

getUserListExports

public OrganizationExportsResponse getUserListExports(UUID organizationId)
                                               throws ApiException

Returns a list of existing User List Exports (requests and completed exports) and their details/metadata Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

Returns:

OrganizationExportsResponse

Throws:

ApiException - if fails to make API call