class DocuSign_eSign::ListStatusChangesOptions

Attributes

ac_status[RW]

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

block[RW]
cdse_mode[RW]
continuation_token[RW]
count[RW]
custom_field[RW]

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

email[RW]
envelope_ids[RW]
exclude[RW]
folder_ids[RW]
folder_types[RW]
from_date[RW]

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.

from_to_status[RW]

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.

include[RW]
include_purge_information[RW]
intersecting_folder_ids[RW]
last_queried_date[RW]
order[RW]
order_by[RW]
powerformids[RW]
query_budget[RW]
requester_date_format[RW]
search_mode[RW]
search_text[RW]
start_position[RW]
status[RW]

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.

to_date[RW]

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

transaction_ids[RW]

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.

user_filter[RW]
user_id[RW]
user_name[RW]

Public Class Methods

default() click to toggle source 
# File lib/docusign_esign/api/envelopes_api.rb, line 425
def self.default
  @@default ||= ListStatusChangesOptions.new
end