Class: Bandwidth::WebhookSubscription

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/webhook_subscription.rb

Overview

Information about a webhook that Bandwidth should send upon the completion of event customer has subscribed to.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



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

def 
  @account_id
end

#basic_authentication ⇒ Object

Returns the value of attribute basic_authentication.



28
29
30
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 28

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.



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

def callback_url
  @callback_url
end

#created_date ⇒ Object

Returns the value of attribute created_date.



30
31
32
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 30

def created_date
  @created_date
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 19

def id
  @id
end

#modified_date ⇒ Object

Returns the value of attribute modified_date.



32
33
34
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 32

def modified_date
  @modified_date
end

#type ⇒ Object

Returns the value of attribute type.



26
27
28
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 26

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.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/bandwidth-sdk/models/webhook_subscription.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.



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

def self.attribute_map
  {
    :'id' => :'id',
    :'account_id' => :'accountId',
    :'callback_url' => :'callbackUrl',
    :'type' => :'type',
    :'basic_authentication' => :'basicAuthentication',
    :'created_date' => :'createdDate',
    :'modified_date' => :'modifiedDate'
  }
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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 225

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



93
94
95
96
97
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'account_id' => :'String',
    :'callback_url' => :'String',
    :'type' => :'WebhookSubscriptionTypeEnum',
    :'basic_authentication' => :'WebhookSubscriptionBasicAuthentication',
    :'created_date' => :'Time',
    :'modified_date' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
       == o. &&
      callback_url == o.callback_url &&
      type == o.type &&
      basic_authentication == o.basic_authentication &&
      created_date == o.created_date &&
      modified_date == o.modified_date
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


212
213
214
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



218
219
220
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 218

def hash
  [id, , callback_url, type, basic_authentication, created_date, modified_date].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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 148

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 247

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



169
170
171
172
173
174
175
 
# File 'lib/bandwidth-sdk/models/webhook_subscription.rb', line 169

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@:%_\+.~#()?&\/\/=]*)/)
  true
end