bandwidth-sdk 0.1.0 → 1.0.0.pre

data/lib/bandwidth/http/http_request.rb

@@ -1,50 +1,50 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-  # Represents a single Http Request.
-  class HttpRequest
-    attr_accessor :http_method, :query_url, :headers,
-                  :parameters, :username, :password
-
-    # The constructor.
-    # @param [HttpMethodEnum] The HTTP method.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
-    def initialize(http_method,
-                   query_url,
-                   headers: {},
-                   parameters: {})
-      @http_method = http_method
-      @query_url = query_url
-      @headers = headers
-      @parameters = parameters
-    end
-
-    # Add a header to the HttpRequest.
-    # @param [String] The name of the header.
-    # @param [String] The value of the header.
-    def add_header(name, value)
-      @headers[name] = value
-    end
-
-    # Add a parameter to the HttpRequest.
-    # @param [String] The name of the parameter.
-    # @param [String] The value of the parameter.
-    def add_parameter(name, value)
-      @parameters[name] = value
-    end
-
-    # Add a query parameter to the HttpRequest.
-    # @param [String] The name of the query parameter.
-    # @param [String] The value of the query parameter.
-    def add_query_parameter(name, value)
-      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
-                                                              name => value)
-      @query_url = APIHelper.clean_url(@query_url)
-    end
-  end
-end
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
+
+    # The constructor.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
+      @query_url = APIHelper.clean_url(@query_url)
+    end
+  end
+end

data/lib/bandwidth/http/http_response.rb

@@ -1,29 +1,29 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-  # Http response received.
-  class HttpResponse
-    attr_reader :status_code, :reason_phrase, :headers, :raw_body, :request
-
-    # The constructor
-    # @param [Integer] The status code returned by the server.
-    # @param [String] The reason phrase returned by the server.
-    # @param [Hash] The headers sent by the server in the response.
-    # @param [String] The raw body of the response.
-    # @param [HttpRequest] The request that resulted in this response.
-    def initialize(status_code,
-                   reason_phrase,
-                   headers,
-                   raw_body,
-                   request)
-      @status_code = status_code
-      @reason_phrase = reason_phrase
-      @headers = headers
-      @raw_body = raw_body
-      @request = request
-    end
-  end
-end
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Http response received.
+  class HttpResponse
+    attr_reader :status_code, :reason_phrase, :headers, :raw_body, :request
+
+    # The constructor
+    # @param [Integer] The status code returned by the server.
+    # @param [String] The reason phrase returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    # @param [HttpRequest] The request that resulted in this response.
+    def initialize(status_code,
+                   reason_phrase,
+                   headers,
+                   raw_body,
+                   request)
+      @status_code = status_code
+      @reason_phrase = reason_phrase
+      @headers = headers
+      @raw_body = raw_body
+      @request = request
+    end
+  end
+end

data/lib/bandwidth/messaging_lib/messaging.rb

@@ -0,0 +1,23 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+
+require_relative 'messaging/client.rb'
+
+# Models
+require_relative 'messaging/models/field_error.rb'
+require_relative 'messaging/models/media.rb'
+require_relative 'messaging/models/tag.rb'
+require_relative 'messaging/models/deferred_result.rb'
+require_relative 'messaging/models/bandwidth_callback_message.rb'
+require_relative 'messaging/models/bandwidth_message.rb'
+require_relative 'messaging/models/message_request.rb'
+
+# Exceptions
+require_relative 'messaging/exceptions/generic_client_exception.rb'
+require_relative 'messaging/exceptions/path_client_exception.rb'
+# Controllers
+require_relative 'messaging/controllers/base_controller.rb'
+require_relative 'messaging/controllers/api_controller.rb'

data/lib/bandwidth/messaging_lib/messaging/client.rb

@@ -0,0 +1,40 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+    module Messaging
+      #  bandwidth client class.
+      class Client
+        attr_reader :config
+
+        # Access to client controller.
+        # @return [APIController] Returns the controller instance.
+        def client
+          @client ||= APIController.new config
+        end
+
+        def initialize(timeout: 0, max_retries: 0, retry_interval: 1,
+                       backoff_factor: 1, environment: Environment::PRODUCTION,
+                       messaging_basic_auth_user_name: 'TODO: Replace',
+                       messaging_basic_auth_password: 'TODO: Replace',
+                       voice_basic_auth_user_name: 'TODO: Replace',
+                       voice_basic_auth_password: 'TODO: Replace', config: nil)
+          @config = if config.nil?
+                      Configuration.new(timeout: timeout,
+                                        max_retries: max_retries,
+                                        retry_interval: retry_interval,
+                                        backoff_factor: backoff_factor,
+                                        environment: environment,
+                                        messaging_basic_auth_user_name: messaging_basic_auth_user_name,
+                                        messaging_basic_auth_password: messaging_basic_auth_password,
+                                        voice_basic_auth_user_name: voice_basic_auth_user_name,
+                                        voice_basic_auth_password: voice_basic_auth_password)
+                    else
+                      config
+                    end
+        end
+  end
+end
+end

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

@@ -0,0 +1,406 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+module Messaging
+  # APIController
+  class APIController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # getMessage
+    # @return [void] response from the API call
+    def get_message
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
+      _query_builder << '/ping'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url
+      )
+      MessagingBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise GenericClientException.new(
+          '400 Request is malformed or invalid',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise PathClientException.new(
+          '401 The specified user does not have access to the account',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise PathClientException.new(
+          '403 The user does not have access to this API',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise PathClientException.new(
+          '404 Path not found',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise GenericClientException.new(
+          '415 The content-type of the request is incorrect',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise GenericClientException.new(
+          '429 The rate limit has been reached',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
+    # listMedia
+    # @param [String] user_id Required parameter: Example:
+    # @param [String] continuation_token Optional parameter: Example:
+    # @return [List of Media] response from the API call
+    def list_media(user_id,
+                   continuation_token: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
+      _query_builder << '/users/{userId}/media'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'userId' => user_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Continuation-Token' => continuation_token
+      }
+
+      # 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 GenericClientException.new(
+          '400 Request is malformed or invalid',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise PathClientException.new(
+          '401 The specified user does not have access to the account',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise PathClientException.new(
+          '403 The user does not have access to this API',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise PathClientException.new(
+          '404 Path not found',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise GenericClientException.new(
+          '415 The content-type of the request is incorrect',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise GenericClientException.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: decoded.map { |element| Media.from_hash(element) })
+    end
+
+    # getMedia
+    # @param [String] user_id Required parameter: Example:
+    # @param [String] media_id Required parameter: Example:
+    # @return [Binary] response from the API call
+    def get_media(user_id,
+                  media_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
+      _query_builder << '/users/{userId}/media/{mediaId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'userId' => user_id,
+        'mediaId' => media_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url
+      )
+      MessagingBasicAuth.apply(config, _request)
+      _response = execute_request(_request, binary: true)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise GenericClientException.new(
+          '400 Request is malformed or invalid',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise PathClientException.new(
+          '401 The specified user does not have access to the account',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise PathClientException.new(
+          '403 The user does not have access to this API',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise PathClientException.new(
+          '404 Path not found',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise GenericClientException.new(
+          '415 The content-type of the request is incorrect',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise GenericClientException.new(
+          '429 The rate limit has been reached',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response, data: _response.raw_body)
+    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] body Required parameter: Example:
+    # @param [String] content_type Optional parameter: Example:
+    # @param [String] cache_control Optional parameter: Example:
+    # @return [void] response from the API call
+    def upload_media(user_id,
+                     media_id,
+                     content_length,
+                     body,
+                     content_type: nil,
+                     cache_control: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
+      _query_builder << '/users/{userId}/media/{mediaId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'userId' => user_id,
+        'mediaId' => media_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'Content-Length' => content_length,
+        'Content-Type' => content_type,
+        'Cache-Control' => cache_control
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body
+      )
+      MessagingBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise GenericClientException.new(
+          '400 Request is malformed or invalid',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise PathClientException.new(
+          '401 The specified user does not have access to the account',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise PathClientException.new(
+          '403 The user does not have access to this API',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise PathClientException.new(
+          '404 Path not found',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise GenericClientException.new(
+          '415 The content-type of the request is incorrect',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise GenericClientException.new(
+          '429 The rate limit has been reached',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
+    # deleteMedia
+    # @param [String] user_id Required parameter: Example:
+    # @param [String] media_id Required parameter: Example:
+    # @return [void] response from the API call
+    def delete_media(user_id,
+                     media_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
+      _query_builder << '/users/{userId}/media/{mediaId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'userId' => user_id,
+        'mediaId' => media_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url
+      )
+      MessagingBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise GenericClientException.new(
+          '400 Request is malformed or invalid',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise PathClientException.new(
+          '401 The specified user does not have access to the account',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise PathClientException.new(
+          '403 The user does not have access to this API',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise PathClientException.new(
+          '404 Path not found',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise GenericClientException.new(
+          '415 The content-type of the request is incorrect',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise GenericClientException.new(
+          '429 The rate limit has been reached',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
+    # createMessage
+    # @param [String] user_id Required parameter: Example:
+    # @param [MessageRequest] body Optional parameter: Example:
+    # @return [BandwidthMessage] response from the API call
+    def create_message(user_id,
+                       body: 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' => user_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      MessagingBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise GenericClientException.new(
+          '400 Request is malformed or invalid',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise PathClientException.new(
+          '401 The specified user does not have access to the account',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise PathClientException.new(
+          '403 The user does not have access to this API',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise PathClientException.new(
+          '404 Path not found',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise GenericClientException.new(
+          '415 The content-type of the request is incorrect',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise GenericClientException.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: BandwidthMessage.from_hash(decoded))
+    end
+  end
+end
+end