sendx-ruby-sdk 1.0.1

data/lib/sendx-ruby-sdk/models/tag_request.rb

@@ -0,0 +1,214 @@
+=begin
+#SendX REST API
+
+## 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. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br> 
+
+The version of the OpenAPI document: 1.0.1
+Contact: support@sendx.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SendX
+  class TagRequest
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SendX::TagRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SendX::TagRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = SendX.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,15 @@
+=begin
+#SendX REST API
+
+## 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. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br> 
+
+The version of the OpenAPI document: 1.0.1
+Contact: support@sendx.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+module SendX
+  VERSION = '1.0.1'
+end

data/lib/sendx-ruby-sdk.rb

@@ -0,0 +1,65 @@
+=begin
+#SendX REST API
+
+## 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. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br> 
+
+The version of the OpenAPI document: 1.0.1
+Contact: support@sendx.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+# Common files
+require 'sendx-ruby-sdk/api_client'
+require 'sendx-ruby-sdk/api_error'
+require 'sendx-ruby-sdk/version'
+require 'sendx-ruby-sdk/configuration'
+
+# Models
+require 'sendx-ruby-sdk/models/campaign'
+require 'sendx-ruby-sdk/models/campaign_dashboard_data'
+require 'sendx-ruby-sdk/models/campaign_request'
+require 'sendx-ruby-sdk/models/contact'
+require 'sendx-ruby-sdk/models/contact_request'
+require 'sendx-ruby-sdk/models/create_response'
+require 'sendx-ruby-sdk/models/dashboard_stats'
+require 'sendx-ruby-sdk/models/delete_campaign200_response'
+require 'sendx-ruby-sdk/models/delete_request'
+require 'sendx-ruby-sdk/models/delete_response'
+require 'sendx-ruby-sdk/models/last_sent_campaign_stat'
+require 'sendx-ruby-sdk/models/list_model'
+require 'sendx-ruby-sdk/models/list_request'
+require 'sendx-ruby-sdk/models/report_data'
+require 'sendx-ruby-sdk/models/response'
+require 'sendx-ruby-sdk/models/sender'
+require 'sendx-ruby-sdk/models/sender_request'
+require 'sendx-ruby-sdk/models/sender_response'
+require 'sendx-ruby-sdk/models/tag'
+require 'sendx-ruby-sdk/models/tag_request'
+
+# APIs
+require 'sendx-ruby-sdk/api/campaign_api'
+require 'sendx-ruby-sdk/api/contact_api'
+require 'sendx-ruby-sdk/api/list_api'
+require 'sendx-ruby-sdk/api/reports_api'
+require 'sendx-ruby-sdk/api/sender_api'
+require 'sendx-ruby-sdk/api/tags_api'
+
+module SendX
+  class << self
+    # Customize default settings for the SDK using block.
+    #   SendX.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/campaign_api_spec.rb

@@ -0,0 +1,98 @@
+=begin
+#SendX REST API
+
+## 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. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br> 
+
+The version of the OpenAPI document: 1.0.1
+Contact: support@sendx.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SendX::CampaignApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CampaignApi' do
+  before do
+    # run before each test
+    @api_instance = SendX::CampaignApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CampaignApi' do
+    it 'should create an instance of CampaignApi' do
+      expect(@api_instance).to be_instance_of(SendX::CampaignApi)
+    end
+  end
+
+  # unit tests for create_campaign
+  # Create Campaign
+  # Create a new email campaign
+  # @param campaign_request The campaign content
+  # @param [Hash] opts the optional parameters
+  # @return [CreateResponse]
+  describe 'create_campaign test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_campaign
+  # Delete Campaign
+  # Deletes a specific campaign by its campaignId.
+  # @param campaign_id The ID of the campaign to delete
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteCampaign200Response]
+  describe 'delete_campaign test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for edit_campaign
+  # Edit Campaign
+  # Submit edited content for a specific campaign.
+  # @param campaign_request 
+  # @param campaign_id The ID of the campaign to edit
+  # @param [Hash] opts the optional parameters
+  # @return [Campaign]
+  describe 'edit_campaign test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_all_campaigns
+  # Get All Campaigns
+  # Retrieve a list of all campaigns.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :offset Offset for pagination
+  # @option opts [Integer] :limit Limit for pagination
+  # @option opts [String] :search Search term to filter campaigns
+  # @return [Array<Campaign>]
+  describe 'get_all_campaigns test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_campaign_by_id
+  # Get Campaign By Id
+  # Retrieve a specific campaign using its ID.
+  # @param campaign_id The ID of the campaign to retrieve.
+  # @param [Hash] opts the optional parameters
+  # @return [Campaign]
+  describe 'get_campaign_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/contact_api_spec.rb

@@ -0,0 +1,111 @@
+=begin
+#SendX REST API
+
+## 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. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br> 
+
+The version of the OpenAPI document: 1.0.1
+Contact: support@sendx.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SendX::ContactApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ContactApi' do
+  before do
+    # run before each test
+    @api_instance = SendX::ContactApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ContactApi' do
+    it 'should create an instance of ContactApi' do
+      expect(@api_instance).to be_instance_of(SendX::ContactApi)
+    end
+  end
+
+  # unit tests for create_contact
+  # Create a contact
+  # Create Contact with given data
+  # @param contact_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Response]
+  describe 'create_contact test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_contact
+  # Delete Contact
+  # Deletes Contact
+  # @param contact_id The Contact ID to delete
+  # @param [Hash] opts the optional parameters
+  # @return [Response]
+  describe 'delete_contact test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_all_contacts
+  # Get All Contacts
+  # Find all contacts with optional filters
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :offset Offset for pagination
+  # @option opts [Integer] :limit Limit for pagination
+  # @option opts [String] :contact_type Filter contacts by type
+  # @option opts [String] :search Search term to filter contacts
+  # @return [Array<Contact>]
+  describe 'get_all_contacts test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_contact_by_id
+  # Get Contact by ID
+  # Retrieve a specific contact by its contactId.
+  # @param contact_id The ID of the contact to retrieve.
+  # @param [Hash] opts the optional parameters
+  # @return [Contact]
+  describe 'get_contact_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for unsubscribe_contact
+  # Unsubscribe Contact
+  # Unsubscribe a globally existing contact
+  # @param contact_id The Contact ID to unsubscribe
+  # @param [Hash] opts the optional parameters
+  # @return [Response]
+  describe 'unsubscribe_contact test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_contact
+  # Update Contact
+  # Update Contact with given data
+  # @param contact_request 
+  # @param contact_id The ID of the Contact to update
+  # @param [Hash] opts the optional parameters
+  # @return [Contact]
+  describe 'update_contact test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/list_api_spec.rb

@@ -0,0 +1,98 @@
+=begin
+#SendX REST API
+
+## 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. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br> 
+
+The version of the OpenAPI document: 1.0.1
+Contact: support@sendx.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SendX::ListApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ListApi' do
+  before do
+    # run before each test
+    @api_instance = SendX::ListApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ListApi' do
+    it 'should create an instance of ListApi' do
+      expect(@api_instance).to be_instance_of(SendX::ListApi)
+    end
+  end
+
+  # unit tests for create_list
+  # Create List
+  # Create a new list.
+  # @param list_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateResponse]
+  describe 'create_list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_list
+  # Delete List
+  # Deletes a specific list by its ID.
+  # @param list_id The ID of the list you want to delete
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteResponse]
+  describe 'delete_list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_all_lists
+  # Get All Lists
+  # Retrieve all lists for the account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :offset Offset for pagination.
+  # @option opts [Integer] :limit Limit the number of results returned.
+  # @option opts [String] :search Search term to filter lists.
+  # @return [Array<ListModel>]
+  describe 'get_all_lists test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_list_by_id
+  # Get List
+  # Retrieve a specific list by its ID.
+  # @param list_id The ID of the list you want to retrieve
+  # @param [Hash] opts the optional parameters
+  # @return [ListModel]
+  describe 'get_list_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_list
+  # Update List
+  # Update an existing list by its ID.
+  # @param list_request 
+  # @param list_id The ID of the list to be updated.
+  # @param [Hash] opts the optional parameters
+  # @return [Response]
+  describe 'update_list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/reports_api_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#SendX REST API
+
+## 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. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br> 
+
+The version of the OpenAPI document: 1.0.1
+Contact: support@sendx.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SendX::ReportsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ReportsApi' do
+  before do
+    # run before each test
+    @api_instance = SendX::ReportsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ReportsApi' do
+    it 'should create an instance of ReportsApi' do
+      expect(@api_instance).to be_instance_of(SendX::ReportsApi)
+    end
+  end
+
+  # unit tests for get_campaign_report
+  # Get CampaignReport Data
+  # Retrieve the campaign report data based on the provided campaign id.
+  # @param campaign_id The ID of the campaign to retrieve the report data for
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :integration_type Type of integration for the report data (optional)
+  # @return [ReportData]
+  describe 'get_campaign_report test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end