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.



189
190
191
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 189

def ac_status
  @ac_status
end

#block ⇒ Object

Returns the value of attribute block.



192
193
194
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 192

def block
  @block
end

#count ⇒ Object

Returns the value of attribute count.



195
196
197
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 195

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



198
199
200
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 198

def custom_field
  @custom_field
end

#email ⇒ Object

Returns the value of attribute email.



201
202
203
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 201

def email
  @email
end

#envelope_ids ⇒ Object

Returns the value of attribute envelope_ids.



204
205
206
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 204

def envelope_ids
  @envelope_ids
end

#exclude ⇒ Object

Returns the value of attribute exclude.



207
208
209
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 207

def exclude
  @exclude
end

#folder_ids ⇒ Object

Returns the value of attribute folder_ids.



210
211
212
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 210

def folder_ids
  @folder_ids
end

#folder_types ⇒ Object

Returns the value of attribute folder_types.



213
214
215
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 213

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.



216
217
218
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 216

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.



219
220
221
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 219

def from_to_status
  @from_to_status
end

#include ⇒ Object

Returns the value of attribute include.



222
223
224
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 222

def include
  @include
end

#intersecting_folder_ids ⇒ Object

Returns the value of attribute intersecting_folder_ids.



225
226
227
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 225

def intersecting_folder_ids
  @intersecting_folder_ids
end

#order ⇒ Object

Returns the value of attribute order.



228
229
230
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 228

def order
  @order
end

#order_by ⇒ Object

Returns the value of attribute order_by.



231
232
233
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 231

def order_by
  @order_by
end

#powerformids ⇒ Object

Returns the value of attribute powerformids.



234
235
236
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 234

def powerformids
  @powerformids
end

#search_text ⇒ Object

Returns the value of attribute search_text.



237
238
239
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 237

def search_text
  @search_text
end

#start_position ⇒ Object

Returns the value of attribute start_position.



240
241
242
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 240

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.



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

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



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

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.



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

def transaction_ids
  @transaction_ids
end

#user_filter ⇒ Object

Returns the value of attribute user_filter.



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

def user_filter
  @user_filter
end

#user_id ⇒ Object

Returns the value of attribute user_id.



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

def user_id
  @user_id
end

#user_name ⇒ Object

Returns the value of attribute user_name.



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

def user_name
  @user_name
end

Class Method Details

.default ⇒ Object 



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

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