bandwidth-sdk 13.1.4 → 14.1.0

data/lib/bandwidth-sdk/models/verification_webhook.rb

@@ -0,0 +1,303 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class VerificationWebhook
+    # User's account ID.
+    attr_accessor :account_id
+
+    # Toll-free telephone number in E.164 format.
+    attr_accessor :phone_number
+
+    attr_accessor :status
+
+    # Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
+    attr_accessor :internal_ticket_number
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'accountId',
+        :'phone_number' => :'phoneNumber',
+        :'status' => :'status',
+        :'internal_ticket_number' => :'internalTicketNumber'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'account_id' => :'String',
+        :'phone_number' => :'String',
+        :'status' => :'TfvCallbackStatusEnum',
+        :'internal_ticket_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::VerificationWebhook` 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 `Bandwidth::VerificationWebhook`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'internal_ticket_number')
+        self.internal_ticket_number = attributes[:'internal_ticket_number']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@phone_number.nil? && @phone_number.to_s.length > 12
+        invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 12.')
+      end
+
+      if !@phone_number.nil? && @phone_number.to_s.length < 12
+        invalid_properties.push('invalid value for "phone_number", the character length must be great than or equal to 12.')
+      end
+
+      pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      if !@phone_number.nil? && @phone_number !~ pattern
+        invalid_properties.push("invalid value for \"phone_number\", must conform to the pattern #{pattern}.")
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@phone_number.nil? && @phone_number.to_s.length > 12
+      return false if !@phone_number.nil? && @phone_number.to_s.length < 12
+      return false if !@phone_number.nil? && @phone_number !~ Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_number Value to be assigned
+    def phone_number=(phone_number)
+      if phone_number.nil?
+        fail ArgumentError, 'phone_number cannot be nil'
+      end
+
+      if phone_number.to_s.length > 12
+        fail ArgumentError, 'invalid value for "phone_number", the character length must be smaller than or equal to 12.'
+      end
+
+      if phone_number.to_s.length < 12
+        fail ArgumentError, 'invalid value for "phone_number", the character length must be great than or equal to 12.'
+      end
+
+      pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      if phone_number !~ pattern
+        fail ArgumentError, "invalid value for \"phone_number\", must conform to the pattern #{pattern}."
+      end
+
+      @phone_number = phone_number
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          account_id == o.account_id &&
+          phone_number == o.phone_number &&
+          status == o.status &&
+          internal_ticket_number == o.internal_ticket_number
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [account_id, phone_number, status, internal_ticket_number].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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 = Bandwidth.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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+  end
+end

data/lib/bandwidth-sdk/models/{message_failed_callback_message.rb → webhook_subscription.rb}

@@ -14,31 +14,22 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  # Message Failed Callback Message Schema
-  class MessageFailedCallbackMessage
+  # Information about a webhook that Bandwidth should send upon the completion of event customer has subscribed to.
+  class WebhookSubscription
     attr_accessor :id
 
-    attr_accessor :owner
+    attr_accessor :account_id
 
-    attr_accessor :application_id
+    # 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.
+    attr_accessor :callback_url
 
-    attr_accessor :time
+    attr_accessor :type
 
-    attr_accessor :segment_count
+    attr_accessor :basic_authentication
 
-    attr_accessor :direction
+    attr_accessor :created_date
 
-    attr_accessor :to
-
-    attr_accessor :from
-
-    attr_accessor :text
-
-    attr_accessor :tag
-
-    attr_accessor :media
-
-    attr_accessor :priority
+    attr_accessor :modified_date
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -66,17 +57,12 @@ module Bandwidth
     def self.attribute_map
       {
         :'id' => :'id',
-        :'owner' => :'owner',
-        :'application_id' => :'applicationId',
-        :'time' => :'time',
-        :'segment_count' => :'segmentCount',
-        :'direction' => :'direction',
-        :'to' => :'to',
-        :'from' => :'from',
-        :'text' => :'text',
-        :'tag' => :'tag',
-        :'media' => :'media',
-        :'priority' => :'priority'
+        :'account_id' => :'accountId',
+        :'callback_url' => :'callbackUrl',
+        :'type' => :'type',
+        :'basic_authentication' => :'basicAuthentication',
+        :'created_date' => :'createdDate',
+        :'modified_date' => :'modifiedDate'
       }
     end
 
@@ -89,23 +75,19 @@ module Bandwidth
     def self.openapi_types
       {
         :'id' => :'String',
-        :'owner' => :'String',
-        :'application_id' => :'String',
-        :'time' => :'Time',
-        :'segment_count' => :'Integer',
-        :'direction' => :'MessageDirectionEnum',
-        :'to' => :'Array<String>',
-        :'from' => :'String',
-        :'text' => :'String',
-        :'tag' => :'String',
-        :'media' => :'Array<String>',
-        :'priority' => :'PriorityEnum'
+        :'account_id' => :'String',
+        :'callback_url' => :'String',
+        :'type' => :'WebhookSubscriptionTypeEnum',
+        :'basic_authentication' => :'WebhookSubscriptionBasicAuthentication',
+        :'created_date' => :'Time',
+        :'modified_date' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'callback_url',
       ])
     end
 
@@ -113,87 +95,45 @@ module Bandwidth
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::MessageFailedCallbackMessage` initialize method'
+        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
       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 `Bandwidth::MessageFailedCallbackMessage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::WebhookSubscription`. 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?(:'id')
         self.id = attributes[:'id']
-      else
-        self.id = nil
-      end
-
-      if attributes.key?(:'owner')
-        self.owner = attributes[:'owner']
-      else
-        self.owner = nil
-      end
-
-      if attributes.key?(:'application_id')
-        self.application_id = attributes[:'application_id']
-      else
-        self.application_id = nil
-      end
-
-      if attributes.key?(:'time')
-        self.time = attributes[:'time']
-      else
-        self.time = nil
       end
 
-      if attributes.key?(:'segment_count')
-        self.segment_count = attributes[:'segment_count']
-      else
-        self.segment_count = nil
-      end
-
-      if attributes.key?(:'direction')
-        self.direction = attributes[:'direction']
-      else
-        self.direction = nil
-      end
-
-      if attributes.key?(:'to')
-        if (value = attributes[:'to']).is_a?(Array)
-          self.to = value
-        end
-      else
-        self.to = nil
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
       end
 
-      if attributes.key?(:'from')
-        self.from = attributes[:'from']
+      if attributes.key?(:'callback_url')
+        self.callback_url = attributes[:'callback_url']
       else
-        self.from = nil
+        self.callback_url = nil
       end
 
-      if attributes.key?(:'text')
-        self.text = attributes[:'text']
-      else
-        self.text = nil
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       end
 
-      if attributes.key?(:'tag')
-        self.tag = attributes[:'tag']
-      else
-        self.tag = nil
+      if attributes.key?(:'basic_authentication')
+        self.basic_authentication = attributes[:'basic_authentication']
       end
 
-      if attributes.key?(:'media')
-        if (value = attributes[:'media']).is_a?(Array)
-          self.media = value
-        end
+      if attributes.key?(:'created_date')
+        self.created_date = attributes[:'created_date']
       end
 
-      if attributes.key?(:'priority')
-        self.priority = attributes[:'priority']
+      if attributes.key?(:'modified_date')
+        self.modified_date = attributes[:'modified_date']
       end
     end
 
@@ -202,44 +142,17 @@ module Bandwidth
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
-      if @owner.nil?
-        invalid_properties.push('invalid value for "owner", owner cannot be nil.')
-      end
-
-      if @application_id.nil?
-        invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
-      end
-
-      if @time.nil?
-        invalid_properties.push('invalid value for "time", time cannot be nil.')
-      end
-
-      if @segment_count.nil?
-        invalid_properties.push('invalid value for "segment_count", segment_count cannot be nil.')
-      end
-
-      if @direction.nil?
-        invalid_properties.push('invalid value for "direction", direction cannot be nil.')
+      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 @to.nil?
-        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      if @callback_url.to_s.length < 0
+        invalid_properties.push('invalid value for "callback_url", the character length must be great than or equal to 0.')
       end
 
-      if @from.nil?
-        invalid_properties.push('invalid value for "from", from cannot be nil.')
-      end
-
-      if @text.nil?
-        invalid_properties.push('invalid value for "text", text cannot be nil.')
-      end
-
-      if @tag.nil?
-        invalid_properties.push('invalid value for "tag", tag cannot be nil.')
+      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
@@ -249,27 +162,29 @@ module Bandwidth
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @id.nil?
-      return false if @owner.nil?
-      return false if @application_id.nil?
-      return false if @time.nil?
-      return false if @segment_count.nil?
-      return false if @direction.nil?
-      return false if @to.nil?
-      return false if @from.nil?
-      return false if @text.nil?
-      return false if @tag.nil?
+      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
 
     # Custom attribute writer method with validation
-    # @param [Object] to Value to be assigned
-    def to=(to)
-      if to.nil?
-        fail ArgumentError, 'to cannot be nil'
+    # @param [Object] callback_url Value to be assigned
+    def callback_url=(callback_url)
+      if !callback_url.nil? && callback_url.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "callback_url", the character length must be smaller than or equal to 2000.'
+      end
+
+      if !callback_url.nil? && callback_url.to_s.length < 0
+        fail ArgumentError, 'invalid value for "callback_url", the character length must be great 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.nil? && callback_url !~ pattern
+        fail ArgumentError, "invalid value for \"callback_url\", must conform to the pattern #{pattern}."
       end
 
-      @to = to
+      @callback_url = callback_url
     end
 
     # Checks equality by comparing each attribute.
@@ -278,17 +193,12 @@ module Bandwidth
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          owner == o.owner &&
-          application_id == o.application_id &&
-          time == o.time &&
-          segment_count == o.segment_count &&
-          direction == o.direction &&
-          to == o.to &&
-          from == o.from &&
-          text == o.text &&
-          tag == o.tag &&
-          media == o.media &&
-          priority == o.priority
+          account_id == o.account_id &&
+          callback_url == o.callback_url &&
+          type == o.type &&
+          basic_authentication == o.basic_authentication &&
+          created_date == o.created_date &&
+          modified_date == o.modified_date
     end
 
     # @see the `==` method
@@ -300,7 +210,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, owner, application_id, time, segment_count, direction, to, from, text, tag, media, priority].hash
+      [id, account_id, callback_url, type, basic_authentication, created_date, modified_date].hash
     end
 
     # Builds the object from hash