clicksend_client 1.0.2

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.
Files changed (261) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +78 -0
  4. data/Rakefile +8 -0
  5. data/clicksend_client-1.0.1.gem +0 -0
  6. data/clicksend_client.gemspec +45 -0
  7. data/docs/Account.md +15 -0
  8. data/docs/AccountApi.md +433 -0
  9. data/docs/AccountForgotPasswordVerify.md +10 -0
  10. data/docs/AccountRechargeApi.md +330 -0
  11. data/docs/AccountVerify.md +10 -0
  12. data/docs/Address.md +14 -0
  13. data/docs/Attachment.md +12 -0
  14. data/docs/Contact.md +23 -0
  15. data/docs/ContactApi.md +416 -0
  16. data/docs/ContactList.md +8 -0
  17. data/docs/ContactListApi.md +398 -0
  18. data/docs/ContactListImport.md +9 -0
  19. data/docs/CountriesApi.md +50 -0
  20. data/docs/CreditCard.md +13 -0
  21. data/docs/DateBefore.md +8 -0
  22. data/docs/DeliveryIssue.md +12 -0
  23. data/docs/DeliveryIssuesApi.md +119 -0
  24. data/docs/DeliveryReceiptRule.md +12 -0
  25. data/docs/DetectAddressApi.md +62 -0
  26. data/docs/Email.md +15 -0
  27. data/docs/EmailAddress.md +8 -0
  28. data/docs/EmailCampaign.md +15 -0
  29. data/docs/EmailDeliveryReceiptRulesApi.md +286 -0
  30. data/docs/EmailFrom.md +9 -0
  31. data/docs/EmailMarketingApi.md +793 -0
  32. data/docs/EmailRecipient.md +9 -0
  33. data/docs/EmailSMSAddress.md +10 -0
  34. data/docs/EmailTemplateNew.md +9 -0
  35. data/docs/EmailTemplateUpdate.md +9 -0
  36. data/docs/EmailToSmsApi.md +395 -0
  37. data/docs/FAXApi.md +401 -0
  38. data/docs/FAXDeliveryReceiptRulesApi.md +286 -0
  39. data/docs/FaxMessage.md +15 -0
  40. data/docs/FaxMessageCollection.md +9 -0
  41. data/docs/Fields.md +8 -0
  42. data/docs/FieldsFields.md +23 -0
  43. data/docs/ForgotPassword.md +8 -0
  44. data/docs/ForgotUsername.md +9 -0
  45. data/docs/InboundFAXRulesApi.md +286 -0
  46. data/docs/InboundFaxRule.md +12 -0
  47. data/docs/InboundSMSRule.md +14 -0
  48. data/docs/InboundSMSRulesApi.md +286 -0
  49. data/docs/MMSApi.md +228 -0
  50. data/docs/MasterEmailTemplatesApi.md +290 -0
  51. data/docs/MmsCampaign.md +14 -0
  52. data/docs/MmsCampaignApi.md +338 -0
  53. data/docs/MmsMessage.md +17 -0
  54. data/docs/MmsMessageCollection.md +9 -0
  55. data/docs/NumberApi.md +183 -0
  56. data/docs/PostLetter.md +14 -0
  57. data/docs/PostLetterApi.md +227 -0
  58. data/docs/PostPostcard.md +9 -0
  59. data/docs/PostPostcardApi.md +227 -0
  60. data/docs/PostRecipient.md +16 -0
  61. data/docs/PostReturnAddressApi.md +284 -0
  62. data/docs/ReferralAccountApi.md +65 -0
  63. data/docs/ResellerAccount.md +15 -0
  64. data/docs/ResellerAccountApi.md +230 -0
  65. data/docs/ResellerAccountTransferCredit.md +10 -0
  66. data/docs/SMSApi.md +999 -0
  67. data/docs/SMSDeliveryReceiptRulesApi.md +286 -0
  68. data/docs/SearchApi.md +68 -0
  69. data/docs/SmsCampaign.md +12 -0
  70. data/docs/SmsCampaignApi.md +338 -0
  71. data/docs/SmsMessage.md +16 -0
  72. data/docs/SmsMessageCollection.md +8 -0
  73. data/docs/SmsTemplate.md +9 -0
  74. data/docs/StatisticsApi.md +104 -0
  75. data/docs/StrippedString.md +8 -0
  76. data/docs/Subaccount.md +18 -0
  77. data/docs/SubaccountApi.md +338 -0
  78. data/docs/TimezonesApi.md +65 -0
  79. data/docs/TransactionalEmailApi.md +237 -0
  80. data/docs/TransferCreditApi.md +62 -0
  81. data/docs/UploadApi.md +65 -0
  82. data/docs/UploadFile.md +8 -0
  83. data/docs/Url.md +8 -0
  84. data/docs/UserEmailTemplatesApi.md +284 -0
  85. data/docs/VoiceApi.md +547 -0
  86. data/docs/VoiceDeliveryReceiptRulesApi.md +286 -0
  87. data/docs/VoiceMessage.md +18 -0
  88. data/docs/VoiceMessageCollection.md +8 -0
  89. data/lib/clicksend_client.rb +121 -0
  90. data/lib/clicksend_client/api/account_api.rb +447 -0
  91. data/lib/clicksend_client/api/account_recharge_api.rb +346 -0
  92. data/lib/clicksend_client/api/contact_api.rb +463 -0
  93. data/lib/clicksend_client/api/contact_list_api.rb +427 -0
  94. data/lib/clicksend_client/api/countries_api.rb +71 -0
  95. data/lib/clicksend_client/api/delivery_issues_api.rb +139 -0
  96. data/lib/clicksend_client/api/detect_address_api.rb +77 -0
  97. data/lib/clicksend_client/api/email_delivery_receipt_rules_api.rb +310 -0
  98. data/lib/clicksend_client/api/email_marketing_api.rb +829 -0
  99. data/lib/clicksend_client/api/email_to_sms_api.rb +423 -0
  100. data/lib/clicksend_client/api/fax_api.rb +425 -0
  101. data/lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb +310 -0
  102. data/lib/clicksend_client/api/inbound_fax_rules_api.rb +310 -0
  103. data/lib/clicksend_client/api/inbound_sms_rules_api.rb +310 -0
  104. data/lib/clicksend_client/api/master_email_templates_api.rb +323 -0
  105. data/lib/clicksend_client/api/mms_api.rb +243 -0
  106. data/lib/clicksend_client/api/mms_campaign_api.rb +361 -0
  107. data/lib/clicksend_client/api/number_api.rb +213 -0
  108. data/lib/clicksend_client/api/post_letter_api.rb +248 -0
  109. data/lib/clicksend_client/api/post_postcard_api.rb +248 -0
  110. data/lib/clicksend_client/api/post_return_address_api.rb +307 -0
  111. data/lib/clicksend_client/api/referral_account_api.rb +85 -0
  112. data/lib/clicksend_client/api/reseller_account_api.rb +253 -0
  113. data/lib/clicksend_client/api/search_api.rb +92 -0
  114. data/lib/clicksend_client/api/sms_api.rb +1032 -0
  115. data/lib/clicksend_client/api/sms_campaign_api.rb +361 -0
  116. data/lib/clicksend_client/api/sms_delivery_receipt_rules_api.rb +310 -0
  117. data/lib/clicksend_client/api/statistics_api.rb +119 -0
  118. data/lib/clicksend_client/api/subaccount_api.rb +361 -0
  119. data/lib/clicksend_client/api/timezones_api.rb +85 -0
  120. data/lib/clicksend_client/api/transactional_email_api.rb +260 -0
  121. data/lib/clicksend_client/api/transfer_credit_api.rb +77 -0
  122. data/lib/clicksend_client/api/upload_api.rb +84 -0
  123. data/lib/clicksend_client/api/user_email_templates_api.rb +307 -0
  124. data/lib/clicksend_client/api/voice_api.rb +570 -0
  125. data/lib/clicksend_client/api/voice_delivery_receipt_rules_api.rb +310 -0
  126. data/lib/clicksend_client/api_client.rb +389 -0
  127. data/lib/clicksend_client/api_error.rb +38 -0
  128. data/lib/clicksend_client/configuration.rb +209 -0
  129. data/lib/clicksend_client/models/account.rb +295 -0
  130. data/lib/clicksend_client/models/account_forgot_password_verify.rb +219 -0
  131. data/lib/clicksend_client/models/account_verify.rb +220 -0
  132. data/lib/clicksend_client/models/address.rb +270 -0
  133. data/lib/clicksend_client/models/attachment.rb +250 -0
  134. data/lib/clicksend_client/models/contact.rb +345 -0
  135. data/lib/clicksend_client/models/contact_list.rb +190 -0
  136. data/lib/clicksend_client/models/contact_list_import.rb +207 -0
  137. data/lib/clicksend_client/models/credit_card.rb +265 -0
  138. data/lib/clicksend_client/models/date_before.rb +185 -0
  139. data/lib/clicksend_client/models/delivery_issue.rb +240 -0
  140. data/lib/clicksend_client/models/delivery_receipt_rule.rb +250 -0
  141. data/lib/clicksend_client/models/email.rb +277 -0
  142. data/lib/clicksend_client/models/email_address.rb +189 -0
  143. data/lib/clicksend_client/models/email_campaign.rb +287 -0
  144. data/lib/clicksend_client/models/email_from.rb +200 -0
  145. data/lib/clicksend_client/models/email_recipient.rb +200 -0
  146. data/lib/clicksend_client/models/email_sms_address.rb +215 -0
  147. data/lib/clicksend_client/models/email_template_new.rb +205 -0
  148. data/lib/clicksend_client/models/email_template_update.rb +200 -0
  149. data/lib/clicksend_client/models/fax_message.rb +262 -0
  150. data/lib/clicksend_client/models/fax_message_collection.rb +207 -0
  151. data/lib/clicksend_client/models/fields.rb +184 -0
  152. data/lib/clicksend_client/models/fields_fields.rb +335 -0
  153. data/lib/clicksend_client/models/forgot_password.rb +189 -0
  154. data/lib/clicksend_client/models/forgot_username.rb +194 -0
  155. data/lib/clicksend_client/models/inbound_fax_rule.rb +250 -0
  156. data/lib/clicksend_client/models/inbound_sms_rule.rb +280 -0
  157. data/lib/clicksend_client/models/mms_campaign.rb +272 -0
  158. data/lib/clicksend_client/models/mms_message.rb +294 -0
  159. data/lib/clicksend_client/models/mms_message_collection.rb +207 -0
  160. data/lib/clicksend_client/models/post_letter.rb +267 -0
  161. data/lib/clicksend_client/models/post_postcard.rb +209 -0
  162. data/lib/clicksend_client/models/post_recipient.rb +302 -0
  163. data/lib/clicksend_client/models/reseller_account.rb +295 -0
  164. data/lib/clicksend_client/models/reseller_account_transfer_credit.rb +220 -0
  165. data/lib/clicksend_client/models/sms_campaign.rb +242 -0
  166. data/lib/clicksend_client/models/sms_message.rb +279 -0
  167. data/lib/clicksend_client/models/sms_message_collection.rb +192 -0
  168. data/lib/clicksend_client/models/sms_template.rb +205 -0
  169. data/lib/clicksend_client/models/stripped_string.rb +190 -0
  170. data/lib/clicksend_client/models/subaccount.rb +325 -0
  171. data/lib/clicksend_client/models/upload_file.rb +190 -0
  172. data/lib/clicksend_client/models/url.rb +190 -0
  173. data/lib/clicksend_client/models/voice_message.rb +316 -0
  174. data/lib/clicksend_client/models/voice_message_collection.rb +192 -0
  175. data/lib/clicksend_client/version.rb +15 -0
  176. data/spec/api/account_api_spec.rb +131 -0
  177. data/spec/api/account_recharge_api_spec.rb +107 -0
  178. data/spec/api/contact_api_spec.rb +129 -0
  179. data/spec/api/contact_list_api_spec.rb +123 -0
  180. data/spec/api/countries_api_spec.rb +46 -0
  181. data/spec/api/delivery_issues_api_spec.rb +60 -0
  182. data/spec/api/detect_address_api_spec.rb +47 -0
  183. data/spec/api/email_delivery_receipt_rules_api_spec.rb +98 -0
  184. data/spec/api/email_marketing_api_spec.rb +213 -0
  185. data/spec/api/email_to_sms_api_spec.rb +122 -0
  186. data/spec/api/fax_api_spec.rb +125 -0
  187. data/spec/api/fax_delivery_receipt_rules_api_spec.rb +98 -0
  188. data/spec/api/inbound_fax_rules_api_spec.rb +98 -0
  189. data/spec/api/inbound_sms_rules_api_spec.rb +98 -0
  190. data/spec/api/master_email_templates_api_spec.rb +99 -0
  191. data/spec/api/mms_api_spec.rb +84 -0
  192. data/spec/api/mms_campaign_api_spec.rb +109 -0
  193. data/spec/api/number_api_spec.rb +76 -0
  194. data/spec/api/post_letter_api_spec.rb +84 -0
  195. data/spec/api/post_postcard_api_spec.rb +84 -0
  196. data/spec/api/post_return_address_api_spec.rb +97 -0
  197. data/spec/api/referral_account_api_spec.rb +48 -0
  198. data/spec/api/reseller_account_api_spec.rb +85 -0
  199. data/spec/api/search_api_spec.rb +49 -0
  200. data/spec/api/sms_api_spec.rb +259 -0
  201. data/spec/api/sms_campaign_api_spec.rb +109 -0
  202. data/spec/api/sms_delivery_receipt_rules_api_spec.rb +98 -0
  203. data/spec/api/statistics_api_spec.rb +57 -0
  204. data/spec/api/subaccount_api_spec.rb +109 -0
  205. data/spec/api/timezones_api_spec.rb +48 -0
  206. data/spec/api/transactional_email_api_spec.rb +88 -0
  207. data/spec/api/transfer_credit_api_spec.rb +47 -0
  208. data/spec/api/upload_api_spec.rb +48 -0
  209. data/spec/api/user_email_templates_api_spec.rb +97 -0
  210. data/spec/api/voice_api_spec.rb +157 -0
  211. data/spec/api/voice_delivery_receipt_rules_api_spec.rb +98 -0
  212. data/spec/api_client_spec.rb +226 -0
  213. data/spec/configuration_spec.rb +42 -0
  214. data/spec/models/account_forgot_password_verify_spec.rb +53 -0
  215. data/spec/models/account_spec.rb +83 -0
  216. data/spec/models/account_verify_spec.rb +53 -0
  217. data/spec/models/address_spec.rb +77 -0
  218. data/spec/models/attachment_spec.rb +65 -0
  219. data/spec/models/contact_list_import_spec.rb +47 -0
  220. data/spec/models/contact_list_spec.rb +41 -0
  221. data/spec/models/contact_spec.rb +131 -0
  222. data/spec/models/credit_card_spec.rb +71 -0
  223. data/spec/models/date_before_spec.rb +41 -0
  224. data/spec/models/delivery_issue_spec.rb +65 -0
  225. data/spec/models/delivery_receipt_rule_spec.rb +65 -0
  226. data/spec/models/email_address_spec.rb +41 -0
  227. data/spec/models/email_campaign_spec.rb +83 -0
  228. data/spec/models/email_from_spec.rb +47 -0
  229. data/spec/models/email_recipient_spec.rb +47 -0
  230. data/spec/models/email_sms_address_spec.rb +53 -0
  231. data/spec/models/email_spec.rb +83 -0
  232. data/spec/models/email_template_new_spec.rb +47 -0
  233. data/spec/models/email_template_update_spec.rb +47 -0
  234. data/spec/models/fax_message_collection_spec.rb +47 -0
  235. data/spec/models/fax_message_spec.rb +83 -0
  236. data/spec/models/fields_fields_spec.rb +131 -0
  237. data/spec/models/fields_spec.rb +41 -0
  238. data/spec/models/forgot_password_spec.rb +41 -0
  239. data/spec/models/forgot_username_spec.rb +47 -0
  240. data/spec/models/inbound_fax_rule_spec.rb +65 -0
  241. data/spec/models/inbound_sms_rule_spec.rb +77 -0
  242. data/spec/models/mms_campaign_spec.rb +77 -0
  243. data/spec/models/mms_message_collection_spec.rb +47 -0
  244. data/spec/models/mms_message_spec.rb +95 -0
  245. data/spec/models/post_letter_spec.rb +77 -0
  246. data/spec/models/post_postcard_spec.rb +47 -0
  247. data/spec/models/post_recipient_spec.rb +89 -0
  248. data/spec/models/reseller_account_spec.rb +83 -0
  249. data/spec/models/reseller_account_transfer_credit_spec.rb +53 -0
  250. data/spec/models/sms_campaign_spec.rb +65 -0
  251. data/spec/models/sms_message_collection_spec.rb +41 -0
  252. data/spec/models/sms_message_spec.rb +89 -0
  253. data/spec/models/sms_template_spec.rb +47 -0
  254. data/spec/models/stripped_string_spec.rb +41 -0
  255. data/spec/models/subaccount_spec.rb +101 -0
  256. data/spec/models/upload_file_spec.rb +41 -0
  257. data/spec/models/url_spec.rb +41 -0
  258. data/spec/models/voice_message_collection_spec.rb +41 -0
  259. data/spec/models/voice_message_spec.rb +101 -0
  260. data/spec/spec_helper.rb +111 -0
  261. metadata +568 -0
@@ -0,0 +1,286 @@
1
+ # ClickSendClient::VoiceDeliveryReceiptRulesApi
2
+
3
+ All URIs are relative to *https://rest.clicksend.com/v3*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**voice_delivery_receipt_automation_delete**](VoiceDeliveryReceiptRulesApi.md#voice_delivery_receipt_automation_delete) | **DELETE** /automations/voice/receipts/{receipt_rule_id} | Delete voice delivery receipt automation
8
+ [**voice_delivery_receipt_automation_get**](VoiceDeliveryReceiptRulesApi.md#voice_delivery_receipt_automation_get) | **GET** /automations/voice/receipts/{receipt_rule_id} | Get specific voice delivery receipt automation
9
+ [**voice_delivery_receipt_automation_post**](VoiceDeliveryReceiptRulesApi.md#voice_delivery_receipt_automation_post) | **POST** /automations/voice/receipts | Create voice delivery receipt automations
10
+ [**voice_delivery_receipt_automation_put**](VoiceDeliveryReceiptRulesApi.md#voice_delivery_receipt_automation_put) | **PUT** /automations/voice/receipts/{receipt_rule_id} | Update voice delivery receipt automation
11
+ [**voice_delivery_receipt_automations_get**](VoiceDeliveryReceiptRulesApi.md#voice_delivery_receipt_automations_get) | **GET** /automations/voice/receipts | Get all voice delivery receipt automations
12
+
13
+
14
+ # **voice_delivery_receipt_automation_delete**
15
+ > String voice_delivery_receipt_automation_delete(receipt_rule_id)
16
+
17
+ Delete voice delivery receipt automation
18
+
19
+ Delete voice delivery receipt automation
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'clicksend_client'
25
+ # setup authorization
26
+ ClickSendClient.configure do |config|
27
+ # Configure HTTP basic authorization: BasicAuth
28
+ config.username = 'YOUR USERNAME'
29
+ config.password = 'YOUR PASSWORD'
30
+ end
31
+
32
+ api_instance = ClickSendClient::VoiceDeliveryReceiptRulesApi.new
33
+
34
+ receipt_rule_id = 56 # Integer | Receipt rule id
35
+
36
+
37
+ begin
38
+ #Delete voice delivery receipt automation
39
+ result = api_instance.voice_delivery_receipt_automation_delete(receipt_rule_id)
40
+ p result
41
+ rescue ClickSendClient::ApiError => e
42
+ puts "Exception when calling VoiceDeliveryReceiptRulesApi->voice_delivery_receipt_automation_delete: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+ Name | Type | Description | Notes
49
+ ------------- | ------------- | ------------- | -------------
50
+ **receipt_rule_id** | **Integer**| Receipt rule id |
51
+
52
+ ### Return type
53
+
54
+ **String**
55
+
56
+ ### Authorization
57
+
58
+ [BasicAuth](../README.md#BasicAuth)
59
+
60
+ ### HTTP request headers
61
+
62
+ - **Content-Type**: application/json
63
+ - **Accept**: application/json
64
+
65
+
66
+
67
+ # **voice_delivery_receipt_automation_get**
68
+ > String voice_delivery_receipt_automation_get(receipt_rule_id)
69
+
70
+ Get specific voice delivery receipt automation
71
+
72
+ Get specific voice delivery receipt automation
73
+
74
+ ### Example
75
+ ```ruby
76
+ # load the gem
77
+ require 'clicksend_client'
78
+ # setup authorization
79
+ ClickSendClient.configure do |config|
80
+ # Configure HTTP basic authorization: BasicAuth
81
+ config.username = 'YOUR USERNAME'
82
+ config.password = 'YOUR PASSWORD'
83
+ end
84
+
85
+ api_instance = ClickSendClient::VoiceDeliveryReceiptRulesApi.new
86
+
87
+ receipt_rule_id = 56 # Integer | Receipt rule id
88
+
89
+
90
+ begin
91
+ #Get specific voice delivery receipt automation
92
+ result = api_instance.voice_delivery_receipt_automation_get(receipt_rule_id)
93
+ p result
94
+ rescue ClickSendClient::ApiError => e
95
+ puts "Exception when calling VoiceDeliveryReceiptRulesApi->voice_delivery_receipt_automation_get: #{e}"
96
+ end
97
+ ```
98
+
99
+ ### Parameters
100
+
101
+ Name | Type | Description | Notes
102
+ ------------- | ------------- | ------------- | -------------
103
+ **receipt_rule_id** | **Integer**| Receipt rule id |
104
+
105
+ ### Return type
106
+
107
+ **String**
108
+
109
+ ### Authorization
110
+
111
+ [BasicAuth](../README.md#BasicAuth)
112
+
113
+ ### HTTP request headers
114
+
115
+ - **Content-Type**: application/json
116
+ - **Accept**: application/json
117
+
118
+
119
+
120
+ # **voice_delivery_receipt_automation_post**
121
+ > String voice_delivery_receipt_automation_post(delivery_receipt_rule)
122
+
123
+ Create voice delivery receipt automations
124
+
125
+ Create voice delivery receipt automations
126
+
127
+ ### Example
128
+ ```ruby
129
+ # load the gem
130
+ require 'clicksend_client'
131
+ # setup authorization
132
+ ClickSendClient.configure do |config|
133
+ # Configure HTTP basic authorization: BasicAuth
134
+ config.username = 'YOUR USERNAME'
135
+ config.password = 'YOUR PASSWORD'
136
+ end
137
+
138
+ api_instance = ClickSendClient::VoiceDeliveryReceiptRulesApi.new
139
+
140
+ delivery_receipt_rule = ClickSendClient::DeliveryReceiptRule.new # DeliveryReceiptRule | voice delivery receipt rule model
141
+
142
+
143
+ begin
144
+ #Create voice delivery receipt automations
145
+ result = api_instance.voice_delivery_receipt_automation_post(delivery_receipt_rule)
146
+ p result
147
+ rescue ClickSendClient::ApiError => e
148
+ puts "Exception when calling VoiceDeliveryReceiptRulesApi->voice_delivery_receipt_automation_post: #{e}"
149
+ end
150
+ ```
151
+
152
+ ### Parameters
153
+
154
+ Name | Type | Description | Notes
155
+ ------------- | ------------- | ------------- | -------------
156
+ **delivery_receipt_rule** | [**DeliveryReceiptRule**](DeliveryReceiptRule.md)| voice delivery receipt rule model |
157
+
158
+ ### Return type
159
+
160
+ **String**
161
+
162
+ ### Authorization
163
+
164
+ [BasicAuth](../README.md#BasicAuth)
165
+
166
+ ### HTTP request headers
167
+
168
+ - **Content-Type**: application/json
169
+ - **Accept**: application/json
170
+
171
+
172
+
173
+ # **voice_delivery_receipt_automation_put**
174
+ > String voice_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule)
175
+
176
+ Update voice delivery receipt automation
177
+
178
+ Update voice delivery receipt automation
179
+
180
+ ### Example
181
+ ```ruby
182
+ # load the gem
183
+ require 'clicksend_client'
184
+ # setup authorization
185
+ ClickSendClient.configure do |config|
186
+ # Configure HTTP basic authorization: BasicAuth
187
+ config.username = 'YOUR USERNAME'
188
+ config.password = 'YOUR PASSWORD'
189
+ end
190
+
191
+ api_instance = ClickSendClient::VoiceDeliveryReceiptRulesApi.new
192
+
193
+ receipt_rule_id = 56 # Integer | Receipt rule id
194
+
195
+ delivery_receipt_rule = ClickSendClient::DeliveryReceiptRule.new # DeliveryReceiptRule | Delivery receipt rule model
196
+
197
+
198
+ begin
199
+ #Update voice delivery receipt automation
200
+ result = api_instance.voice_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule)
201
+ p result
202
+ rescue ClickSendClient::ApiError => e
203
+ puts "Exception when calling VoiceDeliveryReceiptRulesApi->voice_delivery_receipt_automation_put: #{e}"
204
+ end
205
+ ```
206
+
207
+ ### Parameters
208
+
209
+ Name | Type | Description | Notes
210
+ ------------- | ------------- | ------------- | -------------
211
+ **receipt_rule_id** | **Integer**| Receipt rule id |
212
+ **delivery_receipt_rule** | [**DeliveryReceiptRule**](DeliveryReceiptRule.md)| Delivery receipt rule model |
213
+
214
+ ### Return type
215
+
216
+ **String**
217
+
218
+ ### Authorization
219
+
220
+ [BasicAuth](../README.md#BasicAuth)
221
+
222
+ ### HTTP request headers
223
+
224
+ - **Content-Type**: application/json
225
+ - **Accept**: application/json
226
+
227
+
228
+
229
+ # **voice_delivery_receipt_automations_get**
230
+ > String voice_delivery_receipt_automations_get(opts)
231
+
232
+ Get all voice delivery receipt automations
233
+
234
+ Get all voice delivery receipt automations
235
+
236
+ ### Example
237
+ ```ruby
238
+ # load the gem
239
+ require 'clicksend_client'
240
+ # setup authorization
241
+ ClickSendClient.configure do |config|
242
+ # Configure HTTP basic authorization: BasicAuth
243
+ config.username = 'YOUR USERNAME'
244
+ config.password = 'YOUR PASSWORD'
245
+ end
246
+
247
+ api_instance = ClickSendClient::VoiceDeliveryReceiptRulesApi.new
248
+
249
+ opts = {
250
+ q: 'q_example', # String | Your keyword or query.
251
+ page: 1, # Integer | Page number
252
+ limit: 10 # Integer | Number of records per page
253
+ }
254
+
255
+ begin
256
+ #Get all voice delivery receipt automations
257
+ result = api_instance.voice_delivery_receipt_automations_get(opts)
258
+ p result
259
+ rescue ClickSendClient::ApiError => e
260
+ puts "Exception when calling VoiceDeliveryReceiptRulesApi->voice_delivery_receipt_automations_get: #{e}"
261
+ end
262
+ ```
263
+
264
+ ### Parameters
265
+
266
+ Name | Type | Description | Notes
267
+ ------------- | ------------- | ------------- | -------------
268
+ **q** | **String**| Your keyword or query. | [optional]
269
+ **page** | **Integer**| Page number | [optional] [default to 1]
270
+ **limit** | **Integer**| Number of records per page | [optional] [default to 10]
271
+
272
+ ### Return type
273
+
274
+ **String**
275
+
276
+ ### Authorization
277
+
278
+ [BasicAuth](../README.md#BasicAuth)
279
+
280
+ ### HTTP request headers
281
+
282
+ - **Content-Type**: application/json
283
+ - **Accept**: application/json
284
+
285
+
286
+
@@ -0,0 +1,18 @@
1
+ # ClickSendClient::VoiceMessage
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **to** | **String** | Your phone number in E.164 format. |
7
+ **body** | **String** | Biscuit uv3nlCOjRk croissant chocolate lollipop chocolate muffin. |
8
+ **voice** | **String** | Either 'female' or 'male'. |
9
+ **custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. |
10
+ **country** | **String** | The country of the recipient. |
11
+ **source** | **String** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk']
12
+ **list_id** | **Integer** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional]
13
+ **lang** | **String** | au (string, required) - See section on available languages. | [optional]
14
+ **schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp | [optional]
15
+ **require_input** | **Integer** | Whether you want to receive a keypress from the call recipient | [optional] [default to 0]
16
+ **machine_detection** | **Integer** | Whether to attempt to detect an answering machine or voicemail service and leave a message | [optional] [default to 0]
17
+
18
+
@@ -0,0 +1,8 @@
1
+ # ClickSendClient::VoiceMessageCollection
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **messages** | [**Array<VoiceMessage>**](VoiceMessage.md) | Array of VoiceMessage items |
7
+
8
+
@@ -0,0 +1,121 @@
1
+ =begin
2
+ #ClickSend v3 API
3
+
4
+ # This is an official SDK for [ClickSend](https://clicksend.com) Below you will find a current list of the available methods for clicksend. *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..*
5
+
6
+ OpenAPI spec version: 3.1
7
+ Contact: support@clicksend.com
8
+ Generated by: https://github.com/clicksend-api/clicksend-codegen.git
9
+ ClickSend Codegen version: 2.4.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ # Common files
14
+ require 'clicksend_client/api_client'
15
+ require 'clicksend_client/api_error'
16
+ require 'clicksend_client/version'
17
+ require 'clicksend_client/configuration'
18
+
19
+ # Models
20
+ require 'clicksend_client/models/account'
21
+ require 'clicksend_client/models/account_forgot_password_verify'
22
+ require 'clicksend_client/models/account_verify'
23
+ require 'clicksend_client/models/address'
24
+ require 'clicksend_client/models/attachment'
25
+ require 'clicksend_client/models/contact'
26
+ require 'clicksend_client/models/contact_list'
27
+ require 'clicksend_client/models/contact_list_import'
28
+ require 'clicksend_client/models/credit_card'
29
+ require 'clicksend_client/models/date_before'
30
+ require 'clicksend_client/models/delivery_issue'
31
+ require 'clicksend_client/models/delivery_receipt_rule'
32
+ require 'clicksend_client/models/email'
33
+ require 'clicksend_client/models/email_address'
34
+ require 'clicksend_client/models/email_campaign'
35
+ require 'clicksend_client/models/email_from'
36
+ require 'clicksend_client/models/email_recipient'
37
+ require 'clicksend_client/models/email_sms_address'
38
+ require 'clicksend_client/models/email_template_new'
39
+ require 'clicksend_client/models/email_template_update'
40
+ require 'clicksend_client/models/fax_message'
41
+ require 'clicksend_client/models/fax_message_collection'
42
+ require 'clicksend_client/models/fields'
43
+ require 'clicksend_client/models/fields_fields'
44
+ require 'clicksend_client/models/forgot_password'
45
+ require 'clicksend_client/models/forgot_username'
46
+ require 'clicksend_client/models/inbound_fax_rule'
47
+ require 'clicksend_client/models/inbound_sms_rule'
48
+ require 'clicksend_client/models/mms_campaign'
49
+ require 'clicksend_client/models/mms_message'
50
+ require 'clicksend_client/models/mms_message_collection'
51
+ require 'clicksend_client/models/post_letter'
52
+ require 'clicksend_client/models/post_postcard'
53
+ require 'clicksend_client/models/post_recipient'
54
+ require 'clicksend_client/models/reseller_account'
55
+ require 'clicksend_client/models/reseller_account_transfer_credit'
56
+ require 'clicksend_client/models/sms_campaign'
57
+ require 'clicksend_client/models/sms_message'
58
+ require 'clicksend_client/models/sms_message_collection'
59
+ require 'clicksend_client/models/sms_template'
60
+ require 'clicksend_client/models/stripped_string'
61
+ require 'clicksend_client/models/subaccount'
62
+ require 'clicksend_client/models/upload_file'
63
+ require 'clicksend_client/models/url'
64
+ require 'clicksend_client/models/voice_message'
65
+ require 'clicksend_client/models/voice_message_collection'
66
+
67
+ # APIs
68
+ require 'clicksend_client/api/account_api'
69
+ require 'clicksend_client/api/account_recharge_api'
70
+ require 'clicksend_client/api/contact_api'
71
+ require 'clicksend_client/api/contact_list_api'
72
+ require 'clicksend_client/api/countries_api'
73
+ require 'clicksend_client/api/delivery_issues_api'
74
+ require 'clicksend_client/api/detect_address_api'
75
+ require 'clicksend_client/api/email_delivery_receipt_rules_api'
76
+ require 'clicksend_client/api/email_marketing_api'
77
+ require 'clicksend_client/api/email_to_sms_api'
78
+ require 'clicksend_client/api/fax_api'
79
+ require 'clicksend_client/api/fax_delivery_receipt_rules_api'
80
+ require 'clicksend_client/api/inbound_fax_rules_api'
81
+ require 'clicksend_client/api/inbound_sms_rules_api'
82
+ require 'clicksend_client/api/mms_api'
83
+ require 'clicksend_client/api/master_email_templates_api'
84
+ require 'clicksend_client/api/mms_campaign_api'
85
+ require 'clicksend_client/api/number_api'
86
+ require 'clicksend_client/api/post_letter_api'
87
+ require 'clicksend_client/api/post_postcard_api'
88
+ require 'clicksend_client/api/post_return_address_api'
89
+ require 'clicksend_client/api/referral_account_api'
90
+ require 'clicksend_client/api/reseller_account_api'
91
+ require 'clicksend_client/api/sms_api'
92
+ require 'clicksend_client/api/sms_delivery_receipt_rules_api'
93
+ require 'clicksend_client/api/search_api'
94
+ require 'clicksend_client/api/sms_campaign_api'
95
+ require 'clicksend_client/api/statistics_api'
96
+ require 'clicksend_client/api/subaccount_api'
97
+ require 'clicksend_client/api/timezones_api'
98
+ require 'clicksend_client/api/transactional_email_api'
99
+ require 'clicksend_client/api/transfer_credit_api'
100
+ require 'clicksend_client/api/upload_api'
101
+ require 'clicksend_client/api/user_email_templates_api'
102
+ require 'clicksend_client/api/voice_api'
103
+ require 'clicksend_client/api/voice_delivery_receipt_rules_api'
104
+
105
+ module ClickSendClient
106
+ class << self
107
+ # Customize default settings for the SDK using block.
108
+ # ClickSendClient.configure do |config|
109
+ # config.username = "xxx"
110
+ # config.password = "xxx"
111
+ # end
112
+ # If no block given, return the default Configuration object.
113
+ def configure
114
+ if block_given?
115
+ yield(Configuration.default)
116
+ else
117
+ Configuration.default
118
+ end
119
+ end
120
+ end
121
+ end
@@ -0,0 +1,447 @@
1
+ =begin
2
+ #ClickSend v3 API
3
+
4
+ # This is an official SDK for [ClickSend](https://clicksend.com) Below you will find a current list of the available methods for clicksend. *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..*
5
+
6
+ OpenAPI spec version: 3.1
7
+ Contact: support@clicksend.com
8
+ Generated by: https://github.com/clicksend-api/clicksend-codegen.git
9
+ ClickSend Codegen version: 2.4.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module ClickSendClient
16
+ class AccountApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get account information
23
+ # Get account details
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [String]
26
+ def account_get(opts = {})
27
+ data, _status_code, _headers = account_get_with_http_info(opts)
28
+ data
29
+ end
30
+
31
+ # Get account information
32
+ # Get account details
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
35
+ def account_get_with_http_info(opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: AccountApi.account_get ...'
38
+ end
39
+ # resource path
40
+ local_var_path = '/account'
41
+
42
+ # query parameters
43
+ query_params = {}
44
+
45
+ # header parameters
46
+ header_params = {}
47
+ # HTTP header 'Accept' (if needed)
48
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
51
+
52
+ # form parameters
53
+ form_params = {}
54
+
55
+ # http body (model)
56
+ post_body = nil
57
+ auth_names = ['BasicAuth']
58
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
59
+ :header_params => header_params,
60
+ :query_params => query_params,
61
+ :form_params => form_params,
62
+ :body => post_body,
63
+ :auth_names => auth_names,
64
+ :return_type => 'String')
65
+ if @api_client.config.debugging
66
+ @api_client.config.logger.debug "API called: AccountApi#account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
67
+ end
68
+ return data, status_code, headers
69
+ end
70
+ # Create a new account
71
+ # Create An Account
72
+ # @param account Account model
73
+ # @param [Hash] opts the optional parameters
74
+ # @return [String]
75
+ def account_post(account, opts = {})
76
+ data, _status_code, _headers = account_post_with_http_info(account, opts)
77
+ data
78
+ end
79
+
80
+ # Create a new account
81
+ # Create An Account
82
+ # @param account Account model
83
+ # @param [Hash] opts the optional parameters
84
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
85
+ def account_post_with_http_info(account, opts = {})
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug 'Calling API: AccountApi.account_post ...'
88
+ end
89
+ # verify the required parameter 'account' is set
90
+ if @api_client.config.client_side_validation && account.nil?
91
+ fail ArgumentError, "Missing the required parameter 'account' when calling AccountApi.account_post"
92
+ end
93
+ # resource path
94
+ local_var_path = '/account'
95
+
96
+ # query parameters
97
+ query_params = {}
98
+
99
+ # header parameters
100
+ header_params = {}
101
+ # HTTP header 'Accept' (if needed)
102
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
103
+ # HTTP header 'Content-Type'
104
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
105
+
106
+ # form parameters
107
+ form_params = {}
108
+
109
+ # http body (model)
110
+ post_body = @api_client.object_to_http_body(account)
111
+ auth_names = ['BasicAuth']
112
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
113
+ :header_params => header_params,
114
+ :query_params => query_params,
115
+ :form_params => form_params,
116
+ :body => post_body,
117
+ :auth_names => auth_names,
118
+ :return_type => 'String')
119
+ if @api_client.config.debugging
120
+ @api_client.config.logger.debug "API called: AccountApi#account_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
121
+ end
122
+ return data, status_code, headers
123
+ end
124
+ # Get account useage by subaccount
125
+ # Get account useage by subaccount
126
+ # @param year Year to filter by (yyyy)
127
+ # @param month Month to filter by (mm)
128
+ # @param [Hash] opts the optional parameters
129
+ # @return [String]
130
+ def account_useage_by_subaccount_get(year, month, opts = {})
131
+ data, _status_code, _headers = account_useage_by_subaccount_get_with_http_info(year, month, opts)
132
+ data
133
+ end
134
+
135
+ # Get account useage by subaccount
136
+ # Get account useage by subaccount
137
+ # @param year Year to filter by (yyyy)
138
+ # @param month Month to filter by (mm)
139
+ # @param [Hash] opts the optional parameters
140
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
141
+ def account_useage_by_subaccount_get_with_http_info(year, month, opts = {})
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug 'Calling API: AccountApi.account_useage_by_subaccount_get ...'
144
+ end
145
+ # verify the required parameter 'year' is set
146
+ if @api_client.config.client_side_validation && year.nil?
147
+ fail ArgumentError, "Missing the required parameter 'year' when calling AccountApi.account_useage_by_subaccount_get"
148
+ end
149
+ # verify the required parameter 'month' is set
150
+ if @api_client.config.client_side_validation && month.nil?
151
+ fail ArgumentError, "Missing the required parameter 'month' when calling AccountApi.account_useage_by_subaccount_get"
152
+ end
153
+ # resource path
154
+ local_var_path = '/account/usage/{year}/{month}/subaccount'.sub('{' + 'year' + '}', year.to_s).sub('{' + 'month' + '}', month.to_s)
155
+
156
+ # query parameters
157
+ query_params = {}
158
+
159
+ # header parameters
160
+ header_params = {}
161
+ # HTTP header 'Accept' (if needed)
162
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
163
+ # HTTP header 'Content-Type'
164
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
165
+
166
+ # form parameters
167
+ form_params = {}
168
+
169
+ # http body (model)
170
+ post_body = nil
171
+ auth_names = ['BasicAuth']
172
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
173
+ :header_params => header_params,
174
+ :query_params => query_params,
175
+ :form_params => form_params,
176
+ :body => post_body,
177
+ :auth_names => auth_names,
178
+ :return_type => 'String')
179
+ if @api_client.config.debugging
180
+ @api_client.config.logger.debug "API called: AccountApi#account_useage_by_subaccount_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
181
+ end
182
+ return data, status_code, headers
183
+ end
184
+ # Send account activation token
185
+ # Send account activation token
186
+ # @param account_verify Account details
187
+ # @param [Hash] opts the optional parameters
188
+ # @return [String]
189
+ def account_verify_send_put(account_verify, opts = {})
190
+ data, _status_code, _headers = account_verify_send_put_with_http_info(account_verify, opts)
191
+ data
192
+ end
193
+
194
+ # Send account activation token
195
+ # Send account activation token
196
+ # @param account_verify Account details
197
+ # @param [Hash] opts the optional parameters
198
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
199
+ def account_verify_send_put_with_http_info(account_verify, opts = {})
200
+ if @api_client.config.debugging
201
+ @api_client.config.logger.debug 'Calling API: AccountApi.account_verify_send_put ...'
202
+ end
203
+ # verify the required parameter 'account_verify' is set
204
+ if @api_client.config.client_side_validation && account_verify.nil?
205
+ fail ArgumentError, "Missing the required parameter 'account_verify' when calling AccountApi.account_verify_send_put"
206
+ end
207
+ # resource path
208
+ local_var_path = '/account-verify/send'
209
+
210
+ # query parameters
211
+ query_params = {}
212
+
213
+ # header parameters
214
+ header_params = {}
215
+ # HTTP header 'Accept' (if needed)
216
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
217
+ # HTTP header 'Content-Type'
218
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
219
+
220
+ # form parameters
221
+ form_params = {}
222
+
223
+ # http body (model)
224
+ post_body = @api_client.object_to_http_body(account_verify)
225
+ auth_names = ['BasicAuth']
226
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
227
+ :header_params => header_params,
228
+ :query_params => query_params,
229
+ :form_params => form_params,
230
+ :body => post_body,
231
+ :auth_names => auth_names,
232
+ :return_type => 'String')
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug "API called: AccountApi#account_verify_send_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
235
+ end
236
+ return data, status_code, headers
237
+ end
238
+ # Verify new account
239
+ # Verify new account
240
+ # @param activation_token
241
+ # @param [Hash] opts the optional parameters
242
+ # @return [String]
243
+ def account_verify_verify_by_activation_token_put(activation_token, opts = {})
244
+ data, _status_code, _headers = account_verify_verify_by_activation_token_put_with_http_info(activation_token, opts)
245
+ data
246
+ end
247
+
248
+ # Verify new account
249
+ # Verify new account
250
+ # @param activation_token
251
+ # @param [Hash] opts the optional parameters
252
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
253
+ def account_verify_verify_by_activation_token_put_with_http_info(activation_token, opts = {})
254
+ if @api_client.config.debugging
255
+ @api_client.config.logger.debug 'Calling API: AccountApi.account_verify_verify_by_activation_token_put ...'
256
+ end
257
+ # verify the required parameter 'activation_token' is set
258
+ if @api_client.config.client_side_validation && activation_token.nil?
259
+ fail ArgumentError, "Missing the required parameter 'activation_token' when calling AccountApi.account_verify_verify_by_activation_token_put"
260
+ end
261
+ # resource path
262
+ local_var_path = '/account-verify/verify/{activation_token}'.sub('{' + 'activation_token' + '}', activation_token.to_s)
263
+
264
+ # query parameters
265
+ query_params = {}
266
+
267
+ # header parameters
268
+ header_params = {}
269
+ # HTTP header 'Accept' (if needed)
270
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
271
+ # HTTP header 'Content-Type'
272
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
273
+
274
+ # form parameters
275
+ form_params = {}
276
+
277
+ # http body (model)
278
+ post_body = nil
279
+ auth_names = ['BasicAuth']
280
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
281
+ :header_params => header_params,
282
+ :query_params => query_params,
283
+ :form_params => form_params,
284
+ :body => post_body,
285
+ :auth_names => auth_names,
286
+ :return_type => 'String')
287
+ if @api_client.config.debugging
288
+ @api_client.config.logger.debug "API called: AccountApi#account_verify_verify_by_activation_token_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
289
+ end
290
+ return data, status_code, headers
291
+ end
292
+ # Forgot password
293
+ # Forgot password
294
+ # @param [Hash] opts the optional parameters
295
+ # @option opts [ForgotPassword] :forgot_password
296
+ # @return [String]
297
+ def forgot_password_put(opts = {})
298
+ data, _status_code, _headers = forgot_password_put_with_http_info(opts)
299
+ data
300
+ end
301
+
302
+ # Forgot password
303
+ # Forgot password
304
+ # @param [Hash] opts the optional parameters
305
+ # @option opts [ForgotPassword] :forgot_password
306
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
307
+ def forgot_password_put_with_http_info(opts = {})
308
+ if @api_client.config.debugging
309
+ @api_client.config.logger.debug 'Calling API: AccountApi.forgot_password_put ...'
310
+ end
311
+ # resource path
312
+ local_var_path = '/forgot-password'
313
+
314
+ # query parameters
315
+ query_params = {}
316
+
317
+ # header parameters
318
+ header_params = {}
319
+ # HTTP header 'Accept' (if needed)
320
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
321
+ # HTTP header 'Content-Type'
322
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
323
+
324
+ # form parameters
325
+ form_params = {}
326
+
327
+ # http body (model)
328
+ post_body = @api_client.object_to_http_body(opts[:'forgot_password'])
329
+ auth_names = ['BasicAuth']
330
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
331
+ :header_params => header_params,
332
+ :query_params => query_params,
333
+ :form_params => form_params,
334
+ :body => post_body,
335
+ :auth_names => auth_names,
336
+ :return_type => 'String')
337
+ if @api_client.config.debugging
338
+ @api_client.config.logger.debug "API called: AccountApi#forgot_password_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
339
+ end
340
+ return data, status_code, headers
341
+ end
342
+ # Verify forgot password
343
+ # Verify forgot password
344
+ # @param verify_password verifyPassword data
345
+ # @param [Hash] opts the optional parameters
346
+ # @return [String]
347
+ def forgot_password_verify_put(verify_password, opts = {})
348
+ data, _status_code, _headers = forgot_password_verify_put_with_http_info(verify_password, opts)
349
+ data
350
+ end
351
+
352
+ # Verify forgot password
353
+ # Verify forgot password
354
+ # @param verify_password verifyPassword data
355
+ # @param [Hash] opts the optional parameters
356
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
357
+ def forgot_password_verify_put_with_http_info(verify_password, opts = {})
358
+ if @api_client.config.debugging
359
+ @api_client.config.logger.debug 'Calling API: AccountApi.forgot_password_verify_put ...'
360
+ end
361
+ # verify the required parameter 'verify_password' is set
362
+ if @api_client.config.client_side_validation && verify_password.nil?
363
+ fail ArgumentError, "Missing the required parameter 'verify_password' when calling AccountApi.forgot_password_verify_put"
364
+ end
365
+ # resource path
366
+ local_var_path = '/forgot-password/verify'
367
+
368
+ # query parameters
369
+ query_params = {}
370
+
371
+ # header parameters
372
+ header_params = {}
373
+ # HTTP header 'Accept' (if needed)
374
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
375
+ # HTTP header 'Content-Type'
376
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
377
+
378
+ # form parameters
379
+ form_params = {}
380
+
381
+ # http body (model)
382
+ post_body = @api_client.object_to_http_body(verify_password)
383
+ auth_names = ['BasicAuth']
384
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
385
+ :header_params => header_params,
386
+ :query_params => query_params,
387
+ :form_params => form_params,
388
+ :body => post_body,
389
+ :auth_names => auth_names,
390
+ :return_type => 'String')
391
+ if @api_client.config.debugging
392
+ @api_client.config.logger.debug "API called: AccountApi#forgot_password_verify_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
393
+ end
394
+ return data, status_code, headers
395
+ end
396
+ # Forgot username
397
+ # Forgot username
398
+ # @param [Hash] opts the optional parameters
399
+ # @option opts [ForgotUsername] :forgot_username
400
+ # @return [String]
401
+ def forgot_username_put(opts = {})
402
+ data, _status_code, _headers = forgot_username_put_with_http_info(opts)
403
+ data
404
+ end
405
+
406
+ # Forgot username
407
+ # Forgot username
408
+ # @param [Hash] opts the optional parameters
409
+ # @option opts [ForgotUsername] :forgot_username
410
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
411
+ def forgot_username_put_with_http_info(opts = {})
412
+ if @api_client.config.debugging
413
+ @api_client.config.logger.debug 'Calling API: AccountApi.forgot_username_put ...'
414
+ end
415
+ # resource path
416
+ local_var_path = '/forgot-username'
417
+
418
+ # query parameters
419
+ query_params = {}
420
+
421
+ # header parameters
422
+ header_params = {}
423
+ # HTTP header 'Accept' (if needed)
424
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
425
+ # HTTP header 'Content-Type'
426
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
427
+
428
+ # form parameters
429
+ form_params = {}
430
+
431
+ # http body (model)
432
+ post_body = @api_client.object_to_http_body(opts[:'forgot_username'])
433
+ auth_names = []
434
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
435
+ :header_params => header_params,
436
+ :query_params => query_params,
437
+ :form_params => form_params,
438
+ :body => post_body,
439
+ :auth_names => auth_names,
440
+ :return_type => 'String')
441
+ if @api_client.config.debugging
442
+ @api_client.config.logger.debug "API called: AccountApi#forgot_username_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
443
+ end
444
+ return data, status_code, headers
445
+ end
446
+ end
447
+ end