Class: SmplkitGeneratedClient::App::Account

Inherits:
ApiModelBase show all
Defined in:
lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb

Overview

A tenant of smplkit — the unit of isolation that owns all of a customer’s resources (environments, contexts, API keys, and so on).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Account

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 107

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

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

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

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

  if attributes.key?(:'has_stripe_customer')
    self.has_stripe_customer = attributes[:'has_stripe_customer']
  else
    self.has_stripe_customer = false
  end

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

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

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

  if attributes.key?(:'product_subscriptions')
    if (value = attributes[:'product_subscriptions']).is_a?(Hash)
      self.product_subscriptions = value
    end
  end

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

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

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

Instance Attribute Details

#created_at ⇒ Object

When the account was created.



32
33
34
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 32

def created_at
  @created_at
end

#deleted_at ⇒ Object

When the account was deleted. ‘null` for active accounts.



35
36
37
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 35

def deleted_at
  @deleted_at
end

#discount_override_pct ⇒ Object

Custom discount percentage applied to the account in place of the volume-based discount schedule. ‘null` means the volume schedule applies. Who set it, when, and why are captured in the audit-event stream rather than on the subscription row.



47
48
49
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 47

def discount_override_pct
  @discount_override_pct
end

#entry_point ⇒ Object

How the account first reached smplkit (e.g. ‘LOGIN`, `GET_STARTED`, `LIVE_DEMO`).



41
42
43
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 41

def entry_point
  @entry_point
end

#expires_at ⇒ Object

When the account is scheduled to expire. ‘null` for accounts with no expiry.



29
30
31
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 29

def expires_at
  @expires_at
end

#has_stripe_customer ⇒ Object

‘true` once the account has been linked to a billing provider customer record.



26
27
28
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 26

def has_stripe_customer
  @has_stripe_customer
end

#key ⇒ Object

Stable URL-safe identifier for the account, derived from the account name at creation. Used in console URLs and other places that prefer a human-readable handle.



23
24
25
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 23

def key
  @key
end

#name ⇒ Object

Human-readable name for the account.



20
21
22
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 20

def name
  @name
end

#product_subscriptions ⇒ Object

Map of product key to the account’s subscription summary for that product, including plan, status, and entitlement limits.



38
39
40
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 38

def product_subscriptions
  @product_subscriptions
end

#show_sample_data ⇒ Object

Whether the account is currently configured to display the sample dataset alongside the customer’s own resources.



44
45
46
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 44

def show_sample_data
  @show_sample_data
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 50

def self.attribute_map
  {
    :'name' => :'name',
    :'key' => :'key',
    :'has_stripe_customer' => :'has_stripe_customer',
    :'expires_at' => :'expires_at',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'product_subscriptions' => :'product_subscriptions',
    :'entry_point' => :'entry_point',
    :'show_sample_data' => :'show_sample_data',
    :'discount_override_pct' => :'discount_override_pct'
  }
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 239

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 92

def self.openapi_nullable
  Set.new([
    :'key',
    :'expires_at',
    :'created_at',
    :'deleted_at',
    :'product_subscriptions',
    :'entry_point',
    :'show_sample_data',
    :'discount_override_pct'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 76

def self.openapi_types
  {
    :'name' => :'String',
    :'key' => :'String',
    :'has_stripe_customer' => :'Boolean',
    :'expires_at' => :'Time',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'product_subscriptions' => :'Hash<String, Object>',
    :'entry_point' => :'String',
    :'show_sample_data' => :'Boolean',
    :'discount_override_pct' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      key == o.key &&
      has_stripe_customer == o.has_stripe_customer &&
      expires_at == o.expires_at &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      product_subscriptions == o.product_subscriptions &&
      entry_point == o.entry_point &&
      show_sample_data == o.show_sample_data &&
      discount_override_pct == o.discount_override_pct
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 232

def hash
  [name, key, has_stripe_customer, expires_at, created_at, deleted_at, product_subscriptions, entry_point, show_sample_data, discount_override_pct].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



170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 170

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 261

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

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



186
187
188
189
190
191
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 255
  true
end