Class: SubskribeSandboxClient::AutomatedInvoiceRuleRequestJson

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutomatedInvoiceRuleRequestJson

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 83

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

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

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

  if attributes.has_key?(:'cronExpression')
    self.cron_expression = attributes[:'cronExpression']
  end

  if attributes.has_key?(:'firstExecutionDate')
    self.first_execution_date = attributes[:'firstExecutionDate']
  end

  if attributes.has_key?(:'lastExecutionDate')
    self.last_execution_date = attributes[:'lastExecutionDate']
  end

  if attributes.has_key?(:'targetDuration')
    self.target_duration = attributes[:'targetDuration']
  end

  if attributes.has_key?(:'invoiceDuration')
    self.invoice_duration = attributes[:'invoiceDuration']
  end

  if attributes.has_key?(:'includeUsageCharge')
    self.include_usage_charge = attributes[:'includeUsageCharge']
  end

  if attributes.has_key?(:'includeNonUsageCharge')
    self.include_non_usage_charge = attributes[:'includeNonUsageCharge']
  end

  if attributes.has_key?(:'autoPostInvoice')
    self.auto_post_invoice = attributes[:'autoPostInvoice']
  end

  if attributes.has_key?(:'autoEmailInvoice')
    self.auto_email_invoice = attributes[:'autoEmailInvoice']
  end

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

Instance Attribute Details

#auto_email_invoice ⇒ Object

Returns the value of attribute auto_email_invoice.



39
40
41
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 39

def auto_email_invoice
  @auto_email_invoice
end

#auto_post_invoice ⇒ Object

Returns the value of attribute auto_post_invoice.



37
38
39
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 37

def auto_post_invoice
  @auto_post_invoice
end

#cron_expression ⇒ Object

Returns the value of attribute cron_expression.



23
24
25
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 23

def cron_expression
  @cron_expression
end

#description ⇒ Object

Returns the value of attribute description.



21
22
23
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 21

def description
  @description
end

#enabled ⇒ Object

Returns the value of attribute enabled.



41
42
43
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 41

def enabled
  @enabled
end

#first_execution_date ⇒ Object

Returns the value of attribute first_execution_date.



25
26
27
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 25

def first_execution_date
  @first_execution_date
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 17

def id
  @id
end

#include_non_usage_charge ⇒ Object

Returns the value of attribute include_non_usage_charge.



35
36
37
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 35

def include_non_usage_charge
  @include_non_usage_charge
end

#include_usage_charge ⇒ Object

Returns the value of attribute include_usage_charge.



33
34
35
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 33

def include_usage_charge
  @include_usage_charge
end

#invoice_duration ⇒ Object

Returns the value of attribute invoice_duration.



31
32
33
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 31

def invoice_duration
  @invoice_duration
end

#last_execution_date ⇒ Object

Returns the value of attribute last_execution_date.



27
28
29
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 27

def last_execution_date
  @last_execution_date
end

#name ⇒ Object

Returns the value of attribute name.



19
20
21
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 19

def name
  @name
end

#target_duration ⇒ Object

Returns the value of attribute target_duration.



29
30
31
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 29

def target_duration
  @target_duration
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 44

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'cron_expression' => :'cronExpression',
    :'first_execution_date' => :'firstExecutionDate',
    :'last_execution_date' => :'lastExecutionDate',
    :'target_duration' => :'targetDuration',
    :'invoice_duration' => :'invoiceDuration',
    :'include_usage_charge' => :'includeUsageCharge',
    :'include_non_usage_charge' => :'includeNonUsageCharge',
    :'auto_post_invoice' => :'autoPostInvoice',
    :'auto_email_invoice' => :'autoEmailInvoice',
    :'enabled' => :'enabled'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 63

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'cron_expression' => :'String',
    :'first_execution_date' => :'Integer',
    :'last_execution_date' => :'Integer',
    :'target_duration' => :'Integer',
    :'invoice_duration' => :'Integer',
    :'include_usage_charge' => :'BOOLEAN',
    :'include_non_usage_charge' => :'BOOLEAN',
    :'auto_post_invoice' => :'BOOLEAN',
    :'auto_email_invoice' => :'BOOLEAN',
    :'enabled' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      cron_expression == o.cron_expression &&
      first_execution_date == o.first_execution_date &&
      last_execution_date == o.last_execution_date &&
      target_duration == o.target_duration &&
      invoice_duration == o.invoice_duration &&
      include_usage_charge == o.include_usage_charge &&
      include_non_usage_charge == o.include_non_usage_charge &&
      auto_post_invoice == o.auto_post_invoice &&
      auto_email_invoice == o.auto_email_invoice &&
      enabled == o.enabled
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



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
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 226

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 = SubskribeSandboxClient.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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 292

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 205

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


192
193
194
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 198

def hash
  [id, name, description, cron_expression, first_execution_date, last_execution_date, target_duration, invoice_duration, include_usage_charge, include_non_usage_charge, auto_post_invoice, auto_email_invoice, enabled].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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 144

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @cron_expression.nil?
    invalid_properties.push('invalid value for "cron_expression", cron_expression cannot be nil.')
  end

  if @first_execution_date.nil?
    invalid_properties.push('invalid value for "first_execution_date", first_execution_date cannot be nil.')
  end

  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



272
273
274
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 272

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



278
279
280
281
282
283
284
285
286
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 278

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



266
267
268
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 266

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



163
164
165
166
167
168
 
# File 'lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb', line 163

def valid?
  return false if @name.nil?
  return false if @cron_expression.nil?
  return false if @first_execution_date.nil?
  true
end