bandwidth-sdk 2.1.1 → 6.1.0

data/lib/bandwidth/messaging_lib/messaging/controllers/base_controller.rb

@@ -13,7 +13,7 @@ module Bandwidth
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'APIMATIC 2.0'
+        'user-agent' => 'ruby-sdk'
       }
     end
 

data/lib/bandwidth/messaging_lib/messaging/exceptions/{generic_client_exception.rb → messaging_exception.rb}

@@ -4,8 +4,8 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # GenericClientException class.
-  class GenericClientException < APIException
+  # MessagingException class.
+  class MessagingException < APIException
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :type
@@ -14,10 +14,6 @@ module Bandwidth
     # @return [String]
     attr_accessor :description
 
-    # TODO: Write general description for this method
-    # @return [List of FieldError]
-    attr_accessor :field_errors
-
     # The constructor.
     # @param [String] The reason for raising an exception.
     # @param [HttpResponse] The HttpReponse of the API call.
@@ -33,14 +29,6 @@ module Bandwidth
     def unbox(hash)
       @type = hash['type']
       @description = hash['description']
-      # Parameter is an array, so we need to iterate through it
-      @field_errors = nil
-      unless hash['fieldErrors'].nil?
-        @field_errors = []
-        hash['fieldErrors'].each do |structure|
-          @field_errors << (FieldError.from_hash(structure) if structure)
-        end
-      end
     end
   end
 end

data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message.rb

@@ -6,50 +6,55 @@
 module Bandwidth
   # BandwidthMessage Model.
   class BandwidthMessage < BaseModel
-    # TODO: Write general description for this method
+    # The id of the message
     # @return [String]
     attr_accessor :id
 
-    # TODO: Write general description for this method
+    # The Bandwidth phone number associated with the message
     # @return [String]
     attr_accessor :owner
 
-    # TODO: Write general description for this method
+    # The application ID associated with the message
     # @return [String]
     attr_accessor :application_id
 
-    # TODO: Write general description for this method
+    # The datetime stamp of the message in ISO 8601
     # @return [String]
     attr_accessor :time
 
-    # TODO: Write general description for this method
+    # The number of segments the original message from the user is broken into
+    # before sending over to carrier networks
     # @return [Integer]
     attr_accessor :segment_count
 
-    # TODO: Write general description for this method
+    # The direction of the message relative to Bandwidth. Can be in or out
     # @return [String]
     attr_accessor :direction
 
-    # TODO: Write general description for this method
+    # The phone number recipients of the message
     # @return [List of String]
     attr_accessor :to
 
-    # TODO: Write general description for this method
+    # The phone number the message was sent from
     # @return [String]
     attr_accessor :from
 
-    # TODO: Write general description for this method
+    # The list of media URLs sent in the message
     # @return [List of String]
     attr_accessor :media
 
-    # TODO: Write general description for this method
+    # The contents of the message
     # @return [String]
     attr_accessor :text
 
-    # TODO: Write general description for this method
+    # The custom string set by the user
     # @return [String]
     attr_accessor :tag
 
+    # The priority specified by the user
+    # @return [String]
+    attr_accessor :priority
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -64,6 +69,7 @@ module Bandwidth
       @_hash['media'] = 'media'
       @_hash['text'] = 'text'
       @_hash['tag'] = 'tag'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -77,7 +83,8 @@ module Bandwidth
                    from = nil,
                    media = nil,
                    text = nil,
-                   tag = nil)
+                   tag = nil,
+                   priority = nil)
       @id = id
       @owner = owner
       @application_id = application_id
@@ -89,6 +96,7 @@ module Bandwidth
       @media = media
       @text = text
       @tag = tag
+      @priority = priority
     end
 
     # Creates an instance of the object from a hash.
@@ -107,6 +115,7 @@ module Bandwidth
       media = hash['media']
       text = hash['text']
       tag = hash['tag']
+      priority = hash['priority']
 
       # Create object from extracted values.
       BandwidthMessage.new(id,
@@ -119,7 +128,8 @@ module Bandwidth
                            from,
                            media,
                            text,
-                           tag)
+                           tag,
+                           priority)
     end
   end
 end

data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message_item.rb

@@ -0,0 +1,125 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # BandwidthMessageItem Model.
+  class BandwidthMessageItem < BaseModel
+    # The message id
+    # @return [String]
+    attr_accessor :message_id
+
+    # The account id of the message
+    # @return [String]
+    attr_accessor :account_id
+
+    # The source phone number of the message
+    # @return [String]
+    attr_accessor :source_tn
+
+    # The recipient phone number of the message
+    # @return [String]
+    attr_accessor :destination_tn
+
+    # The status of the message
+    # @return [String]
+    attr_accessor :message_status
+
+    # The direction of the message relative to Bandwidth. INBOUND or OUTBOUND
+    # @return [String]
+    attr_accessor :message_direction
+
+    # The type of message. sms or mms
+    # @return [String]
+    attr_accessor :message_type
+
+    # The number of segments the message was sent as
+    # @return [Integer]
+    attr_accessor :segment_count
+
+    # The numeric error code of the message
+    # @return [Integer]
+    attr_accessor :error_code
+
+    # The ISO 8601 datetime of the message
+    # @return [String]
+    attr_accessor :receive_time
+
+    # The name of the carrier. Not currently supported for MMS, coming soon
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message_id'] = 'messageId'
+      @_hash['account_id'] = 'accountId'
+      @_hash['source_tn'] = 'sourceTn'
+      @_hash['destination_tn'] = 'destinationTn'
+      @_hash['message_status'] = 'messageStatus'
+      @_hash['message_direction'] = 'messageDirection'
+      @_hash['message_type'] = 'messageType'
+      @_hash['segment_count'] = 'segmentCount'
+      @_hash['error_code'] = 'errorCode'
+      @_hash['receive_time'] = 'receiveTime'
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash
+    end
+
+    def initialize(message_id = nil,
+                   account_id = nil,
+                   source_tn = nil,
+                   destination_tn = nil,
+                   message_status = nil,
+                   message_direction = nil,
+                   message_type = nil,
+                   segment_count = nil,
+                   error_code = nil,
+                   receive_time = nil,
+                   carrier_name = nil)
+      @message_id = message_id
+      @account_id = account_id
+      @source_tn = source_tn
+      @destination_tn = destination_tn
+      @message_status = message_status
+      @message_direction = message_direction
+      @message_type = message_type
+      @segment_count = segment_count
+      @error_code = error_code
+      @receive_time = receive_time
+      @carrier_name = carrier_name
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      message_id = hash['messageId']
+      account_id = hash['accountId']
+      source_tn = hash['sourceTn']
+      destination_tn = hash['destinationTn']
+      message_status = hash['messageStatus']
+      message_direction = hash['messageDirection']
+      message_type = hash['messageType']
+      segment_count = hash['segmentCount']
+      error_code = hash['errorCode']
+      receive_time = hash['receiveTime']
+      carrier_name = hash['carrierName']
+
+      # Create object from extracted values.
+      BandwidthMessageItem.new(message_id,
+                               account_id,
+                               source_tn,
+                               destination_tn,
+                               message_status,
+                               message_direction,
+                               message_type,
+                               segment_count,
+                               error_code,
+                               receive_time,
+                               carrier_name)
+    end
+  end
+end

data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_messages_list.rb

@@ -0,0 +1,60 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # BandwidthMessagesList Model.
+  class BandwidthMessagesList < BaseModel
+    # Total number of messages matched by the search
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Total number of messages matched by the search
+    # @return [PageInfo]
+    attr_accessor :page_info
+
+    # Total number of messages matched by the search
+    # @return [List of BandwidthMessageItem]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_count'] = 'totalCount'
+      @_hash['page_info'] = 'pageInfo'
+      @_hash['messages'] = 'messages'
+      @_hash
+    end
+
+    def initialize(total_count = nil,
+                   page_info = nil,
+                   messages = nil)
+      @total_count = total_count
+      @page_info = page_info
+      @messages = messages
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_count = hash['totalCount']
+      page_info = PageInfo.from_hash(hash['pageInfo']) if hash['pageInfo']
+      # Parameter is an array, so we need to iterate through it
+      messages = nil
+      unless hash['messages'].nil?
+        messages = []
+        hash['messages'].each do |structure|
+          messages << (BandwidthMessageItem.from_hash(structure) if structure)
+        end
+      end
+
+      # Create object from extracted values.
+      BandwidthMessagesList.new(total_count,
+                                page_info,
+                                messages)
+    end
+  end
+end

data/lib/bandwidth/messaging_lib/messaging/models/media.rb

@@ -30,19 +30,19 @@ module Bandwidth
     # @return [List of Tag]
     attr_accessor :tags
 
-    # TODO: Write general description for this method
+    # User's account ID
     # @return [String]
     attr_accessor :user_id
 
-    # TODO: Write general description for this method
+    # User's account ID
     # @return [String]
     attr_accessor :media_name
 
-    # TODO: Write general description for this method
+    # User's account ID
     # @return [String]
     attr_accessor :media_id
 
-    # TODO: Write general description for this method
+    # User's account ID
     # @return [String]
     attr_accessor :cache_control
 

data/lib/bandwidth/messaging_lib/messaging/models/message_request.rb

@@ -6,30 +6,38 @@
 module Bandwidth
   # MessageRequest Model.
   class MessageRequest < BaseModel
-    # TODO: Write general description for this method
+    # The ID of the Application your from number is associated with in the
+    # Bandwidth Phone Number Dashboard.
     # @return [String]
     attr_accessor :application_id
 
-    # TODO: Write general description for this method
+    # The phone number(s) the message should be sent to in E164 format
     # @return [List of String]
     attr_accessor :to
 
-    # TODO: Write general description for this method
+    # One of your telephone numbers the message should come from in E164 format
     # @return [String]
     attr_accessor :from
 
-    # TODO: Write general description for this method
+    # The contents of the text message. Must be 2048 characters or less.
     # @return [String]
     attr_accessor :text
 
-    # TODO: Write general description for this method
+    # A list of URLs to include as media attachments as part of the message.
     # @return [List of String]
     attr_accessor :media
 
-    # TODO: Write general description for this method
+    # A custom string that will be included in callback events of the message.
+    # Max 1024 characters
     # @return [String]
     attr_accessor :tag
 
+    # The message's priority, currently for toll-free or short code SMS only.
+    # Messages with a priority value of `"high"` are given preference over your
+    # other traffic.
+    # @return [PriorityEnum]
+    attr_accessor :priority
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -39,6 +47,7 @@ module Bandwidth
       @_hash['text'] = 'text'
       @_hash['media'] = 'media'
       @_hash['tag'] = 'tag'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -47,13 +56,15 @@ module Bandwidth
                    from = nil,
                    text = nil,
                    media = nil,
-                   tag = nil)
+                   tag = nil,
+                   priority = nil)
       @application_id = application_id
       @to = to
       @from = from
       @text = text
       @media = media
       @tag = tag
+      @priority = priority
     end
 
     # Creates an instance of the object from a hash.
@@ -67,6 +78,7 @@ module Bandwidth
       text = hash['text']
       media = hash['media']
       tag = hash['tag']
+      priority = hash['priority']
 
       # Create object from extracted values.
       MessageRequest.new(application_id,
@@ -74,7 +86,8 @@ module Bandwidth
                          from,
                          text,
                          media,
-                         tag)
+                         tag,
+                         priority)
     end
   end
 end