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



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

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_uri ⇒ Object

Returns the value of attribute get_uri.



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

def get_uri
  @get_uri
end

#last_scheduled_execution_date ⇒ Object

Returns the value of attribute last_scheduled_execution_date.



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

def last_scheduled_execution_date
  @last_scheduled_execution_date
end

#last_scheduled_execution_success_date ⇒ Object

Returns the value of attribute last_scheduled_execution_success_date.



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

def last_scheduled_execution_success_date
  @last_scheduled_execution_success_date
end

#report_customized_id ⇒ Object

Returns the value of attribute report_customized_id.



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

def report_customized_id
  @report_customized_id
end

#report_description ⇒ Object

Returns the value of attribute report_description.



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

def report_description
  @report_description
end

#report_id ⇒ Object

Returns the value of attribute report_id.



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

def report_id
  @report_id
end

#report_name ⇒ Object

Returns the value of attribute report_name.



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

def report_name
  @report_name
end

#report_type ⇒ Object

Returns the value of attribute report_type.



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

def report_type
  @report_type
end

#run_uri ⇒ Object

Returns the value of attribute run_uri.



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

def run_uri
  @run_uri
end

#save_uri ⇒ Object

Returns the value of attribute save_uri.



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

def save_uri
  @save_uri
end

#schedule_create_date ⇒ Object

Returns the value of attribute schedule_create_date.



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

def schedule_create_date
  @schedule_create_date
end

#schedule_end_date ⇒ Object

Returns the value of attribute schedule_end_date.



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

def schedule_end_date
  @schedule_end_date
end

#schedule_id ⇒ Object

Returns the value of attribute schedule_id.



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

def schedule_id
  @schedule_id
end

#schedule_renew_duration_days ⇒ Object

Returns the value of attribute schedule_renew_duration_days.



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

def schedule_renew_duration_days
  @schedule_renew_duration_days
end

Class Method Details

.attribute_map ⇒ Object

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



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

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_types ⇒ Object

Attribute type mapping.



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

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



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

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



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

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



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

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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

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



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

def valid?
  true
end