clicksend_client 1.0.2

Sign up to get free protection for your applications and to get access to all the features.
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,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 346858ef68ae591b2808e36a2f2e2e82ba6e20542e57c903ec86ec27036b6110
4
+ data.tar.gz: d69a4f507734356cff41be11825a82f67b9dca8ab9a4ae1e41c41533a5cd1387
5
+ SHA512:
6
+ metadata.gz: 40e50129fe673825732e925dd034e4a733f7ace22b7ea79371a2362c42c1ee353883435d53328b9d849a6cabbb80c7ab3cffcabc5f4af075d33238908b8f7356
7
+ data.tar.gz: b33f4ade93f89d5145530321f3949a72f72958c01b1386d516fc82f06213a7a52903b87c4b415f2124c8cae0dd7ee9b1c07480c40a1c9abe7e86e179c1ed94d8
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ end
@@ -0,0 +1,78 @@
1
+ # The official ruby library for ClickSend v3 API
2
+
3
+ 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/)..*
4
+
5
+ ## Installation
6
+
7
+ ### Build a gem
8
+
9
+ To build the Ruby code into a gem:
10
+
11
+ ```shell
12
+ gem build clicksend_client.gemspec
13
+ ```
14
+
15
+ Then either install the gem locally:
16
+
17
+ ```shell
18
+ gem install ./clicksend_client-1.0.0.gem
19
+ ```
20
+ (for development, run `gem install --dev ./clicksend_client-1.0.0.gem` to install the development dependencies)
21
+
22
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
23
+
24
+ Finally add this to the Gemfile:
25
+
26
+ gem 'clicksend_client', '~> 1.0.0'
27
+
28
+ ### Install from Git
29
+
30
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
31
+
32
+ gem 'clicksend_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
33
+
34
+ ### Include the Ruby code directly
35
+
36
+ Include the Ruby code directly using `-I` as follows:
37
+
38
+ ```shell
39
+ ruby -Ilib script.rb
40
+ ```
41
+
42
+ ## Getting Started
43
+
44
+ Please follow the [installation](#installation) procedure and then run the following code:
45
+ ```ruby
46
+ # Load the gem
47
+ require 'clicksend_client'
48
+
49
+ # Setup authorization
50
+ ClickSendClient.configure do |config|
51
+ # Configure HTTP basic authorization: BasicAuth
52
+ config.username = 'YOUR USERNAME'
53
+ config.password = 'YOUR PASSWORD'
54
+ end
55
+
56
+ api_instance = ClickSendClient::AccountApi.new
57
+
58
+ begin
59
+ #Get account information
60
+ result = api_instance.account_get
61
+ p result
62
+ rescue ClickSendClient::ApiError => e
63
+ puts "Exception when calling AccountApi->account_get: #{e}"
64
+ end
65
+
66
+ ```
67
+
68
+ ## Documentation for API Endpoints and Models
69
+
70
+ Documentation can be found here: [ClickSend API Docs](https://developers.clicksend.com/docs/)
71
+
72
+ ## Documentation for Authorization
73
+
74
+
75
+ ### BasicAuth
76
+
77
+ - **Type**: HTTP basic authentication
78
+
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,45 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ =begin
4
+ #ClickSend v3 API
5
+
6
+ # This is an official SDK for [ClickSend](https://clicksend.com) *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..*
7
+
8
+ OpenAPI spec version: 3.1
9
+ Contact: support@clicksend.com
10
+ Generated by: https://github.com/clicksend-api/clicksend-codegen.git
11
+ ClickSend Codegen version: 2.4.1-SNAPSHOT
12
+
13
+ =end
14
+
15
+ $:.push File.expand_path("../lib", __FILE__)
16
+ require "clicksend_client/version"
17
+
18
+ Gem::Specification.new do |s|
19
+ s.name = "clicksend_client"
20
+ s.version = ClickSendClient::VERSION
21
+ s.platform = Gem::Platform::RUBY
22
+ s.authors = ["ClickSend-Codegen"]
23
+ s.email = ["support@clicksend.com"]
24
+ s.homepage = "https://github.com/clicksend-api/clicksend-codegen"
25
+ s.summary = "ClickSend v3 API Ruby Gem"
26
+ s.description = " This is an official SDK for [ClickSend](https://clicksend.com) *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* "
27
+ s.license = "Unlicense"
28
+ s.required_ruby_version = ">= 1.9"
29
+
30
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
32
+
33
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
34
+ s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
35
+ s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
36
+ s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
37
+ s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
38
+ s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
39
+ s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
40
+
41
+ s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
42
+ s.test_files = `find spec/*`.split("\n")
43
+ s.executables = []
44
+ s.require_paths = ["lib"]
45
+ end
@@ -0,0 +1,15 @@
1
+ # ClickSendClient::Account
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **username** | **String** | Your username |
7
+ **password** | **String** | Your password |
8
+ **user_phone** | **String** | Your phone number in E.164 format. |
9
+ **user_email** | **String** | Your email |
10
+ **user_first_name** | **String** | Your first name |
11
+ **user_last_name** | **String** | Your last name |
12
+ **account_name** | **String** | Your delivery to value. |
13
+ **country** | **String** | Your country |
14
+
15
+
@@ -0,0 +1,433 @@
1
+ # ClickSendClient::AccountApi
2
+
3
+ All URIs are relative to *https://rest.clicksend.com/v3*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**account_get**](AccountApi.md#account_get) | **GET** /account | Get account information
8
+ [**account_post**](AccountApi.md#account_post) | **POST** /account | Create a new account
9
+ [**account_useage_by_subaccount_get**](AccountApi.md#account_useage_by_subaccount_get) | **GET** /account/usage/{year}/{month}/subaccount | Get account useage by subaccount
10
+ [**account_verify_send_put**](AccountApi.md#account_verify_send_put) | **PUT** /account-verify/send | Send account activation token
11
+ [**account_verify_verify_by_activation_token_put**](AccountApi.md#account_verify_verify_by_activation_token_put) | **PUT** /account-verify/verify/{activation_token} | Verify new account
12
+ [**forgot_password_put**](AccountApi.md#forgot_password_put) | **PUT** /forgot-password | Forgot password
13
+ [**forgot_password_verify_put**](AccountApi.md#forgot_password_verify_put) | **PUT** /forgot-password/verify | Verify forgot password
14
+ [**forgot_username_put**](AccountApi.md#forgot_username_put) | **PUT** /forgot-username | Forgot username
15
+
16
+
17
+ # **account_get**
18
+ > String account_get
19
+
20
+ Get account information
21
+
22
+ Get account details
23
+
24
+ ### Example
25
+ ```ruby
26
+ # load the gem
27
+ require 'clicksend_client'
28
+ # setup authorization
29
+ ClickSendClient.configure do |config|
30
+ # Configure HTTP basic authorization: BasicAuth
31
+ config.username = 'YOUR USERNAME'
32
+ config.password = 'YOUR PASSWORD'
33
+ end
34
+
35
+ api_instance = ClickSendClient::AccountApi.new
36
+
37
+ begin
38
+ #Get account information
39
+ result = api_instance.account_get
40
+ p result
41
+ rescue ClickSendClient::ApiError => e
42
+ puts "Exception when calling AccountApi->account_get: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Parameters
47
+ This endpoint does not need any parameter.
48
+
49
+ ### Return type
50
+
51
+ **String**
52
+
53
+ ### Authorization
54
+
55
+ [BasicAuth](../README.md#BasicAuth)
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: application/json
60
+ - **Accept**: application/json
61
+
62
+
63
+
64
+ # **account_post**
65
+ > String account_post(account)
66
+
67
+ Create a new account
68
+
69
+ Create An Account
70
+
71
+ ### Example
72
+ ```ruby
73
+ # load the gem
74
+ require 'clicksend_client'
75
+ # setup authorization
76
+ ClickSendClient.configure do |config|
77
+ # Configure HTTP basic authorization: BasicAuth
78
+ config.username = 'YOUR USERNAME'
79
+ config.password = 'YOUR PASSWORD'
80
+ end
81
+
82
+ api_instance = ClickSendClient::AccountApi.new
83
+
84
+ account = ClickSendClient::Account.new # Account | Account model
85
+
86
+
87
+ begin
88
+ #Create a new account
89
+ result = api_instance.account_post(account)
90
+ p result
91
+ rescue ClickSendClient::ApiError => e
92
+ puts "Exception when calling AccountApi->account_post: #{e}"
93
+ end
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ Name | Type | Description | Notes
99
+ ------------- | ------------- | ------------- | -------------
100
+ **account** | [**Account**](Account.md)| Account model |
101
+
102
+ ### Return type
103
+
104
+ **String**
105
+
106
+ ### Authorization
107
+
108
+ [BasicAuth](../README.md#BasicAuth)
109
+
110
+ ### HTTP request headers
111
+
112
+ - **Content-Type**: application/json
113
+ - **Accept**: application/json
114
+
115
+
116
+
117
+ # **account_useage_by_subaccount_get**
118
+ > String account_useage_by_subaccount_get(year, month)
119
+
120
+ Get account useage by subaccount
121
+
122
+ Get account useage by subaccount
123
+
124
+ ### Example
125
+ ```ruby
126
+ # load the gem
127
+ require 'clicksend_client'
128
+ # setup authorization
129
+ ClickSendClient.configure do |config|
130
+ # Configure HTTP basic authorization: BasicAuth
131
+ config.username = 'YOUR USERNAME'
132
+ config.password = 'YOUR PASSWORD'
133
+ end
134
+
135
+ api_instance = ClickSendClient::AccountApi.new
136
+
137
+ year = 56 # Integer | Year to filter by (yyyy)
138
+
139
+ month = 56 # Integer | Month to filter by (mm)
140
+
141
+
142
+ begin
143
+ #Get account useage by subaccount
144
+ result = api_instance.account_useage_by_subaccount_get(year, month)
145
+ p result
146
+ rescue ClickSendClient::ApiError => e
147
+ puts "Exception when calling AccountApi->account_useage_by_subaccount_get: #{e}"
148
+ end
149
+ ```
150
+
151
+ ### Parameters
152
+
153
+ Name | Type | Description | Notes
154
+ ------------- | ------------- | ------------- | -------------
155
+ **year** | **Integer**| Year to filter by (yyyy) |
156
+ **month** | **Integer**| Month to filter by (mm) |
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
+ # **account_verify_send_put**
174
+ > String account_verify_send_put(account_verify)
175
+
176
+ Send account activation token
177
+
178
+ Send account activation token
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::AccountApi.new
192
+
193
+ account_verify = ClickSendClient::AccountVerify.new # AccountVerify | Account details
194
+
195
+
196
+ begin
197
+ #Send account activation token
198
+ result = api_instance.account_verify_send_put(account_verify)
199
+ p result
200
+ rescue ClickSendClient::ApiError => e
201
+ puts "Exception when calling AccountApi->account_verify_send_put: #{e}"
202
+ end
203
+ ```
204
+
205
+ ### Parameters
206
+
207
+ Name | Type | Description | Notes
208
+ ------------- | ------------- | ------------- | -------------
209
+ **account_verify** | [**AccountVerify**](AccountVerify.md)| Account details |
210
+
211
+ ### Return type
212
+
213
+ **String**
214
+
215
+ ### Authorization
216
+
217
+ [BasicAuth](../README.md#BasicAuth)
218
+
219
+ ### HTTP request headers
220
+
221
+ - **Content-Type**: application/json
222
+ - **Accept**: application/json
223
+
224
+
225
+
226
+ # **account_verify_verify_by_activation_token_put**
227
+ > String account_verify_verify_by_activation_token_put(activation_token)
228
+
229
+ Verify new account
230
+
231
+ Verify new account
232
+
233
+ ### Example
234
+ ```ruby
235
+ # load the gem
236
+ require 'clicksend_client'
237
+ # setup authorization
238
+ ClickSendClient.configure do |config|
239
+ # Configure HTTP basic authorization: BasicAuth
240
+ config.username = 'YOUR USERNAME'
241
+ config.password = 'YOUR PASSWORD'
242
+ end
243
+
244
+ api_instance = ClickSendClient::AccountApi.new
245
+
246
+ activation_token = 56 # Integer |
247
+
248
+
249
+ begin
250
+ #Verify new account
251
+ result = api_instance.account_verify_verify_by_activation_token_put(activation_token)
252
+ p result
253
+ rescue ClickSendClient::ApiError => e
254
+ puts "Exception when calling AccountApi->account_verify_verify_by_activation_token_put: #{e}"
255
+ end
256
+ ```
257
+
258
+ ### Parameters
259
+
260
+ Name | Type | Description | Notes
261
+ ------------- | ------------- | ------------- | -------------
262
+ **activation_token** | **Integer**| |
263
+
264
+ ### Return type
265
+
266
+ **String**
267
+
268
+ ### Authorization
269
+
270
+ [BasicAuth](../README.md#BasicAuth)
271
+
272
+ ### HTTP request headers
273
+
274
+ - **Content-Type**: application/json
275
+ - **Accept**: application/json
276
+
277
+
278
+
279
+ # **forgot_password_put**
280
+ > String forgot_password_put(opts)
281
+
282
+ Forgot password
283
+
284
+ Forgot password
285
+
286
+ ### Example
287
+ ```ruby
288
+ # load the gem
289
+ require 'clicksend_client'
290
+ # setup authorization
291
+ ClickSendClient.configure do |config|
292
+ # Configure HTTP basic authorization: BasicAuth
293
+ config.username = 'YOUR USERNAME'
294
+ config.password = 'YOUR PASSWORD'
295
+ end
296
+
297
+ api_instance = ClickSendClient::AccountApi.new
298
+
299
+ opts = {
300
+ forgot_password: ClickSendClient::ForgotPassword.new # ForgotPassword |
301
+ }
302
+
303
+ begin
304
+ #Forgot password
305
+ result = api_instance.forgot_password_put(opts)
306
+ p result
307
+ rescue ClickSendClient::ApiError => e
308
+ puts "Exception when calling AccountApi->forgot_password_put: #{e}"
309
+ end
310
+ ```
311
+
312
+ ### Parameters
313
+
314
+ Name | Type | Description | Notes
315
+ ------------- | ------------- | ------------- | -------------
316
+ **forgot_password** | [**ForgotPassword**](ForgotPassword.md)| | [optional]
317
+
318
+ ### Return type
319
+
320
+ **String**
321
+
322
+ ### Authorization
323
+
324
+ [BasicAuth](../README.md#BasicAuth)
325
+
326
+ ### HTTP request headers
327
+
328
+ - **Content-Type**: application/json
329
+ - **Accept**: application/json
330
+
331
+
332
+
333
+ # **forgot_password_verify_put**
334
+ > String forgot_password_verify_put(verify_password)
335
+
336
+ Verify forgot password
337
+
338
+ Verify forgot password
339
+
340
+ ### Example
341
+ ```ruby
342
+ # load the gem
343
+ require 'clicksend_client'
344
+ # setup authorization
345
+ ClickSendClient.configure do |config|
346
+ # Configure HTTP basic authorization: BasicAuth
347
+ config.username = 'YOUR USERNAME'
348
+ config.password = 'YOUR PASSWORD'
349
+ end
350
+
351
+ api_instance = ClickSendClient::AccountApi.new
352
+
353
+ verify_password = ClickSendClient::AccountForgotPasswordVerify.new # AccountForgotPasswordVerify | verifyPassword data
354
+
355
+
356
+ begin
357
+ #Verify forgot password
358
+ result = api_instance.forgot_password_verify_put(verify_password)
359
+ p result
360
+ rescue ClickSendClient::ApiError => e
361
+ puts "Exception when calling AccountApi->forgot_password_verify_put: #{e}"
362
+ end
363
+ ```
364
+
365
+ ### Parameters
366
+
367
+ Name | Type | Description | Notes
368
+ ------------- | ------------- | ------------- | -------------
369
+ **verify_password** | [**AccountForgotPasswordVerify**](AccountForgotPasswordVerify.md)| verifyPassword data |
370
+
371
+ ### Return type
372
+
373
+ **String**
374
+
375
+ ### Authorization
376
+
377
+ [BasicAuth](../README.md#BasicAuth)
378
+
379
+ ### HTTP request headers
380
+
381
+ - **Content-Type**: application/json
382
+ - **Accept**: application/json
383
+
384
+
385
+
386
+ # **forgot_username_put**
387
+ > String forgot_username_put(opts)
388
+
389
+ Forgot username
390
+
391
+ Forgot username
392
+
393
+ ### Example
394
+ ```ruby
395
+ # load the gem
396
+ require 'clicksend_client'
397
+
398
+ api_instance = ClickSendClient::AccountApi.new
399
+
400
+ opts = {
401
+ forgot_username: ClickSendClient::ForgotUsername.new # ForgotUsername |
402
+ }
403
+
404
+ begin
405
+ #Forgot username
406
+ result = api_instance.forgot_username_put(opts)
407
+ p result
408
+ rescue ClickSendClient::ApiError => e
409
+ puts "Exception when calling AccountApi->forgot_username_put: #{e}"
410
+ end
411
+ ```
412
+
413
+ ### Parameters
414
+
415
+ Name | Type | Description | Notes
416
+ ------------- | ------------- | ------------- | -------------
417
+ **forgot_username** | [**ForgotUsername**](ForgotUsername.md)| | [optional]
418
+
419
+ ### Return type
420
+
421
+ **String**
422
+
423
+ ### Authorization
424
+
425
+ No authorization required
426
+
427
+ ### HTTP request headers
428
+
429
+ - **Content-Type**: application/json
430
+ - **Accept**: application/json
431
+
432
+
433
+