dialmycalls_client 2.0.1

data/docs/TextsApi.md

@@ -0,0 +1,492 @@
+# DialMyCalls::TextsApi
+
+All URIs are relative to *https://api.dialmycalls.com/2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_text_by_id**](TextsApi.md#cancel_text_by_id) | **DELETE** /service/text/{TextId} | Cancel Text
+[**create_text**](TextsApi.md#create_text) | **POST** /service/text | Create Text
+[**delete_incoming_text_by_id**](TextsApi.md#delete_incoming_text_by_id) | **DELETE** /incoming/text/{TextId} | Delete Incoming Text
+[**get_incoming_text_by_id**](TextsApi.md#get_incoming_text_by_id) | **GET** /incoming/text/{TextId} | Get Incoming Text
+[**get_incoming_texts**](TextsApi.md#get_incoming_texts) | **GET** /incoming/texts | List Incoming Texts
+[**get_short_codes**](TextsApi.md#get_short_codes) | **GET** /shortcodes | List Shortcodes
+[**get_text_by_id**](TextsApi.md#get_text_by_id) | **GET** /service/text/{TextId} | Get Text
+[**get_text_recipients_by_text_id**](TextsApi.md#get_text_recipients_by_text_id) | **GET** /service/text/{TextId}/recipients | Get Text Recipients
+[**get_texts**](TextsApi.md#get_texts) | **GET** /service/texts | List Texts
+
+
+# **cancel_text_by_id**
+> Object cancel_text_by_id(text_id)
+
+Cancel Text
+
+Cancel an outgoing text. <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/service/text/$TEXT_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::TextsApi.new
+
+text_id = "text_id_example" # String | TextId
+
+
+begin
+  #Cancel Text
+  result = api_instance.cancel_text_by_id(text_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling TextsApi->cancel_text_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **text_id** | **String**| TextId | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml
+ - **Accept**: application/json, application/xml
+
+
+
+# **create_text**
+> Object create_text(create_text_parameters)
+
+Create Text
+
+Create an outgoing text broadcast. <br><br> Returns a service object on success, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X POST -d \"{\\\"keyword_id\\\": \\\"dfe49537-a0a8-4f4a-98a1-e03df388af11\\\", \\\"send_immediately\\\": true,\\\"messages\\\": [\\\"Testing testing\\\"], \\\"contacts\\\": [{\\\"phone\\\":\\\"1116551235\\\"},{\\\"phone\\\":\\\"1116551234\\\"}]}\" https://$API_KEY@api.dialmycalls.com/2.0/service/text ```
+
+### 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::TextsApi.new
+
+create_text_parameters = DialMyCalls::CreateTextParameters.new # CreateTextParameters | Request body
+
+
+begin
+  #Create Text
+  result = api_instance.create_text(create_text_parameters)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling TextsApi->create_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_text_parameters** | [**CreateTextParameters**](CreateTextParameters.md)| Request body | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml
+ - **Accept**: application/json, application/xml
+
+
+
+# **delete_incoming_text_by_id**
+> Object delete_incoming_text_by_id(text_id)
+
+Delete Incoming Text
+
+Delete a incoming text. <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/incoming/text/$TEXT_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::TextsApi.new
+
+text_id = "text_id_example" # String | TextId
+
+
+begin
+  #Delete Incoming Text
+  result = api_instance.delete_incoming_text_by_id(text_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling TextsApi->delete_incoming_text_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **text_id** | **String**| TextId | 
+
+### 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_incoming_text_by_id**
+> Object get_incoming_text_by_id(text_id)
+
+Get Incoming Text
+
+Retrieve a text. <br><br> Returns a Incoming Text 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/incoming/text/$TEXT_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::TextsApi.new
+
+text_id = "text_id_example" # String | TextId
+
+
+begin
+  #Get Incoming Text
+  result = api_instance.get_incoming_text_by_id(text_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling TextsApi->get_incoming_text_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **text_id** | **String**| TextId | 
+
+### 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_incoming_texts**
+> Object get_incoming_texts(opts)
+
+List Incoming Texts
+
+Retrieve a list of texts. <br><br> Returns a list of Incoming Text objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/incoming/texts ```
+
+### 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::TextsApi.new
+
+opts = { 
+  range: "range_example" # String | Range (ie \"records=201-300\") of texts requested
+}
+
+begin
+  #List Incoming Texts
+  result = api_instance.get_incoming_texts(opts)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling TextsApi->get_incoming_texts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **range** | **String**| Range (ie \&quot;records&#x3D;201-300\&quot;) of texts 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
+
+
+
+# **get_short_codes**
+> Object get_short_codes(opts)
+
+List Shortcodes
+
+Retrieve a list of shortcodes. <br><br> Returns a list of shortcode objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/shortcodes ```
+
+### 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::TextsApi.new
+
+opts = { 
+  range: "range_example" # String | Range (ie \"records=201-300\") of shortcodes requested
+}
+
+begin
+  #List Shortcodes
+  result = api_instance.get_short_codes(opts)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling TextsApi->get_short_codes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **range** | **String**| Range (ie \&quot;records&#x3D;201-300\&quot;) of shortcodes 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
+
+
+
+# **get_text_by_id**
+> Object get_text_by_id(text_id)
+
+Get Text
+
+Retrieve a text. <br><br> Returns a service 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/service/text/$TEXT_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::TextsApi.new
+
+text_id = "text_id_example" # String | TextId
+
+
+begin
+  #Get Text
+  result = api_instance.get_text_by_id(text_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling TextsApi->get_text_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **text_id** | **String**| TextId | 
+
+### 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_text_recipients_by_text_id**
+> Object get_text_recipients_by_text_id(text_id, opts)
+
+Get Text Recipients
+
+Retrieve a list of a text's recipients. <br><br> Returns a list of text recipient objects 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/service/text/$TEXT_ID/recipients ```
+
+### 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::TextsApi.new
+
+text_id = "text_id_example" # String | TextId
+
+opts = { 
+  range: "range_example" # String | Range (ie \"records=201-300\") of recipients requested
+}
+
+begin
+  #Get Text Recipients
+  result = api_instance.get_text_recipients_by_text_id(text_id, opts)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling TextsApi->get_text_recipients_by_text_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **text_id** | **String**| TextId | 
+ **range** | **String**| Range (ie \&quot;records&#x3D;201-300\&quot;) of recipients 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
+
+
+
+# **get_texts**
+> Object get_texts(opts)
+
+List Texts
+
+Retrieve a list of texts. <br><br> Returns a list of service objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/service/texts ```
+
+### 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::TextsApi.new
+
+opts = { 
+  range: "range_example" # String | Range (ie \"records=201-300\") of texts requested
+}
+
+begin
+  #List Texts
+  result = api_instance.get_texts(opts)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling TextsApi->get_texts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **range** | **String**| Range (ie \&quot;records&#x3D;201-300\&quot;) of texts 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
+
+
+

data/docs/UpdateAccessAccountByIdParameters.md

@@ -0,0 +1,10 @@
+# DialMyCalls::UpdateAccessAccountByIdParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The email address for this access account. | [optional] 
+**password** | **String** | The password for this access account. Requirements: 8 characters, 1 digit, 1 upper case character. | [optional] 
+**name** | **String** | The name for this access account. | [optional] 
+
+

data/docs/UpdateCallerIdByIdParameters.md

@@ -0,0 +1,8 @@
+# DialMyCalls::UpdateCallerIdByIdParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | (Required)  The caller ID's name. | [optional] 
+
+

data/docs/UpdateContactByIdParameters.md

@@ -0,0 +1,14 @@
+# DialMyCalls::UpdateContactByIdParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**firstname** | **String** | The contact's first name. | [optional] 
+**lastname** | **String** | The contact's last name. | [optional] 
+**phone** | **String** | (Required)  The contact's phone number. | [optional] 
+**extension** | **String** | The contact's phone extension. | [optional] 
+**email** | **String** | The contact's email address. | [optional] 
+**extra1** | **String** | Miscellaneous data about this contact. | [optional] 
+**groups** | **Array<String>** | List of group IDs that this contact should belong to. | [optional] 
+
+

data/docs/UpdateGroupByIdParameters.md

@@ -0,0 +1,8 @@
+# DialMyCalls::UpdateGroupByIdParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | (Required)  The contact group's name. | [optional] 
+
+

data/docs/UpdateRecordingByIdParameters.md

@@ -0,0 +1,8 @@
+# DialMyCalls::UpdateRecordingByIdParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | (Required)  The recording's name. | [optional] 
+
+

data/docs/UpdateVanityNumberByIdParameters.md

@@ -0,0 +1,12 @@
+# DialMyCalls::UpdateVanityNumberByIdParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_options** | **Array<String>** | The options to include when the number is called.  If an option is not included it will be turned off.  Option values should be boolean.  Possible values are: 'voicemail' (Leave A Message), 'ptt' (Push To Talk), 'optin' (Opt-In), 'repeat' (Repeat Your Message) -- Note: Optout cannot be removed without prior authorization.  Please contact customer support for this. | [optional] 
+**recording_source** | **String** | Where the recording will be generated from.  (specific, lastsent, lastuploaded) | [optional] 
+**specific_recording_id** | **String** | Unique identifier for the recording if recording_source is set to specific. | [optional] 
+**play_cta** | **BOOLEAN** | Setting this to true our system will play the prompts for keys to be pushed. | [optional] 
+**ptt_number_id** | **String** | This is a verified caller id that is on your account.  This will be used if PTT option is used. | [optional] 
+
+