Class: DocuSign_eSign::ListStatusChangesOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/envelopes_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#ac_status ⇒ Object

Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.



243
244
245
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 243

def ac_status
  @ac_status
end

#block ⇒ Object

Returns the value of attribute block.



246
247
248
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 246

def block
  @block
end

#count ⇒ Object

Returns the value of attribute count.



249
250
251
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 249

def count
  @count
end

#custom_field ⇒ Object

This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding ‘%’ (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called "Region" and you want to search for all envelopes where the value is "West" you would use the query: ‘?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of "DocuSign" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is "DocuSign for Salesforce" or "DocuSign envelope."



252
253
254
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 252

def custom_field
  @custom_field
end

#email ⇒ Object

Returns the value of attribute email.



255
256
257
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 255

def email
  @email
end

#envelope_ids ⇒ Object

Returns the value of attribute envelope_ids.



258
259
260
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 258

def envelope_ids
  @envelope_ids
end

#from_date ⇒ Object

The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless ‘envelopeId’s are used.



261
262
263
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 261

def from_date
  @from_date
end

#from_to_status ⇒ Object

This is the status type checked for in the ‘from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.



264
265
266
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 264

def from_to_status
  @from_to_status
end

#start_position ⇒ Object

Returns the value of attribute start_position.



267
268
269
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 267

def start_position
  @start_position
end

#status ⇒ Object

The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.



270
271
272
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 270

def status
  @status
end

#to_date ⇒ Object

Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the ‘to_date`.



273
274
275
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 273

def to_date
  @to_date
end

#transaction_ids ⇒ Object

If included in the query string, this is a comma separated list of envelope ‘transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days.



276
277
278
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 276

def transaction_ids
  @transaction_ids
end

#user_name ⇒ Object

Returns the value of attribute user_name.



279
280
281
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 279

def user_name
  @user_name
end

Class Method Details

.default ⇒ Object 



281
282
283
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 281

def self.default
  @@default ||= ListStatusChangesOptions.new
end