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,119 @@
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 StatisticsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get sms statistics
23
+ # Get sms statistics
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [String]
26
+ def statistics_sms_get(opts = {})
27
+ data, _status_code, _headers = statistics_sms_get_with_http_info(opts)
28
+ data
29
+ end
30
+
31
+ # Get sms statistics
32
+ # Get sms statistics
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
35
+ def statistics_sms_get_with_http_info(opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_sms_get ...'
38
+ end
39
+ # resource path
40
+ local_var_path = '/statistics/sms'
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: StatisticsApi#statistics_sms_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
67
+ end
68
+ return data, status_code, headers
69
+ end
70
+ # Get voice statistics
71
+ # Get voice statistics
72
+ # @param [Hash] opts the optional parameters
73
+ # @return [String]
74
+ def statistics_voice_get(opts = {})
75
+ data, _status_code, _headers = statistics_voice_get_with_http_info(opts)
76
+ data
77
+ end
78
+
79
+ # Get voice statistics
80
+ # Get voice statistics
81
+ # @param [Hash] opts the optional parameters
82
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
83
+ def statistics_voice_get_with_http_info(opts = {})
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_voice_get ...'
86
+ end
87
+ # resource path
88
+ local_var_path = '/statistics/voice'
89
+
90
+ # query parameters
91
+ query_params = {}
92
+
93
+ # header parameters
94
+ header_params = {}
95
+ # HTTP header 'Accept' (if needed)
96
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
97
+ # HTTP header 'Content-Type'
98
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
99
+
100
+ # form parameters
101
+ form_params = {}
102
+
103
+ # http body (model)
104
+ post_body = nil
105
+ auth_names = ['BasicAuth']
106
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
107
+ :header_params => header_params,
108
+ :query_params => query_params,
109
+ :form_params => form_params,
110
+ :body => post_body,
111
+ :auth_names => auth_names,
112
+ :return_type => 'String')
113
+ if @api_client.config.debugging
114
+ @api_client.config.logger.debug "API called: StatisticsApi#statistics_voice_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
115
+ end
116
+ return data, status_code, headers
117
+ end
118
+ end
119
+ end
@@ -0,0 +1,361 @@
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 SubaccountApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Delete a subaccount
23
+ # Delete a subaccount
24
+ # @param subaccount_id ID of subaccount to delete
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [String]
27
+ def subaccounts_by_subaccount_id_delete(subaccount_id, opts = {})
28
+ data, _status_code, _headers = subaccounts_by_subaccount_id_delete_with_http_info(subaccount_id, opts)
29
+ data
30
+ end
31
+
32
+ # Delete a subaccount
33
+ # Delete a subaccount
34
+ # @param subaccount_id ID of subaccount to delete
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
37
+ def subaccounts_by_subaccount_id_delete_with_http_info(subaccount_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_by_subaccount_id_delete ...'
40
+ end
41
+ # verify the required parameter 'subaccount_id' is set
42
+ if @api_client.config.client_side_validation && subaccount_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_by_subaccount_id_delete"
44
+ end
45
+ # resource path
46
+ local_var_path = '/subaccounts/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', subaccount_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: SubaccountApi#subaccounts_by_subaccount_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
73
+ end
74
+ return data, status_code, headers
75
+ end
76
+ # Get specific subaccount
77
+ # Get specific subaccount
78
+ # @param subaccount_id ID of subaccount to get
79
+ # @param [Hash] opts the optional parameters
80
+ # @return [String]
81
+ def subaccounts_by_subaccount_id_get(subaccount_id, opts = {})
82
+ data, _status_code, _headers = subaccounts_by_subaccount_id_get_with_http_info(subaccount_id, opts)
83
+ data
84
+ end
85
+
86
+ # Get specific subaccount
87
+ # Get specific subaccount
88
+ # @param subaccount_id ID of subaccount to get
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
91
+ def subaccounts_by_subaccount_id_get_with_http_info(subaccount_id, opts = {})
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_by_subaccount_id_get ...'
94
+ end
95
+ # verify the required parameter 'subaccount_id' is set
96
+ if @api_client.config.client_side_validation && subaccount_id.nil?
97
+ fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_by_subaccount_id_get"
98
+ end
99
+ # resource path
100
+ local_var_path = '/subaccounts/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', subaccount_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: SubaccountApi#subaccounts_by_subaccount_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
127
+ end
128
+ return data, status_code, headers
129
+ end
130
+ # Update subaccount
131
+ # Update subaccount
132
+ # @param subaccount_id ID of subaccount to update
133
+ # @param subaccount Subaccount model
134
+ # @param [Hash] opts the optional parameters
135
+ # @return [String]
136
+ def subaccounts_by_subaccount_id_put(subaccount_id, subaccount, opts = {})
137
+ data, _status_code, _headers = subaccounts_by_subaccount_id_put_with_http_info(subaccount_id, subaccount, opts)
138
+ data
139
+ end
140
+
141
+ # Update subaccount
142
+ # Update subaccount
143
+ # @param subaccount_id ID of subaccount to update
144
+ # @param subaccount Subaccount model
145
+ # @param [Hash] opts the optional parameters
146
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
147
+ def subaccounts_by_subaccount_id_put_with_http_info(subaccount_id, subaccount, opts = {})
148
+ if @api_client.config.debugging
149
+ @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_by_subaccount_id_put ...'
150
+ end
151
+ # verify the required parameter 'subaccount_id' is set
152
+ if @api_client.config.client_side_validation && subaccount_id.nil?
153
+ fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_by_subaccount_id_put"
154
+ end
155
+ # verify the required parameter 'subaccount' is set
156
+ if @api_client.config.client_side_validation && subaccount.nil?
157
+ fail ArgumentError, "Missing the required parameter 'subaccount' when calling SubaccountApi.subaccounts_by_subaccount_id_put"
158
+ end
159
+ # resource path
160
+ local_var_path = '/subaccounts/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', subaccount_id.to_s)
161
+
162
+ # query parameters
163
+ query_params = {}
164
+
165
+ # header parameters
166
+ header_params = {}
167
+ # HTTP header 'Accept' (if needed)
168
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
169
+ # HTTP header 'Content-Type'
170
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
171
+
172
+ # form parameters
173
+ form_params = {}
174
+
175
+ # http body (model)
176
+ post_body = @api_client.object_to_http_body(subaccount)
177
+ auth_names = ['BasicAuth']
178
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
179
+ :header_params => header_params,
180
+ :query_params => query_params,
181
+ :form_params => form_params,
182
+ :body => post_body,
183
+ :auth_names => auth_names,
184
+ :return_type => 'String')
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_by_subaccount_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
187
+ end
188
+ return data, status_code, headers
189
+ end
190
+ # Get all subaccounts
191
+ # Get all subaccounts
192
+ # @param [Hash] opts the optional parameters
193
+ # @option opts [Integer] :page Page number (default to 1)
194
+ # @option opts [Integer] :limit Number of records per page (default to 10)
195
+ # @return [String]
196
+ def subaccounts_get(opts = {})
197
+ data, _status_code, _headers = subaccounts_get_with_http_info(opts)
198
+ data
199
+ end
200
+
201
+ # Get all subaccounts
202
+ # Get all subaccounts
203
+ # @param [Hash] opts the optional parameters
204
+ # @option opts [Integer] :page Page number
205
+ # @option opts [Integer] :limit Number of records per page
206
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
207
+ def subaccounts_get_with_http_info(opts = {})
208
+ if @api_client.config.debugging
209
+ @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_get ...'
210
+ end
211
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
212
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SubaccountApi.subaccounts_get, must be greater than or equal to 1.'
213
+ end
214
+
215
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
216
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SubaccountApi.subaccounts_get, must be greater than or equal to 1.'
217
+ end
218
+
219
+ # resource path
220
+ local_var_path = '/subaccounts'
221
+
222
+ # query parameters
223
+ query_params = {}
224
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
225
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
226
+
227
+ # header parameters
228
+ header_params = {}
229
+ # HTTP header 'Accept' (if needed)
230
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
231
+ # HTTP header 'Content-Type'
232
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
233
+
234
+ # form parameters
235
+ form_params = {}
236
+
237
+ # http body (model)
238
+ post_body = nil
239
+ auth_names = ['BasicAuth']
240
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
241
+ :header_params => header_params,
242
+ :query_params => query_params,
243
+ :form_params => form_params,
244
+ :body => post_body,
245
+ :auth_names => auth_names,
246
+ :return_type => 'String')
247
+ if @api_client.config.debugging
248
+ @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
249
+ end
250
+ return data, status_code, headers
251
+ end
252
+ # Create new subaccount
253
+ # Create new subaccount
254
+ # @param subaccount Subaccount model
255
+ # @param [Hash] opts the optional parameters
256
+ # @return [String]
257
+ def subaccounts_post(subaccount, opts = {})
258
+ data, _status_code, _headers = subaccounts_post_with_http_info(subaccount, opts)
259
+ data
260
+ end
261
+
262
+ # Create new subaccount
263
+ # Create new subaccount
264
+ # @param subaccount Subaccount model
265
+ # @param [Hash] opts the optional parameters
266
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
267
+ def subaccounts_post_with_http_info(subaccount, opts = {})
268
+ if @api_client.config.debugging
269
+ @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_post ...'
270
+ end
271
+ # verify the required parameter 'subaccount' is set
272
+ if @api_client.config.client_side_validation && subaccount.nil?
273
+ fail ArgumentError, "Missing the required parameter 'subaccount' when calling SubaccountApi.subaccounts_post"
274
+ end
275
+ # resource path
276
+ local_var_path = '/subaccounts'
277
+
278
+ # query parameters
279
+ query_params = {}
280
+
281
+ # header parameters
282
+ header_params = {}
283
+ # HTTP header 'Accept' (if needed)
284
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
285
+ # HTTP header 'Content-Type'
286
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
287
+
288
+ # form parameters
289
+ form_params = {}
290
+
291
+ # http body (model)
292
+ post_body = @api_client.object_to_http_body(subaccount)
293
+ auth_names = ['BasicAuth']
294
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
295
+ :header_params => header_params,
296
+ :query_params => query_params,
297
+ :form_params => form_params,
298
+ :body => post_body,
299
+ :auth_names => auth_names,
300
+ :return_type => 'String')
301
+ if @api_client.config.debugging
302
+ @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
303
+ end
304
+ return data, status_code, headers
305
+ end
306
+ # Regenerate an API Key
307
+ # Regenerate an API Key
308
+ # @param subaccount_id ID of subaccount to regenerate API key for
309
+ # @param [Hash] opts the optional parameters
310
+ # @return [String]
311
+ def subaccounts_regen_api_key_by_subaccount_id_put(subaccount_id, opts = {})
312
+ data, _status_code, _headers = subaccounts_regen_api_key_by_subaccount_id_put_with_http_info(subaccount_id, opts)
313
+ data
314
+ end
315
+
316
+ # Regenerate an API Key
317
+ # Regenerate an API Key
318
+ # @param subaccount_id ID of subaccount to regenerate API key for
319
+ # @param [Hash] opts the optional parameters
320
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
321
+ def subaccounts_regen_api_key_by_subaccount_id_put_with_http_info(subaccount_id, opts = {})
322
+ if @api_client.config.debugging
323
+ @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_regen_api_key_by_subaccount_id_put ...'
324
+ end
325
+ # verify the required parameter 'subaccount_id' is set
326
+ if @api_client.config.client_side_validation && subaccount_id.nil?
327
+ fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_regen_api_key_by_subaccount_id_put"
328
+ end
329
+ # resource path
330
+ local_var_path = '/subaccounts/{subaccount_id}/regen-api-key'.sub('{' + 'subaccount_id' + '}', subaccount_id.to_s)
331
+
332
+ # query parameters
333
+ query_params = {}
334
+
335
+ # header parameters
336
+ header_params = {}
337
+ # HTTP header 'Accept' (if needed)
338
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
339
+ # HTTP header 'Content-Type'
340
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
341
+
342
+ # form parameters
343
+ form_params = {}
344
+
345
+ # http body (model)
346
+ post_body = nil
347
+ auth_names = ['BasicAuth']
348
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
349
+ :header_params => header_params,
350
+ :query_params => query_params,
351
+ :form_params => form_params,
352
+ :body => post_body,
353
+ :auth_names => auth_names,
354
+ :return_type => 'String')
355
+ if @api_client.config.debugging
356
+ @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_regen_api_key_by_subaccount_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
357
+ end
358
+ return data, status_code, headers
359
+ end
360
+ end
361
+ end