Class: Spatio::Organization

Inherits:
ApiModelBase show all
Defined in:
lib/spatio-sdk/models/organization.rb

Overview

Organization summary used in list responses (‘GET /v1/organizations`, `GET /v1/organizations/#id/workspaces`). Returned with camelCase field names. NB: The single-org GET `/v1/organizations/#id` returns a *different shape* (`OrganizationDetailLegacy`, PascalCase keys) today — see that schema for the wire-level reality. This is a known inconsistency the platform-service is expected to converge on the camelCase shape in a future cleanup.

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 = {}) ⇒ Organization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/spatio-sdk/models/organization.rb', line 97

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



39
40
41
 
# File 'lib/spatio-sdk/models/organization.rb', line 39

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



25
26
27
 
# File 'lib/spatio-sdk/models/organization.rb', line 25

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/spatio-sdk/models/organization.rb', line 19

def id
  @id
end

#logo_url ⇒ Object

Returns the value of attribute logo_url.



27
28
29
 
# File 'lib/spatio-sdk/models/organization.rb', line 27

def logo_url
  @logo_url
end

#member_count ⇒ Object

Returns the value of attribute member_count.



32
33
34
 
# File 'lib/spatio-sdk/models/organization.rb', line 32

def member_count
  @member_count
end

#name ⇒ Object

Returns the value of attribute name.



21
22
23
 
# File 'lib/spatio-sdk/models/organization.rb', line 21

def name
  @name
end

#role ⇒ Object

The caller’s role in this org (‘owner`, `admin`, `billing_admin`, `member`).



30
31
32
 
# File 'lib/spatio-sdk/models/organization.rb', line 30

def role
  @role
end

#slug ⇒ Object

Returns the value of attribute slug.



23
24
25
 
# File 'lib/spatio-sdk/models/organization.rb', line 23

def slug
  @slug
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



41
42
43
 
# File 'lib/spatio-sdk/models/organization.rb', line 41

def updated_at
  @updated_at
end

#workspace_count ⇒ Object

Returns the value of attribute workspace_count.



34
35
36
 
# File 'lib/spatio-sdk/models/organization.rb', line 34

def workspace_count
  @workspace_count
end

#workspaces ⇒ Object

Compact workspace summaries embedded in the org-list response.



37
38
39
 
# File 'lib/spatio-sdk/models/organization.rb', line 37

def workspaces
  @workspaces
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



61
62
63
 
# File 'lib/spatio-sdk/models/organization.rb', line 61

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/spatio-sdk/models/organization.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.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
 
# File 'lib/spatio-sdk/models/organization.rb', line 44

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'slug' => :'slug',
    :'description' => :'description',
    :'logo_url' => :'logoUrl',
    :'role' => :'role',
    :'member_count' => :'memberCount',
    :'workspace_count' => :'workspaceCount',
    :'workspaces' => :'workspaces',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt'
  }
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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/spatio-sdk/models/organization.rb', line 308

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



88
89
90
91
92
93
 
# File 'lib/spatio-sdk/models/organization.rb', line 88

def self.openapi_nullable
  Set.new([
    :'description',
    :'logo_url',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/spatio-sdk/models/organization.rb', line 71

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'slug' => :'String',
    :'description' => :'String',
    :'logo_url' => :'String',
    :'role' => :'String',
    :'member_count' => :'Integer',
    :'workspace_count' => :'Integer',
    :'workspaces' => :'Array<OrganizationWorkspacesInner>',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/spatio-sdk/models/organization.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      slug == o.slug &&
      description == o.description &&
      logo_url == o.logo_url &&
      role == o.role &&
      member_count == o.member_count &&
      workspace_count == o.workspace_count &&
      workspaces == o.workspaces &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


295
296
297
 
# File 'lib/spatio-sdk/models/organization.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



301
302
303
 
# File 'lib/spatio-sdk/models/organization.rb', line 301

def hash
  [id, name, slug, description, logo_url, role, member_count, workspace_count, workspaces, created_at, updated_at].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



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
 
# File 'lib/spatio-sdk/models/organization.rb', line 172

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

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

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

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

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

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/spatio-sdk/models/organization.rb', line 330

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



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/spatio-sdk/models/organization.rb', line 204

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @name.nil?
  return false if @slug.nil?
  return false if @role.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end