Class: OpenapiClient::SubscriptionObject

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/subscription_object.rb

Overview

Subscription body object that represents a subscription

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/openapi_client/models/subscription_object.rb', line 61

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SubscriptionObject` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SubscriptionObject`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'email_address')
    self.email_address = attributes[:'email_address']
  end

  if attributes.key?(:'location')
    self.location = attributes[:'location']
  end

  if attributes.key?(:'sector')
    self.sector = attributes[:'sector']
  end

  if attributes.key?(:'frequency')
    self.frequency = attributes[:'frequency']
  end

  if attributes.key?(:'subscription_image')
    self.subscription_image = attributes[:'subscription_image']
  end

  if attributes.key?(:'subscription_payment_card')
    self.subscription_payment_card = attributes[:'subscription_payment_card']
  end
end

Instance Attribute Details

#email_address ⇒ Object

The email address to which the reports will be sent to



19
20
21
 
# File 'lib/openapi_client/models/subscription_object.rb', line 19

def email_address
  @email_address
end

#frequency ⇒ Object

b - Bi-Daily, d - Daily, w - Weekly



28
29
30
 
# File 'lib/openapi_client/models/subscription_object.rb', line 28

def frequency
  @frequency
end

#location ⇒ Object

The location you wish to create a subscription for



22
23
24
 
# File 'lib/openapi_client/models/subscription_object.rb', line 22

def location
  @location
end

#sector ⇒ Object

The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call



25
26
27
 
# File 'lib/openapi_client/models/subscription_object.rb', line 25

def sector
  @sector
end

#subscription_image ⇒ Object

An image that can be included as part of the subscription. MUST be sent in base64 format.



31
32
33
 
# File 'lib/openapi_client/models/subscription_object.rb', line 31

def subscription_image
  @subscription_image
end

#subscription_payment_card ⇒ Object

Returns the value of attribute subscription_payment_card.



33
34
35
 
# File 'lib/openapi_client/models/subscription_object.rb', line 33

def subscription_payment_card
  @subscription_payment_card
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/openapi_client/models/subscription_object.rb', line 36

def self.attribute_map
  {
    :'email_address' => :'emailAddress',
    :'location' => :'location',
    :'sector' => :'sector',
    :'frequency' => :'frequency',
    :'subscription_image' => :'subscriptionImage',
    :'subscription_payment_card' => :'subscriptionPaymentCard'
  }
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



140
141
142
 
# File 'lib/openapi_client/models/subscription_object.rb', line 140

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/openapi_client/models/subscription_object.rb', line 48

def self.openapi_types
  {
    :'email_address' => :'String',
    :'location' => :'String',
    :'sector' => :'Integer',
    :'frequency' => :'String',
    :'subscription_image' => :'String',
    :'subscription_payment_card' => :'SubscriptionPaymentCard'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/openapi_client/models/subscription_object.rb', line 114

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email_address == o.email_address &&
      location == o.location &&
      sector == o.sector &&
      frequency == o.frequency &&
      subscription_image == o.subscription_image &&
      subscription_payment_card == o.subscription_payment_card
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



168
169
170
171
172
173
174
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
 
# File 'lib/openapi_client/models/subscription_object.rb', line 168

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
    OpenapiClient.const_get(type).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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/openapi_client/models/subscription_object.rb', line 233

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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/openapi_client/models/subscription_object.rb', line 147

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


127
128
129
 
# File 'lib/openapi_client/models/subscription_object.rb', line 127

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



133
134
135
 
# File 'lib/openapi_client/models/subscription_object.rb', line 133

def hash
  [email_address, location, sector, frequency, subscription_image, subscription_payment_card].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



101
102
103
104
 
# File 'lib/openapi_client/models/subscription_object.rb', line 101

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



213
214
215
 
# File 'lib/openapi_client/models/subscription_object.rb', line 213

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



219
220
221
222
223
224
225
226
227
 
# File 'lib/openapi_client/models/subscription_object.rb', line 219

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



207
208
209
 
# File 'lib/openapi_client/models/subscription_object.rb', line 207

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



108
109
110
 
# File 'lib/openapi_client/models/subscription_object.rb', line 108

def valid?
  true
end