clicksend_client 5.0.75 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fea9a103b66f723924a61f641b6f4e02c8cff360fa3eb7ff4e83a46a683ee81d
-  data.tar.gz: c1b5855a730451466fce5679441ebd760eddcea02c2d2698916c31983727716c
+  metadata.gz: 181d1e2f83d007446caf8fe730cda04b27077ae1d3434f6ded912e9a2648534d
+  data.tar.gz: f802cb8b0b67a6cf8d9f57ec8d5a7290f6c96a356418e5fcdec453330d0cb457
 SHA512:
-  metadata.gz: d3e98ead8bf538aa31ebef0fffab66b04348a925f5046fe9d9b317b40d71299db5799627828faaa0b0d82e84dfa46450c86545fc835a20d361fc2243d7d04a0a
-  data.tar.gz: baf0294f79f31937a0349caafac0d521bf89860641e80dcff70c61a74a5a12e8bae69a1cd473e32e18651cc06b20c869b068bc21f0f10df4b8d5f97b883c9bc1
+  metadata.gz: 0d80a55007c22f60f656e06627c3e606b9f59d9bcb4c2849aad7c430604bebbfe500e854a1d4db8448c798c1426d742379908d2530ac03541455b0cb3b55d84a
+  data.tar.gz: c5ade6e08ee9bac732742b661212ef09a5a49b06e9c984b53cfa728acb090ad1930f696ebe229bc45404d9c1af10aeac8ad7072192878112dfc545dfb122b6d5

data/clicksend_client.gemspec

@@ -8,7 +8,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/docs/ContactApi.md

@@ -209,7 +209,8 @@ list_id = 56 # Integer | Contact list ID
 
 opts = { 
   page: 1, # Integer | Page number
-  limit: 10 # Integer | Number of records per page
+  limit: 10, # Integer | Number of records per page
+  updated_after: 10 # Integer | Get all contacts updated after a given timestamp.
 }
 
 begin
@@ -228,6 +229,7 @@ Name | Type | Description  | Notes
  **list_id** | **Integer**| Contact list ID | 
  **page** | **Integer**| Page number | [optional] [default to 1]
  **limit** | **Integer**| Number of records per page | [optional] [default to 10]
+ **updated_after** | **Integer**| Get all contacts updated after a given timestamp. | [optional] [default to 10]
 
 ### Return type
 

data/docs/CountryListIds.md

@@ -0,0 +1,8 @@
+# ClickSendClient::CountryListIds
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_list_ids** | **Array<Integer>** | Array of country ids | 
+
+

data/docs/FaxMessage.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **to** | **String** | Recipient fax number in E.164 format. | 
 **list_id** | **Integer** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional] 
 **from** | **String** | Your sender id. Must be a valid fax number. | [optional] 
-**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp | [optional] 
+**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] 
 **custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. | [optional] 
 **country** | **String** | Recipient country. | [optional] 
 **from_email** | **String** | An email address where the reply should be emailed to. | [optional] 

data/docs/GlobalSendingApi.md

@@ -0,0 +1,206 @@
+# ClickSendClient::GlobalSendingApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_countries_get**](GlobalSendingApi.md#list_countries_get) | **GET** /country-list | List of countries
+[**user_countries_agree_post**](GlobalSendingApi.md#user_countries_agree_post) | **POST** /user-countries/agree | Agree to rules and regulation
+[**user_countries_get**](GlobalSendingApi.md#user_countries_get) | **GET** /user-countries | Get Countries for Global Sending
+[**user_countries_post**](GlobalSendingApi.md#user_countries_post) | **POST** /user-countries | Select Countries for Global Sending
+
+
+# **list_countries_get**
+> String list_countries_get
+
+List of countries
+
+List of countries with IDs that can be used in selecting countries for Global sending.
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::GlobalSendingApi.new
+
+begin
+  #List of countries
+  result = api_instance.list_countries_get
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling GlobalSendingApi->list_countries_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **user_countries_agree_post**
+> String user_countries_agree_post
+
+Agree to rules and regulation
+
+To agree on rules and regulations of selected countries and confirm selection.
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::GlobalSendingApi.new
+
+begin
+  #Agree to rules and regulation
+  result = api_instance.user_countries_agree_post
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling GlobalSendingApi->user_countries_agree_post: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **user_countries_get**
+> String user_countries_get
+
+Get Countries for Global Sending
+
+Get the list of selected countries.
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::GlobalSendingApi.new
+
+begin
+  #Get Countries for Global Sending
+  result = api_instance.user_countries_get
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling GlobalSendingApi->user_countries_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **user_countries_post**
+> String user_countries_post(country_list_ids)
+
+Select Countries for Global Sending
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::GlobalSendingApi.new
+
+country_list_ids = ClickSendClient::CountryListIds.new # CountryListIds | Id of countr(ies) you want to select, you can get them from GET /country-list response
+
+
+begin
+  #Select Countries for Global Sending
+  result = api_instance.user_countries_post(country_list_ids)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling GlobalSendingApi->user_countries_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **country_list_ids** | [**CountryListIds**](CountryListIds.md)| Id of countr(ies) you want to select, you can get them from GET /country-list response | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/MmsCampaign.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **list_id** | **Integer** | Your list id. | 
 **name** | **String** | Your campaign name. | 
 **body** | **String** | Your campaign message. | 
-**from** | **String** | Your sender id - more info: http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number. | [optional] 
+**from** | **String** | Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids. | [optional] 
 **schedule** | **Integer** | Your schedule timestamp. | [optional] [default to 0]
 **subject** | **String** | Subject of MMS campaign. | 
 **media_file** | **String** | URL pointing to media file. | 

data/docs/SMSApi.md

@@ -731,7 +731,7 @@ Name | Type | Description  | Notes
 
 Send sms message(s)
 
- # 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://dashboard.clicksend.com/#/signup/step1/) for the possible response message status strings.* 
+ # 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.* 
 
 ### Example
 ```ruby

data/docs/SmsCampaign.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **list_id** | **Integer** | Your list id. | 
 **name** | **String** | Your campaign name. | 
 **body** | **String** | Your campaign message. | 
-**from** | **String** | Your sender id - more info: http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number. | [optional] 
+**from** | **String** | Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids. | [optional] 
 **schedule** | **Integer** | Your schedule timestamp. | [optional] [default to 0]
 **url_to_shorten** | **String** | url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder. | [optional] 
 

data/docs/SmsMessage.md

@@ -3,11 +3,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**from** | **String** | Your sender id - more info: http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number. | [optional] 
+**from** | **String** | Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids. | [optional] 
 **body** | **String** | Your message. | 
 **to** | **String** | Recipient phone number in E.164 format. | [optional] 
 **source** | **String** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk']
-**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp | [optional] [default to 0]
+**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]
 **custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. | [optional] 
 **list_id** | **Integer** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional] 
 **country** | **String** | Recipient country. | [optional] 

data/docs/VoiceMessage.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **source** | **String** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk']
 **list_id** | **Integer** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional] 
 **lang** | **String** | au (string, required) - See section on available languages. | [optional] 
-**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp | [optional] 
+**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] 
 **require_input** | **Integer** | Whether you want to receive a keypress from the call recipient | [optional] [default to 0]
 **machine_detection** | **Integer** | Whether to attempt to detect an answering machine or voicemail service and leave a message | [optional] [default to 0]
 

data/lib/clicksend_client/api/account_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/account_recharge_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/contact_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 
@@ -211,6 +211,7 @@ module ClickSendClient
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Page number (default to 1)
     # @option opts [Integer] :limit Number of records per page (default to 10)
+    # @option opts [Integer] :updated_after Get all contacts updated after a given timestamp. (default to 10)
     # @return [String]
     def lists_contacts_by_list_id_get(list_id, opts = {})
       data, _status_code, _headers = lists_contacts_by_list_id_get_with_http_info(list_id, opts)
@@ -223,6 +224,7 @@ module ClickSendClient
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :limit Number of records per page
+    # @option opts [Integer] :updated_after Get all contacts updated after a given timestamp.
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def lists_contacts_by_list_id_get_with_http_info(list_id, opts = {})
       if @api_client.config.debugging
@@ -240,6 +242,10 @@ module ClickSendClient
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactApi.lists_contacts_by_list_id_get, must be greater than or equal to 1.'
       end
 
+      if @api_client.config.client_side_validation && !opts[:'updated_after'].nil? && opts[:'updated_after'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"updated_after"]" when calling ContactApi.lists_contacts_by_list_id_get, must be greater than or equal to 1.'
+      end
+
       # resource path
       local_var_path = '/lists/{list_id}/contacts'.sub('{' + 'list_id' + '}', list_id.to_s)
 
@@ -247,6 +253,7 @@ module ClickSendClient
       query_params = {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'updated_after'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?
 
       # header parameters
       header_params = {}

data/lib/clicksend_client/api/contact_list_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/countries_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/delivery_issues_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/detect_address_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/email_delivery_receipt_rules_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/email_marketing_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/email_to_sms_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/fax_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.22-SNAPSHOT
+ClickSend Codegen version: 2.4.53-SNAPSHOT
 
 =end