Class: OryClient::NormalizedProjectRevisionCourierChannel

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/models/normalized_project_revision_courier_channel.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NormalizedProjectRevisionCourierChannel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
201
202
203
204
205
206
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 135

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#channel_id ⇒ Object

The Channel’s public ID



19
20
21
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 19

def channel_id
  @channel_id
end

#created_at ⇒ Object

The creation date



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

def created_at
  @created_at
end

#request_config_auth_config_api_key_in ⇒ Object

API key location Can either be "header" or "query"



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

def request_config_auth_config_api_key_in
  @request_config_auth_config_api_key_in
end

#request_config_auth_config_api_key_name ⇒ Object

API key name Only used if the auth type is api_key



28
29
30
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 28

def request_config_auth_config_api_key_name
  @request_config_auth_config_api_key_name
end

#request_config_auth_config_api_key_value ⇒ Object

API key value Only used if the auth type is api_key



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

def request_config_auth_config_api_key_value
  @request_config_auth_config_api_key_value
end

#request_config_auth_config_basic_auth_password ⇒ Object

Basic Auth Password Only used if the auth type is basic_auth



34
35
36
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 34

def request_config_auth_config_basic_auth_password
  @request_config_auth_config_basic_auth_password
end

#request_config_auth_config_basic_auth_user ⇒ Object

Basic Auth Username Only used if the auth type is basic_auth



37
38
39
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 37

def request_config_auth_config_basic_auth_user
  @request_config_auth_config_basic_auth_user
end

#request_config_auth_type ⇒ Object

HTTP Auth Method to use for the HTTP call Can either be basic_auth or api_key basic_auth CourierChannelAuthTypeBasicAuth api_key CourierChannelAuthTypeApiKey



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

def request_config_auth_type
  @request_config_auth_type
end

#request_config_body ⇒ Object

URI pointing to the JsonNet template used for HTTP body payload generation.



43
44
45
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 43

def request_config_body
  @request_config_body
end

#request_config_headers ⇒ Object

NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-



46
47
48
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 46

def request_config_headers
  @request_config_headers
end

#request_config_method ⇒ Object

The HTTP method to use (GET, POST, etc) for the HTTP call



49
50
51
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 49

def request_config_method
  @request_config_method
end

#request_config_url ⇒ Object

Returns the value of attribute request_config_url.



51
52
53
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 51

def request_config_url
  @request_config_url
end

#updated_at ⇒ Object

Last upate time



54
55
56
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 54

def updated_at
  @updated_at
end

Class Method Details

._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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 339

def self._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 = OryClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



98
99
100
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 98

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 103

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 79

def self.attribute_map
  {
    :'channel_id' => :'channel_id',
    :'created_at' => :'created_at',
    :'request_config_auth_config_api_key_in' => :'request_config_auth_config_api_key_in',
    :'request_config_auth_config_api_key_name' => :'request_config_auth_config_api_key_name',
    :'request_config_auth_config_api_key_value' => :'request_config_auth_config_api_key_value',
    :'request_config_auth_config_basic_auth_password' => :'request_config_auth_config_basic_auth_password',
    :'request_config_auth_config_basic_auth_user' => :'request_config_auth_config_basic_auth_user',
    :'request_config_auth_type' => :'request_config_auth_type',
    :'request_config_body' => :'request_config_body',
    :'request_config_headers' => :'request_config_headers',
    :'request_config_method' => :'request_config_method',
    :'request_config_url' => :'request_config_url',
    :'updated_at' => :'updated_at'
  }
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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 315

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



127
128
129
130
131
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 108

def self.openapi_types
  {
    :'channel_id' => :'String',
    :'created_at' => :'Time',
    :'request_config_auth_config_api_key_in' => :'String',
    :'request_config_auth_config_api_key_name' => :'String',
    :'request_config_auth_config_api_key_value' => :'String',
    :'request_config_auth_config_basic_auth_password' => :'String',
    :'request_config_auth_config_basic_auth_user' => :'String',
    :'request_config_auth_type' => :'String',
    :'request_config_body' => :'String',
    :'request_config_headers' => :'Object',
    :'request_config_method' => :'String',
    :'request_config_url' => :'String',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      channel_id == o.channel_id &&
      created_at == o.created_at &&
      request_config_auth_config_api_key_in == o.request_config_auth_config_api_key_in &&
      request_config_auth_config_api_key_name == o.request_config_auth_config_api_key_name &&
      request_config_auth_config_api_key_value == o.request_config_auth_config_api_key_value &&
      request_config_auth_config_basic_auth_password == o.request_config_auth_config_basic_auth_password &&
      request_config_auth_config_basic_auth_user == o.request_config_auth_config_basic_auth_user &&
      request_config_auth_type == o.request_config_auth_type &&
      request_config_body == o.request_config_body &&
      request_config_headers == o.request_config_headers &&
      request_config_method == o.request_config_method &&
      request_config_url == o.request_config_url &&
      updated_at == o.updated_at
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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 410

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


302
303
304
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 308

def hash
  [channel_id, created_at, request_config_auth_config_api_key_in, request_config_auth_config_api_key_name, request_config_auth_config_api_key_value, request_config_auth_config_basic_auth_password, request_config_auth_config_basic_auth_user, request_config_auth_type, request_config_body, request_config_headers, request_config_method, request_config_url, 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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 210

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

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

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

  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



386
387
388
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 386

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 392

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



380
381
382
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 380

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



230
231
232
233
234
235
236
237
238
 
# File 'lib/ory-client/models/normalized_project_revision_courier_channel.rb', line 230

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @channel_id.nil?
  request_config_auth_type_validator = EnumAttributeValidator.new('String', ["basic_auth", "api_key"])
  return false unless request_config_auth_type_validator.valid?(@request_config_auth_type)
  return false if @request_config_body.nil?
  return false if @request_config_method.nil?
  true
end