dialmycalls_client 2.0.1

data/docs/GroupsApi.md

@@ -0,0 +1,277 @@
+# DialMyCalls::GroupsApi
+
+All URIs are relative to *https://api.dialmycalls.com/2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_group**](GroupsApi.md#create_group) | **POST** /group | Add Group
+[**delete_group_by_id**](GroupsApi.md#delete_group_by_id) | **DELETE** /group/{GroupId} | Delete Group
+[**get_group_by_id**](GroupsApi.md#get_group_by_id) | **GET** /group/{GroupId} | Get Group
+[**get_groups**](GroupsApi.md#get_groups) | **GET** /groups | List Groups
+[**update_group_by_id**](GroupsApi.md#update_group_by_id) | **PUT** /group/{GroupId} | Update Group
+
+
+# **create_group**
+> Object create_group(create_group_parameters)
+
+Add Group
+
+Add a contact group. <br><br> Returns a group object on success, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X POST -d \"{\\\"name\\\": \\\"Test Group\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/group ```
+
+### 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::GroupsApi.new
+
+create_group_parameters = DialMyCalls::CreateGroupParameters.new # CreateGroupParameters | Request body
+
+
+begin
+  #Add Group
+  result = api_instance.create_group(create_group_parameters)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling GroupsApi->create_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_group_parameters** | [**CreateGroupParameters**](CreateGroupParameters.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_group_by_id**
+> Object delete_group_by_id(group_id)
+
+Delete Group
+
+Delete a contact group. <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/group/$GROUP_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::GroupsApi.new
+
+group_id = "group_id_example" # String | GroupId
+
+
+begin
+  #Delete Group
+  result = api_instance.delete_group_by_id(group_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling GroupsApi->delete_group_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| GroupId | 
+
+### 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_group_by_id**
+> Object get_group_by_id(group_id)
+
+Get Group
+
+Retrieve a contact group. <br><br> Returns a group 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/group/$GROUP_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::GroupsApi.new
+
+group_id = "group_id_example" # String | GroupId
+
+
+begin
+  #Get Group
+  result = api_instance.get_group_by_id(group_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling GroupsApi->get_group_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| GroupId | 
+
+### 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_groups**
+> Object get_groups(opts)
+
+List Groups
+
+Retrieve a list of contact groups. <br><br> Returns a list of group objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/groups ```
+
+### 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::GroupsApi.new
+
+opts = { 
+  range: "range_example" # String | Range (ie \"records=201-300\") of groups requested
+}
+
+begin
+  #List Groups
+  result = api_instance.get_groups(opts)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling GroupsApi->get_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **range** | **String**| Range (ie \&quot;records&#x3D;201-300\&quot;) of groups 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_group_by_id**
+> Object update_group_by_id(update_group_by_id_parameters, group_id)
+
+Update Group
+
+Update an existing contact group. <br><br> Returns a group object if a valid identifier was provided and input validation passed, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X PUT -d \"{\\\"name\\\": \\\"Test Group Updated\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/group/$GROUP_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::GroupsApi.new
+
+update_group_by_id_parameters = DialMyCalls::UpdateGroupByIdParameters.new # UpdateGroupByIdParameters | Request body
+
+group_id = "group_id_example" # String | GroupId
+
+
+begin
+  #Update Group
+  result = api_instance.update_group_by_id(update_group_by_id_parameters, group_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling GroupsApi->update_group_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_group_by_id_parameters** | [**UpdateGroupByIdParameters**](UpdateGroupByIdParameters.md)| Request body | 
+ **group_id** | **String**| GroupId | 
+
+### 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/Identifier.md

@@ -0,0 +1,8 @@
+# DialMyCalls::Identifier
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for this access account. | [optional] 
+
+

data/docs/Incomingtext.md

@@ -0,0 +1,13 @@
+# DialMyCalls::Incomingtext
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for this text. | [optional] 
+**from_number** | **String** | The phone number the text message was sent from. | [optional] 
+**to_number** | **String** | The phone number the text message was sent to. | [optional] 
+**message** | **String** | The text message that was sent.  This data is URL encoded. | [optional] 
+**created_at** | **String** | When the text message was created. | [optional] 
+**updated_at** | **String** | When the text message was last updated. | [optional] 
+
+

data/docs/Keyword.md

@@ -0,0 +1,12 @@
+# DialMyCalls::Keyword
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for this keyword. | [optional] 
+**keyword** | **String** | The keyword. | [optional] 
+**status** | **String** | The status of the keyword. Options: active, pendingdelete, onhold, billingdecline | [optional] 
+**created_at** | **String** | When the keyword was created. | [optional] 
+**updated_at** | **String** | When the keyword was last updated. | [optional] 
+
+

data/docs/KeywordsApi.md

@@ -0,0 +1,168 @@
+# DialMyCalls::KeywordsApi
+
+All URIs are relative to *https://api.dialmycalls.com/2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_keyword_by_id**](KeywordsApi.md#delete_keyword_by_id) | **DELETE** /keyword/{KeywordId} | Delete Keyword
+[**get_keyword_by_id**](KeywordsApi.md#get_keyword_by_id) | **GET** /keyword/{KeywordId} | Get Keyword
+[**get_keywords**](KeywordsApi.md#get_keywords) | **GET** /keywords | List Keywords
+
+
+# **delete_keyword_by_id**
+> Object delete_keyword_by_id(keyword_id)
+
+Delete Keyword
+
+Delete a keyword. <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/$KEYWORD_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::KeywordsApi.new
+
+keyword_id = "keyword_id_example" # String | KeywordId
+
+
+begin
+  #Delete Keyword
+  result = api_instance.delete_keyword_by_id(keyword_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling KeywordsApi->delete_keyword_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **keyword_id** | **String**| KeywordId | 
+
+### 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_keyword_by_id**
+> Object get_keyword_by_id(keyword_id)
+
+Get Keyword
+
+Retrieve a keyword. <br><br> Returns a keyword 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/keyword/$KEYWORD_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::KeywordsApi.new
+
+keyword_id = "keyword_id_example" # String | KeywordId
+
+
+begin
+  #Get Keyword
+  result = api_instance.get_keyword_by_id(keyword_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling KeywordsApi->get_keyword_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **keyword_id** | **String**| KeywordId | 
+
+### 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_keywords**
+> Object get_keywords(opts)
+
+List Keywords
+
+Retrieve a list of keywords. <br><br> Returns a list of keyword objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/keywords ```
+
+### 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::KeywordsApi.new
+
+opts = { 
+  range: "range_example" # String | Range (ie \"records=201-300\") of keywords requested
+}
+
+begin
+  #List Keywords
+  result = api_instance.get_keywords(opts)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling KeywordsApi->get_keywords: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **range** | **String**| Range (ie \&quot;records&#x3D;201-300\&quot;) of keywords 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/Polling.md

@@ -0,0 +1,10 @@
+# DialMyCalls::Polling
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The add-on type. Option: polling | [optional] 
+**options** | **String** | A list of polling options. | [optional] 
+**add_message** | **Object** | Add a generic add-on message. | [optional] 
+
+

data/docs/PushToListenAgain.md

@@ -0,0 +1,9 @@
+# DialMyCalls::PushToListenAgain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The add-on type. Option: listen | [optional] 
+**add_message** | **Object** | Add a generic add-on message. | [optional] 
+
+

data/docs/PushToOptOut.md

@@ -0,0 +1,9 @@
+# DialMyCalls::PushToOptOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The add-on type. Option: optout | [optional] 
+**add_message** | **Object** | Add a generic add-on message. | [optional] 
+
+

data/docs/PushToRecord.md

@@ -0,0 +1,9 @@
+# DialMyCalls::PushToRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The add-on type. Option: record | [optional] 
+**add_message** | **Object** | Add a generic add-on message. | [optional] 
+
+

data/docs/PushToTalk.md

@@ -0,0 +1,12 @@
+# DialMyCalls::PushToTalk
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The add-on type. Option: ptt | [optional] 
+**callerid_id** | **String** | Phone number to connect the caller to. | [optional] 
+**ringtone** | **String** | The ringtone to play to the user when connecting. Options: elevator_music, caribbean_music, classical_music, digital_ringing, old_phone_ringing, goofy_music | [optional] 
+**cpm** | **Integer** | Calls per minute throttling. | [optional] 
+**add_message** | **Object** | Add a generic add-on message. | [optional] 
+
+

data/docs/Recording.md

@@ -0,0 +1,15 @@
+# DialMyCalls::Recording
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for this recording. | [optional] 
+**name** | **String** | The recording name. | [optional] 
+**type** | **String** | The recording type. Options: text or sound | [optional] 
+**seconds** | **Integer** | The length of the recording. | [optional] 
+**url** | **String** | The URL of the recording file. | [optional] 
+**processed** | **BOOLEAN** | Whether the recording is ready for use. | [optional] 
+**created_at** | **String** | When the recording was created. | [optional] 
+**updated_at** | **String** | When the recording was last updated. | [optional] 
+
+