bandwidth-sdk 13.1.4 → 14.1.0

data/lib/bandwidth-sdk/models/{message_sending_callback.rb → tfv_error.rb}

@@ -14,26 +14,21 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  # Message Sending Callback
-  class MessageSendingCallback
-    attr_accessor :time
-
+  # A generic error object.
+  class TfvError
     attr_accessor :type
 
-    attr_accessor :to
-
     attr_accessor :description
 
-    attr_accessor :message
+    # Each key of this errors object refers to a field of the submitted object (using dot notation for nested objects), with the field being a key to an array of one or more errors for that field.
+    attr_accessor :errors
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'time' => :'time',
         :'type' => :'type',
-        :'to' => :'to',
         :'description' => :'description',
-        :'message' => :'message'
+        :'errors' => :'errors'
       }
     end
 
@@ -45,11 +40,9 @@ module Bandwidth
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'time' => :'Time',
         :'type' => :'String',
-        :'to' => :'String',
         :'description' => :'String',
-        :'message' => :'MessageSendingCallbackMessage'
+        :'errors' => :'Object'
       }
     end
 
@@ -63,45 +56,27 @@ 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::MessageSendingCallback` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::TfvError` 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::MessageSendingCallback`. 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::TfvError`. 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?(:'time')
-        self.time = attributes[:'time']
-      else
-        self.time = nil
-      end
-
       if attributes.key?(:'type')
         self.type = attributes[:'type']
-      else
-        self.type = nil
-      end
-
-      if attributes.key?(:'to')
-        self.to = attributes[:'to']
-      else
-        self.to = nil
       end
 
       if attributes.key?(:'description')
         self.description = attributes[:'description']
-      else
-        self.description = nil
       end
 
-      if attributes.key?(:'message')
-        self.message = attributes[:'message']
-      else
-        self.message = nil
+      if attributes.key?(:'errors')
+        self.errors = attributes[:'errors']
       end
     end
 
@@ -110,26 +85,6 @@ module Bandwidth
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @time.nil?
-        invalid_properties.push('invalid value for "time", time cannot be nil.')
-      end
-
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-
-      if @to.nil?
-        invalid_properties.push('invalid value for "to", to cannot be nil.')
-      end
-
-      if @description.nil?
-        invalid_properties.push('invalid value for "description", description cannot be nil.')
-      end
-
-      if @message.nil?
-        invalid_properties.push('invalid value for "message", message cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -137,11 +92,6 @@ module Bandwidth
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @time.nil?
-      return false if @type.nil?
-      return false if @to.nil?
-      return false if @description.nil?
-      return false if @message.nil?
       true
     end
 
@@ -150,11 +100,9 @@ module Bandwidth
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          time == o.time &&
           type == o.type &&
-          to == o.to &&
           description == o.description &&
-          message == o.message
+          errors == o.errors
     end
 
     # @see the `==` method
@@ -166,7 +114,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [time, type, to, description, message].hash
+      [type, description, errors].hash
     end
 
     # Builds the object from hash

data/lib/bandwidth-sdk/models/{message_delivered_callback_message.rb → tfv_status.rb}

@@ -14,31 +14,28 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  # Message Delivered Callback Message Schema
-  class MessageDeliveredCallbackMessage
-    attr_accessor :id
+  class TfvStatus
+    # Toll-free telephone number in E.164 format.
+    attr_accessor :phone_number
 
-    attr_accessor :owner
+    attr_accessor :status
 
-    attr_accessor :application_id
+    # Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads.
+    attr_accessor :internal_ticket_number
 
-    attr_accessor :time
+    # Explanation for why a verification request was declined.
+    attr_accessor :decline_reason_description
 
-    attr_accessor :segment_count
+    # Whether a Toll-Free Verification request qualifies for resubmission via PUT.
+    attr_accessor :resubmit_allowed
 
-    attr_accessor :direction
+    # Date and time the verification request was created.
+    attr_accessor :created_date_time
 
-    attr_accessor :to
+    # Date and time the verification request was last modified.
+    attr_accessor :modified_date_time
 
-    attr_accessor :from
-
-    attr_accessor :text
-
-    attr_accessor :tag
-
-    attr_accessor :media
-
-    attr_accessor :priority
+    attr_accessor :submission
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -65,18 +62,14 @@ module Bandwidth
     # Attribute mapping from ruby-style variable name to JSON key.
     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'
+        :'phone_number' => :'phoneNumber',
+        :'status' => :'status',
+        :'internal_ticket_number' => :'internalTicketNumber',
+        :'decline_reason_description' => :'declineReasonDescription',
+        :'resubmit_allowed' => :'resubmitAllowed',
+        :'created_date_time' => :'createdDateTime',
+        :'modified_date_time' => :'modifiedDateTime',
+        :'submission' => :'submission'
       }
     end
 
@@ -88,18 +81,14 @@ module Bandwidth
     # Attribute type mapping.
     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'
+        :'phone_number' => :'String',
+        :'status' => :'TfvStatusEnum',
+        :'internal_ticket_number' => :'String',
+        :'decline_reason_description' => :'String',
+        :'resubmit_allowed' => :'Boolean',
+        :'created_date_time' => :'Time',
+        :'modified_date_time' => :'Time',
+        :'submission' => :'TfvSubmissionInfo'
       }
     end
 
@@ -113,87 +102,47 @@ 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::MessageDeliveredCallbackMessage` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::TfvStatus` 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::MessageDeliveredCallbackMessage`. 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::TfvStatus`. 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
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
       end
 
-      if attributes.key?(:'segment_count')
-        self.segment_count = attributes[:'segment_count']
-      else
-        self.segment_count = nil
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
       end
 
-      if attributes.key?(:'direction')
-        self.direction = attributes[:'direction']
-      else
-        self.direction = nil
+      if attributes.key?(:'internal_ticket_number')
+        self.internal_ticket_number = attributes[:'internal_ticket_number']
       end
 
-      if attributes.key?(:'to')
-        if (value = attributes[:'to']).is_a?(Array)
-          self.to = value
-        end
-      else
-        self.to = nil
+      if attributes.key?(:'decline_reason_description')
+        self.decline_reason_description = attributes[:'decline_reason_description']
       end
 
-      if attributes.key?(:'from')
-        self.from = attributes[:'from']
-      else
-        self.from = nil
-      end
-
-      if attributes.key?(:'text')
-        self.text = attributes[:'text']
-      else
-        self.text = nil
+      if attributes.key?(:'resubmit_allowed')
+        self.resubmit_allowed = attributes[:'resubmit_allowed']
       end
 
-      if attributes.key?(:'tag')
-        self.tag = attributes[:'tag']
-      else
-        self.tag = nil
+      if attributes.key?(:'created_date_time')
+        self.created_date_time = attributes[:'created_date_time']
       end
 
-      if attributes.key?(:'media')
-        if (value = attributes[:'media']).is_a?(Array)
-          self.media = value
-        end
+      if attributes.key?(:'modified_date_time')
+        self.modified_date_time = attributes[:'modified_date_time']
       end
 
-      if attributes.key?(:'priority')
-        self.priority = attributes[:'priority']
+      if attributes.key?(:'submission')
+        self.submission = attributes[:'submission']
       end
     end
 
@@ -202,44 +151,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.')
-      end
-
-      if @to.nil?
-        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      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 @from.nil?
-        invalid_properties.push('invalid value for "from", from cannot be nil.')
+      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
 
-      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(/^\+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
@@ -249,27 +171,33 @@ 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 !@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] to Value to be assigned
-    def to=(to)
-      if to.nil?
-        fail ArgumentError, 'to cannot be nil'
+    # @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
 
-      @to = to
+      @phone_number = phone_number
     end
 
     # Checks equality by comparing each attribute.
@@ -277,18 +205,14 @@ module Bandwidth
     def ==(o)
       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
+          phone_number == o.phone_number &&
+          status == o.status &&
+          internal_ticket_number == o.internal_ticket_number &&
+          decline_reason_description == o.decline_reason_description &&
+          resubmit_allowed == o.resubmit_allowed &&
+          created_date_time == o.created_date_time &&
+          modified_date_time == o.modified_date_time &&
+          submission == o.submission
     end
 
     # @see the `==` method
@@ -300,7 +224,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
+      [phone_number, status, internal_ticket_number, decline_reason_description, resubmit_allowed, created_date_time, modified_date_time, submission].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,43 @@
+=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 TfvStatusEnum
+    VERIFIED = 'VERIFIED'.freeze
+    UNVERIFIED = 'UNVERIFIED'.freeze
+    PENDING = 'PENDING'.freeze
+    PARTIALLY_VERIFIED = 'PARTIALLY_VERIFIED'.freeze
+    INVALID_STATUS = 'INVALID_STATUS'.freeze
+
+    def self.all_vars
+      @all_vars ||= [VERIFIED, UNVERIFIED, PENDING, PARTIALLY_VERIFIED, INVALID_STATUS].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if TfvStatusEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #TfvStatusEnum"
+    end
+  end
+end