Class: DocuSign_eSign::ReportInProductListItem

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportInProductListItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash


101
102
103
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 101

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?(:'getUri')
    self.get_uri = attributes[:'getUri']
  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?(:'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?(:'scheduleCreateDate')
    self.schedule_create_date = attributes[:'scheduleCreateDate']
  end

  if attributes.has_key?(:'scheduleEndDate')
    self.schedule_end_date = attributes[:'scheduleEndDate']
  end

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

  if attributes.has_key?(:'scheduleRenewDurationDays')
    self.schedule_renew_duration_days = attributes[:'scheduleRenewDurationDays']
  end
end

Instance Attribute Details

#get_uriObject

Returns the value of attribute get_uri


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

def get_uri
  @get_uri
end

#last_scheduled_execution_dateObject

Returns the value of attribute last_scheduled_execution_date


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

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


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

def last_scheduled_execution_success_date
  @last_scheduled_execution_success_date
end

#report_customized_idObject

Returns the value of attribute report_customized_id


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

def report_customized_id
  @report_customized_id
end

#report_descriptionObject

Returns the value of attribute report_description


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

def report_description
  @report_description
end

#report_idObject

Returns the value of attribute report_id


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

def report_id
  @report_id
end

#report_nameObject

Returns the value of attribute report_name


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

def report_name
  @report_name
end

#report_typeObject

Returns the value of attribute report_type


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

def report_type
  @report_type
end

#run_uriObject

Returns the value of attribute run_uri


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

def run_uri
  @run_uri
end

#save_uriObject

Returns the value of attribute save_uri


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

def save_uri
  @save_uri
end

#schedule_create_dateObject

Returns the value of attribute schedule_create_date


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

def schedule_create_date
  @schedule_create_date
end

#schedule_end_dateObject

Returns the value of attribute schedule_end_date


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

def schedule_end_date
  @schedule_end_date
end

#schedule_idObject

Returns the value of attribute schedule_id


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

def schedule_id
  @schedule_id
end

#schedule_renew_duration_daysObject

Returns the value of attribute schedule_renew_duration_days


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

def schedule_renew_duration_days
  @schedule_renew_duration_days
end

Class Method Details

.attribute_mapObject

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


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 60

def self.attribute_map
  {
    :'get_uri' => :'getUri',
    :'last_scheduled_execution_date' => :'lastScheduledExecutionDate',
    :'last_scheduled_execution_success_date' => :'lastScheduledExecutionSuccessDate',
    :'report_customized_id' => :'reportCustomizedId',
    :'report_description' => :'reportDescription',
    :'report_id' => :'reportId',
    :'report_name' => :'reportName',
    :'report_type' => :'reportType',
    :'run_uri' => :'runUri',
    :'save_uri' => :'saveUri',
    :'schedule_create_date' => :'scheduleCreateDate',
    :'schedule_end_date' => :'scheduleEndDate',
    :'schedule_id' => :'scheduleId',
    :'schedule_renew_duration_days' => :'scheduleRenewDurationDays'
  }
end

.swagger_typesObject

Attribute type mapping.


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 80

def self.swagger_types
  {
    :'get_uri' => :'String',
    :'last_scheduled_execution_date' => :'String',
    :'last_scheduled_execution_success_date' => :'String',
    :'report_customized_id' => :'String',
    :'report_description' => :'String',
    :'report_id' => :'String',
    :'report_name' => :'String',
    :'report_type' => :'String',
    :'run_uri' => :'String',
    :'save_uri' => :'String',
    :'schedule_create_date' => :'String',
    :'schedule_end_date' => :'String',
    :'schedule_id' => :'String',
    :'schedule_renew_duration_days' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      get_uri == o.get_uri &&
      last_scheduled_execution_date == o.last_scheduled_execution_date &&
      last_scheduled_execution_success_date == o.last_scheduled_execution_success_date &&
      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_create_date == o.schedule_create_date &&
      schedule_end_date == o.schedule_end_date &&
      schedule_id == o.schedule_id &&
      schedule_renew_duration_days == o.schedule_renew_duration_days
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


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
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 234

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


300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 300

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


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 213

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

200
201
202
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 200

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


206
207
208
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 206

def hash
  [get_uri, last_scheduled_execution_date, last_scheduled_execution_success_date, report_customized_id, report_description, report_id, report_name, report_type, run_uri, save_uri, schedule_create_date, schedule_end_date, schedule_id, schedule_renew_duration_days].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


166
167
168
169
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 166

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


280
281
282
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 280

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


286
287
288
289
290
291
292
293
294
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 286

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


274
275
276
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 274

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


173
174
175
# File 'lib/docusign_esign/models/report_in_product_list_item.rb', line 173

def valid?
  true
end