Class: Zernio::CreateApiKeyRequest

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/create_api_key_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 99

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

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

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

  if attributes.key?(:'permission')
    self.permission = attributes[:'permission']
  else
    self.permission = 'read-write'
  end

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

Instance Attribute Details

#disabled_resource_groups ⇒ Object

Resource groups to DISABLE on this key (opt-out denylist). Omit for a legacy full-access key. A key with any group disabled mints with the zrk_ prefix, gets 403 with code=insufficient_permissions and required_group on operations in disabled groups (each operation's group is published as x-resource-group), and can never manage API keys, invites, or member identity. With 'messages' disabled, the key cannot read or send private messages through any API surface and cannot create or edit a webhook subscription broader than itself. Subscriptions that already exist are governed by their own disabledResourceGroups, not by this key's. OAuth connector tokens resolve against the same registry, but their groups are not settable yet.



33
34
35
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 33

def disabled_resource_groups
  @disabled_resource_groups
end

#expires_in ⇒ Object

Days until expiry



21
22
23
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 21

def expires_in
  @expires_in
end

#name ⇒ Object

Returns the value of attribute name.



18
19
20
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 18

def name
  @name
end

#permission ⇒ Object

'read-write' allows all operations (default), 'read' restricts to GET requests only



30
31
32
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 30

def permission
  @permission
end

#profile_ids ⇒ Object

Profile IDs this key can access. Required when scope is 'profiles'.



27
28
29
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 27

def profile_ids
  @profile_ids
end

#scope ⇒ Object

'full' grants access to all profiles (default), 'profiles' restricts to specific profiles



24
25
26
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 24

def scope
  @scope
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 58

def self.attribute_map
  {
    :'name' => :'name',
    :'expires_in' => :'expiresIn',
    :'scope' => :'scope',
    :'profile_ids' => :'profileIds',
    :'permission' => :'permission',
    :'disabled_resource_groups' => :'disabledResourceGroups'
  }
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 230

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
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 92

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 80

def self.openapi_types
  {
    :'name' => :'String',
    :'expires_in' => :'Integer',
    :'scope' => :'String',
    :'profile_ids' => :'Array<String>',
    :'permission' => :'String',
    :'disabled_resource_groups' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      expires_in == o.expires_in &&
      scope == o.scope &&
      profile_ids == o.profile_ids &&
      permission == o.permission &&
      disabled_resource_groups == o.disabled_resource_groups
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 223

def hash
  [name, expires_in, scope, profile_ids, permission, disabled_resource_groups].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



150
151
152
153
154
155
156
157
158
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 150

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 252

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



162
163
164
165
166
167
168
169
170
 
# File 'lib/zernio-sdk/models/create_api_key_request.rb', line 162

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  scope_validator = EnumAttributeValidator.new('String', ["full", "profiles"])
  return false unless scope_validator.valid?(@scope)
  permission_validator = EnumAttributeValidator.new('String', ["read-write", "read"])
  return false unless permission_validator.valid?(@permission)
  true
end