Class: Fastly::Customer

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/customer.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Customer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
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
263
264
265
266
267
268
269
270
271
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
 
# File 'lib/fastly/models/customer.rb', line 190

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::Customer` 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 `Fastly::Customer`. 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?(:'billing_contact_id')
    self.billing_contact_id = attributes[:'billing_contact_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_contact_id ⇒ Object

The alphanumeric string representing the primary billing contact.



17
18
19
 
# File 'lib/fastly/models/customer.rb', line 17

def billing_contact_id
  @billing_contact_id
end

#billing_network_type ⇒ Object

Customer’s current network revenue type.



20
21
22
 
# File 'lib/fastly/models/customer.rb', line 20

def billing_network_type
  @billing_network_type
end

#billing_ref ⇒ Object

Used for adding purchased orders to customer’s account.



23
24
25
 
# File 'lib/fastly/models/customer.rb', line 23

def billing_ref
  @billing_ref
end

#can_configure_wordpress ⇒ Object

Whether this customer can view or edit wordpress.



26
27
28
 
# File 'lib/fastly/models/customer.rb', line 26

def can_configure_wordpress
  @can_configure_wordpress
end

#can_reset_passwords ⇒ Object

Whether this customer can reset passwords.



29
30
31
 
# File 'lib/fastly/models/customer.rb', line 29

def can_reset_passwords
  @can_reset_passwords
end

#can_upload_vcl ⇒ Object

Whether this customer can upload VCL.



32
33
34
 
# File 'lib/fastly/models/customer.rb', line 32

def can_upload_vcl
  @can_upload_vcl
end

#force_2fa ⇒ Object

Specifies whether 2FA is forced or not forced on the customer account. Logs out non-2FA users once 2FA is force enabled.



35
36
37
 
# File 'lib/fastly/models/customer.rb', line 35

def force_2fa
  @force_2fa
end

#force_sso ⇒ Object

Specifies whether SSO is forced or not forced on the customer account.



38
39
40
 
# File 'lib/fastly/models/customer.rb', line 38

def force_sso
  @force_sso
end

#has_account_panel ⇒ Object

Specifies whether the account has access or does not have access to the account panel.



41
42
43
 
# File 'lib/fastly/models/customer.rb', line 41

def 
  @has_account_panel
end

#has_improved_events ⇒ Object

Specifies whether the account has access or does not have access to the improved events.



44
45
46
 
# File 'lib/fastly/models/customer.rb', line 44

def has_improved_events
  @has_improved_events
end

#has_improved_ssl_config ⇒ Object

Whether this customer can view or edit the SSL config.



47
48
49
 
# File 'lib/fastly/models/customer.rb', line 47

def has_improved_ssl_config
  @has_improved_ssl_config
end

#has_openstack_logging ⇒ Object

Specifies whether the account has enabled or not enabled openstack logging.



50
51
52
 
# File 'lib/fastly/models/customer.rb', line 50

def has_openstack_logging
  @has_openstack_logging
end

#has_pci ⇒ Object

Specifies whether the account can edit PCI for a service.



53
54
55
 
# File 'lib/fastly/models/customer.rb', line 53

def has_pci
  @has_pci
end

#has_pci_passwords ⇒ Object

Specifies whether PCI passwords are required for the account.



56
57
58
 
# File 'lib/fastly/models/customer.rb', line 56

def has_pci_passwords
  @has_pci_passwords
end

#ip_whitelist ⇒ Object

The range of IP addresses authorized to access the customer account.



59
60
61
 
# File 'lib/fastly/models/customer.rb', line 59

def ip_whitelist
  @ip_whitelist
end

#legal_contact_id ⇒ Object

The alphanumeric string identifying the account’s legal contact.



62
63
64
 
# File 'lib/fastly/models/customer.rb', line 62

def legal_contact_id
  @legal_contact_id
end

#name ⇒ Object

The name of the customer, generally the company name.



65
66
67
 
# File 'lib/fastly/models/customer.rb', line 65

def name
  @name
end

#owner_id ⇒ Object

The alphanumeric string identifying the account owner.



68
69
70
 
# File 'lib/fastly/models/customer.rb', line 68

def owner_id
  @owner_id
end

#phone_number ⇒ Object

The phone number associated with the account.



71
72
73
 
# File 'lib/fastly/models/customer.rb', line 71

def phone_number
  @phone_number
end

#postal_address ⇒ Object

The postal address associated with the account.



74
75
76
 
# File 'lib/fastly/models/customer.rb', line 74

def postal_address
  @postal_address
end

#pricing_plan ⇒ Object

The pricing plan this customer is under.



77
78
79
 
# File 'lib/fastly/models/customer.rb', line 77

def pricing_plan
  @pricing_plan
end

#pricing_plan_id ⇒ Object

The alphanumeric string identifying the pricing plan.



80
81
82
 
# File 'lib/fastly/models/customer.rb', line 80

def pricing_plan_id
  @pricing_plan_id
end

#security_contact_id ⇒ Object

The alphanumeric string identifying the account’s security contact.



83
84
85
 
# File 'lib/fastly/models/customer.rb', line 83

def security_contact_id
  @security_contact_id
end

#technical_contact_id ⇒ Object

The alphanumeric string identifying the account’s technical contact.



86
87
88
 
# File 'lib/fastly/models/customer.rb', line 86

def technical_contact_id
  @technical_contact_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



141
142
143
 
# File 'lib/fastly/models/customer.rb', line 141

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/fastly/models/customer.rb', line 111

def self.attribute_map
  {
    :'billing_contact_id' => :'billing_contact_id',
    :'billing_network_type' => :'billing_network_type',
    :'billing_ref' => :'billing_ref',
    :'can_configure_wordpress' => :'can_configure_wordpress',
    :'can_reset_passwords' => :'can_reset_passwords',
    :'can_upload_vcl' => :'can_upload_vcl',
    :'force_2fa' => :'force_2fa',
    :'force_sso' => :'force_sso',
    :'has_account_panel' => :'has_account_panel',
    :'has_improved_events' => :'has_improved_events',
    :'has_improved_ssl_config' => :'has_improved_ssl_config',
    :'has_openstack_logging' => :'has_openstack_logging',
    :'has_pci' => :'has_pci',
    :'has_pci_passwords' => :'has_pci_passwords',
    :'ip_whitelist' => :'ip_whitelist',
    :'legal_contact_id' => :'legal_contact_id',
    :'name' => :'name',
    :'owner_id' => :'owner_id',
    :'phone_number' => :'phone_number',
    :'postal_address' => :'postal_address',
    :'pricing_plan' => :'pricing_plan',
    :'pricing_plan_id' => :'pricing_plan_id',
    :'security_contact_id' => :'security_contact_id',
    :'technical_contact_id' => :'technical_contact_id'
  }
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



371
372
373
 
# File 'lib/fastly/models/customer.rb', line 371

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

.fastly_nullable ⇒ Object

List of attributes with nullable: true



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/fastly/models/customer.rb', line 176

def self.fastly_nullable
  Set.new([
    :'billing_contact_id',
    :'billing_ref',
    :'can_configure_wordpress',
    :'legal_contact_id',
    :'postal_address',
    :'security_contact_id',
    :'technical_contact_id'
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/fastly/models/customer.rb', line 146

def self.fastly_types
  {
    :'billing_contact_id' => :'String',
    :'billing_network_type' => :'String',
    :'billing_ref' => :'String',
    :'can_configure_wordpress' => :'Boolean',
    :'can_reset_passwords' => :'Boolean',
    :'can_upload_vcl' => :'Boolean',
    :'force_2fa' => :'Boolean',
    :'force_sso' => :'Boolean',
    :'has_account_panel' => :'Boolean',
    :'has_improved_events' => :'Boolean',
    :'has_improved_ssl_config' => :'Boolean',
    :'has_openstack_logging' => :'Boolean',
    :'has_pci' => :'Boolean',
    :'has_pci_passwords' => :'Boolean',
    :'ip_whitelist' => :'String',
    :'legal_contact_id' => :'String',
    :'name' => :'String',
    :'owner_id' => :'String',
    :'phone_number' => :'String',
    :'postal_address' => :'String',
    :'pricing_plan' => :'String',
    :'pricing_plan_id' => :'String',
    :'security_contact_id' => :'String',
    :'technical_contact_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/fastly/models/customer.rb', line 327

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      billing_contact_id == o.billing_contact_id &&
      billing_network_type == o.billing_network_type &&
      billing_ref == o.billing_ref &&
      can_configure_wordpress == o.can_configure_wordpress &&
      can_reset_passwords == o.can_reset_passwords &&
      can_upload_vcl == o.can_upload_vcl &&
      force_2fa == o.force_2fa &&
      force_sso == o.force_sso &&
       == o. &&
      has_improved_events == o.has_improved_events &&
      has_improved_ssl_config == o.has_improved_ssl_config &&
      has_openstack_logging == o.has_openstack_logging &&
      has_pci == o.has_pci &&
      has_pci_passwords == o.has_pci_passwords &&
      ip_whitelist == o.ip_whitelist &&
      legal_contact_id == o.legal_contact_id &&
      name == o.name &&
      owner_id == o.owner_id &&
      phone_number == o.phone_number &&
      postal_address == o.postal_address &&
      pricing_plan == o.pricing_plan &&
      pricing_plan_id == o.pricing_plan_id &&
      security_contact_id == o.security_contact_id &&
      technical_contact_id == o.technical_contact_id
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



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/fastly/models/customer.rb', line 401

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Fastly.const_get(type)
    klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.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



472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/fastly/models/customer.rb', line 472

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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/fastly/models/customer.rb', line 378

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


358
359
360
 
# File 'lib/fastly/models/customer.rb', line 358

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



364
365
366
 
# File 'lib/fastly/models/customer.rb', line 364

def hash
  [billing_contact_id, billing_network_type, billing_ref, can_configure_wordpress, can_reset_passwords, can_upload_vcl, force_2fa, force_sso, , has_improved_events, has_improved_ssl_config, has_openstack_logging, has_pci, has_pci_passwords, ip_whitelist, legal_contact_id, name, owner_id, phone_number, postal_address, pricing_plan, pricing_plan_id, security_contact_id, technical_contact_id].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



302
303
304
305
 
# File 'lib/fastly/models/customer.rb', line 302

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



448
449
450
 
# File 'lib/fastly/models/customer.rb', line 448

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



454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/fastly/models/customer.rb', line 454

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



442
443
444
 
# File 'lib/fastly/models/customer.rb', line 442

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



309
310
311
312
313
 
# File 'lib/fastly/models/customer.rb', line 309

def valid?
  billing_network_type_validator = EnumAttributeValidator.new('String', ["public", "private"])
  return false unless billing_network_type_validator.valid?(@billing_network_type)
  true
end