DocuSign.eSign.Api.OrganizationsApi Class Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.OrganizationsApi:

Public Member Functions
	OrganizationsApi (DocuSignClient aplClient)
	Initializes a new instance of the OrganizationsApi class using AplClient object More...
String	GetBasePath ()
	Gets the base path of the API client. More...
void	GetReportV2 (string organizationId, string reportCorrelationId)
	Retrieves org level report by correlation id and site. More...
ApiResponse< Object >	GetReportV2WithHttpInfo (string organizationId, string reportCorrelationId)
	Retrieves org level report by correlation id and site. More...
async System.Threading.Tasks.Task	GetReportV2Async (string organizationId, string reportCorrelationId)
	Retrieves org level report by correlation id and site. More...
async System.Threading.Tasks.Task< ApiResponse< Object > >	GetReportV2AsyncWithHttpInfo (string organizationId, string reportCorrelationId)
	Retrieves org level report by correlation id and site. More...

Properties
DocuSignClient	ApiClient [get, set]
	Gets or sets the ApiClient object More...
DocuSign.eSign.Client.ExceptionFactory	ExceptionFactory [get, set]
	Provides a factory method hook for the creation of exceptions. More...
Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient [get, set]
	Gets or sets the ApiClient object More...
ExceptionFactory	ExceptionFactory [get, set]
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

OrganizationsApi()

DocuSign.eSign.Api.OrganizationsApi.OrganizationsApi ( DocuSignClient  aplClient )

inline

Initializes a new instance of the OrganizationsApi class using AplClient object

Parameters

aplClient

An instance of AplClient

Returns

Member Function Documentation

GetBasePath()

String DocuSign.eSign.Api.OrganizationsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

GetReportV2()

void DocuSign.eSign.Api.OrganizationsApi.GetReportV2 ( string  organizationId, string  reportCorrelationId  )

inline

Retrieves org level report by correlation id and site.

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

organizationId
reportCorrelationId

Returns

Implements DocuSign.eSign.Api.IOrganizationsApi.

GetReportV2Async()

async System.Threading.Tasks.Task DocuSign.eSign.Api.OrganizationsApi.GetReportV2Async ( string  organizationId, string  reportCorrelationId  )

inline

Retrieves org level report by correlation id and site.

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

organizationId
reportCorrelationId

Returns

Task of void

Implements DocuSign.eSign.Api.IOrganizationsApi.

GetReportV2AsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.OrganizationsApi.GetReportV2AsyncWithHttpInfo ( string  organizationId, string  reportCorrelationId  )

inline

Retrieves org level report by correlation id and site.

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

organizationId
reportCorrelationId

Returns

Task of ApiResponse

Implements DocuSign.eSign.Api.IOrganizationsApi.

GetReportV2WithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.OrganizationsApi.GetReportV2WithHttpInfo ( string  organizationId, string  reportCorrelationId  )

inline

Retrieves org level report by correlation id and site.

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

organizationId
reportCorrelationId

Returns

ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IOrganizationsApi.

Property Documentation

ApiClient

DocuSignClient DocuSign.eSign.Api.OrganizationsApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.OrganizationsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

---

The documentation for this class was generated from the following file:

• sdk/src/DocuSign.eSign/Api/OrganizationsApi.cs