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.



316
317
318
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 316

def ac_status
  @ac_status
end

#block ⇒ Object

Returns the value of attribute block.



319
320
321
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 319

def block
  @block
end

#cdse_mode ⇒ Object

Returns the value of attribute cdse_mode.



322
323
324
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 322

def cdse_mode
  @cdse_mode
end

#continuation_token ⇒ Object

Returns the value of attribute continuation_token.



325
326
327
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 325

def continuation_token
  @continuation_token
end

#count ⇒ Object

Returns the value of attribute count.



328
329
330
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 328

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."



331
332
333
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 331

def custom_field
  @custom_field
end

#email ⇒ Object

Returns the value of attribute email.



334
335
336
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 334

def email
  @email
end

#envelope_ids ⇒ Object

Returns the value of attribute envelope_ids.



337
338
339
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 337

def envelope_ids
  @envelope_ids
end

#exclude ⇒ Object

Returns the value of attribute exclude.



340
341
342
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 340

def exclude
  @exclude
end

#folder_ids ⇒ Object

Returns the value of attribute folder_ids.



343
344
345
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 343

def folder_ids
  @folder_ids
end

#folder_types ⇒ Object

Returns the value of attribute folder_types.



346
347
348
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 346

def folder_types
  @folder_types
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.



349
350
351
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 349

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.



352
353
354
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 352

def from_to_status
  @from_to_status
end

#include ⇒ Object

Returns the value of attribute include.



355
356
357
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 355

def include
  @include
end

#include_purge_information ⇒ Object

Returns the value of attribute include_purge_information.



358
359
360
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 358

def include_purge_information
  @include_purge_information
end

#intersecting_folder_ids ⇒ Object

Returns the value of attribute intersecting_folder_ids.



361
362
363
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 361

def intersecting_folder_ids
  @intersecting_folder_ids
end

#last_queried_date ⇒ Object

Returns the value of attribute last_queried_date.



364
365
366
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 364

def last_queried_date
  @last_queried_date
end

#order ⇒ Object

Returns the value of attribute order.



367
368
369
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 367

def order
  @order
end

#order_by ⇒ Object

Returns the value of attribute order_by.



370
371
372
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 370

def order_by
  @order_by
end

#powerformids ⇒ Object

Returns the value of attribute powerformids.



373
374
375
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 373

def powerformids
  @powerformids
end

#query_budget ⇒ Object

Returns the value of attribute query_budget.



376
377
378
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 376

def query_budget
  @query_budget
end

#requester_date_format ⇒ Object

Returns the value of attribute requester_date_format.



379
380
381
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 379

def requester_date_format
  @requester_date_format
end

#search_text ⇒ Object

Returns the value of attribute search_text.



382
383
384
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 382

def search_text
  @search_text
end

#start_position ⇒ Object

Returns the value of attribute start_position.



385
386
387
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 385

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.



388
389
390
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 388

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`.



391
392
393
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 391

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.



394
395
396
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 394

def transaction_ids
  @transaction_ids
end

#user_filter ⇒ Object

Returns the value of attribute user_filter.



397
398
399
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 397

def user_filter
  @user_filter
end

#user_id ⇒ Object

Returns the value of attribute user_id.



400
401
402
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 400

def user_id
  @user_id
end

#user_name ⇒ Object

Returns the value of attribute user_name.



403
404
405
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 403

def user_name
  @user_name
end

Class Method Details

.default ⇒ Object 



405
406
407
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 405

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