Class: OryClient::ImportAPIKeyRequest

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/import_api_key_request.rb

Overview

Example: { "raw_key": "sk_live_abc123xyz789", "name": "Stripe Production Key", "actor_id": "payment-processor", "scopes": ["read", "write"], "ttl": "8760h", // 1 year (also accepts: 31536000s) "metadata": "stripe", "environment": "production" }

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 114

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#actor_id ⇒ Object

actor_id is the identifier of the entity that owns this imported key. Required so every imported key is traceable to an actor for revocation and audit queries.



20
21
22
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 20

def actor_id
  @actor_id
end

#ip_restriction ⇒ Object

Returns the value of attribute ip_restriction.



22
23
24
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 22

def ip_restriction
  @ip_restriction
end

#metadata ⇒ Object

metadata is a free-form JSON object for caller-defined attributes (e.g., source, environment, tags). Values may be strings, numbers, booleans, arrays, objects, or null. Total serialized size is capped at 4KB. AIP-148 metadata field.



25
26
27
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 25

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



27
28
29
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 27

def name
  @name
end

#rate_limit_policy ⇒ Object

Returns the value of attribute rate_limit_policy.



29
30
31
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 29

def rate_limit_policy
  @rate_limit_policy
end

#raw_key ⇒ Object

Returns the value of attribute raw_key.



31
32
33
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 31

def raw_key
  @raw_key
end

#request_id ⇒ Object

Returns the value of attribute request_id.



33
34
35
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 33

def request_id
  @request_id
end

#scopes ⇒ Object

Returns the value of attribute scopes.



35
36
37
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 35

def scopes
  @scopes
end

#ttl ⇒ Object

ttl sets the expiry as a duration from now. Encoded as a google.protobuf.Duration (string ending in "s", e.g. "3600s"). Accepted bounds: 1s to 315360000s (~10 years). If unset or zero, the project default TTL applies. For convenience, the server also accepts Go-style duration strings ("24h", "30m", "1h30m") and an extended unit set ("1d", "1w", "1mo", "1y"; approximations: 1mo = 30d, 1y = 365d). Clients should prefer the standard Duration encoding for portability.



38
39
40
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 38

def ttl
  @ttl
end

#visibility ⇒ Object

Returns the value of attribute visibility.



40
41
42
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 40

def visibility
  @visibility
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



81
82
83
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 81

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 86

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 65

def self.attribute_map
  {
    :'actor_id' => :'actor_id',
    :'ip_restriction' => :'ip_restriction',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'rate_limit_policy' => :'rate_limit_policy',
    :'raw_key' => :'raw_key',
    :'request_id' => :'request_id',
    :'scopes' => :'scopes',
    :'ttl' => :'ttl',
    :'visibility' => :'visibility'
  }
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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 220

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



107
108
109
110
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 91

def self.openapi_types
  {
    :'actor_id' => :'String',
    :'ip_restriction' => :'IPRestriction',
    :'metadata' => :'Object',
    :'name' => :'String',
    :'rate_limit_policy' => :'RateLimitPolicy',
    :'raw_key' => :'String',
    :'request_id' => :'String',
    :'scopes' => :'Array<String>',
    :'ttl' => :'String',
    :'visibility' => :'KeyVisibility'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      actor_id == o.actor_id &&
      ip_restriction == o.ip_restriction &&
      metadata == o.metadata &&
      name == o.name &&
      rate_limit_policy == o.rate_limit_policy &&
      raw_key == o.raw_key &&
      request_id == o.request_id &&
      scopes == o.scopes &&
      ttl == o.ttl &&
      visibility == o.visibility
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


207
208
209
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 213

def hash
  [actor_id, ip_restriction, metadata, name, rate_limit_policy, raw_key, request_id, scopes, ttl, visibility].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



175
176
177
178
179
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 175

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 242

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



183
184
185
186
 
# File 'lib/ory-client/models/import_api_key_request.rb', line 183

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end