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


175
176
177
178
179
180
181
182
183
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
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 175

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?(:'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
end

Instance Attribute Details

#custom_field_filterObject

Returns the value of attribute custom_field_filter


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

def custom_field_filter
  @custom_field_filter
end

#date_range_custom_from_dateObject

Returns the value of attribute date_range_custom_from_date


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

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


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

def date_range_custom_to_date
  @date_range_custom_to_date
end

#date_range_filterObject

Returns the value of attribute date_range_filter


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

def date_range_filter
  @date_range_filter
end

#display_orderObject

Returns the value of attribute display_order


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

def display_order
  @display_order
end

#envelope_date_type_filterObject

Returns the value of attribute envelope_date_type_filter


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

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


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

def envelope_recipient_name_contains_filter
  @envelope_recipient_name_contains_filter
end

#envelope_status_filterObject

Returns the value of attribute envelope_status_filter


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

def envelope_status_filter
  @envelope_status_filter
end

#envelope_subject_contains_filterObject

Returns the value of attribute envelope_subject_contains_filter


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

def envelope_subject_contains_filter
  @envelope_subject_contains_filter
end

#fieldsObject

Returns the value of attribute fields


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

def fields
  @fields
end

#last_scheduled_execution_dateObject

Returns the value of attribute last_scheduled_execution_date


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

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


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

def last_scheduled_execution_success_date
  @last_scheduled_execution_success_date
end

#max_download_rowsObject

Returns the value of attribute max_download_rows


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

def max_download_rows
  @max_download_rows
end

#max_grid_rowsObject

Returns the value of attribute max_grid_rows


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

def max_grid_rows
  @max_grid_rows
end

#max_scheduled_rowsObject

Returns the value of attribute max_scheduled_rows


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

def max_scheduled_rows
  @max_scheduled_rows
end

#period_length_filterObject

Returns the value of attribute period_length_filter


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

def period_length_filter
  @period_length_filter
end

#report_customized_idObject

Returns the value of attribute report_customized_id


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

def report_customized_id
  @report_customized_id
end

#report_descriptionObject

Returns the value of attribute report_description


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

def report_description
  @report_description
end

#report_idObject

Returns the value of attribute report_id


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

def report_id
  @report_id
end

#report_nameObject

Returns the value of attribute report_name


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

def report_name
  @report_name
end

#report_typeObject

Returns the value of attribute report_type


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

def report_type
  @report_type
end

#run_uriObject

Returns the value of attribute run_uri


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

def run_uri
  @run_uri
end

#save_uriObject

Returns the value of attribute save_uri


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

def save_uri
  @save_uri
end

#schedule_idObject

Returns the value of attribute schedule_id


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

def schedule_id
  @schedule_id
end

#sent_by_detailsObject

Returns the value of attribute sent_by_details


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

def sent_by_details
  @sent_by_details
end

#sent_by_filterObject

Returns the value of attribute sent_by_filter


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

def sent_by_filter
  @sent_by_filter
end

#sent_by_idsObject

Returns the value of attribute sent_by_ids


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

def sent_by_ids
  @sent_by_ids
end

#sort_field_directionObject

Returns the value of attribute sort_field_direction


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

def sort_field_direction
  @sort_field_direction
end

#sort_field_nameObject

Returns the value of attribute sort_field_name


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

def sort_field_name
  @sort_field_name
end

Class Method Details

.attribute_mapObject

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


104
105
106
107
108
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
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 104

def self.attribute_map
  {
    :'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'
  }
end

.swagger_typesObject

Attribute type mapping.


139
140
141
142
143
144
145
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
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 139

def self.swagger_types
  {
    :'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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 315

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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
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


385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 385

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


451
452
453
454
455
456
457
458
459
460
461
462
463
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 451

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


364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 364

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

351
352
353
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 351

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


357
358
359
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 357

def hash
  [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].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


302
303
304
305
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 302

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


431
432
433
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 431

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


437
438
439
440
441
442
443
444
445
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 437

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


425
426
427
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 425

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


309
310
311
# File 'lib/docusign_esign/models/report_in_product_get.rb', line 309

def valid?
  true
end