Merge pull request #11 from Bandwidth/release/2021-01-27-20-40-15

New deploy

Author: jmulford-bw

Gemfile

@@ -2,4 +2,8 @@
 
 source 'https://rubygems.org'
 
+group :test do
+  gem 'rake'
+end
+
 gemspec

Rakefile

@@ -2,3 +2,12 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb', 'spec/**/*_spec.rb']
+  t.warning = false
+end
+
+task :default => :test

bandwidth.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'bandwidth-sdk'
-  s.version = '4.0.0'
+  s.version = '5.0.0'
   s.summary = 'bandwidth'
   s.description = 'Bandwidth\'s set of APIs'
   s.authors = ['APIMatic SDK Generator']
@@ -13,6 +13,8 @@ Gem::Specification.new do |s|
   s.add_dependency('certifi', '~> 2018.1', '>= 2018.01.18')
   s.add_dependency('faraday-http-cache', '~> 2.2')
   s.add_dependency('builder', '~> 3.2.4')
+  s.add_development_dependency('minitest', '~> 5.14', '>= 5.14.1')
+  s.add_development_dependency('minitest-proveit', '~> 1.0')
   s.required_ruby_version = '>= 2.0'
   s.files = Dir['{bin,lib,man,test,spec}/**/*', 'README*', 'LICENSE*']
   s.require_paths = ['lib']

lib/bandwidth/messaging_lib/messaging.rb

@@ -7,6 +7,9 @@
 require_relative 'messaging/client.rb'
 
 # Models
+require_relative 'messaging/models/bandwidth_messages_list.rb'
+require_relative 'messaging/models/bandwidth_message_item.rb'
+require_relative 'messaging/models/page_info.rb'
 require_relative 'messaging/models/media.rb'
 require_relative 'messaging/models/tag.rb'
 require_relative 'messaging/models/deferred_result.rb'

lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb

@@ -12,8 +12,9 @@ def initialize(config, http_call_back: nil)
     end
 
     # listMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] continuation_token Optional parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] continuation_token Optional parameter: Continuation token
+    # used to retrieve subsequent media.
     # @return [List of Media] response from the API call
     def list_media(user_id,
                    continuation_token: nil)
@@ -83,8 +84,8 @@ def list_media(user_id,
     end
 
     # getMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] media_id Required parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] media_id Required parameter: Media ID to retrieve
     # @return [Binary] response from the API call
     def get_media(user_id,
                   media_id)
@@ -146,13 +147,17 @@ def get_media(user_id,
     end
 
     # uploadMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] media_id Required parameter: Example:
-    # @param [Long] content_length Required parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] media_id Required parameter: The user supplied custom
+    # media ID
+    # @param [Long] content_length Required parameter: The size of the
+    # entity-body
     # @param [File | UploadIO] body Required parameter: Example:
-    # @param [String] content_type Optional parameter:
-    # Example:application/octet-stream
-    # @param [String] cache_control Optional parameter: Example:
+    # @param [String] content_type Optional parameter: The media type of the
+    # entity-body
+    # @param [String] cache_control Optional parameter: General-header field is
+    # used to specify directives that MUST be obeyed by all caching mechanisms
+    # along the request/response chain.
     # @return [void] response from the API call
     def upload_media(user_id,
                      media_id,
@@ -234,8 +239,8 @@ def upload_media(user_id,
     end
 
     # deleteMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] media_id Required parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] media_id Required parameter: The media ID to delete
     # @return [void] response from the API call
     def delete_media(user_id,
                      media_id)
@@ -294,12 +299,122 @@ def delete_media(user_id,
       ApiResponse.new(_response)
     end
 
+    # getMessages
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] message_id Optional parameter: The ID of the message to
+    # search for. Special characters need to be encoded using URL encoding
+    # @param [String] source_tn Optional parameter: The phone number that sent
+    # the message
+    # @param [String] destination_tn Optional parameter: The phone number that
+    # received the message
+    # @param [String] message_status Optional parameter: The status of the
+    # message. One of RECEIVED, QUEUED, SENDING, SENT, FAILED, DELIVERED,
+    # DLR_EXPIRED
+    # @param [Integer] error_code Optional parameter: The error code of the
+    # message
+    # @param [String] from_date_time Optional parameter: The start of the date
+    # range to search in ISO 8601 format. Uses the message receive time. The
+    # date range to search in is currently 14 days.
+    # @param [String] to_date_time Optional parameter: The end of the date range
+    # to search in ISO 8601 format. Uses the message receive time. The date
+    # range to search in is currently 14 days.
+    # @param [String] page_token Optional parameter: A base64 encoded value used
+    # for pagination of results
+    # @param [Integer] limit Optional parameter: The maximum records requested
+    # in search result. Default 100. The sum of limit and after cannot be more
+    # than 10000
+    # @return [BandwidthMessagesList] response from the API call
+    def get_messages(user_id,
+                     message_id: nil,
+                     source_tn: nil,
+                     destination_tn: nil,
+                     message_status: nil,
+                     error_code: nil,
+                     from_date_time: nil,
+                     to_date_time: nil,
+                     page_token: nil,
+                     limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
+      _query_builder << '/users/{userId}/messages'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'userId' => { 'value' => user_id, 'encode' => false }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'messageId' => message_id,
+        'sourceTn' => source_tn,
+        'destinationTn' => destination_tn,
+        'messageStatus' => message_status,
+        'errorCode' => error_code,
+        'fromDateTime' => from_date_time,
+        'toDateTime' => to_date_time,
+        'pageToken' => page_token,
+        'limit' => limit
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      MessagingBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise MessagingException.new(
+          '400 Request is malformed or invalid',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise MessagingException.new(
+          '401 The specified user does not have access to the account',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise MessagingException.new(
+          '403 The user does not have access to this API',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise MessagingException.new(
+          '404 Path not found',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise MessagingException.new(
+          '415 The content-type of the request is incorrect',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise MessagingException.new(
+          '429 The rate limit has been reached',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response, data: BandwidthMessagesList.from_hash(decoded)
+      )
+    end
+
     # createMessage
-    # @param [String] user_id Required parameter: Example:
-    # @param [MessageRequest] body Optional parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [MessageRequest] body Required parameter: Example:
     # @return [BandwidthMessage] response from the API call
     def create_message(user_id,
-                       body: nil)
+                       body)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
       _query_builder << '/users/{userId}/messages'

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

@@ -6,47 +6,48 @@
 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