Class: Bfwd::Organization

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/organization.rb

Overview

Organization within which all your BillForward interactions are scoped.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Organization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/bf_ruby2/models/organization.rb', line 102

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

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

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

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

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

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

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  else
    self.deleted = false
  end

  if attributes.has_key?(:'webhooks')
    if (value = attributes[:'webhooks']).is_a?(Array)
      self.webhooks = value
    end
  end

  if attributes.has_key?(:'alias')
    if (value = attributes[:'alias']).is_a?(Array)
      self._alias = value
    end
  end

  if attributes.has_key?(:'clients')
    if (value = attributes[:'clients']).is_a?(Array)
      self.clients = value
    end
  end

  if attributes.has_key?(:'dunningLines')
    if (value = attributes[:'dunningLines']).is_a?(Array)
      self.dunning_lines = value
    end
  end

  if attributes.has_key?(:'taxationStrategies')
    if (value = attributes[:'taxationStrategies']).is_a?(Array)
      self.taxation_strategies = value
    end
  end

  if attributes.has_key?(:'organizationGateways')
    if (value = attributes[:'organizationGateways']).is_a?(Array)
      self.organization_gateways = value
    end
  end

  if attributes.has_key?(:'apiConfigurations')
    if (value = attributes[:'apiConfigurations']).is_a?(Array)
      self.api_configurations = value
    end
  end

end

Instance Attribute Details

#_alias ⇒ Object

Returns the value of attribute _alias.



42
43
44
 
# File 'lib/bf_ruby2/models/organization.rb', line 42

def _alias
  @_alias
end

#api_configurations ⇒ Object

{ "description" : "Stores the organizations 3rd party API keys which may be used by the system for payment gateway integration etc.", "verbs“: }



57
58
59
 
# File 'lib/bf_ruby2/models/organization.rb', line 57

def api_configurations
  @api_configurations
end

#changed_by ⇒ Object

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }



22
23
24
 
# File 'lib/bf_ruby2/models/organization.rb', line 22

def changed_by
  @changed_by
end

#clients ⇒ Object

{ "description" : "The OAuth2 clients associated with the organization. In most cases an organization would not have any clients associated with their account. In the case of an APP developer, a clients would exist per an application they have developed. To further understand clients please see the client, OAuth2 API and APP development documentation.", "verbs“: }



45
46
47
 
# File 'lib/bf_ruby2/models/organization.rb', line 45

def clients
  @clients
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/organization.rb', line 19

def created
  @created
end

#customer_code ⇒ Object

{ "description" : "A shortcode for the organization. This is used as a short reference code for use when referring to the organization, by default this is set to the organizations name.", "verbs“: }



31
32
33
 
# File 'lib/bf_ruby2/models/organization.rb', line 31

def customer_code
  @customer_code
end

#deleted ⇒ Object

{ "description" : "Indicates if an organization has been retired. If an organization has been retired it can still be retrieved using the appropriate flag on API requests.", "verbs“: }



37
38
39
 
# File 'lib/bf_ruby2/models/organization.rb', line 37

def deleted
  @deleted
end

#dunning_lines ⇒ Object

{ "description" : "The dunning-lines associated with the organization. Dunning lines are used as re-try logic for invoices to attempt to reconcile the payment.", "verbs“: }



48
49
50
 
# File 'lib/bf_ruby2/models/organization.rb', line 48

def dunning_lines
  @dunning_lines
end

#id ⇒ Object

{ "description" : "ID of the organization.", "verbs“: }



28
29
30
 
# File 'lib/bf_ruby2/models/organization.rb', line 28

def id
  @id
end

#name ⇒ Object

{ "description" : "The name of the organization.", "verbs“: }



34
35
36
 
# File 'lib/bf_ruby2/models/organization.rb', line 34

def name
  @name
end

#organization_gateways ⇒ Object

{ "description" : "The card-vault gateways associated with the organization.", "verbs“: }



54
55
56
 
# File 'lib/bf_ruby2/models/organization.rb', line 54

def organization_gateways
  @organization_gateways
end

#taxation_strategies ⇒ Object

{ "description" : "The taxation-strategies associated with the organization. Taxation-strategies may be linked to product-rate-plans to specify how their tax should be calculated.", "verbs“: }



51
52
53
 
# File 'lib/bf_ruby2/models/organization.rb', line 51

def taxation_strategies
  @taxation_strategies
end

#updated ⇒ Object

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }



25
26
27
 
# File 'lib/bf_ruby2/models/organization.rb', line 25

def updated
  @updated
end

#webhooks ⇒ Object

{ "description" : "The WebHooks associated with the organization. These are the end-points where notifications are sent. WebHooks are added, updated and removed from the organization. Thus to add a WebHook, the webhook must be defined on this property of the organization and then the organization updated. To update a WebHook the same procedure must be followed, first retrieving the organization followed by updating the appropriate WebHook, finally the organization is updated.", "verbs“: }



40
41
42
 
# File 'lib/bf_ruby2/models/organization.rb', line 40

def webhooks
  @webhooks
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'id' => :'id',
    :'customer_code' => :'customerCode',
    :'name' => :'name',
    :'deleted' => :'deleted',
    :'webhooks' => :'webhooks',
    :'_alias' => :'alias',
    :'clients' => :'clients',
    :'dunning_lines' => :'dunningLines',
    :'taxation_strategies' => :'taxationStrategies',
    :'organization_gateways' => :'organizationGateways',
    :'api_configurations' => :'apiConfigurations'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'id' => :'String',
    :'customer_code' => :'String',
    :'name' => :'String',
    :'deleted' => :'BOOLEAN',
    :'webhooks' => :'Array<MutableBillingEntity>',
    :'_alias' => :'Array<ModelAlias>',
    :'clients' => :'Array<Client>',
    :'dunning_lines' => :'Array<DunningLine>',
    :'taxation_strategies' => :'Array<MutableBillingEntity>',
    :'organization_gateways' => :'Array<MutableBillingEntity>',
    :'api_configurations' => :'Array<MutableBillingEntity>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/bf_ruby2/models/organization.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      id == o.id &&
      customer_code == o.customer_code &&
      name == o.name &&
      deleted == o.deleted &&
      webhooks == o.webhooks &&
      _alias == o._alias &&
      clients == o.clients &&
      dunning_lines == o.dunning_lines &&
      taxation_strategies == o.taxation_strategies &&
      organization_gateways == o.organization_gateways &&
      api_configurations == o.api_configurations
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



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
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/bf_ruby2/models/organization.rb', line 272

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/bf_ruby2/models/organization.rb', line 338

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/bf_ruby2/models/organization.rb', line 251

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 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


238
239
240
 
# File 'lib/bf_ruby2/models/organization.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



244
245
246
 
# File 'lib/bf_ruby2/models/organization.rb', line 244

def hash
  [created, changed_by, updated, id, customer_code, name, deleted, webhooks, _alias, clients, dunning_lines, taxation_strategies, organization_gateways, api_configurations].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/bf_ruby2/models/organization.rb', line 184

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

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

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

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

  return 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



318
319
320
 
# File 'lib/bf_ruby2/models/organization.rb', line 318

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



324
325
326
327
328
329
330
331
332
 
# File 'lib/bf_ruby2/models/organization.rb', line 324

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



312
313
314
 
# File 'lib/bf_ruby2/models/organization.rb', line 312

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



207
208
209
210
211
212
213
 
# File 'lib/bf_ruby2/models/organization.rb', line 207

def valid?
  return false if @customer_code.nil?
  return false if @name.nil?
  return false if @deleted.nil?
  return false if @webhooks.nil?
  return true
end