Class: Bandwidth::WebhookSubscriptionRequestSchema

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 64

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

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

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

Instance Attribute Details

#basic_authentication ⇒ Object

Returns the value of attribute basic_authentication.



18
19
20
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 18

def basic_authentication
  @basic_authentication
end

#callback_url ⇒ Object

Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID.



21
22
23
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 21

def callback_url
  @callback_url
end

#shared_secret_key ⇒ Object

An ASCII string submitted by the user as a shared secret key for generating an HMAC header for callbacks.



24
25
26
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 24

def shared_secret_key
  @shared_secret_key
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



36
37
38
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 36

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



41
42
43
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 41

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 27

def self.attribute_map
  {
    :'basic_authentication' => :'basicAuthentication',
    :'callback_url' => :'callbackUrl',
    :'shared_secret_key' => :'sharedSecretKey'
  }
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 203

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



55
56
57
58
59
60
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 55

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 46

def self.openapi_types
  {
    :'basic_authentication' => :'TfvBasicAuthentication',
    :'callback_url' => :'String',
    :'shared_secret_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      basic_authentication == o.basic_authentication &&
      callback_url == o.callback_url &&
      shared_secret_key == o.shared_secret_key
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


190
191
192
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



196
197
198
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 196

def hash
  [basic_authentication, callback_url, shared_secret_key].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



95
96
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
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 95

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @callback_url.to_s.length > 2000
    invalid_properties.push('invalid value for "callback_url", the character length must be smaller than or equal to 2000.')
  end

  if @callback_url.to_s.length < 0
    invalid_properties.push('invalid value for "callback_url", the character length must be greater than or equal to 0.')
  end

  pattern = Regexp.new(/^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&\/\/=]*)/)
  if @callback_url !~ pattern
    invalid_properties.push("invalid value for \"callback_url\", must conform to the pattern #{pattern}.")
  end

  if !@shared_secret_key.nil? && @shared_secret_key.to_s.length > 64
    invalid_properties.push('invalid value for "shared_secret_key", the character length must be smaller than or equal to 64.')
  end

  if !@shared_secret_key.nil? && @shared_secret_key.to_s.length < 16
    invalid_properties.push('invalid value for "shared_secret_key", the character length must be greater than or equal to 16.')
  end

  pattern = Regexp.new(/^[ -~]{16,64}$/)
  if !@shared_secret_key.nil? && @shared_secret_key !~ pattern
    invalid_properties.push("invalid value for \"shared_secret_key\", must conform to the pattern #{pattern}.")
  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



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

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



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb', line 129

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @callback_url.to_s.length > 2000
  return false if @callback_url.to_s.length < 0
  return false if @callback_url !~ Regexp.new(/^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&\/\/=]*)/)
  return false if !@shared_secret_key.nil? && @shared_secret_key.to_s.length > 64
  return false if !@shared_secret_key.nil? && @shared_secret_key.to_s.length < 16
  return false if !@shared_secret_key.nil? && @shared_secret_key !~ Regexp.new(/^[ -~]{16,64}$/)
  true
end