clicksend_client 1.0.2 → 5.0.75

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346858ef68ae591b2808e36a2f2e2e82ba6e20542e57c903ec86ec27036b6110
-  data.tar.gz: d69a4f507734356cff41be11825a82f67b9dca8ab9a4ae1e41c41533a5cd1387
+  metadata.gz: fea9a103b66f723924a61f641b6f4e02c8cff360fa3eb7ff4e83a46a683ee81d
+  data.tar.gz: c1b5855a730451466fce5679441ebd760eddcea02c2d2698916c31983727716c
 SHA512:
-  metadata.gz: 40e50129fe673825732e925dd034e4a733f7ace22b7ea79371a2362c42c1ee353883435d53328b9d849a6cabbb80c7ab3cffcabc5f4af075d33238908b8f7356
-  data.tar.gz: b33f4ade93f89d5145530321f3949a72f72958c01b1386d516fc82f06213a7a52903b87c4b415f2124c8cae0dd7ee9b1c07480c40a1c9abe7e86e179c1ed94d8
+  metadata.gz: d3e98ead8bf538aa31ebef0fffab66b04348a925f5046fe9d9b317b40d71299db5799627828faaa0b0d82e84dfa46450c86545fc835a20d361fc2243d7d04a0a
+  data.tar.gz: baf0294f79f31937a0349caafac0d521bf89860641e80dcff70c61a74a5a12e8bae69a1cd473e32e18651cc06b20c869b068bc21f0f10df4b8d5f97b883c9bc1

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 12.3.3'
 end

data/README.md

@@ -1,6 +1,12 @@
 # The official ruby library for ClickSend v3 API
 
- 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/)..* 
+
+This is the official [ClickSend](https://clicksend.com) SDK. Documentation can be found [here](https://developers.clicksend.com/docs/rest/v3/?ruby#introduction).
+
+## Requirements
+
+- [Sign Up](https://www.clicksend.com/signup) for a free ClickSend account.
+- Copy your API key from the [API Credentials](https://dashboard.clicksend.com/#/account/subaccount) area.
 
 ## Installation
 
@@ -65,9 +71,9 @@ end
 
 ```
 
-## Documentation for API Endpoints and Models
+## Documentation
 
-Documentation can be found here: [ClickSend API Docs](https://developers.clicksend.com/docs/)
+Documentation for our SDK and REST API can be found [here](https://developers.clicksend.com/docs/rest/v3/?ruby#introduction).
 
 ## Documentation for Authorization
 

data/clicksend_client.gemspec

@@ -3,12 +3,12 @@
 =begin
 #ClickSend v3 API
 
-# 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/)..* 
+# 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/)..* 
 
 OpenAPI spec version: 3.1
 Contact: support@clicksend.com
 Generated by: https://github.com/clicksend-api/clicksend-codegen.git
-ClickSend Codegen version: 2.4.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-SNAPSHOT
 
 =end
 
@@ -23,12 +23,13 @@ Gem::Specification.new do |s|
   s.email       = ["support@clicksend.com"]
   s.homepage    = "https://github.com/clicksend-api/clicksend-codegen"
   s.summary     = "ClickSend v3 API Ruby Gem"
-  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/)..* "
+  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/)..* "
   s.license     = "Unlicense"
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+  s.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'

data/docs/ContactApi.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**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
 [**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
 [**lists_contacts_by_list_id_post**](ContactApi.md#lists_contacts_by_list_id_post) | **POST** /lists/{list_id}/contacts | Create new contact
+[**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
 [**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
 [**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
 
@@ -299,6 +300,65 @@ Name | Type | Description  | Notes
 
 
 
+# **lists_copy_contact_put**
+> String lists_copy_contact_put(from_list_id, contact_id, to_list_id)
+
+Copy contact to another list
+
+Copy contact to another list
+
+### 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::ContactApi.new
+
+from_list_id = 56 # Integer | List ID for list that contains contact.
+
+contact_id = 56 # Integer | Contact ID
+
+to_list_id = 56 # Integer | List ID for list you want to copy the contact to.
+
+
+begin
+  #Copy contact to another list
+  result = api_instance.lists_copy_contact_put(from_list_id, contact_id, to_list_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling ContactApi->lists_copy_contact_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **from_list_id** | **Integer**| List ID for list that contains contact. | 
+ **contact_id** | **Integer**| Contact ID | 
+ **to_list_id** | **Integer**| List ID for list you want to copy the contact to. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put**
 > String lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put(list_id, opt_out_list_id)
 

data/docs/InboundSMSRule.md

@@ -10,5 +10,6 @@ Name | Type | Description | Notes
 **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). | 
 **action_address** | **String** | Action address. | 
 **enabled** | **Float** | Enabled: Disabled=0 or Enabled=1. | 
+**webhook_type** | **String** | post, get, or json. post by default | [optional] 
 
 

data/docs/MMSApi.md

@@ -4,12 +4,129 @@ All URIs are relative to *https://rest.clicksend.com/v3*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**mms_history_export_get**](MMSApi.md#mms_history_export_get) | **GET** /mms/history/export | Export all mms history
+[**mms_history_get**](MMSApi.md#mms_history_get) | **GET** /mms/history | Get all mms history
 [**mms_price_post**](MMSApi.md#mms_price_post) | **POST** /mms/price | Get Price for MMS sent
 [**mms_receipts_get**](MMSApi.md#mms_receipts_get) | **GET** /mms/receipts | Get all delivery receipts
 [**mms_receipts_read_put**](MMSApi.md#mms_receipts_read_put) | **PUT** /mms/receipts-read | Mark delivery receipts as read
 [**mms_send_post**](MMSApi.md#mms_send_post) | **POST** /mms/send | Send MMS
 
 
+# **mms_history_export_get**
+> String mms_history_export_get(filename)
+
+Export all mms history
+
+Export all mms history
+
+### 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::MMSApi.new
+
+filename = 'filename_example' # String | Filename to download history as
+
+
+begin
+  #Export all mms history
+  result = api_instance.mms_history_export_get(filename)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MMSApi->mms_history_export_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filename** | **String**| Filename to download history as | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **mms_history_get**
+> String mms_history_get(opts)
+
+Get all mms history
+
+Get all mms history
+
+### 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::MMSApi.new
+
+opts = { 
+  q: 'q_example', # String | Custom query Example: from:{number},status_code:201.
+  date_from: 56, # Integer | Start date
+  date_to: 56, # Integer | End date
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all mms history
+  result = api_instance.mms_history_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MMSApi->mms_history_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q** | **String**| Custom query Example: from:{number},status_code:201. | [optional] 
+ **date_from** | **Integer**| Start date | [optional] 
+ **date_to** | **Integer**| End date | [optional] 
+ **page** | **Integer**| Page number | [optional] [default to 1]
+ **limit** | **Integer**| Number of records per page | [optional] [default to 10]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **mms_price_post**
 > String mms_price_post(mms_messages)
 

data/docs/MmsMessage.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**to** | **String** | Recipient phone number in E.164 format | 
+**to** | **String** | Recipient phone number in E.164 format | [optional] 
 **body** | **String** | Your message | 
 **subject** | **String** | Subject line (max 20 characters) | 
 **from** | **String** | Your sender ID | [optional] 

data/docs/SmsCampaign.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **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] 
 **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

@@ -5,7 +5,7 @@ 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] 
 **body** | **String** | Your message. | 
-**to** | **String** | Recipient phone number in E.164 format. | 
+**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]
 **custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. | [optional] 

data/docs/VoiceMessage.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**to** | **String** | Your phone number in E.164 format. | 
+**to** | **String** | Your phone number in E.164 format. | [optional] 
 **body** | **String** | Biscuit uv3nlCOjRk croissant chocolate lollipop chocolate muffin. | 
 **voice** | **String** | Either 'female' or 'male'. | 
 **custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. | 

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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-SNAPSHOT
 
 =end
 
@@ -333,6 +333,72 @@ module ClickSendClient
       end
       return data, status_code, headers
     end
+    # Copy contact to another list
+    # Copy contact to another list
+    # @param from_list_id List ID for list that contains contact.
+    # @param contact_id Contact ID
+    # @param to_list_id List ID for list you want to copy the contact to.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def lists_copy_contact_put(from_list_id, contact_id, to_list_id, opts = {})
+      data, _status_code, _headers = lists_copy_contact_put_with_http_info(from_list_id, contact_id, to_list_id, opts)
+      data
+    end
+
+    # Copy contact to another list
+    # Copy contact to another list
+    # @param from_list_id List ID for list that contains contact.
+    # @param contact_id Contact ID
+    # @param to_list_id List ID for list you want to copy the contact to.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def lists_copy_contact_put_with_http_info(from_list_id, contact_id, to_list_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContactApi.lists_copy_contact_put ...'
+      end
+      # verify the required parameter 'from_list_id' is set
+      if @api_client.config.client_side_validation && from_list_id.nil?
+        fail ArgumentError, "Missing the required parameter 'from_list_id' when calling ContactApi.lists_copy_contact_put"
+      end
+      # verify the required parameter 'contact_id' is set
+      if @api_client.config.client_side_validation && contact_id.nil?
+        fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactApi.lists_copy_contact_put"
+      end
+      # verify the required parameter 'to_list_id' is set
+      if @api_client.config.client_side_validation && to_list_id.nil?
+        fail ArgumentError, "Missing the required parameter 'to_list_id' when calling ContactApi.lists_copy_contact_put"
+      end
+      # resource path
+      local_var_path = '/lists/{from_list_id}/contacts/{contact_id}/copy/{to_list_id}'.sub('{' + 'from_list_id' + '}', from_list_id.to_s).sub('{' + 'contact_id' + '}', contact_id.to_s).sub('{' + 'to_list_id' + '}', to_list_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['BasicAuth']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ContactApi#lists_copy_contact_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Remove all opted out contacts
     # Remove all opted out contacts
     # @param list_id Your list id

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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/inbound_fax_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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/inbound_sms_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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-SNAPSHOT
 
 =end
 

data/lib/clicksend_client/api/master_email_templates_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.1-SNAPSHOT
+ClickSend Codegen version: 2.4.22-SNAPSHOT
 
 =end