clicksend_client 1.0.2 → 5.1.1
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.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +9 -3
- data/clicksend_client.gemspec +4 -3
- data/docs/ContactApi.md +63 -1
- data/docs/CountryListIds.md +8 -0
- data/docs/FaxMessage.md +1 -1
- data/docs/GlobalSendingApi.md +206 -0
- data/docs/InboundSMSRule.md +1 -0
- data/docs/MMSApi.md +117 -0
- data/docs/MmsCampaign.md +1 -1
- data/docs/MmsMessage.md +1 -1
- data/docs/SMSApi.md +1 -1
- data/docs/SmsCampaign.md +2 -1
- data/docs/SmsMessage.md +3 -3
- data/docs/VoiceMessage.md +2 -2
- data/lib/clicksend_client/api/account_api.rb +1 -1
- data/lib/clicksend_client/api/account_recharge_api.rb +1 -1
- data/lib/clicksend_client/api/contact_api.rb +74 -1
- data/lib/clicksend_client/api/contact_list_api.rb +1 -1
- data/lib/clicksend_client/api/countries_api.rb +1 -1
- data/lib/clicksend_client/api/delivery_issues_api.rb +1 -1
- data/lib/clicksend_client/api/detect_address_api.rb +1 -1
- data/lib/clicksend_client/api/email_delivery_receipt_rules_api.rb +1 -1
- data/lib/clicksend_client/api/email_marketing_api.rb +1 -1
- data/lib/clicksend_client/api/email_to_sms_api.rb +1 -1
- data/lib/clicksend_client/api/fax_api.rb +1 -1
- data/lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb +1 -1
- data/lib/clicksend_client/api/global_sending_api.rb +221 -0
- data/lib/clicksend_client/api/inbound_fax_rules_api.rb +1 -1
- data/lib/clicksend_client/api/inbound_sms_rules_api.rb +1 -1
- data/lib/clicksend_client/api/master_email_templates_api.rb +1 -1
- data/lib/clicksend_client/api/mms_api.rb +127 -1
- data/lib/clicksend_client/api/mms_campaign_api.rb +1 -1
- data/lib/clicksend_client/api/number_api.rb +1 -1
- data/lib/clicksend_client/api/post_letter_api.rb +1 -1
- data/lib/clicksend_client/api/post_postcard_api.rb +1 -1
- data/lib/clicksend_client/api/post_return_address_api.rb +1 -1
- data/lib/clicksend_client/api/referral_account_api.rb +1 -1
- data/lib/clicksend_client/api/reseller_account_api.rb +1 -1
- data/lib/clicksend_client/api/search_api.rb +1 -1
- data/lib/clicksend_client/api/sms_api.rb +3 -3
- data/lib/clicksend_client/api/sms_campaign_api.rb +1 -1
- data/lib/clicksend_client/api/sms_delivery_receipt_rules_api.rb +1 -1
- data/lib/clicksend_client/api/statistics_api.rb +1 -1
- data/lib/clicksend_client/api/subaccount_api.rb +1 -1
- data/lib/clicksend_client/api/timezones_api.rb +1 -1
- data/lib/clicksend_client/api/transactional_email_api.rb +1 -1
- data/lib/clicksend_client/api/transfer_credit_api.rb +1 -1
- data/lib/clicksend_client/api/upload_api.rb +1 -1
- data/lib/clicksend_client/api/user_email_templates_api.rb +1 -1
- data/lib/clicksend_client/api/voice_api.rb +1 -1
- data/lib/clicksend_client/api/voice_delivery_receipt_rules_api.rb +1 -1
- data/lib/clicksend_client/api_client.rb +6 -4
- data/lib/clicksend_client/api_error.rb +1 -1
- data/lib/clicksend_client/configuration.rb +3 -3
- data/lib/clicksend_client/models/account.rb +3 -2
- data/lib/clicksend_client/models/account_forgot_password_verify.rb +3 -2
- data/lib/clicksend_client/models/account_verify.rb +3 -2
- data/lib/clicksend_client/models/address.rb +3 -2
- data/lib/clicksend_client/models/attachment.rb +3 -2
- data/lib/clicksend_client/models/contact.rb +3 -2
- data/lib/clicksend_client/models/contact_list.rb +3 -2
- data/lib/clicksend_client/models/contact_list_import.rb +3 -2
- data/lib/clicksend_client/models/country_list_ids.rb +192 -0
- data/lib/clicksend_client/models/credit_card.rb +3 -2
- data/lib/clicksend_client/models/date_before.rb +4 -3
- data/lib/clicksend_client/models/delivery_issue.rb +3 -2
- data/lib/clicksend_client/models/delivery_receipt_rule.rb +3 -2
- data/lib/clicksend_client/models/email.rb +3 -2
- data/lib/clicksend_client/models/email_address.rb +3 -2
- data/lib/clicksend_client/models/email_campaign.rb +3 -2
- data/lib/clicksend_client/models/email_from.rb +3 -2
- data/lib/clicksend_client/models/email_recipient.rb +3 -2
- data/lib/clicksend_client/models/email_sms_address.rb +3 -2
- data/lib/clicksend_client/models/email_template_new.rb +3 -2
- data/lib/clicksend_client/models/email_template_update.rb +3 -2
- data/lib/clicksend_client/models/fax_message.rb +4 -3
- data/lib/clicksend_client/models/fax_message_collection.rb +3 -2
- data/lib/clicksend_client/models/fields.rb +3 -2
- data/lib/clicksend_client/models/fields_fields.rb +3 -2
- data/lib/clicksend_client/models/forgot_password.rb +3 -2
- data/lib/clicksend_client/models/forgot_username.rb +3 -2
- data/lib/clicksend_client/models/inbound_fax_rule.rb +3 -2
- data/lib/clicksend_client/models/inbound_sms_rule.rb +17 -6
- data/lib/clicksend_client/models/mms_campaign.rb +4 -3
- data/lib/clicksend_client/models/mms_message.rb +3 -7
- data/lib/clicksend_client/models/mms_message_collection.rb +3 -2
- data/lib/clicksend_client/models/post_letter.rb +3 -2
- data/lib/clicksend_client/models/post_postcard.rb +3 -2
- data/lib/clicksend_client/models/post_recipient.rb +3 -2
- data/lib/clicksend_client/models/reseller_account.rb +3 -2
- data/lib/clicksend_client/models/reseller_account_transfer_credit.rb +3 -2
- data/lib/clicksend_client/models/sms_campaign.rb +18 -7
- data/lib/clicksend_client/models/sms_message.rb +5 -9
- data/lib/clicksend_client/models/sms_message_collection.rb +3 -2
- data/lib/clicksend_client/models/sms_template.rb +3 -2
- data/lib/clicksend_client/models/stripped_string.rb +3 -2
- data/lib/clicksend_client/models/subaccount.rb +3 -2
- data/lib/clicksend_client/models/upload_file.rb +3 -2
- data/lib/clicksend_client/models/url.rb +3 -2
- data/lib/clicksend_client/models/voice_message.rb +4 -8
- data/lib/clicksend_client/models/voice_message_collection.rb +3 -2
- data/lib/clicksend_client/version.rb +2 -2
- data/lib/clicksend_client.rb +3 -1
- data/spec/api/account_api_spec.rb +1 -1
- data/spec/api/account_recharge_api_spec.rb +1 -1
- data/spec/api/contact_api_spec.rb +16 -1
- data/spec/api/contact_list_api_spec.rb +1 -1
- data/spec/api/countries_api_spec.rb +1 -1
- data/spec/api/delivery_issues_api_spec.rb +1 -1
- data/spec/api/detect_address_api_spec.rb +1 -1
- data/spec/api/email_delivery_receipt_rules_api_spec.rb +1 -1
- data/spec/api/email_marketing_api_spec.rb +1 -1
- data/spec/api/email_to_sms_api_spec.rb +1 -1
- data/spec/api/fax_api_spec.rb +1 -1
- data/spec/api/fax_delivery_receipt_rules_api_spec.rb +1 -1
- data/spec/api/global_sending_api_spec.rb +80 -0
- data/spec/api/inbound_fax_rules_api_spec.rb +1 -1
- data/spec/api/inbound_sms_rules_api_spec.rb +1 -1
- data/spec/api/master_email_templates_api_spec.rb +1 -1
- data/spec/api/mms_api_spec.rb +29 -1
- data/spec/api/mms_campaign_api_spec.rb +1 -1
- data/spec/api/number_api_spec.rb +1 -1
- data/spec/api/post_letter_api_spec.rb +1 -1
- data/spec/api/post_postcard_api_spec.rb +1 -1
- data/spec/api/post_return_address_api_spec.rb +1 -1
- data/spec/api/referral_account_api_spec.rb +1 -1
- data/spec/api/reseller_account_api_spec.rb +1 -1
- data/spec/api/search_api_spec.rb +1 -1
- data/spec/api/sms_api_spec.rb +2 -2
- data/spec/api/sms_campaign_api_spec.rb +1 -1
- data/spec/api/sms_delivery_receipt_rules_api_spec.rb +1 -1
- data/spec/api/statistics_api_spec.rb +1 -1
- data/spec/api/subaccount_api_spec.rb +1 -1
- data/spec/api/timezones_api_spec.rb +1 -1
- data/spec/api/transactional_email_api_spec.rb +1 -1
- data/spec/api/transfer_credit_api_spec.rb +1 -1
- data/spec/api/upload_api_spec.rb +1 -1
- data/spec/api/user_email_templates_api_spec.rb +1 -1
- data/spec/api/voice_api_spec.rb +1 -1
- data/spec/api/voice_delivery_receipt_rules_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +18 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/account_forgot_password_verify_spec.rb +1 -1
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/account_verify_spec.rb +1 -1
- data/spec/models/address_spec.rb +1 -1
- data/spec/models/attachment_spec.rb +1 -1
- data/spec/models/contact_list_import_spec.rb +1 -1
- data/spec/models/contact_list_spec.rb +1 -1
- data/spec/models/contact_spec.rb +1 -1
- data/spec/models/country_list_ids_spec.rb +41 -0
- data/spec/models/credit_card_spec.rb +1 -1
- data/spec/models/date_before_spec.rb +1 -1
- data/spec/models/delivery_issue_spec.rb +1 -1
- data/spec/models/delivery_receipt_rule_spec.rb +1 -1
- data/spec/models/email_address_spec.rb +1 -1
- data/spec/models/email_campaign_spec.rb +1 -1
- data/spec/models/email_from_spec.rb +1 -1
- data/spec/models/email_recipient_spec.rb +1 -1
- data/spec/models/email_sms_address_spec.rb +1 -1
- data/spec/models/email_spec.rb +1 -1
- data/spec/models/email_template_new_spec.rb +1 -1
- data/spec/models/email_template_update_spec.rb +1 -1
- data/spec/models/fax_message_collection_spec.rb +1 -1
- data/spec/models/fax_message_spec.rb +1 -1
- data/spec/models/fields_fields_spec.rb +1 -1
- data/spec/models/fields_spec.rb +1 -1
- data/spec/models/forgot_password_spec.rb +1 -1
- data/spec/models/forgot_username_spec.rb +1 -1
- data/spec/models/inbound_fax_rule_spec.rb +1 -1
- data/spec/models/inbound_sms_rule_spec.rb +7 -1
- data/spec/models/mms_campaign_spec.rb +1 -1
- data/spec/models/mms_message_collection_spec.rb +1 -1
- data/spec/models/mms_message_spec.rb +1 -1
- data/spec/models/post_letter_spec.rb +1 -1
- data/spec/models/post_postcard_spec.rb +1 -1
- data/spec/models/post_recipient_spec.rb +1 -1
- data/spec/models/reseller_account_spec.rb +1 -1
- data/spec/models/reseller_account_transfer_credit_spec.rb +1 -1
- data/spec/models/sms_campaign_spec.rb +7 -1
- data/spec/models/sms_message_collection_spec.rb +1 -1
- data/spec/models/sms_message_spec.rb +1 -1
- data/spec/models/sms_template_spec.rb +1 -1
- data/spec/models/stripped_string_spec.rb +1 -1
- data/spec/models/subaccount_spec.rb +1 -1
- data/spec/models/upload_file_spec.rb +1 -1
- data/spec/models/url_spec.rb +1 -1
- data/spec/models/voice_message_collection_spec.rb +1 -1
- data/spec/models/voice_message_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +109 -84
- data/clicksend_client-1.0.1.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 181d1e2f83d007446caf8fe730cda04b27077ae1d3434f6ded912e9a2648534d
|
|
4
|
+
data.tar.gz: f802cb8b0b67a6cf8d9f57ec8d5a7290f6c96a356418e5fcdec453330d0cb457
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0d80a55007c22f60f656e06627c3e606b9f59d9bcb4c2849aad7c430604bebbfe500e854a1d4db8448c798c1426d742379908d2530ac03541455b0cb3b55d84a
|
|
7
|
+
data.tar.gz: c5ade6e08ee9bac732742b661212ef09a5a49b06e9c984b53cfa728acb090ad1930f696ebe229bc45404d9c1af10aeac8ad7072192878112dfc545dfb122b6d5
|
data/Gemfile
CHANGED
data/README.md
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
# The official ruby library for ClickSend v3 API
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
|
|
4
|
+
This is the official [ClickSend](https://clicksend.com) SDK. Documentation can be found [here](https://developers.clicksend.com/docs/rest/v3/?ruby#introduction).
|
|
5
|
+
|
|
6
|
+
## Requirements
|
|
7
|
+
|
|
8
|
+
- [Sign Up](https://www.clicksend.com/signup) for a free ClickSend account.
|
|
9
|
+
- Copy your API key from the [API Credentials](https://dashboard.clicksend.com/#/account/subaccount) area.
|
|
4
10
|
|
|
5
11
|
## Installation
|
|
6
12
|
|
|
@@ -65,9 +71,9 @@ end
|
|
|
65
71
|
|
|
66
72
|
```
|
|
67
73
|
|
|
68
|
-
## Documentation
|
|
74
|
+
## Documentation
|
|
69
75
|
|
|
70
|
-
Documentation can be found here
|
|
76
|
+
Documentation for our SDK and REST API can be found [here](https://developers.clicksend.com/docs/rest/v3/?ruby#introduction).
|
|
71
77
|
|
|
72
78
|
## Documentation for Authorization
|
|
73
79
|
|
data/clicksend_client.gemspec
CHANGED
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#ClickSend v3 API
|
|
5
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/)..*
|
|
6
|
+
# 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/)..*
|
|
7
7
|
|
|
8
8
|
OpenAPI spec version: 3.1
|
|
9
9
|
Contact: support@clicksend.com
|
|
10
10
|
Generated by: https://github.com/clicksend-api/clicksend-codegen.git
|
|
11
|
-
ClickSend Codegen version: 2.4.
|
|
11
|
+
ClickSend Codegen version: 2.4.53-SNAPSHOT
|
|
12
12
|
|
|
13
13
|
=end
|
|
14
14
|
|
|
@@ -23,12 +23,13 @@ Gem::Specification.new do |s|
|
|
|
23
23
|
s.email = ["support@clicksend.com"]
|
|
24
24
|
s.homepage = "https://github.com/clicksend-api/clicksend-codegen"
|
|
25
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/)..* "
|
|
26
|
+
s.description = " 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/)..* "
|
|
27
27
|
s.license = "Unlicense"
|
|
28
28
|
s.required_ruby_version = ">= 1.9"
|
|
29
29
|
|
|
30
30
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
|
31
31
|
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
|
32
|
+
s.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.0'
|
|
32
33
|
|
|
33
34
|
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
|
34
35
|
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
data/docs/ContactApi.md
CHANGED
|
@@ -9,6 +9,7 @@ Method | HTTP request | Description
|
|
|
9
9
|
[**lists_contacts_by_list_id_and_contact_id_put**](ContactApi.md#lists_contacts_by_list_id_and_contact_id_put) | **PUT** /lists/{list_id}/contacts/{contact_id} | Update specific contact
|
|
10
10
|
[**lists_contacts_by_list_id_get**](ContactApi.md#lists_contacts_by_list_id_get) | **GET** /lists/{list_id}/contacts | Get all contacts in a list
|
|
11
11
|
[**lists_contacts_by_list_id_post**](ContactApi.md#lists_contacts_by_list_id_post) | **POST** /lists/{list_id}/contacts | Create new contact
|
|
12
|
+
[**lists_copy_contact_put**](ContactApi.md#lists_copy_contact_put) | **PUT** /lists/{from_list_id}/contacts/{contact_id}/copy/{to_list_id} | Copy contact to another list
|
|
12
13
|
[**lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put**](ContactApi.md#lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put) | **PUT** /lists/{list_id}/remove-opted-out-contacts/{opt_out_list_id} | Remove all opted out contacts
|
|
13
14
|
[**lists_transfer_contact_put**](ContactApi.md#lists_transfer_contact_put) | **PUT** /lists/{from_list_id}/contacts/{contact_id}/transfer/{to_list_id} | Transfer contact to another list
|
|
14
15
|
|
|
@@ -208,7 +209,8 @@ list_id = 56 # Integer | Contact list ID
|
|
|
208
209
|
|
|
209
210
|
opts = {
|
|
210
211
|
page: 1, # Integer | Page number
|
|
211
|
-
limit: 10 # Integer | Number of records per page
|
|
212
|
+
limit: 10, # Integer | Number of records per page
|
|
213
|
+
updated_after: 10 # Integer | Get all contacts updated after a given timestamp.
|
|
212
214
|
}
|
|
213
215
|
|
|
214
216
|
begin
|
|
@@ -227,6 +229,7 @@ Name | Type | Description | Notes
|
|
|
227
229
|
**list_id** | **Integer**| Contact list ID |
|
|
228
230
|
**page** | **Integer**| Page number | [optional] [default to 1]
|
|
229
231
|
**limit** | **Integer**| Number of records per page | [optional] [default to 10]
|
|
232
|
+
**updated_after** | **Integer**| Get all contacts updated after a given timestamp. | [optional] [default to 10]
|
|
230
233
|
|
|
231
234
|
### Return type
|
|
232
235
|
|
|
@@ -299,6 +302,65 @@ Name | Type | Description | Notes
|
|
|
299
302
|
|
|
300
303
|
|
|
301
304
|
|
|
305
|
+
# **lists_copy_contact_put**
|
|
306
|
+
> String lists_copy_contact_put(from_list_id, contact_id, to_list_id)
|
|
307
|
+
|
|
308
|
+
Copy contact to another list
|
|
309
|
+
|
|
310
|
+
Copy contact to another list
|
|
311
|
+
|
|
312
|
+
### Example
|
|
313
|
+
```ruby
|
|
314
|
+
# load the gem
|
|
315
|
+
require 'clicksend_client'
|
|
316
|
+
# setup authorization
|
|
317
|
+
ClickSendClient.configure do |config|
|
|
318
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
319
|
+
config.username = 'YOUR USERNAME'
|
|
320
|
+
config.password = 'YOUR PASSWORD'
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
api_instance = ClickSendClient::ContactApi.new
|
|
324
|
+
|
|
325
|
+
from_list_id = 56 # Integer | List ID for list that contains contact.
|
|
326
|
+
|
|
327
|
+
contact_id = 56 # Integer | Contact ID
|
|
328
|
+
|
|
329
|
+
to_list_id = 56 # Integer | List ID for list you want to copy the contact to.
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
begin
|
|
333
|
+
#Copy contact to another list
|
|
334
|
+
result = api_instance.lists_copy_contact_put(from_list_id, contact_id, to_list_id)
|
|
335
|
+
p result
|
|
336
|
+
rescue ClickSendClient::ApiError => e
|
|
337
|
+
puts "Exception when calling ContactApi->lists_copy_contact_put: #{e}"
|
|
338
|
+
end
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Parameters
|
|
342
|
+
|
|
343
|
+
Name | Type | Description | Notes
|
|
344
|
+
------------- | ------------- | ------------- | -------------
|
|
345
|
+
**from_list_id** | **Integer**| List ID for list that contains contact. |
|
|
346
|
+
**contact_id** | **Integer**| Contact ID |
|
|
347
|
+
**to_list_id** | **Integer**| List ID for list you want to copy the contact to. |
|
|
348
|
+
|
|
349
|
+
### Return type
|
|
350
|
+
|
|
351
|
+
**String**
|
|
352
|
+
|
|
353
|
+
### Authorization
|
|
354
|
+
|
|
355
|
+
[BasicAuth](../README.md#BasicAuth)
|
|
356
|
+
|
|
357
|
+
### HTTP request headers
|
|
358
|
+
|
|
359
|
+
- **Content-Type**: application/json
|
|
360
|
+
- **Accept**: application/json
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
302
364
|
# **lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put**
|
|
303
365
|
> String lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put(list_id, opt_out_list_id)
|
|
304
366
|
|
data/docs/FaxMessage.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**to** | **String** | Recipient fax number in E.164 format. |
|
|
8
8
|
**list_id** | **Integer** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional]
|
|
9
9
|
**from** | **String** | Your sender id. Must be a valid fax number. | [optional]
|
|
10
|
-
**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format
|
|
10
|
+
**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp | [optional]
|
|
11
11
|
**custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. | [optional]
|
|
12
12
|
**country** | **String** | Recipient country. | [optional]
|
|
13
13
|
**from_email** | **String** | An email address where the reply should be emailed to. | [optional]
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
# ClickSendClient::GlobalSendingApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://rest.clicksend.com/v3*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**list_countries_get**](GlobalSendingApi.md#list_countries_get) | **GET** /country-list | List of countries
|
|
8
|
+
[**user_countries_agree_post**](GlobalSendingApi.md#user_countries_agree_post) | **POST** /user-countries/agree | Agree to rules and regulation
|
|
9
|
+
[**user_countries_get**](GlobalSendingApi.md#user_countries_get) | **GET** /user-countries | Get Countries for Global Sending
|
|
10
|
+
[**user_countries_post**](GlobalSendingApi.md#user_countries_post) | **POST** /user-countries | Select Countries for Global Sending
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
# **list_countries_get**
|
|
14
|
+
> String list_countries_get
|
|
15
|
+
|
|
16
|
+
List of countries
|
|
17
|
+
|
|
18
|
+
List of countries with IDs that can be used in selecting countries for Global sending.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
```ruby
|
|
22
|
+
# load the gem
|
|
23
|
+
require 'clicksend_client'
|
|
24
|
+
# setup authorization
|
|
25
|
+
ClickSendClient.configure do |config|
|
|
26
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
27
|
+
config.username = 'YOUR USERNAME'
|
|
28
|
+
config.password = 'YOUR PASSWORD'
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
api_instance = ClickSendClient::GlobalSendingApi.new
|
|
32
|
+
|
|
33
|
+
begin
|
|
34
|
+
#List of countries
|
|
35
|
+
result = api_instance.list_countries_get
|
|
36
|
+
p result
|
|
37
|
+
rescue ClickSendClient::ApiError => e
|
|
38
|
+
puts "Exception when calling GlobalSendingApi->list_countries_get: #{e}"
|
|
39
|
+
end
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Parameters
|
|
43
|
+
This endpoint does not need any parameter.
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
**String**
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
[BasicAuth](../README.md#BasicAuth)
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: application/json
|
|
56
|
+
- **Accept**: application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
# **user_countries_agree_post**
|
|
61
|
+
> String user_countries_agree_post
|
|
62
|
+
|
|
63
|
+
Agree to rules and regulation
|
|
64
|
+
|
|
65
|
+
To agree on rules and regulations of selected countries and confirm selection.
|
|
66
|
+
|
|
67
|
+
### Example
|
|
68
|
+
```ruby
|
|
69
|
+
# load the gem
|
|
70
|
+
require 'clicksend_client'
|
|
71
|
+
# setup authorization
|
|
72
|
+
ClickSendClient.configure do |config|
|
|
73
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
74
|
+
config.username = 'YOUR USERNAME'
|
|
75
|
+
config.password = 'YOUR PASSWORD'
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
api_instance = ClickSendClient::GlobalSendingApi.new
|
|
79
|
+
|
|
80
|
+
begin
|
|
81
|
+
#Agree to rules and regulation
|
|
82
|
+
result = api_instance.user_countries_agree_post
|
|
83
|
+
p result
|
|
84
|
+
rescue ClickSendClient::ApiError => e
|
|
85
|
+
puts "Exception when calling GlobalSendingApi->user_countries_agree_post: #{e}"
|
|
86
|
+
end
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
This endpoint does not need any parameter.
|
|
91
|
+
|
|
92
|
+
### Return type
|
|
93
|
+
|
|
94
|
+
**String**
|
|
95
|
+
|
|
96
|
+
### Authorization
|
|
97
|
+
|
|
98
|
+
[BasicAuth](../README.md#BasicAuth)
|
|
99
|
+
|
|
100
|
+
### HTTP request headers
|
|
101
|
+
|
|
102
|
+
- **Content-Type**: application/json
|
|
103
|
+
- **Accept**: application/json
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
# **user_countries_get**
|
|
108
|
+
> String user_countries_get
|
|
109
|
+
|
|
110
|
+
Get Countries for Global Sending
|
|
111
|
+
|
|
112
|
+
Get the list of selected countries.
|
|
113
|
+
|
|
114
|
+
### Example
|
|
115
|
+
```ruby
|
|
116
|
+
# load the gem
|
|
117
|
+
require 'clicksend_client'
|
|
118
|
+
# setup authorization
|
|
119
|
+
ClickSendClient.configure do |config|
|
|
120
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
121
|
+
config.username = 'YOUR USERNAME'
|
|
122
|
+
config.password = 'YOUR PASSWORD'
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
api_instance = ClickSendClient::GlobalSendingApi.new
|
|
126
|
+
|
|
127
|
+
begin
|
|
128
|
+
#Get Countries for Global Sending
|
|
129
|
+
result = api_instance.user_countries_get
|
|
130
|
+
p result
|
|
131
|
+
rescue ClickSendClient::ApiError => e
|
|
132
|
+
puts "Exception when calling GlobalSendingApi->user_countries_get: #{e}"
|
|
133
|
+
end
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
This endpoint does not need any parameter.
|
|
138
|
+
|
|
139
|
+
### Return type
|
|
140
|
+
|
|
141
|
+
**String**
|
|
142
|
+
|
|
143
|
+
### Authorization
|
|
144
|
+
|
|
145
|
+
[BasicAuth](../README.md#BasicAuth)
|
|
146
|
+
|
|
147
|
+
### HTTP request headers
|
|
148
|
+
|
|
149
|
+
- **Content-Type**: application/json
|
|
150
|
+
- **Accept**: application/json
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
# **user_countries_post**
|
|
155
|
+
> String user_countries_post(country_list_ids)
|
|
156
|
+
|
|
157
|
+
Select Countries for Global Sending
|
|
158
|
+
|
|
159
|
+
Use this endpoint to select countries that you intend to send sms / mms to. To remove / unselect a country, just remove the country id from the array in the payload.
|
|
160
|
+
|
|
161
|
+
### Example
|
|
162
|
+
```ruby
|
|
163
|
+
# load the gem
|
|
164
|
+
require 'clicksend_client'
|
|
165
|
+
# setup authorization
|
|
166
|
+
ClickSendClient.configure do |config|
|
|
167
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
168
|
+
config.username = 'YOUR USERNAME'
|
|
169
|
+
config.password = 'YOUR PASSWORD'
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
api_instance = ClickSendClient::GlobalSendingApi.new
|
|
173
|
+
|
|
174
|
+
country_list_ids = ClickSendClient::CountryListIds.new # CountryListIds | Id of countr(ies) you want to select, you can get them from GET /country-list response
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
begin
|
|
178
|
+
#Select Countries for Global Sending
|
|
179
|
+
result = api_instance.user_countries_post(country_list_ids)
|
|
180
|
+
p result
|
|
181
|
+
rescue ClickSendClient::ApiError => e
|
|
182
|
+
puts "Exception when calling GlobalSendingApi->user_countries_post: #{e}"
|
|
183
|
+
end
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Parameters
|
|
187
|
+
|
|
188
|
+
Name | Type | Description | Notes
|
|
189
|
+
------------- | ------------- | ------------- | -------------
|
|
190
|
+
**country_list_ids** | [**CountryListIds**](CountryListIds.md)| Id of countr(ies) you want to select, you can get them from GET /country-list response |
|
|
191
|
+
|
|
192
|
+
### Return type
|
|
193
|
+
|
|
194
|
+
**String**
|
|
195
|
+
|
|
196
|
+
### Authorization
|
|
197
|
+
|
|
198
|
+
[BasicAuth](../README.md#BasicAuth)
|
|
199
|
+
|
|
200
|
+
### HTTP request headers
|
|
201
|
+
|
|
202
|
+
- **Content-Type**: application/json
|
|
203
|
+
- **Accept**: application/json
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
data/docs/InboundSMSRule.md
CHANGED
|
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**action** | **String** | Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE). |
|
|
11
11
|
**action_address** | **String** | Action address. |
|
|
12
12
|
**enabled** | **Float** | Enabled: Disabled=0 or Enabled=1. |
|
|
13
|
+
**webhook_type** | **String** | post, get, or json. post by default | [optional]
|
|
13
14
|
|
|
14
15
|
|
data/docs/MMSApi.md
CHANGED
|
@@ -4,12 +4,129 @@ All URIs are relative to *https://rest.clicksend.com/v3*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**mms_history_export_get**](MMSApi.md#mms_history_export_get) | **GET** /mms/history/export | Export all mms history
|
|
8
|
+
[**mms_history_get**](MMSApi.md#mms_history_get) | **GET** /mms/history | Get all mms history
|
|
7
9
|
[**mms_price_post**](MMSApi.md#mms_price_post) | **POST** /mms/price | Get Price for MMS sent
|
|
8
10
|
[**mms_receipts_get**](MMSApi.md#mms_receipts_get) | **GET** /mms/receipts | Get all delivery receipts
|
|
9
11
|
[**mms_receipts_read_put**](MMSApi.md#mms_receipts_read_put) | **PUT** /mms/receipts-read | Mark delivery receipts as read
|
|
10
12
|
[**mms_send_post**](MMSApi.md#mms_send_post) | **POST** /mms/send | Send MMS
|
|
11
13
|
|
|
12
14
|
|
|
15
|
+
# **mms_history_export_get**
|
|
16
|
+
> String mms_history_export_get(filename)
|
|
17
|
+
|
|
18
|
+
Export all mms history
|
|
19
|
+
|
|
20
|
+
Export all mms history
|
|
21
|
+
|
|
22
|
+
### Example
|
|
23
|
+
```ruby
|
|
24
|
+
# load the gem
|
|
25
|
+
require 'clicksend_client'
|
|
26
|
+
# setup authorization
|
|
27
|
+
ClickSendClient.configure do |config|
|
|
28
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
29
|
+
config.username = 'YOUR USERNAME'
|
|
30
|
+
config.password = 'YOUR PASSWORD'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = ClickSendClient::MMSApi.new
|
|
34
|
+
|
|
35
|
+
filename = 'filename_example' # String | Filename to download history as
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
begin
|
|
39
|
+
#Export all mms history
|
|
40
|
+
result = api_instance.mms_history_export_get(filename)
|
|
41
|
+
p result
|
|
42
|
+
rescue ClickSendClient::ApiError => e
|
|
43
|
+
puts "Exception when calling MMSApi->mms_history_export_get: #{e}"
|
|
44
|
+
end
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
Name | Type | Description | Notes
|
|
50
|
+
------------- | ------------- | ------------- | -------------
|
|
51
|
+
**filename** | **String**| Filename to download history as |
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
**String**
|
|
56
|
+
|
|
57
|
+
### Authorization
|
|
58
|
+
|
|
59
|
+
[BasicAuth](../README.md#BasicAuth)
|
|
60
|
+
|
|
61
|
+
### HTTP request headers
|
|
62
|
+
|
|
63
|
+
- **Content-Type**: application/json
|
|
64
|
+
- **Accept**: application/json
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
# **mms_history_get**
|
|
69
|
+
> String mms_history_get(opts)
|
|
70
|
+
|
|
71
|
+
Get all mms history
|
|
72
|
+
|
|
73
|
+
Get all mms history
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
```ruby
|
|
77
|
+
# load the gem
|
|
78
|
+
require 'clicksend_client'
|
|
79
|
+
# setup authorization
|
|
80
|
+
ClickSendClient.configure do |config|
|
|
81
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
82
|
+
config.username = 'YOUR USERNAME'
|
|
83
|
+
config.password = 'YOUR PASSWORD'
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
api_instance = ClickSendClient::MMSApi.new
|
|
87
|
+
|
|
88
|
+
opts = {
|
|
89
|
+
q: 'q_example', # String | Custom query Example: from:{number},status_code:201.
|
|
90
|
+
date_from: 56, # Integer | Start date
|
|
91
|
+
date_to: 56, # Integer | End date
|
|
92
|
+
page: 1, # Integer | Page number
|
|
93
|
+
limit: 10 # Integer | Number of records per page
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
begin
|
|
97
|
+
#Get all mms history
|
|
98
|
+
result = api_instance.mms_history_get(opts)
|
|
99
|
+
p result
|
|
100
|
+
rescue ClickSendClient::ApiError => e
|
|
101
|
+
puts "Exception when calling MMSApi->mms_history_get: #{e}"
|
|
102
|
+
end
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Parameters
|
|
106
|
+
|
|
107
|
+
Name | Type | Description | Notes
|
|
108
|
+
------------- | ------------- | ------------- | -------------
|
|
109
|
+
**q** | **String**| Custom query Example: from:{number},status_code:201. | [optional]
|
|
110
|
+
**date_from** | **Integer**| Start date | [optional]
|
|
111
|
+
**date_to** | **Integer**| End date | [optional]
|
|
112
|
+
**page** | **Integer**| Page number | [optional] [default to 1]
|
|
113
|
+
**limit** | **Integer**| Number of records per page | [optional] [default to 10]
|
|
114
|
+
|
|
115
|
+
### Return type
|
|
116
|
+
|
|
117
|
+
**String**
|
|
118
|
+
|
|
119
|
+
### Authorization
|
|
120
|
+
|
|
121
|
+
[BasicAuth](../README.md#BasicAuth)
|
|
122
|
+
|
|
123
|
+
### HTTP request headers
|
|
124
|
+
|
|
125
|
+
- **Content-Type**: application/json
|
|
126
|
+
- **Accept**: application/json
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
13
130
|
# **mms_price_post**
|
|
14
131
|
> String mms_price_post(mms_messages)
|
|
15
132
|
|
data/docs/MmsCampaign.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**list_id** | **Integer** | Your list id. |
|
|
7
7
|
**name** | **String** | Your campaign name. |
|
|
8
8
|
**body** | **String** | Your campaign message. |
|
|
9
|
-
**from** | **String** | Your sender id - more info:
|
|
9
|
+
**from** | **String** | Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids. | [optional]
|
|
10
10
|
**schedule** | **Integer** | Your schedule timestamp. | [optional] [default to 0]
|
|
11
11
|
**subject** | **String** | Subject of MMS campaign. |
|
|
12
12
|
**media_file** | **String** | URL pointing to media file. |
|
data/docs/MmsMessage.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**to** | **String** | Recipient phone number in E.164 format |
|
|
6
|
+
**to** | **String** | Recipient phone number in E.164 format | [optional]
|
|
7
7
|
**body** | **String** | Your message |
|
|
8
8
|
**subject** | **String** | Subject line (max 20 characters) |
|
|
9
9
|
**from** | **String** | Your sender ID | [optional]
|
data/docs/SMSApi.md
CHANGED
|
@@ -731,7 +731,7 @@ Name | Type | Description | Notes
|
|
|
731
731
|
|
|
732
732
|
Send sms message(s)
|
|
733
733
|
|
|
734
|
-
# Send one or more SMS messages You can post up to 1000 messages with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains status and details for each recipient. *Refer to [Application Status Codes](https://
|
|
734
|
+
# Send one or more SMS messages You can post up to 1000 messages with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains status and details for each recipient. *Refer to [Application Status Codes](https://developers.clicksend.com/docs/#application-status-codes) for the possible response message status strings.*
|
|
735
735
|
|
|
736
736
|
### Example
|
|
737
737
|
```ruby
|
data/docs/SmsCampaign.md
CHANGED
|
@@ -6,7 +6,8 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**list_id** | **Integer** | Your list id. |
|
|
7
7
|
**name** | **String** | Your campaign name. |
|
|
8
8
|
**body** | **String** | Your campaign message. |
|
|
9
|
-
**from** | **String** | Your sender id - more info:
|
|
9
|
+
**from** | **String** | Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids. | [optional]
|
|
10
10
|
**schedule** | **Integer** | Your schedule timestamp. | [optional] [default to 0]
|
|
11
|
+
**url_to_shorten** | **String** | url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder. | [optional]
|
|
11
12
|
|
|
12
13
|
|
data/docs/SmsMessage.md
CHANGED
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**from** | **String** | Your sender id - more info:
|
|
6
|
+
**from** | **String** | Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids. | [optional]
|
|
7
7
|
**body** | **String** | Your message. |
|
|
8
|
-
**to** | **String** | Recipient phone number in E.164 format. |
|
|
8
|
+
**to** | **String** | Recipient phone number in E.164 format. | [optional]
|
|
9
9
|
**source** | **String** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk']
|
|
10
|
-
**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format
|
|
10
|
+
**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp | [optional] [default to 0]
|
|
11
11
|
**custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. | [optional]
|
|
12
12
|
**list_id** | **Integer** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional]
|
|
13
13
|
**country** | **String** | Recipient country. | [optional]
|
data/docs/VoiceMessage.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**to** | **String** | Your phone number in E.164 format. |
|
|
6
|
+
**to** | **String** | Your phone number in E.164 format. | [optional]
|
|
7
7
|
**body** | **String** | Biscuit uv3nlCOjRk croissant chocolate lollipop chocolate muffin. |
|
|
8
8
|
**voice** | **String** | Either 'female' or 'male'. |
|
|
9
9
|
**custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. |
|
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**source** | **String** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk']
|
|
12
12
|
**list_id** | **Integer** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional]
|
|
13
13
|
**lang** | **String** | au (string, required) - See section on available languages. | [optional]
|
|
14
|
-
**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format
|
|
14
|
+
**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp | [optional]
|
|
15
15
|
**require_input** | **Integer** | Whether you want to receive a keypress from the call recipient | [optional] [default to 0]
|
|
16
16
|
**machine_detection** | **Integer** | Whether to attempt to detect an answering machine or voicemail service and leave a message | [optional] [default to 0]
|
|
17
17
|
|