dialmycalls_client 2.0.1

data/docs/Contact.md

@@ -0,0 +1,18 @@
+# DialMyCalls::Contact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for this contact. | [optional] 
+**firstname** | **String** | The contact's first name. | [optional] 
+**lastname** | **String** | The contact's last name. | [optional] 
+**miscellaneous** | **String** | Miscellaneous information. | [optional] 
+**phone** | **String** | 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** | **String** | List of groups that this contact belongs to. | [optional] 
+**created_at** | **String** | When the contact was created. | [optional] 
+**updated_at** | **String** | When the contact was last updated. | [optional] 
+
+

data/docs/ContactAttributes.md

@@ -0,0 +1,11 @@
+# DialMyCalls::ContactAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone** | **String** | Contact's phone number. | [optional] 
+**firstname** | **String** | Contact's first name. | [optional] 
+**lastname** | **String** | Contact's last name. | [optional] 
+**email** | **String** | Contact's email address. | [optional] 
+
+

data/docs/ContactsApi.md

@@ -0,0 +1,330 @@
+# DialMyCalls::ContactsApi
+
+All URIs are relative to *https://api.dialmycalls.com/2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_contact**](ContactsApi.md#create_contact) | **POST** /contact | Add Contact
+[**delete_contact_by_id**](ContactsApi.md#delete_contact_by_id) | **DELETE** /contact/{ContactId} | Delete Contact
+[**get_contact_by_id**](ContactsApi.md#get_contact_by_id) | **GET** /contact/{ContactId} | Get Contact
+[**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | List Contacts
+[**get_contacts_by_group_id**](ContactsApi.md#get_contacts_by_group_id) | **GET** /contacts/{GroupId} | List Contacts in Group
+[**update_contact_by_id**](ContactsApi.md#update_contact_by_id) | **PUT** /contact/{ContactId} | Update Contact
+
+
+# **create_contact**
+> Object create_contact(create_contact_parameters)
+
+Add Contact
+
+Add a contact to your contact list. <br><br> Returns a contact object on success, and returns an error otherwise. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X POST -d \"{\\\"phone\\\": \\\"5555555555\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/contact ```
+
+### 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::ContactsApi.new
+
+create_contact_parameters = DialMyCalls::CreateContactParameters.new # CreateContactParameters | Request body
+
+
+begin
+  #Add Contact
+  result = api_instance.create_contact(create_contact_parameters)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling ContactsApi->create_contact: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_contact_parameters** | [**CreateContactParameters**](CreateContactParameters.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_contact_by_id**
+> Object delete_contact_by_id(contact_id)
+
+Delete Contact
+
+Delete a contact from your contact list. <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/contact/$CONTACT_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::ContactsApi.new
+
+contact_id = "contact_id_example" # String | ContactId
+
+
+begin
+  #Delete Contact
+  result = api_instance.delete_contact_by_id(contact_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling ContactsApi->delete_contact_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contact_id** | **String**| ContactId | 
+
+### 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_contact_by_id**
+> Object get_contact_by_id(contact_id)
+
+Get Contact
+
+Retrieve a contact to your contact list. <br><br> Returns a contact 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/contact/$CONTACT_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::ContactsApi.new
+
+contact_id = "contact_id_example" # String | ContactId
+
+
+begin
+  #Get Contact
+  result = api_instance.get_contact_by_id(contact_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling ContactsApi->get_contact_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contact_id** | **String**| ContactId | 
+
+### 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_contacts**
+> Object get_contacts(opts)
+
+List Contacts
+
+Retrieve a list of contacts. <br><br> Returns a list of contact objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/contacts ```
+
+### 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::ContactsApi.new
+
+opts = { 
+  range: "range_example" # String | Range (ie \"records=201-300\") of contacts requested
+}
+
+begin
+  #List Contacts
+  result = api_instance.get_contacts(opts)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling ContactsApi->get_contacts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **range** | **String**| Range (ie \&quot;records&#x3D;201-300\&quot;) of contacts 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_contacts_by_group_id**
+> Object get_contacts_by_group_id(group_id)
+
+List Contacts in Group
+
+Retrieve a list of contacts in a contact group. <br><br> Returns a list of contact objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/contacts/$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::ContactsApi.new
+
+group_id = "group_id_example" # String | GroupId
+
+
+begin
+  #List Contacts in Group
+  result = api_instance.get_contacts_by_group_id(group_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling ContactsApi->get_contacts_by_group_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
+
+
+
+# **update_contact_by_id**
+> Object update_contact_by_id(update_contact_by_id_parameters, contact_id)
+
+Update Contact
+
+Update an existing contact in your contact list. <br><br> Returns a contact 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 \"{\\\"phone\\\": \\\"5555555555\\\"}\" https://$API_KEY@api.dialmycalls.com/2.0/contact/$CONTACT_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::ContactsApi.new
+
+update_contact_by_id_parameters = DialMyCalls::UpdateContactByIdParameters.new # UpdateContactByIdParameters | Request body
+
+contact_id = "contact_id_example" # String | ContactId
+
+
+begin
+  #Update Contact
+  result = api_instance.update_contact_by_id(update_contact_by_id_parameters, contact_id)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling ContactsApi->update_contact_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_contact_by_id_parameters** | [**UpdateContactByIdParameters**](UpdateContactByIdParameters.md)| Request body | 
+ **contact_id** | **String**| ContactId | 
+
+### 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/CreateAccessAccountParameters.md

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

data/docs/CreateCallParameters.md

@@ -0,0 +1,18 @@
+# DialMyCalls::CreateCallParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | (Required)  Name the broadcast. | [optional] 
+**callerid_id** | **String** | (Required)  The caller id that the message should be sent from. | [optional] 
+**recording_id** | **String** | (Required)  The recording id of the message that should be played. | [optional] 
+**machine_recording_id** | **String** | The recording id of the message that should be played on answering machines.  If not supplied the recording_id will be used.  use_amd must be true in order for this feature to work. | [optional] 
+**send_at** | **String** | When the broadcast should be sent. (Ex: 2016-07-25T12:00:00+0000) | [optional] 
+**send_immediately** | **BOOLEAN** | Should the broadcast go out immediately? | [optional] 
+**use_amd** | **BOOLEAN** | Using answering machine detection? | [optional] 
+**send_email** | **BOOLEAN** | Also send an email to the contacts? | [optional] 
+**accessaccount_id** | **String** | Schedule this broadcast as an access account. | [optional] 
+**contacts** | [**Array<ContactAttributes>**](ContactAttributes.md) | (Required)  List of contact information that should be sent the broadcast. | [optional] 
+**add_ons** | [**Array<PushToListenAgain>**](PushToListenAgain.md) | A list of feature add-ons for the calls. | [optional] 
+
+

data/docs/CreateCallerIdParameters.md

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

data/docs/CreateContactParameters.md

@@ -0,0 +1,14 @@
+# DialMyCalls::CreateContactParameters
+
+## 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/CreateGroupParameters.md

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

data/docs/CreateRecordingByPhoneParameters.md

@@ -0,0 +1,12 @@
+# DialMyCalls::CreateRecordingByPhoneParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | (Required)  The name of the recording. | [optional] 
+**callerid_id** | **String** | The caller id that the create recording message should be sent from. | [optional] 
+**whitelabel** | **BOOLEAN** | Add or remove the DialMyCalls intro message. | [optional] 
+**phone** | **String** | (Required)  The recipient's phone number who will record the message. | [optional] 
+**extension** | **String** | The recipient's phone extension up to 10 numeric digits. | [optional] 
+
+

data/docs/CreateRecordingByUrlParameters.md

@@ -0,0 +1,9 @@
+# DialMyCalls::CreateRecordingByUrlParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | (Required)  The name of the recording. | [optional] 
+**url** | **String** | (Required)  The URL of the sound file. (Formats: MP3 or WAV) | [optional] 
+
+

data/docs/CreateRecordingParameters.md

@@ -0,0 +1,11 @@
+# DialMyCalls::CreateRecordingParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | (Required)  The name of the recording. | [optional] 
+**gender** | **String** | (Required)  Gender of the recording. Options: M or F | [optional] 
+**language** | **String** | (Required)  The language of the recording. Options: en, es | [optional] 
+**text** | **String** | (Required)  The text to convert to speech. | [optional] 
+
+

data/docs/CreateTextParameters.md

@@ -0,0 +1,17 @@
+# DialMyCalls::CreateTextParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | (Required)  Name the broadcast. | [optional] 
+**keyword_id** | **String** | (Required)  The keyword id that should be associated with this broadcast. | [optional] 
+**messages** | **Array<String>** | (Required)  List of messages to send (up to 10). | [optional] 
+**send_at** | **String** | When the broadcast should be sent. (Ex: 2016-07-25T12:00:00+0000) | [optional] 
+**send_immediately** | **BOOLEAN** | Should the broadcast go out immediately? | [optional] 
+**send_email** | **BOOLEAN** | Also send an email to the contacts? | [optional] 
+**accessaccount_id** | **String** | Schedule this broadcast as an access account. | [optional] 
+**shortcode_id** | **String** | The shortcode id that the broadcast will be sent from. | [optional] 
+**concatenate_sms** | **BOOLEAN** | Combine all SMS messages into 1 message on the end users device. | [optional] 
+**contacts** | [**Array<ContactAttributes>**](ContactAttributes.md) | (Required)  List of contact information that should be sent the broadcast. | [optional] 
+
+

data/docs/CreateUnverifiedCallerIdParameters.md

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

data/docs/DoNotContactsApi.md

@@ -0,0 +1,62 @@
+# DialMyCalls::DoNotContactsApi
+
+All URIs are relative to *https://api.dialmycalls.com/2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_do_not_contacts**](DoNotContactsApi.md#get_do_not_contacts) | **GET** /donotcontacts | List DoNotContacts
+
+
+# **get_do_not_contacts**
+> Object get_do_not_contacts(opts)
+
+List DoNotContacts
+
+Retrieve a list of donotcontacts. <br><br> Returns a list of donotcontact objects. <br><br> ``` curl -i -H \"Content-Type: application/json\" -X GET https://$API_KEY@api.dialmycalls.com/2.0/donotcontacts ```
+
+### 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::DoNotContactsApi.new
+
+opts = { 
+  range: "range_example" # String | Range (ie \"records=201-300\") of donotcontacts requested
+}
+
+begin
+  #List DoNotContacts
+  result = api_instance.get_do_not_contacts(opts)
+  p result
+rescue DialMyCalls::ApiError => e
+  puts "Exception when calling DoNotContactsApi->get_do_not_contacts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **range** | **String**| Range (ie \&quot;records&#x3D;201-300\&quot;) of donotcontacts 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/Donotcontact.md

@@ -0,0 +1,12 @@
+# DialMyCalls::Donotcontact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for this group. | [optional] 
+**phone** | **String** | The phone number that is on the donotcontact list. | [optional] 
+**type** | **String** | The type of the donotcontact. Options: call, text | [optional] 
+**created_at** | **String** | When the donotcontact was created. | [optional] 
+**updated_at** | **String** | When the donotcontact was last updated. | [optional] 
+
+

data/docs/Group.md

@@ -0,0 +1,12 @@
+# DialMyCalls::Group
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for this group. | [optional] 
+**name** | **String** | The group name. | [optional] 
+**contacts_count** | **Float** | The number of contacts in the group. | [optional] 
+**created_at** | **String** | When the group was created. | [optional] 
+**updated_at** | **String** | When the group was last updated. | [optional] 
+
+