sendx-ruby-sdk 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4066535e320b8ed263c20f167a540080a3cfbaacf8a152197d5c297c46e901b2
-  data.tar.gz: 4b0744839d25cb6fa06b94fd8bbf7fdc8bfd944187d02b6adfad54c393e07493
+  metadata.gz: 3a42a2cd69e7b9ea8e4162a38183effa20ede3c7954be0281883f927d29387df
+  data.tar.gz: 3831f17146ae2e3d23043f0e8ede428a85e8118b27c4c3cc2337a178d22f8472
 SHA512:
-  metadata.gz: 90c5dc5dbcb638d030ec9da67b25154128c91e59d8506a528a0ff0704489b77a5381483b77419bb86c4a42925c9a468810d261f4c6a838ebeed05acfc6afe97a
-  data.tar.gz: 196718d49b9884f6e0cc8fe3b577c3379b04487f01a75b88f3b56b39a8ebc9c22705b9f26835f33b547c445d410483c7f06cfadbb4b727e4d353b8931277580e
+  metadata.gz: 9212032cb16a569bd2a394a1f87bb8e27b0fb08dc363b363d43f910b5413ff614a6e335d9dcec11930b9ff2fb3f885317d871daa1883c2aefc654709fe71f5ca
+  data.tar.gz: 17bb196b661df70d5180214f73e90e9ff224df8eaab050bf36b44e3f9c116ee34d180b79d62f1c858d0287410b69b82f8270476663f2d8e9e1fd0c96e70cca7e

data/README.md

@@ -1,8 +1,8 @@
-# sendx-ruby-sdk
+# SendX Ruby SDK
 
 SendX - the Ruby gem for the SendX REST API
 
-# Introduction 
+## Introduction 
 
 SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. 
 
@@ -14,29 +14,26 @@ The SendX Rest API doesn’t support bulk updates. You can work on only one obje
 
 ### Build a gem
 
-To build the Ruby code into a gem:
 
-```shell
-gem build sendx-ruby-sdk.gemspec
-```
-
-Then either install the gem locally:
+To install the gem:
 
+Install via command line
 ```shell
-gem install ./sendx-ruby-sdk-1.0.0.gem
+gem install sendx-ruby-sdk
 ```
 
-(for development, run `gem install --dev ./sendx-ruby-sdk-1.0.0.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+Install via Gemfile
 
-Finally add this to the Gemfile:
+```ruby
+source "https://rubygems.pkg.github.com/sendx" do
+  gem "sendx-ruby-sdk", "1.0.1"
+end
+```
 
-    gem 'sendx-ruby-sdk', '~> 1.0.0'
 
 ### Install from Git
 
-If the Ruby gem is hosted at a git repository: https://github.com/sendx/sendx-ruby-sdk, then add the following in the Gemfile:
+The Ruby gem is hosted at a git repository: https://github.com/sendx/sendx-ruby-sdk, add the following in the Gemfile:
 
     gem 'sendx-ruby-sdk', :git => 'https://github.com/sendx/sendx-ruby-sdk.git'
 

data/lib/sendx-ruby-sdk/api/contact_api.rb

@@ -89,29 +89,29 @@ module SendX
 
     # Delete Contact
     # Deletes Contact
-    # @param contact_id [String] The Contact ID to delete
+    # @param identifier [String] The Contact ID/ Email to delete
     # @param [Hash] opts the optional parameters
     # @return [Response]
-    def delete_contact(contact_id, opts = {})
-      data, _status_code, _headers = delete_contact_with_http_info(contact_id, opts)
+    def delete_contact(identifier, opts = {})
+      data, _status_code, _headers = delete_contact_with_http_info(identifier, opts)
       data
     end
 
     # Delete Contact
     # Deletes Contact
-    # @param contact_id [String] The Contact ID to delete
+    # @param identifier [String] The Contact ID/ Email to delete
     # @param [Hash] opts the optional parameters
     # @return [Array<(Response, Integer, Hash)>] Response data, response status code and response headers
-    def delete_contact_with_http_info(contact_id, opts = {})
+    def delete_contact_with_http_info(identifier, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContactApi.delete_contact ...'
       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.delete_contact"
+      # verify the required parameter 'identifier' is set
+      if @api_client.config.client_side_validation && identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactApi.delete_contact"
       end
       # resource path
-      local_var_path = '/contact/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))
+      local_var_path = '/contact/{identifier}'.sub('{' + 'identifier' + '}', CGI.escape(identifier.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -223,31 +223,31 @@ module SendX
       return data, status_code, headers
     end
 
-    # Get Contact by ID
-    # Retrieve a specific contact by its contactId.
-    # @param contact_id [String] The ID of the contact to retrieve.
+    # Get Contact by Identifier
+    # Retrieve a specific contact by its identifier.
+    # @param identifier [String] The ID or Email of the contact to retrieve.
     # @param [Hash] opts the optional parameters
     # @return [Contact]
-    def get_contact_by_id(contact_id, opts = {})
-      data, _status_code, _headers = get_contact_by_id_with_http_info(contact_id, opts)
+    def get_contact_by_id(identifier, opts = {})
+      data, _status_code, _headers = get_contact_by_id_with_http_info(identifier, opts)
       data
     end
 
-    # Get Contact by ID
-    # Retrieve a specific contact by its contactId.
-    # @param contact_id [String] The ID of the contact to retrieve.
+    # Get Contact by Identifier
+    # Retrieve a specific contact by its identifier.
+    # @param identifier [String] The ID or Email of the contact to retrieve.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Contact, Integer, Hash)>] Contact data, response status code and response headers
-    def get_contact_by_id_with_http_info(contact_id, opts = {})
+    def get_contact_by_id_with_http_info(identifier, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContactApi.get_contact_by_id ...'
       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.get_contact_by_id"
+      # verify the required parameter 'identifier' is set
+      if @api_client.config.client_side_validation && identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactApi.get_contact_by_id"
       end
       # resource path
-      local_var_path = '/contact/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))
+      local_var_path = '/contact/{identifier}'.sub('{' + 'identifier' + '}', CGI.escape(identifier.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -288,29 +288,29 @@ module SendX
 
     # Unsubscribe Contact
     # Unsubscribe a globally existing contact
-    # @param contact_id [String] The Contact ID to unsubscribe
+    # @param identifier [String] The Contact ID or email to unsubscribe
     # @param [Hash] opts the optional parameters
     # @return [Response]
-    def unsubscribe_contact(contact_id, opts = {})
-      data, _status_code, _headers = unsubscribe_contact_with_http_info(contact_id, opts)
+    def unsubscribe_contact(identifier, opts = {})
+      data, _status_code, _headers = unsubscribe_contact_with_http_info(identifier, opts)
       data
     end
 
     # Unsubscribe Contact
     # Unsubscribe a globally existing contact
-    # @param contact_id [String] The Contact ID to unsubscribe
+    # @param identifier [String] The Contact ID or email to unsubscribe
     # @param [Hash] opts the optional parameters
     # @return [Array<(Response, Integer, Hash)>] Response data, response status code and response headers
-    def unsubscribe_contact_with_http_info(contact_id, opts = {})
+    def unsubscribe_contact_with_http_info(identifier, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContactApi.unsubscribe_contact ...'
       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.unsubscribe_contact"
+      # verify the required parameter 'identifier' is set
+      if @api_client.config.client_side_validation && identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactApi.unsubscribe_contact"
       end
       # resource path
-      local_var_path = '/contact/unsubscribe/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))
+      local_var_path = '/contact/unsubscribe/{identifier}'.sub('{' + 'identifier' + '}', CGI.escape(identifier.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -352,21 +352,21 @@ module SendX
     # Update Contact
     # Update Contact with given data
     # @param contact_request [ContactRequest] 
-    # @param contact_id [String] The ID of the Contact to update
+    # @param identifier [String] The ID or email of the Contact to update
     # @param [Hash] opts the optional parameters
     # @return [Contact]
-    def update_contact(contact_request, contact_id, opts = {})
-      data, _status_code, _headers = update_contact_with_http_info(contact_request, contact_id, opts)
+    def update_contact(contact_request, identifier, opts = {})
+      data, _status_code, _headers = update_contact_with_http_info(contact_request, identifier, opts)
       data
     end
 
     # Update Contact
     # Update Contact with given data
     # @param contact_request [ContactRequest] 
-    # @param contact_id [String] The ID of the Contact to update
+    # @param identifier [String] The ID or email of the Contact to update
     # @param [Hash] opts the optional parameters
     # @return [Array<(Contact, Integer, Hash)>] Contact data, response status code and response headers
-    def update_contact_with_http_info(contact_request, contact_id, opts = {})
+    def update_contact_with_http_info(contact_request, identifier, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContactApi.update_contact ...'
       end
@@ -374,12 +374,12 @@ module SendX
       if @api_client.config.client_side_validation && contact_request.nil?
         fail ArgumentError, "Missing the required parameter 'contact_request' when calling ContactApi.update_contact"
       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.update_contact"
+      # verify the required parameter 'identifier' is set
+      if @api_client.config.client_side_validation && identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactApi.update_contact"
       end
       # resource path
-      local_var_path = '/contact/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))
+      local_var_path = '/contact/{identifier}'.sub('{' + 'identifier' + '}', CGI.escape(identifier.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/sendx-ruby-sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.8.0
 =end
 
 module SendX
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendx-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - SendX
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus