dialmycalls_client 2.0.1

data/docs/VanityNumbersApi.md

@@ -0,0 +1,224 @@
+# DialMyCalls::VanityNumbersApi
+
+All URIs are relative to *https://api.dialmycalls.com/2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_vanity_number_by_id**](VanityNumbersApi.md#delete_vanity_number_by_id) | **DELETE** /vanitynumber/{VanityNumberId} | Delete Vanity Number
+[**get_vanity_number_by_id**](VanityNumbersApi.md#get_vanity_number_by_id) | **GET** /vanitynumber/{VanityNumberId} | Get Vanity Number
+[**get_vanity_numbers**](VanityNumbersApi.md#get_vanity_numbers) | **GET** /vanitynumbers | List Vanity Numbers
+[**update_vanity_number_by_id**](VanityNumbersApi.md#update_vanity_number_by_id) | **PUT** /vanitynumber/{VanityNumberId} | Update Vanity Number
+
+
+# **delete_vanity_number_by_id**
+> Object delete_vanity_number_by_id(vanity_number_id)
+
+Delete Vanity Number
+
+Delete a vanity number. <br><br> Returns the following if a valid identifier was provided, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X DELETE https://$API_KEY@api.dialmycalls.com/2.0/keyword/$VANITYNUMBER_ID ```
+
+### Example
+```ruby
+# load the gem
+require 'dialmycalls_client'
+# setup authorization
+DialMyCalls.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-ApiKey'] = 'YOUR API KEY'
+end
+
+api_instance = DialMyCalls::VanityNumbersApi.new
+
+vanity_number_id = "vanity_number_id_example" # String | VanityNumberId
+
+
+begin
+  #Delete Vanity Number
+  result = api_instance.delete_vanity_number_by_id(vanity_number_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling VanityNumbersApi->delete_vanity_number_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vanity_number_id** | **String**| VanityNumberId | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml
+ - **Accept**: application/json, application/xml
+
+
+
+# **get_vanity_number_by_id**
+> Object get_vanity_number_by_id(vanity_number_id)
+
+Get Vanity Number
+
+Retrieve a vanity number. <br><br> Returns a vanitynumber object if a valid identifier was provided, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/vanitynumber/$VANITYNUMBER_ID ```
+
+### Example
+```ruby
+# load the gem
+require 'dialmycalls_client'
+# setup authorization
+DialMyCalls.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-ApiKey'] = 'YOUR API KEY'
+end
+
+api_instance = DialMyCalls::VanityNumbersApi.new
+
+vanity_number_id = "vanity_number_id_example" # String | VanityNumberId
+
+
+begin
+  #Get Vanity Number
+  result = api_instance.get_vanity_number_by_id(vanity_number_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling VanityNumbersApi->get_vanity_number_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vanity_number_id** | **String**| VanityNumberId | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml
+ - **Accept**: application/json, application/xml
+
+
+
+# **get_vanity_numbers**
+> Object get_vanity_numbers(opts)
+
+List Vanity Numbers
+
+Retrieve a list of vanity numbers. <br><br> Returns a list of vanitynumber objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/vanitynumbers ```
+
+### Example
+```ruby
+# load the gem
+require 'dialmycalls_client'
+# setup authorization
+DialMyCalls.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-ApiKey'] = 'YOUR API KEY'
+end
+
+api_instance = DialMyCalls::VanityNumbersApi.new
+
+opts = { 
+  range: "range_example" # String | Range (ie \"records=201-300\") of vanitynumbers requested
+}
+
+begin
+  #List Vanity Numbers
+  result = api_instance.get_vanity_numbers(opts)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling VanityNumbersApi->get_vanity_numbers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **range** | **String**| Range (ie \&quot;records&#x3D;201-300\&quot;) of vanitynumbers requested | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml
+ - **Accept**: application/json, application/xml
+
+
+
+# **update_vanity_number_by_id**
+> Object update_vanity_number_by_id(update_vanity_number_by_id_parameters, vanity_number_id)
+
+Update Vanity Number
+
+Update a vanity number. <br><br> Returns a vanitynumber object if a valid identifier was provided, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X PUT -d \"{\\\"ptt_number_id\\\":\\\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee\\\",\\\"call_options\\\":{\\\"voicemail\\\":true}}\" https://$API_KEY@api.dialmycalls.com/2.0/vanitynumber/$VANITYNUMBER_ID ```
+
+### Example
+```ruby
+# load the gem
+require 'dialmycalls_client'
+# setup authorization
+DialMyCalls.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-ApiKey'] = 'YOUR API KEY'
+end
+
+api_instance = DialMyCalls::VanityNumbersApi.new
+
+update_vanity_number_by_id_parameters = DialMyCalls::UpdateVanityNumberByIdParameters.new # UpdateVanityNumberByIdParameters | Request body
+
+vanity_number_id = "vanity_number_id_example" # String | VanityNumberId
+
+
+begin
+  #Update Vanity Number
+  result = api_instance.update_vanity_number_by_id(update_vanity_number_by_id_parameters, vanity_number_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling VanityNumbersApi->update_vanity_number_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_vanity_number_by_id_parameters** | [**UpdateVanityNumberByIdParameters**](UpdateVanityNumberByIdParameters.md)| Request body | 
+ **vanity_number_id** | **String**| VanityNumberId | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml
+ - **Accept**: application/json, application/xml
+
+
+

data/docs/Vanitynumber.md

@@ -0,0 +1,16 @@
+# DialMyCalls::Vanitynumber
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for this group. | [optional] 
+**phone** | **String** | The phone number. | [optional] 
+**status** | **String** | The status of the vanity number. Options: active, onhold, billingdecline, pendingdelete | [optional] 
+**minutes_used** | **Float** | The amount of minutes used since last billing. | [optional] 
+**minutes_allowed** | **Float** | The amount of minutes included with the vanity number before billed additionally. | [optional] 
+**voicemails_new** | **Integer** | The amount of voicemails that have not been downloaded. | [optional] 
+**voicemails_old** | **Integer** | The amount of voicemails that have been downloaded. | [optional] 
+**created_at** | **String** | When the keyword was created. | [optional] 
+**updated_at** | **String** | When the keyword was last updated. | [optional] 
+
+

data/docs/VerifyCallerIdByIdParameters.md

@@ -0,0 +1,8 @@
+# DialMyCalls::VerifyCallerIdByIdParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pin** | **String** | (Required)  Verification PIN number received from making add caller ID request. | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,67 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# 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="dialmycalls"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="ruby-sdk-v2"
+    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'
+