DocuSign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.BulkEnvelopeStatus Class Reference

BulkEnvelopeStatus More...

Inheritance diagram for DocuSign.eSign.Model.BulkEnvelopeStatus:

Public Member Functions

 BulkEnvelopeStatus (string BatchId=default(string), string BatchSize=default(string), List< BulkEnvelope > BulkEnvelopes=default(List< BulkEnvelope >), string BulkEnvelopesBatchUri=default(string), string EndPosition=default(string), string Failed=default(string), string NextUri=default(string), string PreviousUri=default(string), string Queued=default(string), string ResultSetSize=default(string), string Sent=default(string), string StartPosition=default(string), string SubmittedDate=default(string), string TotalSetSize=default(string))
 Initializes a new instance of the BulkEnvelopeStatus class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object obj)
 Returns true if objects are equal More...
 
bool Equals (BulkEnvelopeStatus other)
 Returns true if BulkEnvelopeStatus instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string BatchId [get, set]
 Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches. More...
 
string BatchSize [get, set]
 The number of items returned in this response. More...
 
List< BulkEnvelopeBulkEnvelopes [get, set]
 Reserved: TBD More...
 
string BulkEnvelopesBatchUri [get, set]
 Reserved: TBD More...
 
string EndPosition [get, set]
 The last position in the result set. More...
 
string Failed [get, set]
 The number of entries with a status of failed. More...
 
string NextUri [get, set]
 The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. More...
 
string PreviousUri [get, set]
 The postal code for the billing address. More...
 
string Queued [get, set]
 The number of entries with a status of queued. More...
 
string ResultSetSize [get, set]
 The number of results returned in this response. More...
 
string Sent [get, set]
 The number of entries with a status of sent. More...
 
string StartPosition [get, set]
 Starting position of the current result set. More...
 
string SubmittedDate [get, set]
 Gets or Sets SubmittedDate More...
 
string TotalSetSize [get, set]
 The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. More...
 

Detailed Description

BulkEnvelopeStatus

Constructor & Destructor Documentation

◆ BulkEnvelopeStatus()

DocuSign.eSign.Model.BulkEnvelopeStatus.BulkEnvelopeStatus ( string  BatchId = default(string),
string  BatchSize = default(string),
List< BulkEnvelope BulkEnvelopes = default(List<BulkEnvelope>),
string  BulkEnvelopesBatchUri = default(string),
string  EndPosition = default(string),
string  Failed = default(string),
string  NextUri = default(string),
string  PreviousUri = default(string),
string  Queued = default(string),
string  ResultSetSize = default(string),
string  Sent = default(string),
string  StartPosition = default(string),
string  SubmittedDate = default(string),
string  TotalSetSize = default(string) 
)
inline

Initializes a new instance of the BulkEnvelopeStatus class.

Parameters
BatchIdSpecifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches..
BatchSizeThe number of items returned in this response..
BulkEnvelopesReserved: TBD.
BulkEnvelopesBatchUriReserved: TBD.
EndPositionThe last position in the result set. .
FailedThe number of entries with a status of failed. .
NextUriThe URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. .
PreviousUriThe postal code for the billing address..
QueuedThe number of entries with a status of queued. .
ResultSetSizeThe number of results returned in this response. .
SentThe number of entries with a status of sent..
StartPositionStarting position of the current result set..
SubmittedDateSubmittedDate.
TotalSetSizeThe total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.BulkEnvelopeStatus.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.BulkEnvelopeStatus.Equals ( BulkEnvelopeStatus  other)
inline

Returns true if BulkEnvelopeStatus instances are equal

Parameters
otherInstance of BulkEnvelopeStatus to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.BulkEnvelopeStatus.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.BulkEnvelopeStatus.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.BulkEnvelopeStatus.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ BatchId

string DocuSign.eSign.Model.BulkEnvelopeStatus.BatchId
getset

Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.

Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.

◆ BatchSize

string DocuSign.eSign.Model.BulkEnvelopeStatus.BatchSize
getset

The number of items returned in this response.

The number of items returned in this response.

◆ BulkEnvelopes

List<BulkEnvelope> DocuSign.eSign.Model.BulkEnvelopeStatus.BulkEnvelopes
getset

Reserved: TBD

Reserved: TBD

◆ BulkEnvelopesBatchUri

string DocuSign.eSign.Model.BulkEnvelopeStatus.BulkEnvelopesBatchUri
getset

Reserved: TBD

Reserved: TBD

◆ EndPosition

string DocuSign.eSign.Model.BulkEnvelopeStatus.EndPosition
getset

The last position in the result set.

The last position in the result set.

◆ Failed

string DocuSign.eSign.Model.BulkEnvelopeStatus.Failed
getset

The number of entries with a status of failed.

The number of entries with a status of failed.

◆ NextUri

string DocuSign.eSign.Model.BulkEnvelopeStatus.NextUri
getset

The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.

The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.

◆ PreviousUri

string DocuSign.eSign.Model.BulkEnvelopeStatus.PreviousUri
getset

The postal code for the billing address.

The postal code for the billing address.

◆ Queued

string DocuSign.eSign.Model.BulkEnvelopeStatus.Queued
getset

The number of entries with a status of queued.

The number of entries with a status of queued.

◆ ResultSetSize

string DocuSign.eSign.Model.BulkEnvelopeStatus.ResultSetSize
getset

The number of results returned in this response.

The number of results returned in this response.

◆ Sent

string DocuSign.eSign.Model.BulkEnvelopeStatus.Sent
getset

The number of entries with a status of sent.

The number of entries with a status of sent.

◆ StartPosition

string DocuSign.eSign.Model.BulkEnvelopeStatus.StartPosition
getset

Starting position of the current result set.

Starting position of the current result set.

◆ SubmittedDate

string DocuSign.eSign.Model.BulkEnvelopeStatus.SubmittedDate
getset

Gets or Sets SubmittedDate

◆ TotalSetSize

string DocuSign.eSign.Model.BulkEnvelopeStatus.TotalSetSize
getset

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.


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