dialmycalls_client 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/README.md +186 -0
- data/dialmycalls_client-1.0.0.gem +0 -0
- data/dialmycalls_client.gemspec +55 -0
- data/docs/Accessaccount.md +12 -0
- data/docs/Account.md +9 -0
- data/docs/AccountsApi.md +324 -0
- data/docs/CallRecipient.md +19 -0
- data/docs/CallerIdsApi.md +386 -0
- data/docs/Callerid.md +13 -0
- data/docs/CallsApi.md +278 -0
- data/docs/Callservice.md +17 -0
- data/docs/Contact.md +18 -0
- data/docs/ContactAttributes.md +11 -0
- data/docs/ContactsApi.md +330 -0
- data/docs/CreateAccessAccountParameters.md +10 -0
- data/docs/CreateCallParameters.md +18 -0
- data/docs/CreateCallerIdParameters.md +9 -0
- data/docs/CreateContactParameters.md +14 -0
- data/docs/CreateGroupParameters.md +8 -0
- data/docs/CreateRecordingByPhoneParameters.md +12 -0
- data/docs/CreateRecordingByUrlParameters.md +9 -0
- data/docs/CreateRecordingParameters.md +11 -0
- data/docs/CreateTextParameters.md +17 -0
- data/docs/CreateUnverifiedCallerIdParameters.md +9 -0
- data/docs/DoNotContactsApi.md +62 -0
- data/docs/Donotcontact.md +12 -0
- data/docs/Group.md +12 -0
- data/docs/GroupsApi.md +277 -0
- data/docs/Identifier.md +8 -0
- data/docs/Incomingtext.md +13 -0
- data/docs/Keyword.md +12 -0
- data/docs/KeywordsApi.md +168 -0
- data/docs/Polling.md +10 -0
- data/docs/PushToListenAgain.md +9 -0
- data/docs/PushToOptOut.md +9 -0
- data/docs/PushToRecord.md +9 -0
- data/docs/PushToTalk.md +12 -0
- data/docs/Recording.md +15 -0
- data/docs/RecordingsApi.md +383 -0
- data/docs/Service.md +16 -0
- data/docs/Shortcode.md +11 -0
- data/docs/TextRecipient.md +13 -0
- data/docs/TextsApi.md +492 -0
- data/docs/UpdateAccessAccountByIdParameters.md +10 -0
- data/docs/UpdateCallerIdByIdParameters.md +8 -0
- data/docs/UpdateContactByIdParameters.md +14 -0
- data/docs/UpdateGroupByIdParameters.md +8 -0
- data/docs/UpdateRecordingByIdParameters.md +8 -0
- data/docs/UpdateVanityNumberByIdParameters.md +12 -0
- data/docs/VanityNumbersApi.md +224 -0
- data/docs/Vanitynumber.md +16 -0
- data/docs/VerifyCallerIdByIdParameters.md +8 -0
- data/git_push.sh +67 -0
- data/lib/dialmycalls_client/api/accounts_api.rb +375 -0
- data/lib/dialmycalls_client/api/caller_ids_api.rb +440 -0
- data/lib/dialmycalls_client/api/calls_api.rb +321 -0
- data/lib/dialmycalls_client/api/contacts_api.rb +379 -0
- data/lib/dialmycalls_client/api/do_not_contacts_api.rb +90 -0
- data/lib/dialmycalls_client/api/groups_api.rb +322 -0
- data/lib/dialmycalls_client/api/keywords_api.rb +204 -0
- data/lib/dialmycalls_client/api/recordings_api.rb +436 -0
- data/lib/dialmycalls_client/api/texts_api.rb +547 -0
- data/lib/dialmycalls_client/api/vanity_numbers_api.rb +265 -0
- data/lib/dialmycalls_client/api_client.rb +379 -0
- data/lib/dialmycalls_client/api_error.rb +47 -0
- data/lib/dialmycalls_client/configuration.rb +214 -0
- data/lib/dialmycalls_client/models/accessaccount.rb +240 -0
- data/lib/dialmycalls_client/models/account.rb +210 -0
- data/lib/dialmycalls_client/models/call_recipient.rb +310 -0
- data/lib/dialmycalls_client/models/callerid.rb +250 -0
- data/lib/dialmycalls_client/models/callservice.rb +290 -0
- data/lib/dialmycalls_client/models/contact.rb +300 -0
- data/lib/dialmycalls_client/models/contact_attributes.rb +230 -0
- data/lib/dialmycalls_client/models/create_access_account_parameters.rb +220 -0
- data/lib/dialmycalls_client/models/create_call_parameters.rb +304 -0
- data/lib/dialmycalls_client/models/create_caller_id_parameters.rb +210 -0
- data/lib/dialmycalls_client/models/create_contact_parameters.rb +262 -0
- data/lib/dialmycalls_client/models/create_group_parameters.rb +200 -0
- data/lib/dialmycalls_client/models/create_recording_by_phone_parameters.rb +240 -0
- data/lib/dialmycalls_client/models/create_recording_by_url_parameters.rb +210 -0
- data/lib/dialmycalls_client/models/create_recording_parameters.rb +230 -0
- data/lib/dialmycalls_client/models/create_text_parameters.rb +294 -0
- data/lib/dialmycalls_client/models/create_unverified_caller_id_parameters.rb +210 -0
- data/lib/dialmycalls_client/models/donotcontact.rb +240 -0
- data/lib/dialmycalls_client/models/group.rb +240 -0
- data/lib/dialmycalls_client/models/identifier.rb +200 -0
- data/lib/dialmycalls_client/models/incomingtext.rb +250 -0
- data/lib/dialmycalls_client/models/keyword.rb +240 -0
- data/lib/dialmycalls_client/models/polling.rb +220 -0
- data/lib/dialmycalls_client/models/push_to_listen_again.rb +210 -0
- data/lib/dialmycalls_client/models/push_to_opt_out.rb +210 -0
- data/lib/dialmycalls_client/models/push_to_record.rb +210 -0
- data/lib/dialmycalls_client/models/push_to_talk.rb +240 -0
- data/lib/dialmycalls_client/models/recording.rb +270 -0
- data/lib/dialmycalls_client/models/service.rb +280 -0
- data/lib/dialmycalls_client/models/shortcode.rb +230 -0
- data/lib/dialmycalls_client/models/text_recipient.rb +250 -0
- data/lib/dialmycalls_client/models/update_access_account_by_id_parameters.rb +220 -0
- data/lib/dialmycalls_client/models/update_caller_id_by_id_parameters.rb +200 -0
- data/lib/dialmycalls_client/models/update_contact_by_id_parameters.rb +262 -0
- data/lib/dialmycalls_client/models/update_group_by_id_parameters.rb +200 -0
- data/lib/dialmycalls_client/models/update_recording_by_id_parameters.rb +200 -0
- data/lib/dialmycalls_client/models/update_vanity_number_by_id_parameters.rb +242 -0
- data/lib/dialmycalls_client/models/vanitynumber.rb +280 -0
- data/lib/dialmycalls_client/models/verify_caller_id_by_id_parameters.rb +200 -0
- data/lib/dialmycalls_client/version.rb +26 -0
- data/lib/dialmycalls_client.rb +99 -0
- data/spec/api/accounts_api_spec.rb +118 -0
- data/spec/api/caller_ids_api_spec.rb +132 -0
- data/spec/api/calls_api_spec.rb +107 -0
- data/spec/api/contacts_api_spec.rb +119 -0
- data/spec/api/do_not_contacts_api_spec.rb +58 -0
- data/spec/api/groups_api_spec.rb +107 -0
- data/spec/api/keywords_api_spec.rb +82 -0
- data/spec/api/recordings_api_spec.rb +131 -0
- data/spec/api/texts_api_spec.rb +155 -0
- data/spec/api/vanity_numbers_api_spec.rb +95 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +53 -0
- data/spec/models/accessaccount_spec.rb +77 -0
- data/spec/models/account_spec.rb +59 -0
- data/spec/models/call_recipient_spec.rb +119 -0
- data/spec/models/callerid_spec.rb +83 -0
- data/spec/models/callservice_spec.rb +107 -0
- data/spec/models/contact_attributes_spec.rb +71 -0
- data/spec/models/contact_spec.rb +113 -0
- data/spec/models/create_access_account_parameters_spec.rb +65 -0
- data/spec/models/create_call_parameters_spec.rb +113 -0
- data/spec/models/create_caller_id_parameters_spec.rb +59 -0
- data/spec/models/create_contact_parameters_spec.rb +89 -0
- data/spec/models/create_group_parameters_spec.rb +53 -0
- data/spec/models/create_recording_by_phone_parameters_spec.rb +77 -0
- data/spec/models/create_recording_by_url_parameters_spec.rb +59 -0
- data/spec/models/create_recording_parameters_spec.rb +71 -0
- data/spec/models/create_text_parameters_spec.rb +107 -0
- data/spec/models/create_unverified_caller_id_parameters_spec.rb +59 -0
- data/spec/models/donotcontact_spec.rb +77 -0
- data/spec/models/group_spec.rb +77 -0
- data/spec/models/identifier_spec.rb +53 -0
- data/spec/models/incomingtext_spec.rb +83 -0
- data/spec/models/keyword_spec.rb +77 -0
- data/spec/models/polling_spec.rb +65 -0
- data/spec/models/push_to_listen_again_spec.rb +59 -0
- data/spec/models/push_to_opt_out_spec.rb +59 -0
- data/spec/models/push_to_record_spec.rb +59 -0
- data/spec/models/push_to_talk_spec.rb +77 -0
- data/spec/models/recording_spec.rb +95 -0
- data/spec/models/service_spec.rb +101 -0
- data/spec/models/shortcode_spec.rb +71 -0
- data/spec/models/text_recipient_spec.rb +83 -0
- data/spec/models/update_access_account_by_id_parameters_spec.rb +65 -0
- data/spec/models/update_caller_id_by_id_parameters_spec.rb +53 -0
- data/spec/models/update_contact_by_id_parameters_spec.rb +89 -0
- data/spec/models/update_group_by_id_parameters_spec.rb +53 -0
- data/spec/models/update_recording_by_id_parameters_spec.rb +53 -0
- data/spec/models/update_vanity_number_by_id_parameters_spec.rb +77 -0
- data/spec/models/vanitynumber_spec.rb +101 -0
- data/spec/models/verify_caller_id_by_id_parameters_spec.rb +53 -0
- data/spec/spec_helper.rb +122 -0
- metadata +436 -0
|
@@ -0,0 +1,379 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#DialMyCalls API
|
|
3
|
+
|
|
4
|
+
#The DialMyCalls API
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 2.0.1
|
|
7
|
+
Contact: support@dialmycalls.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
|
|
10
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
11
|
+
you may not use this file except in compliance with the License.
|
|
12
|
+
You may obtain a copy of the License at
|
|
13
|
+
|
|
14
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
15
|
+
|
|
16
|
+
Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
See the License for the specific language governing permissions and
|
|
20
|
+
limitations under the License.
|
|
21
|
+
|
|
22
|
+
=end
|
|
23
|
+
|
|
24
|
+
require "uri"
|
|
25
|
+
|
|
26
|
+
module DialMyCalls
|
|
27
|
+
class ContactsApi
|
|
28
|
+
attr_accessor :api_client
|
|
29
|
+
|
|
30
|
+
def initialize(api_client = ApiClient.default)
|
|
31
|
+
@api_client = api_client
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Add Contact
|
|
35
|
+
# 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 ```
|
|
36
|
+
# @param create_contact_parameters Request body
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @return [Object]
|
|
39
|
+
def create_contact(create_contact_parameters, opts = {})
|
|
40
|
+
data, _status_code, _headers = create_contact_with_http_info(create_contact_parameters, opts)
|
|
41
|
+
return data
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# Add Contact
|
|
45
|
+
# 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 ```
|
|
46
|
+
# @param create_contact_parameters Request body
|
|
47
|
+
# @param [Hash] opts the optional parameters
|
|
48
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
49
|
+
def create_contact_with_http_info(create_contact_parameters, opts = {})
|
|
50
|
+
if @api_client.config.debugging
|
|
51
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.create_contact ..."
|
|
52
|
+
end
|
|
53
|
+
# verify the required parameter 'create_contact_parameters' is set
|
|
54
|
+
fail ArgumentError, "Missing the required parameter 'create_contact_parameters' when calling ContactsApi.create_contact" if create_contact_parameters.nil?
|
|
55
|
+
# resource path
|
|
56
|
+
local_var_path = "/contact".sub('{format}','json')
|
|
57
|
+
|
|
58
|
+
# query parameters
|
|
59
|
+
query_params = {}
|
|
60
|
+
|
|
61
|
+
# header parameters
|
|
62
|
+
header_params = {}
|
|
63
|
+
|
|
64
|
+
# HTTP header 'Accept' (if needed)
|
|
65
|
+
local_header_accept = ['application/json', 'application/xml']
|
|
66
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
67
|
+
|
|
68
|
+
# HTTP header 'Content-Type'
|
|
69
|
+
local_header_content_type = ['application/json', 'application/xml']
|
|
70
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
71
|
+
|
|
72
|
+
# form parameters
|
|
73
|
+
form_params = {}
|
|
74
|
+
|
|
75
|
+
# http body (model)
|
|
76
|
+
post_body = @api_client.object_to_http_body(create_contact_parameters)
|
|
77
|
+
auth_names = ['api_key']
|
|
78
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
79
|
+
:header_params => header_params,
|
|
80
|
+
:query_params => query_params,
|
|
81
|
+
:form_params => form_params,
|
|
82
|
+
:body => post_body,
|
|
83
|
+
:auth_names => auth_names,
|
|
84
|
+
:return_type => 'Object')
|
|
85
|
+
if @api_client.config.debugging
|
|
86
|
+
@api_client.config.logger.debug "API called: ContactsApi#create_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
87
|
+
end
|
|
88
|
+
return data, status_code, headers
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# Delete Contact
|
|
92
|
+
# 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 ```
|
|
93
|
+
# @param contact_id ContactId
|
|
94
|
+
# @param [Hash] opts the optional parameters
|
|
95
|
+
# @return [Object]
|
|
96
|
+
def delete_contact_by_id(contact_id, opts = {})
|
|
97
|
+
data, _status_code, _headers = delete_contact_by_id_with_http_info(contact_id, opts)
|
|
98
|
+
return data
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Delete Contact
|
|
102
|
+
# 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 ```
|
|
103
|
+
# @param contact_id ContactId
|
|
104
|
+
# @param [Hash] opts the optional parameters
|
|
105
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
106
|
+
def delete_contact_by_id_with_http_info(contact_id, opts = {})
|
|
107
|
+
if @api_client.config.debugging
|
|
108
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.delete_contact_by_id ..."
|
|
109
|
+
end
|
|
110
|
+
# verify the required parameter 'contact_id' is set
|
|
111
|
+
fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.delete_contact_by_id" if contact_id.nil?
|
|
112
|
+
# resource path
|
|
113
|
+
local_var_path = "/contact/{ContactId}".sub('{format}','json').sub('{' + 'ContactId' + '}', contact_id.to_s)
|
|
114
|
+
|
|
115
|
+
# query parameters
|
|
116
|
+
query_params = {}
|
|
117
|
+
|
|
118
|
+
# header parameters
|
|
119
|
+
header_params = {}
|
|
120
|
+
|
|
121
|
+
# HTTP header 'Accept' (if needed)
|
|
122
|
+
local_header_accept = ['application/json', 'application/xml']
|
|
123
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
124
|
+
|
|
125
|
+
# HTTP header 'Content-Type'
|
|
126
|
+
local_header_content_type = ['application/json', 'application/xml']
|
|
127
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
128
|
+
|
|
129
|
+
# form parameters
|
|
130
|
+
form_params = {}
|
|
131
|
+
|
|
132
|
+
# http body (model)
|
|
133
|
+
post_body = nil
|
|
134
|
+
auth_names = ['api_key']
|
|
135
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
136
|
+
:header_params => header_params,
|
|
137
|
+
:query_params => query_params,
|
|
138
|
+
:form_params => form_params,
|
|
139
|
+
:body => post_body,
|
|
140
|
+
:auth_names => auth_names,
|
|
141
|
+
:return_type => 'Object')
|
|
142
|
+
if @api_client.config.debugging
|
|
143
|
+
@api_client.config.logger.debug "API called: ContactsApi#delete_contact_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
144
|
+
end
|
|
145
|
+
return data, status_code, headers
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# Get Contact
|
|
149
|
+
# 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 ```
|
|
150
|
+
# @param contact_id ContactId
|
|
151
|
+
# @param [Hash] opts the optional parameters
|
|
152
|
+
# @return [Object]
|
|
153
|
+
def get_contact_by_id(contact_id, opts = {})
|
|
154
|
+
data, _status_code, _headers = get_contact_by_id_with_http_info(contact_id, opts)
|
|
155
|
+
return data
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Get Contact
|
|
159
|
+
# 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 ```
|
|
160
|
+
# @param contact_id ContactId
|
|
161
|
+
# @param [Hash] opts the optional parameters
|
|
162
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
163
|
+
def get_contact_by_id_with_http_info(contact_id, opts = {})
|
|
164
|
+
if @api_client.config.debugging
|
|
165
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.get_contact_by_id ..."
|
|
166
|
+
end
|
|
167
|
+
# verify the required parameter 'contact_id' is set
|
|
168
|
+
fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.get_contact_by_id" if contact_id.nil?
|
|
169
|
+
# resource path
|
|
170
|
+
local_var_path = "/contact/{ContactId}".sub('{format}','json').sub('{' + 'ContactId' + '}', contact_id.to_s)
|
|
171
|
+
|
|
172
|
+
# query parameters
|
|
173
|
+
query_params = {}
|
|
174
|
+
|
|
175
|
+
# header parameters
|
|
176
|
+
header_params = {}
|
|
177
|
+
|
|
178
|
+
# HTTP header 'Accept' (if needed)
|
|
179
|
+
local_header_accept = ['application/json', 'application/xml']
|
|
180
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
181
|
+
|
|
182
|
+
# HTTP header 'Content-Type'
|
|
183
|
+
local_header_content_type = ['application/json', 'application/xml']
|
|
184
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
185
|
+
|
|
186
|
+
# form parameters
|
|
187
|
+
form_params = {}
|
|
188
|
+
|
|
189
|
+
# http body (model)
|
|
190
|
+
post_body = nil
|
|
191
|
+
auth_names = ['api_key']
|
|
192
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
193
|
+
:header_params => header_params,
|
|
194
|
+
:query_params => query_params,
|
|
195
|
+
:form_params => form_params,
|
|
196
|
+
:body => post_body,
|
|
197
|
+
:auth_names => auth_names,
|
|
198
|
+
:return_type => 'Object')
|
|
199
|
+
if @api_client.config.debugging
|
|
200
|
+
@api_client.config.logger.debug "API called: ContactsApi#get_contact_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
201
|
+
end
|
|
202
|
+
return data, status_code, headers
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
# List Contacts
|
|
206
|
+
# 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 ```
|
|
207
|
+
# @param [Hash] opts the optional parameters
|
|
208
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of contacts requested
|
|
209
|
+
# @return [Object]
|
|
210
|
+
def get_contacts(opts = {})
|
|
211
|
+
data, _status_code, _headers = get_contacts_with_http_info(opts)
|
|
212
|
+
return data
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
# List Contacts
|
|
216
|
+
# 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 ```
|
|
217
|
+
# @param [Hash] opts the optional parameters
|
|
218
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of contacts requested
|
|
219
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
220
|
+
def get_contacts_with_http_info(opts = {})
|
|
221
|
+
if @api_client.config.debugging
|
|
222
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.get_contacts ..."
|
|
223
|
+
end
|
|
224
|
+
# resource path
|
|
225
|
+
local_var_path = "/contacts".sub('{format}','json')
|
|
226
|
+
|
|
227
|
+
# query parameters
|
|
228
|
+
query_params = {}
|
|
229
|
+
|
|
230
|
+
# header parameters
|
|
231
|
+
header_params = {}
|
|
232
|
+
|
|
233
|
+
# HTTP header 'Accept' (if needed)
|
|
234
|
+
local_header_accept = ['application/json', 'application/xml']
|
|
235
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
236
|
+
|
|
237
|
+
# HTTP header 'Content-Type'
|
|
238
|
+
local_header_content_type = ['application/json', 'application/xml']
|
|
239
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
240
|
+
header_params[:'Range'] = opts[:'range'] if !opts[:'range'].nil?
|
|
241
|
+
|
|
242
|
+
# form parameters
|
|
243
|
+
form_params = {}
|
|
244
|
+
|
|
245
|
+
# http body (model)
|
|
246
|
+
post_body = nil
|
|
247
|
+
auth_names = ['api_key']
|
|
248
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
249
|
+
:header_params => header_params,
|
|
250
|
+
:query_params => query_params,
|
|
251
|
+
:form_params => form_params,
|
|
252
|
+
:body => post_body,
|
|
253
|
+
:auth_names => auth_names,
|
|
254
|
+
:return_type => 'Object')
|
|
255
|
+
if @api_client.config.debugging
|
|
256
|
+
@api_client.config.logger.debug "API called: ContactsApi#get_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
257
|
+
end
|
|
258
|
+
return data, status_code, headers
|
|
259
|
+
end
|
|
260
|
+
|
|
261
|
+
# List Contacts in Group
|
|
262
|
+
# 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 ```
|
|
263
|
+
# @param group_id GroupId
|
|
264
|
+
# @param [Hash] opts the optional parameters
|
|
265
|
+
# @return [Object]
|
|
266
|
+
def get_contacts_by_group_id(group_id, opts = {})
|
|
267
|
+
data, _status_code, _headers = get_contacts_by_group_id_with_http_info(group_id, opts)
|
|
268
|
+
return data
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
# List Contacts in Group
|
|
272
|
+
# 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 ```
|
|
273
|
+
# @param group_id GroupId
|
|
274
|
+
# @param [Hash] opts the optional parameters
|
|
275
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
276
|
+
def get_contacts_by_group_id_with_http_info(group_id, opts = {})
|
|
277
|
+
if @api_client.config.debugging
|
|
278
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.get_contacts_by_group_id ..."
|
|
279
|
+
end
|
|
280
|
+
# verify the required parameter 'group_id' is set
|
|
281
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling ContactsApi.get_contacts_by_group_id" if group_id.nil?
|
|
282
|
+
# resource path
|
|
283
|
+
local_var_path = "/contacts/{GroupId}".sub('{format}','json').sub('{' + 'GroupId' + '}', group_id.to_s)
|
|
284
|
+
|
|
285
|
+
# query parameters
|
|
286
|
+
query_params = {}
|
|
287
|
+
|
|
288
|
+
# header parameters
|
|
289
|
+
header_params = {}
|
|
290
|
+
|
|
291
|
+
# HTTP header 'Accept' (if needed)
|
|
292
|
+
local_header_accept = ['application/json', 'application/xml']
|
|
293
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
294
|
+
|
|
295
|
+
# HTTP header 'Content-Type'
|
|
296
|
+
local_header_content_type = ['application/json', 'application/xml']
|
|
297
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
298
|
+
|
|
299
|
+
# form parameters
|
|
300
|
+
form_params = {}
|
|
301
|
+
|
|
302
|
+
# http body (model)
|
|
303
|
+
post_body = nil
|
|
304
|
+
auth_names = ['api_key']
|
|
305
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
306
|
+
:header_params => header_params,
|
|
307
|
+
:query_params => query_params,
|
|
308
|
+
:form_params => form_params,
|
|
309
|
+
:body => post_body,
|
|
310
|
+
:auth_names => auth_names,
|
|
311
|
+
:return_type => 'Object')
|
|
312
|
+
if @api_client.config.debugging
|
|
313
|
+
@api_client.config.logger.debug "API called: ContactsApi#get_contacts_by_group_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
314
|
+
end
|
|
315
|
+
return data, status_code, headers
|
|
316
|
+
end
|
|
317
|
+
|
|
318
|
+
# Update Contact
|
|
319
|
+
# 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 ```
|
|
320
|
+
# @param update_contact_by_id_parameters Request body
|
|
321
|
+
# @param contact_id ContactId
|
|
322
|
+
# @param [Hash] opts the optional parameters
|
|
323
|
+
# @return [Object]
|
|
324
|
+
def update_contact_by_id(update_contact_by_id_parameters, contact_id, opts = {})
|
|
325
|
+
data, _status_code, _headers = update_contact_by_id_with_http_info(update_contact_by_id_parameters, contact_id, opts)
|
|
326
|
+
return data
|
|
327
|
+
end
|
|
328
|
+
|
|
329
|
+
# Update Contact
|
|
330
|
+
# 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 ```
|
|
331
|
+
# @param update_contact_by_id_parameters Request body
|
|
332
|
+
# @param contact_id ContactId
|
|
333
|
+
# @param [Hash] opts the optional parameters
|
|
334
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
335
|
+
def update_contact_by_id_with_http_info(update_contact_by_id_parameters, contact_id, opts = {})
|
|
336
|
+
if @api_client.config.debugging
|
|
337
|
+
@api_client.config.logger.debug "Calling API: ContactsApi.update_contact_by_id ..."
|
|
338
|
+
end
|
|
339
|
+
# verify the required parameter 'update_contact_by_id_parameters' is set
|
|
340
|
+
fail ArgumentError, "Missing the required parameter 'update_contact_by_id_parameters' when calling ContactsApi.update_contact_by_id" if update_contact_by_id_parameters.nil?
|
|
341
|
+
# verify the required parameter 'contact_id' is set
|
|
342
|
+
fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.update_contact_by_id" if contact_id.nil?
|
|
343
|
+
# resource path
|
|
344
|
+
local_var_path = "/contact/{ContactId}".sub('{format}','json').sub('{' + 'ContactId' + '}', contact_id.to_s)
|
|
345
|
+
|
|
346
|
+
# query parameters
|
|
347
|
+
query_params = {}
|
|
348
|
+
|
|
349
|
+
# header parameters
|
|
350
|
+
header_params = {}
|
|
351
|
+
|
|
352
|
+
# HTTP header 'Accept' (if needed)
|
|
353
|
+
local_header_accept = ['application/json', 'application/xml']
|
|
354
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
355
|
+
|
|
356
|
+
# HTTP header 'Content-Type'
|
|
357
|
+
local_header_content_type = ['application/json', 'application/xml']
|
|
358
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
359
|
+
|
|
360
|
+
# form parameters
|
|
361
|
+
form_params = {}
|
|
362
|
+
|
|
363
|
+
# http body (model)
|
|
364
|
+
post_body = @api_client.object_to_http_body(update_contact_by_id_parameters)
|
|
365
|
+
auth_names = ['api_key']
|
|
366
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
367
|
+
:header_params => header_params,
|
|
368
|
+
:query_params => query_params,
|
|
369
|
+
:form_params => form_params,
|
|
370
|
+
:body => post_body,
|
|
371
|
+
:auth_names => auth_names,
|
|
372
|
+
:return_type => 'Object')
|
|
373
|
+
if @api_client.config.debugging
|
|
374
|
+
@api_client.config.logger.debug "API called: ContactsApi#update_contact_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
375
|
+
end
|
|
376
|
+
return data, status_code, headers
|
|
377
|
+
end
|
|
378
|
+
end
|
|
379
|
+
end
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#DialMyCalls API
|
|
3
|
+
|
|
4
|
+
#The DialMyCalls API
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 2.0.1
|
|
7
|
+
Contact: support@dialmycalls.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
|
|
10
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
11
|
+
you may not use this file except in compliance with the License.
|
|
12
|
+
You may obtain a copy of the License at
|
|
13
|
+
|
|
14
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
15
|
+
|
|
16
|
+
Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
See the License for the specific language governing permissions and
|
|
20
|
+
limitations under the License.
|
|
21
|
+
|
|
22
|
+
=end
|
|
23
|
+
|
|
24
|
+
require "uri"
|
|
25
|
+
|
|
26
|
+
module DialMyCalls
|
|
27
|
+
class DoNotContactsApi
|
|
28
|
+
attr_accessor :api_client
|
|
29
|
+
|
|
30
|
+
def initialize(api_client = ApiClient.default)
|
|
31
|
+
@api_client = api_client
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# List DoNotContacts
|
|
35
|
+
# 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 ```
|
|
36
|
+
# @param [Hash] opts the optional parameters
|
|
37
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of donotcontacts requested
|
|
38
|
+
# @return [Object]
|
|
39
|
+
def get_do_not_contacts(opts = {})
|
|
40
|
+
data, _status_code, _headers = get_do_not_contacts_with_http_info(opts)
|
|
41
|
+
return data
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# List DoNotContacts
|
|
45
|
+
# 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 ```
|
|
46
|
+
# @param [Hash] opts the optional parameters
|
|
47
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of donotcontacts requested
|
|
48
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
49
|
+
def get_do_not_contacts_with_http_info(opts = {})
|
|
50
|
+
if @api_client.config.debugging
|
|
51
|
+
@api_client.config.logger.debug "Calling API: DoNotContactsApi.get_do_not_contacts ..."
|
|
52
|
+
end
|
|
53
|
+
# resource path
|
|
54
|
+
local_var_path = "/donotcontacts".sub('{format}','json')
|
|
55
|
+
|
|
56
|
+
# query parameters
|
|
57
|
+
query_params = {}
|
|
58
|
+
|
|
59
|
+
# header parameters
|
|
60
|
+
header_params = {}
|
|
61
|
+
|
|
62
|
+
# HTTP header 'Accept' (if needed)
|
|
63
|
+
local_header_accept = ['application/json', 'application/xml']
|
|
64
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
65
|
+
|
|
66
|
+
# HTTP header 'Content-Type'
|
|
67
|
+
local_header_content_type = ['application/json', 'application/xml']
|
|
68
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
69
|
+
header_params[:'Range'] = opts[:'range'] if !opts[:'range'].nil?
|
|
70
|
+
|
|
71
|
+
# form parameters
|
|
72
|
+
form_params = {}
|
|
73
|
+
|
|
74
|
+
# http body (model)
|
|
75
|
+
post_body = nil
|
|
76
|
+
auth_names = ['api_key']
|
|
77
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
78
|
+
:header_params => header_params,
|
|
79
|
+
:query_params => query_params,
|
|
80
|
+
:form_params => form_params,
|
|
81
|
+
:body => post_body,
|
|
82
|
+
:auth_names => auth_names,
|
|
83
|
+
:return_type => 'Object')
|
|
84
|
+
if @api_client.config.debugging
|
|
85
|
+
@api_client.config.logger.debug "API called: DoNotContactsApi#get_do_not_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
86
|
+
end
|
|
87
|
+
return data, status_code, headers
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
end
|