Class: OryClient::NormalizedProjectRevisionHook

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NormalizedProjectRevisionHook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#config_key ⇒ Object

The Hooks Config Key



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

def config_key
  @config_key
end

#created_at ⇒ Object

The Project’s Revision Creation Date



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

def created_at
  @created_at
end

#hook ⇒ Object

The Hook Type



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

def hook
  @hook
end

#id ⇒ Object

ID of the entry



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

def id
  @id
end

#project_revision_id ⇒ Object

The Revision’s ID this schema belongs to



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

def project_revision_id
  @project_revision_id
end

#updated_at ⇒ Object

Last Time Project’s Revision was Updated



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

def updated_at
  @updated_at
end

#web_hook_config_auth_api_key_in ⇒ Object

Whether to send the API Key in the HTTP Header or as a HTTP Cookie



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

def web_hook_config_auth_api_key_in
  @web_hook_config_auth_api_key_in
end

#web_hook_config_auth_api_key_name ⇒ Object

The name of the api key



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

def web_hook_config_auth_api_key_name
  @web_hook_config_auth_api_key_name
end

#web_hook_config_auth_api_key_value ⇒ Object

The value of the api key



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

def web_hook_config_auth_api_key_value
  @web_hook_config_auth_api_key_value
end

#web_hook_config_auth_basic_auth_password ⇒ Object

The password to be sent in the HTTP Basic Auth Header



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

def web_hook_config_auth_basic_auth_password
  @web_hook_config_auth_basic_auth_password
end

#web_hook_config_auth_basic_auth_user ⇒ Object

The username to be sent in the HTTP Basic Auth Header



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

def web_hook_config_auth_basic_auth_user
  @web_hook_config_auth_basic_auth_user
end

#web_hook_config_auth_type ⇒ Object

HTTP Auth Method to use for the Web-Hook



52
53
54
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 52

def web_hook_config_auth_type
  @web_hook_config_auth_type
end

#web_hook_config_body ⇒ Object

URI pointing to the JsonNet template used for Web-Hook payload generation. Only used for those HTTP methods, which support HTTP body payloads.



55
56
57
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 55

def web_hook_config_body
  @web_hook_config_body
end

#web_hook_config_can_interrupt ⇒ Object

If enabled allows the web hook to interrupt / abort the self-service flow. It only applies to certain flows (registration/verification/login/settings) and requires a valid response format.



58
59
60
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 58

def web_hook_config_can_interrupt
  @web_hook_config_can_interrupt
end

#web_hook_config_method ⇒ Object

The HTTP method to use (GET, POST, etc) for the Web-Hook



61
62
63
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 61

def web_hook_config_method
  @web_hook_config_method
end

#web_hook_config_response_ignore ⇒ Object

Whether to ignore the Web Hook response



64
65
66
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 64

def web_hook_config_response_ignore
  @web_hook_config_response_ignore
end

#web_hook_config_response_parse ⇒ Object

Whether to parse the Web Hook response



67
68
69
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 67

def web_hook_config_response_parse
  @web_hook_config_response_parse
end

#web_hook_config_url ⇒ Object

The URL the Web-Hook should call



70
71
72
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 70

def web_hook_config_url
  @web_hook_config_url
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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 312

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_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 73

def self.attribute_map
  {
    :'config_key' => :'config_key',
    :'created_at' => :'created_at',
    :'hook' => :'hook',
    :'id' => :'id',
    :'project_revision_id' => :'project_revision_id',
    :'updated_at' => :'updated_at',
    :'web_hook_config_auth_api_key_in' => :'web_hook_config_auth_api_key_in',
    :'web_hook_config_auth_api_key_name' => :'web_hook_config_auth_api_key_name',
    :'web_hook_config_auth_api_key_value' => :'web_hook_config_auth_api_key_value',
    :'web_hook_config_auth_basic_auth_password' => :'web_hook_config_auth_basic_auth_password',
    :'web_hook_config_auth_basic_auth_user' => :'web_hook_config_auth_basic_auth_user',
    :'web_hook_config_auth_type' => :'web_hook_config_auth_type',
    :'web_hook_config_body' => :'web_hook_config_body',
    :'web_hook_config_can_interrupt' => :'web_hook_config_can_interrupt',
    :'web_hook_config_method' => :'web_hook_config_method',
    :'web_hook_config_response_ignore' => :'web_hook_config_response_ignore',
    :'web_hook_config_response_parse' => :'web_hook_config_response_parse',
    :'web_hook_config_url' => :'web_hook_config_url'
  }
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 288

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



126
127
128
129
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 102

def self.openapi_types
  {
    :'config_key' => :'String',
    :'created_at' => :'Time',
    :'hook' => :'String',
    :'id' => :'String',
    :'project_revision_id' => :'String',
    :'updated_at' => :'Time',
    :'web_hook_config_auth_api_key_in' => :'String',
    :'web_hook_config_auth_api_key_name' => :'String',
    :'web_hook_config_auth_api_key_value' => :'String',
    :'web_hook_config_auth_basic_auth_password' => :'String',
    :'web_hook_config_auth_basic_auth_user' => :'String',
    :'web_hook_config_auth_type' => :'String',
    :'web_hook_config_body' => :'String',
    :'web_hook_config_can_interrupt' => :'Boolean',
    :'web_hook_config_method' => :'String',
    :'web_hook_config_response_ignore' => :'Boolean',
    :'web_hook_config_response_parse' => :'Boolean',
    :'web_hook_config_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 250

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      config_key == o.config_key &&
      created_at == o.created_at &&
      hook == o.hook &&
      id == o.id &&
      project_revision_id == o.project_revision_id &&
      updated_at == o.updated_at &&
      web_hook_config_auth_api_key_in == o.web_hook_config_auth_api_key_in &&
      web_hook_config_auth_api_key_name == o.web_hook_config_auth_api_key_name &&
      web_hook_config_auth_api_key_value == o.web_hook_config_auth_api_key_value &&
      web_hook_config_auth_basic_auth_password == o.web_hook_config_auth_basic_auth_password &&
      web_hook_config_auth_basic_auth_user == o.web_hook_config_auth_basic_auth_user &&
      web_hook_config_auth_type == o.web_hook_config_auth_type &&
      web_hook_config_body == o.web_hook_config_body &&
      web_hook_config_can_interrupt == o.web_hook_config_can_interrupt &&
      web_hook_config_method == o.web_hook_config_method &&
      web_hook_config_response_ignore == o.web_hook_config_response_ignore &&
      web_hook_config_response_parse == o.web_hook_config_response_parse &&
      web_hook_config_url == o.web_hook_config_url
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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 383

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


275
276
277
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 275

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



281
282
283
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 281

def hash
  [config_key, created_at, hook, id, project_revision_id, updated_at, web_hook_config_auth_api_key_in, web_hook_config_auth_api_key_name, web_hook_config_auth_api_key_value, web_hook_config_auth_basic_auth_password, web_hook_config_auth_basic_auth_user, web_hook_config_auth_type, web_hook_config_body, web_hook_config_can_interrupt, web_hook_config_method, web_hook_config_response_ignore, web_hook_config_response_parse, web_hook_config_url].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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 225

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

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



359
360
361
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 359

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 365

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



353
354
355
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 353

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



241
242
243
244
245
246
 
# File 'lib/ory-client/models/normalized_project_revision_hook.rb', line 241

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @config_key.nil?
  return false if @hook.nil?
  true
end