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.



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

def ac_status
  @ac_status
end

#block ⇒ Object

Returns the value of attribute block.



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

def block
  @block
end

#cdse_mode ⇒ Object

Returns the value of attribute cdse_mode.



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

def cdse_mode
  @cdse_mode
end

#continuation_token ⇒ Object

Returns the value of attribute continuation_token.



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

def continuation_token
  @continuation_token
end

#count ⇒ Object

Returns the value of attribute count.



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

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



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

def custom_field
  @custom_field
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#envelope_ids ⇒ Object

Returns the value of attribute envelope_ids.



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

def envelope_ids
  @envelope_ids
end

#exclude ⇒ Object

Returns the value of attribute exclude.



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

def exclude
  @exclude
end

#folder_ids ⇒ Object

Returns the value of attribute folder_ids.



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

def folder_ids
  @folder_ids
end

#folder_types ⇒ Object

Returns the value of attribute folder_types.



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

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.



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

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.



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

def from_to_status
  @from_to_status
end

#include ⇒ Object

Returns the value of attribute include.



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

def include
  @include
end

#include_purge_information ⇒ Object

Returns the value of attribute include_purge_information.



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

def include_purge_information
  @include_purge_information
end

#intersecting_folder_ids ⇒ Object

Returns the value of attribute intersecting_folder_ids.



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

def intersecting_folder_ids
  @intersecting_folder_ids
end

#last_queried_date ⇒ Object

Returns the value of attribute last_queried_date.



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

def last_queried_date
  @last_queried_date
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#order_by ⇒ Object

Returns the value of attribute order_by.



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

def order_by
  @order_by
end

#powerformids ⇒ Object

Returns the value of attribute powerformids.



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

def powerformids
  @powerformids
end

#query_budget ⇒ Object

Returns the value of attribute query_budget.



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

def query_budget
  @query_budget
end

#requester_date_format ⇒ Object

Returns the value of attribute requester_date_format.



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

def requester_date_format
  @requester_date_format
end

#search_mode ⇒ Object

Returns the value of attribute search_mode.



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

def search_mode
  @search_mode
end

#search_text ⇒ Object

Returns the value of attribute search_text.



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

def search_text
  @search_text
end

#start_position ⇒ Object

Returns the value of attribute start_position.



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

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.



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

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



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

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.



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

def transaction_ids
  @transaction_ids
end

#user_filter ⇒ Object

Returns the value of attribute user_filter.



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

def user_filter
  @user_filter
end

#user_id ⇒ Object

Returns the value of attribute user_id.



408
409
410
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 408

def user_id
  @user_id
end

#user_name ⇒ Object

Returns the value of attribute user_name.



411
412
413
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 411

def user_name
  @user_name
end

Class Method Details

.default ⇒ Object 



413
414
415
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 413

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