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,310 @@
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 FAXDeliveryReceiptRulesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Delete fax delivery receipt automation
23
+ # Delete fax delivery receipt automation
24
+ # @param receipt_rule_id Receipt rule id
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [String]
27
+ def fax_delivery_receipt_automation_delete(receipt_rule_id, opts = {})
28
+ data, _status_code, _headers = fax_delivery_receipt_automation_delete_with_http_info(receipt_rule_id, opts)
29
+ data
30
+ end
31
+
32
+ # Delete fax delivery receipt automation
33
+ # Delete fax delivery receipt automation
34
+ # @param receipt_rule_id Receipt rule id
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
37
+ def fax_delivery_receipt_automation_delete_with_http_info(receipt_rule_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_delete ...'
40
+ end
41
+ # verify the required parameter 'receipt_rule_id' is set
42
+ if @api_client.config.client_side_validation && receipt_rule_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'receipt_rule_id' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_delete"
44
+ end
45
+ # resource path
46
+ local_var_path = '/automations/fax/receipts/{receipt_rule_id}'.sub('{' + 'receipt_rule_id' + '}', receipt_rule_id.to_s)
47
+
48
+ # query parameters
49
+ query_params = {}
50
+
51
+ # header parameters
52
+ header_params = {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
57
+
58
+ # form parameters
59
+ form_params = {}
60
+
61
+ # http body (model)
62
+ post_body = nil
63
+ auth_names = ['BasicAuth']
64
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
65
+ :header_params => header_params,
66
+ :query_params => query_params,
67
+ :form_params => form_params,
68
+ :body => post_body,
69
+ :auth_names => auth_names,
70
+ :return_type => 'String')
71
+ if @api_client.config.debugging
72
+ @api_client.config.logger.debug "API called: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automation_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
73
+ end
74
+ return data, status_code, headers
75
+ end
76
+ # Get specific fax delivery receipt automation
77
+ # Get specific fax delivery receipt automation
78
+ # @param receipt_rule_id Receipt rule id
79
+ # @param [Hash] opts the optional parameters
80
+ # @return [String]
81
+ def fax_delivery_receipt_automation_get(receipt_rule_id, opts = {})
82
+ data, _status_code, _headers = fax_delivery_receipt_automation_get_with_http_info(receipt_rule_id, opts)
83
+ data
84
+ end
85
+
86
+ # Get specific fax delivery receipt automation
87
+ # Get specific fax delivery receipt automation
88
+ # @param receipt_rule_id Receipt rule id
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
91
+ def fax_delivery_receipt_automation_get_with_http_info(receipt_rule_id, opts = {})
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_get ...'
94
+ end
95
+ # verify the required parameter 'receipt_rule_id' is set
96
+ if @api_client.config.client_side_validation && receipt_rule_id.nil?
97
+ fail ArgumentError, "Missing the required parameter 'receipt_rule_id' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_get"
98
+ end
99
+ # resource path
100
+ local_var_path = '/automations/fax/receipts/{receipt_rule_id}'.sub('{' + 'receipt_rule_id' + '}', receipt_rule_id.to_s)
101
+
102
+ # query parameters
103
+ query_params = {}
104
+
105
+ # header parameters
106
+ header_params = {}
107
+ # HTTP header 'Accept' (if needed)
108
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
109
+ # HTTP header 'Content-Type'
110
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
111
+
112
+ # form parameters
113
+ form_params = {}
114
+
115
+ # http body (model)
116
+ post_body = nil
117
+ auth_names = ['BasicAuth']
118
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
119
+ :header_params => header_params,
120
+ :query_params => query_params,
121
+ :form_params => form_params,
122
+ :body => post_body,
123
+ :auth_names => auth_names,
124
+ :return_type => 'String')
125
+ if @api_client.config.debugging
126
+ @api_client.config.logger.debug "API called: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
127
+ end
128
+ return data, status_code, headers
129
+ end
130
+ # Create fax delivery receipt automations
131
+ # Create fax delivery receipt automations
132
+ # @param delivery_receipt_rule fax delivery receipt rule model
133
+ # @param [Hash] opts the optional parameters
134
+ # @return [String]
135
+ def fax_delivery_receipt_automation_post(delivery_receipt_rule, opts = {})
136
+ data, _status_code, _headers = fax_delivery_receipt_automation_post_with_http_info(delivery_receipt_rule, opts)
137
+ data
138
+ end
139
+
140
+ # Create fax delivery receipt automations
141
+ # Create fax delivery receipt automations
142
+ # @param delivery_receipt_rule fax delivery receipt rule model
143
+ # @param [Hash] opts the optional parameters
144
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
145
+ def fax_delivery_receipt_automation_post_with_http_info(delivery_receipt_rule, opts = {})
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_post ...'
148
+ end
149
+ # verify the required parameter 'delivery_receipt_rule' is set
150
+ if @api_client.config.client_side_validation && delivery_receipt_rule.nil?
151
+ fail ArgumentError, "Missing the required parameter 'delivery_receipt_rule' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_post"
152
+ end
153
+ # resource path
154
+ local_var_path = '/automations/fax/receipts'
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 = @api_client.object_to_http_body(delivery_receipt_rule)
171
+ auth_names = ['BasicAuth']
172
+ data, status_code, headers = @api_client.call_api(:POST, 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: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automation_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
181
+ end
182
+ return data, status_code, headers
183
+ end
184
+ # Update fax delivery receipt automation
185
+ # Update fax delivery receipt automation
186
+ # @param receipt_rule_id Receipt rule id
187
+ # @param delivery_receipt_rule Delivery receipt rule model
188
+ # @param [Hash] opts the optional parameters
189
+ # @return [String]
190
+ def fax_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule, opts = {})
191
+ data, _status_code, _headers = fax_delivery_receipt_automation_put_with_http_info(receipt_rule_id, delivery_receipt_rule, opts)
192
+ data
193
+ end
194
+
195
+ # Update fax delivery receipt automation
196
+ # Update fax delivery receipt automation
197
+ # @param receipt_rule_id Receipt rule id
198
+ # @param delivery_receipt_rule Delivery receipt rule model
199
+ # @param [Hash] opts the optional parameters
200
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
201
+ def fax_delivery_receipt_automation_put_with_http_info(receipt_rule_id, delivery_receipt_rule, opts = {})
202
+ if @api_client.config.debugging
203
+ @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_put ...'
204
+ end
205
+ # verify the required parameter 'receipt_rule_id' is set
206
+ if @api_client.config.client_side_validation && receipt_rule_id.nil?
207
+ fail ArgumentError, "Missing the required parameter 'receipt_rule_id' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_put"
208
+ end
209
+ # verify the required parameter 'delivery_receipt_rule' is set
210
+ if @api_client.config.client_side_validation && delivery_receipt_rule.nil?
211
+ fail ArgumentError, "Missing the required parameter 'delivery_receipt_rule' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_put"
212
+ end
213
+ # resource path
214
+ local_var_path = '/automations/fax/receipts/{receipt_rule_id}'.sub('{' + 'receipt_rule_id' + '}', receipt_rule_id.to_s)
215
+
216
+ # query parameters
217
+ query_params = {}
218
+
219
+ # header parameters
220
+ header_params = {}
221
+ # HTTP header 'Accept' (if needed)
222
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
223
+ # HTTP header 'Content-Type'
224
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
225
+
226
+ # form parameters
227
+ form_params = {}
228
+
229
+ # http body (model)
230
+ post_body = @api_client.object_to_http_body(delivery_receipt_rule)
231
+ auth_names = ['BasicAuth']
232
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
233
+ :header_params => header_params,
234
+ :query_params => query_params,
235
+ :form_params => form_params,
236
+ :body => post_body,
237
+ :auth_names => auth_names,
238
+ :return_type => 'String')
239
+ if @api_client.config.debugging
240
+ @api_client.config.logger.debug "API called: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automation_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
241
+ end
242
+ return data, status_code, headers
243
+ end
244
+ # Get all fax delivery receipt automations
245
+ # Get all fax delivery receipt automations
246
+ # @param [Hash] opts the optional parameters
247
+ # @option opts [String] :q Your keyword or query.
248
+ # @option opts [Integer] :page Page number (default to 1)
249
+ # @option opts [Integer] :limit Number of records per page (default to 10)
250
+ # @return [String]
251
+ def fax_delivery_receipt_automations_get(opts = {})
252
+ data, _status_code, _headers = fax_delivery_receipt_automations_get_with_http_info(opts)
253
+ data
254
+ end
255
+
256
+ # Get all fax delivery receipt automations
257
+ # Get all fax delivery receipt automations
258
+ # @param [Hash] opts the optional parameters
259
+ # @option opts [String] :q Your keyword or query.
260
+ # @option opts [Integer] :page Page number
261
+ # @option opts [Integer] :limit Number of records per page
262
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
263
+ def fax_delivery_receipt_automations_get_with_http_info(opts = {})
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automations_get ...'
266
+ end
267
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
268
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automations_get, must be greater than or equal to 1.'
269
+ end
270
+
271
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
272
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automations_get, must be greater than or equal to 1.'
273
+ end
274
+
275
+ # resource path
276
+ local_var_path = '/automations/fax/receipts'
277
+
278
+ # query parameters
279
+ query_params = {}
280
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
281
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
282
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
283
+
284
+ # header parameters
285
+ header_params = {}
286
+ # HTTP header 'Accept' (if needed)
287
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
288
+ # HTTP header 'Content-Type'
289
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
290
+
291
+ # form parameters
292
+ form_params = {}
293
+
294
+ # http body (model)
295
+ post_body = nil
296
+ auth_names = ['BasicAuth']
297
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
298
+ :header_params => header_params,
299
+ :query_params => query_params,
300
+ :form_params => form_params,
301
+ :body => post_body,
302
+ :auth_names => auth_names,
303
+ :return_type => 'String')
304
+ if @api_client.config.debugging
305
+ @api_client.config.logger.debug "API called: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
306
+ end
307
+ return data, status_code, headers
308
+ end
309
+ end
310
+ end
@@ -0,0 +1,310 @@
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 InboundFAXRulesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Delete inbound fax automation
23
+ # Delete inbound fax automation
24
+ # @param inbound_rule_id Inbound rule id
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [String]
27
+ def fax_inbound_automation_delete(inbound_rule_id, opts = {})
28
+ data, _status_code, _headers = fax_inbound_automation_delete_with_http_info(inbound_rule_id, opts)
29
+ data
30
+ end
31
+
32
+ # Delete inbound fax automation
33
+ # Delete inbound fax automation
34
+ # @param inbound_rule_id Inbound rule id
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
37
+ def fax_inbound_automation_delete_with_http_info(inbound_rule_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: InboundFAXRulesApi.fax_inbound_automation_delete ...'
40
+ end
41
+ # verify the required parameter 'inbound_rule_id' is set
42
+ if @api_client.config.client_side_validation && inbound_rule_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'inbound_rule_id' when calling InboundFAXRulesApi.fax_inbound_automation_delete"
44
+ end
45
+ # resource path
46
+ local_var_path = '/automations/fax/inbound/{inbound_rule_id}'.sub('{' + 'inbound_rule_id' + '}', inbound_rule_id.to_s)
47
+
48
+ # query parameters
49
+ query_params = {}
50
+
51
+ # header parameters
52
+ header_params = {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
57
+
58
+ # form parameters
59
+ form_params = {}
60
+
61
+ # http body (model)
62
+ post_body = nil
63
+ auth_names = ['BasicAuth']
64
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
65
+ :header_params => header_params,
66
+ :query_params => query_params,
67
+ :form_params => form_params,
68
+ :body => post_body,
69
+ :auth_names => auth_names,
70
+ :return_type => 'String')
71
+ if @api_client.config.debugging
72
+ @api_client.config.logger.debug "API called: InboundFAXRulesApi#fax_inbound_automation_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
73
+ end
74
+ return data, status_code, headers
75
+ end
76
+ # Get specific inbound fax automation
77
+ # Get specific inbound fax automation
78
+ # @param inbound_rule_id Inbound rule id
79
+ # @param [Hash] opts the optional parameters
80
+ # @return [String]
81
+ def fax_inbound_automation_get(inbound_rule_id, opts = {})
82
+ data, _status_code, _headers = fax_inbound_automation_get_with_http_info(inbound_rule_id, opts)
83
+ data
84
+ end
85
+
86
+ # Get specific inbound fax automation
87
+ # Get specific inbound fax automation
88
+ # @param inbound_rule_id Inbound rule id
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
91
+ def fax_inbound_automation_get_with_http_info(inbound_rule_id, opts = {})
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug 'Calling API: InboundFAXRulesApi.fax_inbound_automation_get ...'
94
+ end
95
+ # verify the required parameter 'inbound_rule_id' is set
96
+ if @api_client.config.client_side_validation && inbound_rule_id.nil?
97
+ fail ArgumentError, "Missing the required parameter 'inbound_rule_id' when calling InboundFAXRulesApi.fax_inbound_automation_get"
98
+ end
99
+ # resource path
100
+ local_var_path = '/automations/fax/inbound/{inbound_rule_id}'.sub('{' + 'inbound_rule_id' + '}', inbound_rule_id.to_s)
101
+
102
+ # query parameters
103
+ query_params = {}
104
+
105
+ # header parameters
106
+ header_params = {}
107
+ # HTTP header 'Accept' (if needed)
108
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
109
+ # HTTP header 'Content-Type'
110
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
111
+
112
+ # form parameters
113
+ form_params = {}
114
+
115
+ # http body (model)
116
+ post_body = nil
117
+ auth_names = ['BasicAuth']
118
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
119
+ :header_params => header_params,
120
+ :query_params => query_params,
121
+ :form_params => form_params,
122
+ :body => post_body,
123
+ :auth_names => auth_names,
124
+ :return_type => 'String')
125
+ if @api_client.config.debugging
126
+ @api_client.config.logger.debug "API called: InboundFAXRulesApi#fax_inbound_automation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
127
+ end
128
+ return data, status_code, headers
129
+ end
130
+ # Create new inbound fax automation
131
+ # Create new inbound fax automation
132
+ # @param inbound_fax_rule Inbound fax rule model
133
+ # @param [Hash] opts the optional parameters
134
+ # @return [String]
135
+ def fax_inbound_automation_post(inbound_fax_rule, opts = {})
136
+ data, _status_code, _headers = fax_inbound_automation_post_with_http_info(inbound_fax_rule, opts)
137
+ data
138
+ end
139
+
140
+ # Create new inbound fax automation
141
+ # Create new inbound fax automation
142
+ # @param inbound_fax_rule Inbound fax rule model
143
+ # @param [Hash] opts the optional parameters
144
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
145
+ def fax_inbound_automation_post_with_http_info(inbound_fax_rule, opts = {})
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug 'Calling API: InboundFAXRulesApi.fax_inbound_automation_post ...'
148
+ end
149
+ # verify the required parameter 'inbound_fax_rule' is set
150
+ if @api_client.config.client_side_validation && inbound_fax_rule.nil?
151
+ fail ArgumentError, "Missing the required parameter 'inbound_fax_rule' when calling InboundFAXRulesApi.fax_inbound_automation_post"
152
+ end
153
+ # resource path
154
+ local_var_path = '/automations/fax/inbound'
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 = @api_client.object_to_http_body(inbound_fax_rule)
171
+ auth_names = ['BasicAuth']
172
+ data, status_code, headers = @api_client.call_api(:POST, 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: InboundFAXRulesApi#fax_inbound_automation_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
181
+ end
182
+ return data, status_code, headers
183
+ end
184
+ # Update inbound fax automation
185
+ # Update inbound fax automation
186
+ # @param inbound_rule_id Inbound rule id
187
+ # @param inbound_fax_rule Inbound fax rule model
188
+ # @param [Hash] opts the optional parameters
189
+ # @return [String]
190
+ def fax_inbound_automation_put(inbound_rule_id, inbound_fax_rule, opts = {})
191
+ data, _status_code, _headers = fax_inbound_automation_put_with_http_info(inbound_rule_id, inbound_fax_rule, opts)
192
+ data
193
+ end
194
+
195
+ # Update inbound fax automation
196
+ # Update inbound fax automation
197
+ # @param inbound_rule_id Inbound rule id
198
+ # @param inbound_fax_rule Inbound fax rule model
199
+ # @param [Hash] opts the optional parameters
200
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
201
+ def fax_inbound_automation_put_with_http_info(inbound_rule_id, inbound_fax_rule, opts = {})
202
+ if @api_client.config.debugging
203
+ @api_client.config.logger.debug 'Calling API: InboundFAXRulesApi.fax_inbound_automation_put ...'
204
+ end
205
+ # verify the required parameter 'inbound_rule_id' is set
206
+ if @api_client.config.client_side_validation && inbound_rule_id.nil?
207
+ fail ArgumentError, "Missing the required parameter 'inbound_rule_id' when calling InboundFAXRulesApi.fax_inbound_automation_put"
208
+ end
209
+ # verify the required parameter 'inbound_fax_rule' is set
210
+ if @api_client.config.client_side_validation && inbound_fax_rule.nil?
211
+ fail ArgumentError, "Missing the required parameter 'inbound_fax_rule' when calling InboundFAXRulesApi.fax_inbound_automation_put"
212
+ end
213
+ # resource path
214
+ local_var_path = '/automations/fax/inbound/{inbound_rule_id}'.sub('{' + 'inbound_rule_id' + '}', inbound_rule_id.to_s)
215
+
216
+ # query parameters
217
+ query_params = {}
218
+
219
+ # header parameters
220
+ header_params = {}
221
+ # HTTP header 'Accept' (if needed)
222
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
223
+ # HTTP header 'Content-Type'
224
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
225
+
226
+ # form parameters
227
+ form_params = {}
228
+
229
+ # http body (model)
230
+ post_body = @api_client.object_to_http_body(inbound_fax_rule)
231
+ auth_names = ['BasicAuth']
232
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
233
+ :header_params => header_params,
234
+ :query_params => query_params,
235
+ :form_params => form_params,
236
+ :body => post_body,
237
+ :auth_names => auth_names,
238
+ :return_type => 'String')
239
+ if @api_client.config.debugging
240
+ @api_client.config.logger.debug "API called: InboundFAXRulesApi#fax_inbound_automation_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
241
+ end
242
+ return data, status_code, headers
243
+ end
244
+ # Get all inbound fax automations
245
+ # Get all inbound fax automations
246
+ # @param [Hash] opts the optional parameters
247
+ # @option opts [String] :q Your keyword or query.
248
+ # @option opts [Integer] :page Page number (default to 1)
249
+ # @option opts [Integer] :limit Number of records per page (default to 10)
250
+ # @return [String]
251
+ def fax_inbound_automations_get(opts = {})
252
+ data, _status_code, _headers = fax_inbound_automations_get_with_http_info(opts)
253
+ data
254
+ end
255
+
256
+ # Get all inbound fax automations
257
+ # Get all inbound fax automations
258
+ # @param [Hash] opts the optional parameters
259
+ # @option opts [String] :q Your keyword or query.
260
+ # @option opts [Integer] :page Page number
261
+ # @option opts [Integer] :limit Number of records per page
262
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
263
+ def fax_inbound_automations_get_with_http_info(opts = {})
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug 'Calling API: InboundFAXRulesApi.fax_inbound_automations_get ...'
266
+ end
267
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
268
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling InboundFAXRulesApi.fax_inbound_automations_get, must be greater than or equal to 1.'
269
+ end
270
+
271
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
272
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboundFAXRulesApi.fax_inbound_automations_get, must be greater than or equal to 1.'
273
+ end
274
+
275
+ # resource path
276
+ local_var_path = '/automations/fax/inbound'
277
+
278
+ # query parameters
279
+ query_params = {}
280
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
281
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
282
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
283
+
284
+ # header parameters
285
+ header_params = {}
286
+ # HTTP header 'Accept' (if needed)
287
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
288
+ # HTTP header 'Content-Type'
289
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
290
+
291
+ # form parameters
292
+ form_params = {}
293
+
294
+ # http body (model)
295
+ post_body = nil
296
+ auth_names = ['BasicAuth']
297
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
298
+ :header_params => header_params,
299
+ :query_params => query_params,
300
+ :form_params => form_params,
301
+ :body => post_body,
302
+ :auth_names => auth_names,
303
+ :return_type => 'String')
304
+ if @api_client.config.debugging
305
+ @api_client.config.logger.debug "API called: InboundFAXRulesApi#fax_inbound_automations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
306
+ end
307
+ return data, status_code, headers
308
+ end
309
+ end
310
+ end