dialmycalls_client 2.0.1
Sign up to get free protection for your applications and to get access to all the features.
- 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,547 @@
|
|
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 TextsApi
|
28
|
+
attr_accessor :api_client
|
29
|
+
|
30
|
+
def initialize(api_client = ApiClient.default)
|
31
|
+
@api_client = api_client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Cancel Text
|
35
|
+
# 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 ```
|
36
|
+
# @param text_id TextId
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Object]
|
39
|
+
def cancel_text_by_id(text_id, opts = {})
|
40
|
+
data, _status_code, _headers = cancel_text_by_id_with_http_info(text_id, opts)
|
41
|
+
return data
|
42
|
+
end
|
43
|
+
|
44
|
+
# Cancel Text
|
45
|
+
# 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 ```
|
46
|
+
# @param text_id TextId
|
47
|
+
# @param [Hash] opts the optional parameters
|
48
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
49
|
+
def cancel_text_by_id_with_http_info(text_id, opts = {})
|
50
|
+
if @api_client.config.debugging
|
51
|
+
@api_client.config.logger.debug "Calling API: TextsApi.cancel_text_by_id ..."
|
52
|
+
end
|
53
|
+
# verify the required parameter 'text_id' is set
|
54
|
+
fail ArgumentError, "Missing the required parameter 'text_id' when calling TextsApi.cancel_text_by_id" if text_id.nil?
|
55
|
+
# resource path
|
56
|
+
local_var_path = "/service/text/{TextId}".sub('{format}','json').sub('{' + 'TextId' + '}', text_id.to_s)
|
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 = nil
|
77
|
+
auth_names = ['api_key']
|
78
|
+
data, status_code, headers = @api_client.call_api(:DELETE, 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: TextsApi#cancel_text_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
87
|
+
end
|
88
|
+
return data, status_code, headers
|
89
|
+
end
|
90
|
+
|
91
|
+
# Create Text
|
92
|
+
# 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 ```
|
93
|
+
# @param create_text_parameters Request body
|
94
|
+
# @param [Hash] opts the optional parameters
|
95
|
+
# @return [Object]
|
96
|
+
def create_text(create_text_parameters, opts = {})
|
97
|
+
data, _status_code, _headers = create_text_with_http_info(create_text_parameters, opts)
|
98
|
+
return data
|
99
|
+
end
|
100
|
+
|
101
|
+
# Create Text
|
102
|
+
# 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 ```
|
103
|
+
# @param create_text_parameters Request body
|
104
|
+
# @param [Hash] opts the optional parameters
|
105
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
106
|
+
def create_text_with_http_info(create_text_parameters, opts = {})
|
107
|
+
if @api_client.config.debugging
|
108
|
+
@api_client.config.logger.debug "Calling API: TextsApi.create_text ..."
|
109
|
+
end
|
110
|
+
# verify the required parameter 'create_text_parameters' is set
|
111
|
+
fail ArgumentError, "Missing the required parameter 'create_text_parameters' when calling TextsApi.create_text" if create_text_parameters.nil?
|
112
|
+
# resource path
|
113
|
+
local_var_path = "/service/text".sub('{format}','json')
|
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 = @api_client.object_to_http_body(create_text_parameters)
|
134
|
+
auth_names = ['api_key']
|
135
|
+
data, status_code, headers = @api_client.call_api(:POST, 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: TextsApi#create_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
144
|
+
end
|
145
|
+
return data, status_code, headers
|
146
|
+
end
|
147
|
+
|
148
|
+
# Delete Incoming Text
|
149
|
+
# 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 ```
|
150
|
+
# @param text_id TextId
|
151
|
+
# @param [Hash] opts the optional parameters
|
152
|
+
# @return [Object]
|
153
|
+
def delete_incoming_text_by_id(text_id, opts = {})
|
154
|
+
data, _status_code, _headers = delete_incoming_text_by_id_with_http_info(text_id, opts)
|
155
|
+
return data
|
156
|
+
end
|
157
|
+
|
158
|
+
# Delete Incoming Text
|
159
|
+
# 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 ```
|
160
|
+
# @param text_id TextId
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
163
|
+
def delete_incoming_text_by_id_with_http_info(text_id, opts = {})
|
164
|
+
if @api_client.config.debugging
|
165
|
+
@api_client.config.logger.debug "Calling API: TextsApi.delete_incoming_text_by_id ..."
|
166
|
+
end
|
167
|
+
# verify the required parameter 'text_id' is set
|
168
|
+
fail ArgumentError, "Missing the required parameter 'text_id' when calling TextsApi.delete_incoming_text_by_id" if text_id.nil?
|
169
|
+
# resource path
|
170
|
+
local_var_path = "/incoming/text/{TextId}".sub('{format}','json').sub('{' + 'TextId' + '}', text_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(:DELETE, 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: TextsApi#delete_incoming_text_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
201
|
+
end
|
202
|
+
return data, status_code, headers
|
203
|
+
end
|
204
|
+
|
205
|
+
# Get Incoming Text
|
206
|
+
# 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 ```
|
207
|
+
# @param text_id TextId
|
208
|
+
# @param [Hash] opts the optional parameters
|
209
|
+
# @return [Object]
|
210
|
+
def get_incoming_text_by_id(text_id, opts = {})
|
211
|
+
data, _status_code, _headers = get_incoming_text_by_id_with_http_info(text_id, opts)
|
212
|
+
return data
|
213
|
+
end
|
214
|
+
|
215
|
+
# Get Incoming Text
|
216
|
+
# 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 ```
|
217
|
+
# @param text_id TextId
|
218
|
+
# @param [Hash] opts the optional parameters
|
219
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
220
|
+
def get_incoming_text_by_id_with_http_info(text_id, opts = {})
|
221
|
+
if @api_client.config.debugging
|
222
|
+
@api_client.config.logger.debug "Calling API: TextsApi.get_incoming_text_by_id ..."
|
223
|
+
end
|
224
|
+
# verify the required parameter 'text_id' is set
|
225
|
+
fail ArgumentError, "Missing the required parameter 'text_id' when calling TextsApi.get_incoming_text_by_id" if text_id.nil?
|
226
|
+
# resource path
|
227
|
+
local_var_path = "/incoming/text/{TextId}".sub('{format}','json').sub('{' + 'TextId' + '}', text_id.to_s)
|
228
|
+
|
229
|
+
# query parameters
|
230
|
+
query_params = {}
|
231
|
+
|
232
|
+
# header parameters
|
233
|
+
header_params = {}
|
234
|
+
|
235
|
+
# HTTP header 'Accept' (if needed)
|
236
|
+
local_header_accept = ['application/json', 'application/xml']
|
237
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
238
|
+
|
239
|
+
# HTTP header 'Content-Type'
|
240
|
+
local_header_content_type = ['application/json', 'application/xml']
|
241
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
242
|
+
|
243
|
+
# form parameters
|
244
|
+
form_params = {}
|
245
|
+
|
246
|
+
# http body (model)
|
247
|
+
post_body = nil
|
248
|
+
auth_names = ['api_key']
|
249
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
250
|
+
:header_params => header_params,
|
251
|
+
:query_params => query_params,
|
252
|
+
:form_params => form_params,
|
253
|
+
:body => post_body,
|
254
|
+
:auth_names => auth_names,
|
255
|
+
:return_type => 'Object')
|
256
|
+
if @api_client.config.debugging
|
257
|
+
@api_client.config.logger.debug "API called: TextsApi#get_incoming_text_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
258
|
+
end
|
259
|
+
return data, status_code, headers
|
260
|
+
end
|
261
|
+
|
262
|
+
# List Incoming Texts
|
263
|
+
# 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 ```
|
264
|
+
# @param [Hash] opts the optional parameters
|
265
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of texts requested
|
266
|
+
# @return [Object]
|
267
|
+
def get_incoming_texts(opts = {})
|
268
|
+
data, _status_code, _headers = get_incoming_texts_with_http_info(opts)
|
269
|
+
return data
|
270
|
+
end
|
271
|
+
|
272
|
+
# List Incoming Texts
|
273
|
+
# 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 ```
|
274
|
+
# @param [Hash] opts the optional parameters
|
275
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of texts requested
|
276
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
277
|
+
def get_incoming_texts_with_http_info(opts = {})
|
278
|
+
if @api_client.config.debugging
|
279
|
+
@api_client.config.logger.debug "Calling API: TextsApi.get_incoming_texts ..."
|
280
|
+
end
|
281
|
+
# resource path
|
282
|
+
local_var_path = "/incoming/texts".sub('{format}','json')
|
283
|
+
|
284
|
+
# query parameters
|
285
|
+
query_params = {}
|
286
|
+
|
287
|
+
# header parameters
|
288
|
+
header_params = {}
|
289
|
+
|
290
|
+
# HTTP header 'Accept' (if needed)
|
291
|
+
local_header_accept = ['application/json', 'application/xml']
|
292
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
293
|
+
|
294
|
+
# HTTP header 'Content-Type'
|
295
|
+
local_header_content_type = ['application/json', 'application/xml']
|
296
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
297
|
+
header_params[:'Range'] = opts[:'range'] if !opts[:'range'].nil?
|
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: TextsApi#get_incoming_texts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
314
|
+
end
|
315
|
+
return data, status_code, headers
|
316
|
+
end
|
317
|
+
|
318
|
+
# List Shortcodes
|
319
|
+
# 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 ```
|
320
|
+
# @param [Hash] opts the optional parameters
|
321
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of shortcodes requested
|
322
|
+
# @return [Object]
|
323
|
+
def get_short_codes(opts = {})
|
324
|
+
data, _status_code, _headers = get_short_codes_with_http_info(opts)
|
325
|
+
return data
|
326
|
+
end
|
327
|
+
|
328
|
+
# List Shortcodes
|
329
|
+
# 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 ```
|
330
|
+
# @param [Hash] opts the optional parameters
|
331
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of shortcodes requested
|
332
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
333
|
+
def get_short_codes_with_http_info(opts = {})
|
334
|
+
if @api_client.config.debugging
|
335
|
+
@api_client.config.logger.debug "Calling API: TextsApi.get_short_codes ..."
|
336
|
+
end
|
337
|
+
# resource path
|
338
|
+
local_var_path = "/shortcodes".sub('{format}','json')
|
339
|
+
|
340
|
+
# query parameters
|
341
|
+
query_params = {}
|
342
|
+
|
343
|
+
# header parameters
|
344
|
+
header_params = {}
|
345
|
+
|
346
|
+
# HTTP header 'Accept' (if needed)
|
347
|
+
local_header_accept = ['application/json', 'application/xml']
|
348
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
349
|
+
|
350
|
+
# HTTP header 'Content-Type'
|
351
|
+
local_header_content_type = ['application/json', 'application/xml']
|
352
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
353
|
+
header_params[:'Range'] = opts[:'range'] if !opts[:'range'].nil?
|
354
|
+
|
355
|
+
# form parameters
|
356
|
+
form_params = {}
|
357
|
+
|
358
|
+
# http body (model)
|
359
|
+
post_body = nil
|
360
|
+
auth_names = ['api_key']
|
361
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
362
|
+
:header_params => header_params,
|
363
|
+
:query_params => query_params,
|
364
|
+
:form_params => form_params,
|
365
|
+
:body => post_body,
|
366
|
+
:auth_names => auth_names,
|
367
|
+
:return_type => 'Object')
|
368
|
+
if @api_client.config.debugging
|
369
|
+
@api_client.config.logger.debug "API called: TextsApi#get_short_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
370
|
+
end
|
371
|
+
return data, status_code, headers
|
372
|
+
end
|
373
|
+
|
374
|
+
# Get Text
|
375
|
+
# 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 ```
|
376
|
+
# @param text_id TextId
|
377
|
+
# @param [Hash] opts the optional parameters
|
378
|
+
# @return [Object]
|
379
|
+
def get_text_by_id(text_id, opts = {})
|
380
|
+
data, _status_code, _headers = get_text_by_id_with_http_info(text_id, opts)
|
381
|
+
return data
|
382
|
+
end
|
383
|
+
|
384
|
+
# Get Text
|
385
|
+
# 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 ```
|
386
|
+
# @param text_id TextId
|
387
|
+
# @param [Hash] opts the optional parameters
|
388
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
389
|
+
def get_text_by_id_with_http_info(text_id, opts = {})
|
390
|
+
if @api_client.config.debugging
|
391
|
+
@api_client.config.logger.debug "Calling API: TextsApi.get_text_by_id ..."
|
392
|
+
end
|
393
|
+
# verify the required parameter 'text_id' is set
|
394
|
+
fail ArgumentError, "Missing the required parameter 'text_id' when calling TextsApi.get_text_by_id" if text_id.nil?
|
395
|
+
# resource path
|
396
|
+
local_var_path = "/service/text/{TextId}".sub('{format}','json').sub('{' + 'TextId' + '}', text_id.to_s)
|
397
|
+
|
398
|
+
# query parameters
|
399
|
+
query_params = {}
|
400
|
+
|
401
|
+
# header parameters
|
402
|
+
header_params = {}
|
403
|
+
|
404
|
+
# HTTP header 'Accept' (if needed)
|
405
|
+
local_header_accept = ['application/json', 'application/xml']
|
406
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
407
|
+
|
408
|
+
# HTTP header 'Content-Type'
|
409
|
+
local_header_content_type = ['application/json', 'application/xml']
|
410
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
411
|
+
|
412
|
+
# form parameters
|
413
|
+
form_params = {}
|
414
|
+
|
415
|
+
# http body (model)
|
416
|
+
post_body = nil
|
417
|
+
auth_names = ['api_key']
|
418
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
419
|
+
:header_params => header_params,
|
420
|
+
:query_params => query_params,
|
421
|
+
:form_params => form_params,
|
422
|
+
:body => post_body,
|
423
|
+
:auth_names => auth_names,
|
424
|
+
:return_type => 'Object')
|
425
|
+
if @api_client.config.debugging
|
426
|
+
@api_client.config.logger.debug "API called: TextsApi#get_text_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
427
|
+
end
|
428
|
+
return data, status_code, headers
|
429
|
+
end
|
430
|
+
|
431
|
+
# Get Text Recipients
|
432
|
+
# 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 ```
|
433
|
+
# @param text_id TextId
|
434
|
+
# @param [Hash] opts the optional parameters
|
435
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of recipients requested
|
436
|
+
# @return [Object]
|
437
|
+
def get_text_recipients_by_text_id(text_id, opts = {})
|
438
|
+
data, _status_code, _headers = get_text_recipients_by_text_id_with_http_info(text_id, opts)
|
439
|
+
return data
|
440
|
+
end
|
441
|
+
|
442
|
+
# Get Text Recipients
|
443
|
+
# 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 ```
|
444
|
+
# @param text_id TextId
|
445
|
+
# @param [Hash] opts the optional parameters
|
446
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of recipients requested
|
447
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
448
|
+
def get_text_recipients_by_text_id_with_http_info(text_id, opts = {})
|
449
|
+
if @api_client.config.debugging
|
450
|
+
@api_client.config.logger.debug "Calling API: TextsApi.get_text_recipients_by_text_id ..."
|
451
|
+
end
|
452
|
+
# verify the required parameter 'text_id' is set
|
453
|
+
fail ArgumentError, "Missing the required parameter 'text_id' when calling TextsApi.get_text_recipients_by_text_id" if text_id.nil?
|
454
|
+
# resource path
|
455
|
+
local_var_path = "/service/text/{TextId}/recipients".sub('{format}','json').sub('{' + 'TextId' + '}', text_id.to_s)
|
456
|
+
|
457
|
+
# query parameters
|
458
|
+
query_params = {}
|
459
|
+
|
460
|
+
# header parameters
|
461
|
+
header_params = {}
|
462
|
+
|
463
|
+
# HTTP header 'Accept' (if needed)
|
464
|
+
local_header_accept = ['application/json', 'application/xml']
|
465
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
466
|
+
|
467
|
+
# HTTP header 'Content-Type'
|
468
|
+
local_header_content_type = ['application/json', 'application/xml']
|
469
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
470
|
+
header_params[:'Range'] = opts[:'range'] if !opts[:'range'].nil?
|
471
|
+
|
472
|
+
# form parameters
|
473
|
+
form_params = {}
|
474
|
+
|
475
|
+
# http body (model)
|
476
|
+
post_body = nil
|
477
|
+
auth_names = ['api_key']
|
478
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
479
|
+
:header_params => header_params,
|
480
|
+
:query_params => query_params,
|
481
|
+
:form_params => form_params,
|
482
|
+
:body => post_body,
|
483
|
+
:auth_names => auth_names,
|
484
|
+
:return_type => 'Object')
|
485
|
+
if @api_client.config.debugging
|
486
|
+
@api_client.config.logger.debug "API called: TextsApi#get_text_recipients_by_text_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
487
|
+
end
|
488
|
+
return data, status_code, headers
|
489
|
+
end
|
490
|
+
|
491
|
+
# List Texts
|
492
|
+
# 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 ```
|
493
|
+
# @param [Hash] opts the optional parameters
|
494
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of texts requested
|
495
|
+
# @return [Object]
|
496
|
+
def get_texts(opts = {})
|
497
|
+
data, _status_code, _headers = get_texts_with_http_info(opts)
|
498
|
+
return data
|
499
|
+
end
|
500
|
+
|
501
|
+
# List Texts
|
502
|
+
# 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 ```
|
503
|
+
# @param [Hash] opts the optional parameters
|
504
|
+
# @option opts [String] :range Range (ie \"records=201-300\") of texts requested
|
505
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
506
|
+
def get_texts_with_http_info(opts = {})
|
507
|
+
if @api_client.config.debugging
|
508
|
+
@api_client.config.logger.debug "Calling API: TextsApi.get_texts ..."
|
509
|
+
end
|
510
|
+
# resource path
|
511
|
+
local_var_path = "/service/texts".sub('{format}','json')
|
512
|
+
|
513
|
+
# query parameters
|
514
|
+
query_params = {}
|
515
|
+
|
516
|
+
# header parameters
|
517
|
+
header_params = {}
|
518
|
+
|
519
|
+
# HTTP header 'Accept' (if needed)
|
520
|
+
local_header_accept = ['application/json', 'application/xml']
|
521
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
522
|
+
|
523
|
+
# HTTP header 'Content-Type'
|
524
|
+
local_header_content_type = ['application/json', 'application/xml']
|
525
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
526
|
+
header_params[:'Range'] = opts[:'range'] if !opts[:'range'].nil?
|
527
|
+
|
528
|
+
# form parameters
|
529
|
+
form_params = {}
|
530
|
+
|
531
|
+
# http body (model)
|
532
|
+
post_body = nil
|
533
|
+
auth_names = ['api_key']
|
534
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
535
|
+
:header_params => header_params,
|
536
|
+
:query_params => query_params,
|
537
|
+
:form_params => form_params,
|
538
|
+
:body => post_body,
|
539
|
+
:auth_names => auth_names,
|
540
|
+
:return_type => 'Object')
|
541
|
+
if @api_client.config.debugging
|
542
|
+
@api_client.config.logger.debug "API called: TextsApi#get_texts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
543
|
+
end
|
544
|
+
return data, status_code, headers
|
545
|
+
end
|
546
|
+
end
|
547
|
+
end
|