Class: DocuSign_eSign::ReportInProductGet

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/report_in_product_get.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportInProductGet

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 184

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'authenticationSuccessFilter')
    self.authentication_success_filter = attributes[:'authenticationSuccessFilter']
  end

  if attributes.has_key?(:'customFieldFilter')
    self.custom_field_filter = attributes[:'customFieldFilter']
  end

  if attributes.has_key?(:'dateRangeCustomFromDate')
    self.date_range_custom_from_date = attributes[:'dateRangeCustomFromDate']
  end

  if attributes.has_key?(:'dateRangeCustomToDate')
    self.date_range_custom_to_date = attributes[:'dateRangeCustomToDate']
  end

  if attributes.has_key?(:'dateRangeFilter')
    self.date_range_filter = attributes[:'dateRangeFilter']
  end

  if attributes.has_key?(:'displayOrder')
    self.display_order = attributes[:'displayOrder']
  end

  if attributes.has_key?(:'envelopeDateTypeFilter')
    self.envelope_date_type_filter = attributes[:'envelopeDateTypeFilter']
  end

  if attributes.has_key?(:'envelopeRecipientNameContainsFilter')
    self.envelope_recipient_name_contains_filter = attributes[:'envelopeRecipientNameContainsFilter']
  end

  if attributes.has_key?(:'envelopeStatusFilter')
    self.envelope_status_filter = attributes[:'envelopeStatusFilter']
  end

  if attributes.has_key?(:'envelopeSubjectContainsFilter')
    self.envelope_subject_contains_filter = attributes[:'envelopeSubjectContainsFilter']
  end

  if attributes.has_key?(:'fields')
    if (value = attributes[:'fields']).is_a?(Array)
      self.fields = value
    end
  end

  if attributes.has_key?(:'lastScheduledExecutionDate')
    self.last_scheduled_execution_date = attributes[:'lastScheduledExecutionDate']
  end

  if attributes.has_key?(:'lastScheduledExecutionSuccessDate')
    self.last_scheduled_execution_success_date = attributes[:'lastScheduledExecutionSuccessDate']
  end

  if attributes.has_key?(:'maxDownloadRows')
    self.max_download_rows = attributes[:'maxDownloadRows']
  end

  if attributes.has_key?(:'maxGridRows')
    self.max_grid_rows = attributes[:'maxGridRows']
  end

  if attributes.has_key?(:'maxScheduledRows')
    self.max_scheduled_rows = attributes[:'maxScheduledRows']
  end

  if attributes.has_key?(:'periodLengthFilter')
    self.period_length_filter = attributes[:'periodLengthFilter']
  end

  if attributes.has_key?(:'reportCustomizedId')
    self.report_customized_id = attributes[:'reportCustomizedId']
  end

  if attributes.has_key?(:'reportDescription')
    self.report_description = attributes[:'reportDescription']
  end

  if attributes.has_key?(:'reportId')
    self.report_id = attributes[:'reportId']
  end

  if attributes.has_key?(:'reportName')
    self.report_name = attributes[:'reportName']
  end

  if attributes.has_key?(:'reportType')
    self.report_type = attributes[:'reportType']
  end

  if attributes.has_key?(:'runUri')
    self.run_uri = attributes[:'runUri']
  end

  if attributes.has_key?(:'saveUri')
    self.save_uri = attributes[:'saveUri']
  end

  if attributes.has_key?(:'scheduleId')
    self.schedule_id = attributes[:'scheduleId']
  end

  if attributes.has_key?(:'sentByDetails')
    self.sent_by_details = attributes[:'sentByDetails']
  end

  if attributes.has_key?(:'sentByFilter')
    self.sent_by_filter = attributes[:'sentByFilter']
  end

  if attributes.has_key?(:'sentByIds')
    self.sent_by_ids = attributes[:'sentByIds']
  end

  if attributes.has_key?(:'sortFieldDirection')
    self.sort_field_direction = attributes[:'sortFieldDirection']
  end

  if attributes.has_key?(:'sortFieldName')
    self.sort_field_name = attributes[:'sortFieldName']
  end

  if attributes.has_key?(:'verificationStatusFilter')
    self.verification_status_filter = attributes[:'verificationStatusFilter']
  end
end

Instance Attribute Details

#authentication_success_filterObject

Returns the value of attribute authentication_success_filter


17
18
19
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 17

def authentication_success_filter
  @authentication_success_filter
end

#custom_field_filterObject

Returns the value of attribute custom_field_filter


20
21
22
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 20

def custom_field_filter
  @custom_field_filter
end

#date_range_custom_from_dateObject

Returns the value of attribute date_range_custom_from_date


23
24
25
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 23

def date_range_custom_from_date
  @date_range_custom_from_date
end

#date_range_custom_to_dateObject

Returns the value of attribute date_range_custom_to_date


26
27
28
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 26

def date_range_custom_to_date
  @date_range_custom_to_date
end

#date_range_filterObject

Returns the value of attribute date_range_filter


29
30
31
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 29

def date_range_filter
  @date_range_filter
end

#display_orderObject

Returns the value of attribute display_order


32
33
34
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 32

def display_order
  @display_order
end

#envelope_date_type_filterObject

Returns the value of attribute envelope_date_type_filter


35
36
37
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 35

def envelope_date_type_filter
  @envelope_date_type_filter
end

#envelope_recipient_name_contains_filterObject

Returns the value of attribute envelope_recipient_name_contains_filter


38
39
40
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 38

def envelope_recipient_name_contains_filter
  @envelope_recipient_name_contains_filter
end

#envelope_status_filterObject

Returns the value of attribute envelope_status_filter


41
42
43
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 41

def envelope_status_filter
  @envelope_status_filter
end

#envelope_subject_contains_filterObject

Returns the value of attribute envelope_subject_contains_filter


44
45
46
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 44

def envelope_subject_contains_filter
  @envelope_subject_contains_filter
end

#fieldsObject

Returns the value of attribute fields


47
48
49
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 47

def fields
  @fields
end

#last_scheduled_execution_dateObject

Returns the value of attribute last_scheduled_execution_date


50
51
52
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 50

def last_scheduled_execution_date
  @last_scheduled_execution_date
end

#last_scheduled_execution_success_dateObject

Returns the value of attribute last_scheduled_execution_success_date


53
54
55
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 53

def last_scheduled_execution_success_date
  @last_scheduled_execution_success_date
end

#max_download_rowsObject

Returns the value of attribute max_download_rows


56
57
58
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 56

def max_download_rows
  @max_download_rows
end

#max_grid_rowsObject

Returns the value of attribute max_grid_rows


59
60
61
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 59

def max_grid_rows
  @max_grid_rows
end

#max_scheduled_rowsObject

Returns the value of attribute max_scheduled_rows


62
63
64
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 62

def max_scheduled_rows
  @max_scheduled_rows
end

#period_length_filterObject

Returns the value of attribute period_length_filter


65
66
67
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 65

def period_length_filter
  @period_length_filter
end

#report_customized_idObject

Returns the value of attribute report_customized_id


68
69
70
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 68

def report_customized_id
  @report_customized_id
end

#report_descriptionObject

Returns the value of attribute report_description


71
72
73
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 71

def report_description
  @report_description
end

#report_idObject

Returns the value of attribute report_id


74
75
76
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 74

def report_id
  @report_id
end

#report_nameObject

Returns the value of attribute report_name


77
78
79
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 77

def report_name
  @report_name
end

#report_typeObject

Returns the value of attribute report_type


80
81
82
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 80

def report_type
  @report_type
end

#run_uriObject

Returns the value of attribute run_uri


83
84
85
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 83

def run_uri
  @run_uri
end

#save_uriObject

Returns the value of attribute save_uri


86
87
88
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 86

def save_uri
  @save_uri
end

#schedule_idObject

Returns the value of attribute schedule_id


89
90
91
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 89

def schedule_id
  @schedule_id
end

#sent_by_detailsObject

Returns the value of attribute sent_by_details


91
92
93
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 91

def sent_by_details
  @sent_by_details
end

#sent_by_filterObject

Returns the value of attribute sent_by_filter


94
95
96
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 94

def sent_by_filter
  @sent_by_filter
end

#sent_by_idsObject

Returns the value of attribute sent_by_ids


97
98
99
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 97

def sent_by_ids
  @sent_by_ids
end

#sort_field_directionObject

Returns the value of attribute sort_field_direction


100
101
102
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 100

def sort_field_direction
  @sort_field_direction
end

#sort_field_nameObject

Returns the value of attribute sort_field_name


103
104
105
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 103

def sort_field_name
  @sort_field_name
end

#verification_status_filterObject

Returns the value of attribute verification_status_filter


106
107
108
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 106

def verification_status_filter
  @verification_status_filter
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 109

def self.attribute_map
  {
    :'authentication_success_filter' => :'authenticationSuccessFilter',
    :'custom_field_filter' => :'customFieldFilter',
    :'date_range_custom_from_date' => :'dateRangeCustomFromDate',
    :'date_range_custom_to_date' => :'dateRangeCustomToDate',
    :'date_range_filter' => :'dateRangeFilter',
    :'display_order' => :'displayOrder',
    :'envelope_date_type_filter' => :'envelopeDateTypeFilter',
    :'envelope_recipient_name_contains_filter' => :'envelopeRecipientNameContainsFilter',
    :'envelope_status_filter' => :'envelopeStatusFilter',
    :'envelope_subject_contains_filter' => :'envelopeSubjectContainsFilter',
    :'fields' => :'fields',
    :'last_scheduled_execution_date' => :'lastScheduledExecutionDate',
    :'last_scheduled_execution_success_date' => :'lastScheduledExecutionSuccessDate',
    :'max_download_rows' => :'maxDownloadRows',
    :'max_grid_rows' => :'maxGridRows',
    :'max_scheduled_rows' => :'maxScheduledRows',
    :'period_length_filter' => :'periodLengthFilter',
    :'report_customized_id' => :'reportCustomizedId',
    :'report_description' => :'reportDescription',
    :'report_id' => :'reportId',
    :'report_name' => :'reportName',
    :'report_type' => :'reportType',
    :'run_uri' => :'runUri',
    :'save_uri' => :'saveUri',
    :'schedule_id' => :'scheduleId',
    :'sent_by_details' => :'sentByDetails',
    :'sent_by_filter' => :'sentByFilter',
    :'sent_by_ids' => :'sentByIds',
    :'sort_field_direction' => :'sortFieldDirection',
    :'sort_field_name' => :'sortFieldName',
    :'verification_status_filter' => :'verificationStatusFilter'
  }
end

.swagger_typesObject

Attribute type mapping.


146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 146

def self.swagger_types
  {
    :'authentication_success_filter' => :'String',
    :'custom_field_filter' => :'String',
    :'date_range_custom_from_date' => :'String',
    :'date_range_custom_to_date' => :'String',
    :'date_range_filter' => :'String',
    :'display_order' => :'String',
    :'envelope_date_type_filter' => :'String',
    :'envelope_recipient_name_contains_filter' => :'String',
    :'envelope_status_filter' => :'String',
    :'envelope_subject_contains_filter' => :'String',
    :'fields' => :'Array<ReportInProductField>',
    :'last_scheduled_execution_date' => :'String',
    :'last_scheduled_execution_success_date' => :'String',
    :'max_download_rows' => :'String',
    :'max_grid_rows' => :'String',
    :'max_scheduled_rows' => :'String',
    :'period_length_filter' => :'String',
    :'report_customized_id' => :'String',
    :'report_description' => :'String',
    :'report_id' => :'String',
    :'report_name' => :'String',
    :'report_type' => :'String',
    :'run_uri' => :'String',
    :'save_uri' => :'String',
    :'schedule_id' => :'String',
    :'sent_by_details' => :'ReportInProductSentByDetails',
    :'sent_by_filter' => :'String',
    :'sent_by_ids' => :'String',
    :'sort_field_direction' => :'String',
    :'sort_field_name' => :'String',
    :'verification_status_filter' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 332

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authentication_success_filter == o.authentication_success_filter &&
      custom_field_filter == o.custom_field_filter &&
      date_range_custom_from_date == o.date_range_custom_from_date &&
      date_range_custom_to_date == o.date_range_custom_to_date &&
      date_range_filter == o.date_range_filter &&
      display_order == o.display_order &&
      envelope_date_type_filter == o.envelope_date_type_filter &&
      envelope_recipient_name_contains_filter == o.envelope_recipient_name_contains_filter &&
      envelope_status_filter == o.envelope_status_filter &&
      envelope_subject_contains_filter == o.envelope_subject_contains_filter &&
      fields == o.fields &&
      last_scheduled_execution_date == o.last_scheduled_execution_date &&
      last_scheduled_execution_success_date == o.last_scheduled_execution_success_date &&
      max_download_rows == o.max_download_rows &&
      max_grid_rows == o.max_grid_rows &&
      max_scheduled_rows == o.max_scheduled_rows &&
      period_length_filter == o.period_length_filter &&
      report_customized_id == o.report_customized_id &&
      report_description == o.report_description &&
      report_id == o.report_id &&
      report_name == o.report_name &&
      report_type == o.report_type &&
      run_uri == o.run_uri &&
      save_uri == o.save_uri &&
      schedule_id == o.schedule_id &&
      sent_by_details == o.sent_by_details &&
      sent_by_filter == o.sent_by_filter &&
      sent_by_ids == o.sent_by_ids &&
      sort_field_direction == o.sort_field_direction &&
      sort_field_name == o.sort_field_name &&
      verification_status_filter == o.verification_status_filter
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 404

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


470
471
472
473
474
475
476
477
478
479
480
481
482
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 470

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 383

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

370
371
372
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 370

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


376
377
378
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 376

def hash
  [authentication_success_filter, custom_field_filter, date_range_custom_from_date, date_range_custom_to_date, date_range_filter, display_order, envelope_date_type_filter, envelope_recipient_name_contains_filter, envelope_status_filter, envelope_subject_contains_filter, fields, last_scheduled_execution_date, last_scheduled_execution_success_date, max_download_rows, max_grid_rows, max_scheduled_rows, period_length_filter, report_customized_id, report_description, report_id, report_name, report_type, run_uri, save_uri, schedule_id, sent_by_details, sent_by_filter, sent_by_ids, sort_field_direction, sort_field_name, verification_status_filter].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


319
320
321
322
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 319

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


450
451
452
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 450

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


456
457
458
459
460
461
462
463
464
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 456

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


444
445
446
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 444

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


326
327
328
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 326

def valid?
  true
end