sms_works_sdk 1.0.0

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/swagger_client.rb

@@ -0,0 +1,60 @@
+=begin
+#The SMS Works API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+# Common files
+require 'swagger_client/api_client'
+require 'swagger_client/api_error'
+require 'swagger_client/version'
+require 'swagger_client/configuration'
+
+# Models
+require 'swagger_client/models/api_key_response'
+require 'swagger_client/models/batch_message'
+require 'swagger_client/models/batch_message_response'
+require 'swagger_client/models/cancelled_message_response'
+require 'swagger_client/models/error_model'
+require 'swagger_client/models/hello_world_response'
+require 'swagger_client/models/login'
+require 'swagger_client/models/message'
+require 'swagger_client/models/message_response'
+require 'swagger_client/models/messages_response'
+require 'swagger_client/models/messages_response_messages'
+require 'swagger_client/models/query'
+require 'swagger_client/models/scheduled_batch_response'
+require 'swagger_client/models/scheduled_message_response'
+require 'swagger_client/models/send_message_response'
+require 'swagger_client/models/token_response'
+require 'swagger_client/models/extended_error_model'
+
+# APIs
+require 'swagger_client/api/auth_api'
+require 'swagger_client/api/batch_messages_api'
+require 'swagger_client/api/messages_api'
+require 'swagger_client/api/utils_api'
+
+module SwaggerClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   SwaggerClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/swagger_client/api/auth_api.rb

@@ -0,0 +1,134 @@
+=begin
+#The SMS Works API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require "uri"
+
+module SwaggerClient
+  class AuthApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # Generates an API Key/Secret pair
+    # @param customerid The Customer ID
+    # @param [Hash] opts the optional parameters
+    # @return [ApiKeyResponse]
+    def key_secret(customerid, opts = {})
+      data, _status_code, _headers = key_secret_with_http_info(customerid, opts)
+      return data
+    end
+
+    # 
+    # Generates an API Key/Secret pair
+    # @param customerid The Customer ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiKeyResponse, Fixnum, Hash)>] ApiKeyResponse data, response status code and response headers
+    def key_secret_with_http_info(customerid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuthApi.key_secret ..."
+      end
+      # verify the required parameter 'customerid' is set
+      if @api_client.config.client_side_validation && customerid.nil?
+        fail ArgumentError, "Missing the required parameter 'customerid' when calling AuthApi.key_secret"
+      end
+      # resource path
+      local_var_path = "/auth/getApiKey"
+
+      # query parameters
+      query_params = {}
+      query_params[:'customerid'] = customerid
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiKeyResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthApi#key_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Generates a Json Web Token
+    # @param credentials API Key &amp; Secret
+    # @param [Hash] opts the optional parameters
+    # @return [TokenResponse]
+    def login(credentials, opts = {})
+      data, _status_code, _headers = login_with_http_info(credentials, opts)
+      return data
+    end
+
+    # 
+    # Generates a Json Web Token
+    # @param credentials API Key &amp; Secret
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TokenResponse, Fixnum, Hash)>] TokenResponse data, response status code and response headers
+    def login_with_http_info(credentials, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuthApi.login ..."
+      end
+      # verify the required parameter 'credentials' is set
+      if @api_client.config.client_side_validation && credentials.nil?
+        fail ArgumentError, "Missing the required parameter 'credentials' when calling AuthApi.login"
+      end
+      # resource path
+      local_var_path = "/auth/token"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(credentials)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TokenResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthApi#login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/swagger_client/api/batch_messages_api.rb

@@ -0,0 +1,243 @@
+=begin
+#The SMS Works API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require "uri"
+
+module SwaggerClient
+  class BatchMessagesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # Cancels a scheduled SMS message
+    # @param batchid The ID of the batch you would like returned
+    # @param [Hash] opts the optional parameters
+    # @return [CancelledMessageResponse]
+    def cancel_scheduled_batch_job(batchid, opts = {})
+      data, _status_code, _headers = cancel_scheduled_batch_job_with_http_info(batchid, opts)
+      return data
+    end
+
+    # 
+    # Cancels a scheduled SMS message
+    # @param batchid The ID of the batch you would like returned
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CancelledMessageResponse, Fixnum, Hash)>] CancelledMessageResponse data, response status code and response headers
+    def cancel_scheduled_batch_job_with_http_info(batchid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BatchMessagesApi.cancel_scheduled_batch_job ..."
+      end
+      # verify the required parameter 'batchid' is set
+      if @api_client.config.client_side_validation && batchid.nil?
+        fail ArgumentError, "Missing the required parameter 'batchid' when calling BatchMessagesApi.cancel_scheduled_batch_job"
+      end
+      # resource path
+      local_var_path = "/batches/schedule/{batchid}".sub('{' + 'batchid' + '}', batchid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['JWT']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CancelledMessageResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchMessagesApi#cancel_scheduled_batch_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Retrieve all messages in a batch with the given batch ID
+    # @param batchid The ID of the batch you would like returned
+    # @param [Hash] opts the optional parameters
+    # @return [MessagesResponse]
+    def get_batch_by_id(batchid, opts = {})
+      data, _status_code, _headers = get_batch_by_id_with_http_info(batchid, opts)
+      return data
+    end
+
+    # 
+    # Retrieve all messages in a batch with the given batch ID
+    # @param batchid The ID of the batch you would like returned
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MessagesResponse, Fixnum, Hash)>] MessagesResponse data, response status code and response headers
+    def get_batch_by_id_with_http_info(batchid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BatchMessagesApi.get_batch_by_id ..."
+      end
+      # verify the required parameter 'batchid' is set
+      if @api_client.config.client_side_validation && batchid.nil?
+        fail ArgumentError, "Missing the required parameter 'batchid' when calling BatchMessagesApi.get_batch_by_id"
+      end
+      # resource path
+      local_var_path = "/batch/{batchid}".sub('{' + 'batchid' + '}', batchid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['JWT']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'MessagesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchMessagesApi#get_batch_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Schedules a batch of SMS messages to be sent at the date-time you specify
+    # @param sms_message Message properties
+    # @param [Hash] opts the optional parameters
+    # @return [ScheduledBatchResponse]
+    def schedule_batch(sms_message, opts = {})
+      data, _status_code, _headers = schedule_batch_with_http_info(sms_message, opts)
+      return data
+    end
+
+    # 
+    # Schedules a batch of SMS messages to be sent at the date-time you specify
+    # @param sms_message Message properties
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ScheduledBatchResponse, Fixnum, Hash)>] ScheduledBatchResponse data, response status code and response headers
+    def schedule_batch_with_http_info(sms_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BatchMessagesApi.schedule_batch ..."
+      end
+      # verify the required parameter 'sms_message' is set
+      if @api_client.config.client_side_validation && sms_message.nil?
+        fail ArgumentError, "Missing the required parameter 'sms_message' when calling BatchMessagesApi.schedule_batch"
+      end
+      # resource path
+      local_var_path = "/batch/schedule"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(sms_message)
+      auth_names = ['JWT']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ScheduledBatchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchMessagesApi#schedule_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Send a single SMS message to multiple recipients
+    # @param sms_message Message properties
+    # @param [Hash] opts the optional parameters
+    # @return [BatchMessageResponse]
+    def send_batch(sms_message, opts = {})
+      data, _status_code, _headers = send_batch_with_http_info(sms_message, opts)
+      return data
+    end
+
+    # 
+    # Send a single SMS message to multiple recipients
+    # @param sms_message Message properties
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BatchMessageResponse, Fixnum, Hash)>] BatchMessageResponse data, response status code and response headers
+    def send_batch_with_http_info(sms_message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BatchMessagesApi.send_batch ..."
+      end
+      # verify the required parameter 'sms_message' is set
+      if @api_client.config.client_side_validation && sms_message.nil?
+        fail ArgumentError, "Missing the required parameter 'sms_message' when calling BatchMessagesApi.send_batch"
+      end
+      # resource path
+      local_var_path = "/batch/send"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(sms_message)
+      auth_names = ['JWT']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'BatchMessageResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchMessagesApi#send_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end