sendx-ruby-sdk 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4066535e320b8ed263c20f167a540080a3cfbaacf8a152197d5c297c46e901b2
+  data.tar.gz: 4b0744839d25cb6fa06b94fd8bbf7fdc8bfd944187d02b6adfad54c393e07493
+SHA512:
+  metadata.gz: 90c5dc5dbcb638d030ec9da67b25154128c91e59d8506a528a0ff0704489b77a5381483b77419bb86c4a42925c9a468810d261f4c6a838ebeed05acfc6afe97a
+  data.tar.gz: 196718d49b9884f6e0cc8fe3b577c3379b04487f01a75b88f3b56b39a8ebc9c22705b9f26835f33b547c445d410483c7f06cfadbb4b727e4d353b8931277580e

data/README.md

@@ -0,0 +1,156 @@
+# sendx-ruby-sdk
+
+SendX - the Ruby gem for the 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>
+
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build sendx-ruby-sdk.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./sendx-ruby-sdk-1.0.0.gem
+```
+
+(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/).
+
+Finally add this to the Gemfile:
+
+    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:
+
+    gem 'sendx-ruby-sdk', :git => 'https://github.com/sendx/sendx-ruby-sdk.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'time'
+require 'sendx-ruby-sdk'
+# setup authorization
+SendX.configure do |config|
+  # Configure API key authorization: apiKeyAuth
+  config.api_key['apiKeyAuth'] = 'YOUR API KEY'
+  config.server_index = 2
+end
+
+api_instance = SendX::ContactApi.new
+contact_request = SendX::ContactRequest.new(
+  email: "john@doe.com",
+  first_name: "John",
+  last_name: "Doe",
+  company: "SendX",
+  last_tracked_ip: "34.94.159.140",
+  tags: ["MKdhTovsTJDetCyrJmRySL"],
+  custom_fields: {
+        'fnwfnke23kn4kn' => "VIP",
+        "9i0jinjn0ib0"=> "Subscribers"
+    },
+)
+
+begin
+  # Create a contact
+  result = api_instance.create_contact(contact_request)
+  p result
+rescue SendX::ApiError => e
+  puts "Error when calling ContactApi->create_contact: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.sendx.io/api/v1/rest*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SendX::CampaignApi* | [**create_campaign**](docs/CampaignApi.md#create_campaign) | **POST** /campaign | Create Campaign
+*SendX::CampaignApi* | [**delete_campaign**](docs/CampaignApi.md#delete_campaign) | **DELETE** /campaign/{campaignId} | Delete Campaign
+*SendX::CampaignApi* | [**edit_campaign**](docs/CampaignApi.md#edit_campaign) | **PUT** /campaign/{campaignId} | Edit Campaign
+*SendX::CampaignApi* | [**get_all_campaigns**](docs/CampaignApi.md#get_all_campaigns) | **GET** /campaign | Get All Campaigns
+*SendX::CampaignApi* | [**get_campaign_by_id**](docs/CampaignApi.md#get_campaign_by_id) | **GET** /campaign/{campaignId} | Get Campaign By Id
+*SendX::ContactApi* | [**create_contact**](docs/ContactApi.md#create_contact) | **POST** /contact | Create a contact
+*SendX::ContactApi* | [**delete_contact**](docs/ContactApi.md#delete_contact) | **DELETE** /contact/{contactId} | Delete Contact
+*SendX::ContactApi* | [**get_all_contacts**](docs/ContactApi.md#get_all_contacts) | **GET** /contact | Get All Contacts
+*SendX::ContactApi* | [**get_contact_by_id**](docs/ContactApi.md#get_contact_by_id) | **GET** /contact/{contactId} | Get Contact by ID
+*SendX::ContactApi* | [**unsubscribe_contact**](docs/ContactApi.md#unsubscribe_contact) | **POST** /contact/unsubscribe/{contactId} | Unsubscribe Contact
+*SendX::ContactApi* | [**update_contact**](docs/ContactApi.md#update_contact) | **PUT** /contact/{contactId} | Update Contact
+*SendX::ListApi* | [**create_list**](docs/ListApi.md#create_list) | **POST** /list | Create List
+*SendX::ListApi* | [**delete_list**](docs/ListApi.md#delete_list) | **DELETE** /list/{listId} | Delete List
+*SendX::ListApi* | [**get_all_lists**](docs/ListApi.md#get_all_lists) | **GET** /list | Get All Lists
+*SendX::ListApi* | [**get_list_by_id**](docs/ListApi.md#get_list_by_id) | **GET** /list/{listId} | Get List
+*SendX::ListApi* | [**update_list**](docs/ListApi.md#update_list) | **PUT** /list/{listId} | Update List
+*SendX::ReportsApi* | [**get_campaign_report**](docs/ReportsApi.md#get_campaign_report) | **GET** /report/campaign/{campaignId} | Get CampaignReport Data
+*SendX::SenderApi* | [**create_sender**](docs/SenderApi.md#create_sender) | **POST** /sender | Create Sender
+*SendX::SenderApi* | [**get_all_senders**](docs/SenderApi.md#get_all_senders) | **GET** /sender | Get All Senders
+*SendX::TagsApi* | [**create_tag**](docs/TagsApi.md#create_tag) | **POST** /tag | Create a Tag
+*SendX::TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /tag/{tagId} | Delete a Tag
+*SendX::TagsApi* | [**get_all_tags**](docs/TagsApi.md#get_all_tags) | **GET** /tag | Get All Tags
+*SendX::TagsApi* | [**get_tag_by_id**](docs/TagsApi.md#get_tag_by_id) | **GET** /tag/{tagId} | Get a Tag by ID
+*SendX::TagsApi* | [**update_tag**](docs/TagsApi.md#update_tag) | **PUT** /tag/{tagId} | Update a Tag
+
+
+## Documentation for Models
+
+ - [SendX::Campaign](docs/Campaign.md)
+ - [SendX::CampaignDashboardData](docs/CampaignDashboardData.md)
+ - [SendX::CampaignRequest](docs/CampaignRequest.md)
+ - [SendX::Contact](docs/Contact.md)
+ - [SendX::ContactRequest](docs/ContactRequest.md)
+ - [SendX::CreateResponse](docs/CreateResponse.md)
+ - [SendX::DashboardStats](docs/DashboardStats.md)
+ - [SendX::DeleteCampaign200Response](docs/DeleteCampaign200Response.md)
+ - [SendX::DeleteRequest](docs/DeleteRequest.md)
+ - [SendX::DeleteResponse](docs/DeleteResponse.md)
+ - [SendX::LastSentCampaignStat](docs/LastSentCampaignStat.md)
+ - [SendX::ListModel](docs/ListModel.md)
+ - [SendX::ListRequest](docs/ListRequest.md)
+ - [SendX::ReportData](docs/ReportData.md)
+ - [SendX::Response](docs/Response.md)
+ - [SendX::Sender](docs/Sender.md)
+ - [SendX::SenderRequest](docs/SenderRequest.md)
+ - [SendX::SenderResponse](docs/SenderResponse.md)
+ - [SendX::Tag](docs/Tag.md)
+ - [SendX::TagRequest](docs/TagRequest.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### apiKeyAuth
+
+
+- **Type**: API key
+- **API key parameter name**: X-Team-ApiKey
+- **Location**: HTTP header
+

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

@@ -0,0 +1,356 @@
+=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 'cgi'
+
+module SendX
+  class CampaignApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Campaign
+    # Create a new email campaign
+    # @param campaign_request [CampaignRequest] The campaign content
+    # @param [Hash] opts the optional parameters
+    # @return [CreateResponse]
+    def create_campaign(campaign_request, opts = {})
+      data, _status_code, _headers = create_campaign_with_http_info(campaign_request, opts)
+      data
+    end
+
+    # Create Campaign
+    # Create a new email campaign
+    # @param campaign_request [CampaignRequest] The campaign content
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateResponse, Integer, Hash)>] CreateResponse data, response status code and response headers
+    def create_campaign_with_http_info(campaign_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignApi.create_campaign ...'
+      end
+      # verify the required parameter 'campaign_request' is set
+      if @api_client.config.client_side_validation && campaign_request.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_request' when calling CampaignApi.create_campaign"
+      end
+      # resource path
+      local_var_path = '/campaign'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CampaignApi.create_campaign",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignApi#create_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete Campaign
+    # Deletes a specific campaign by its campaignId.
+    # @param campaign_id [String] The ID of the campaign to delete
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteCampaign200Response]
+    def delete_campaign(campaign_id, opts = {})
+      data, _status_code, _headers = delete_campaign_with_http_info(campaign_id, opts)
+      data
+    end
+
+    # Delete Campaign
+    # Deletes a specific campaign by its campaignId.
+    # @param campaign_id [String] The ID of the campaign to delete
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteCampaign200Response, Integer, Hash)>] DeleteCampaign200Response data, response status code and response headers
+    def delete_campaign_with_http_info(campaign_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignApi.delete_campaign ...'
+      end
+      # verify the required parameter 'campaign_id' is set
+      if @api_client.config.client_side_validation && campaign_id.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_id' when calling CampaignApi.delete_campaign"
+      end
+      # resource path
+      local_var_path = '/campaign/{campaignId}'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DeleteCampaign200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CampaignApi.delete_campaign",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignApi#delete_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Edit Campaign
+    # Submit edited content for a specific campaign.
+    # @param campaign_request [CampaignRequest] 
+    # @param campaign_id [String] The ID of the campaign to edit
+    # @param [Hash] opts the optional parameters
+    # @return [Campaign]
+    def edit_campaign(campaign_request, campaign_id, opts = {})
+      data, _status_code, _headers = edit_campaign_with_http_info(campaign_request, campaign_id, opts)
+      data
+    end
+
+    # Edit Campaign
+    # Submit edited content for a specific campaign.
+    # @param campaign_request [CampaignRequest] 
+    # @param campaign_id [String] The ID of the campaign to edit
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Campaign, Integer, Hash)>] Campaign data, response status code and response headers
+    def edit_campaign_with_http_info(campaign_request, campaign_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignApi.edit_campaign ...'
+      end
+      # verify the required parameter 'campaign_request' is set
+      if @api_client.config.client_side_validation && campaign_request.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_request' when calling CampaignApi.edit_campaign"
+      end
+      # verify the required parameter 'campaign_id' is set
+      if @api_client.config.client_side_validation && campaign_id.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_id' when calling CampaignApi.edit_campaign"
+      end
+      # resource path
+      local_var_path = '/campaign/{campaignId}'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Campaign'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CampaignApi.edit_campaign",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignApi#edit_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get All Campaigns
+    # Retrieve a list of all campaigns.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Offset for pagination (default to 0)
+    # @option opts [Integer] :limit Limit for pagination (default to 20)
+    # @option opts [String] :search Search term to filter campaigns
+    # @return [Array<Campaign>]
+    def get_all_campaigns(opts = {})
+      data, _status_code, _headers = get_all_campaigns_with_http_info(opts)
+      data
+    end
+
+    # Get All Campaigns
+    # Retrieve a list of all campaigns.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Offset for pagination (default to 0)
+    # @option opts [Integer] :limit Limit for pagination (default to 20)
+    # @option opts [String] :search Search term to filter campaigns
+    # @return [Array<(Array<Campaign>, Integer, Hash)>] Array<Campaign> data, response status code and response headers
+    def get_all_campaigns_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignApi.get_all_campaigns ...'
+      end
+      # resource path
+      local_var_path = '/campaign'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Campaign>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CampaignApi.get_all_campaigns",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignApi#get_all_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Campaign By Id
+    # Retrieve a specific campaign using its ID.
+    # @param campaign_id [String] The ID of the campaign to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @return [Campaign]
+    def get_campaign_by_id(campaign_id, opts = {})
+      data, _status_code, _headers = get_campaign_by_id_with_http_info(campaign_id, opts)
+      data
+    end
+
+    # Get Campaign By Id
+    # Retrieve a specific campaign using its ID.
+    # @param campaign_id [String] The ID of the campaign to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Campaign, Integer, Hash)>] Campaign data, response status code and response headers
+    def get_campaign_by_id_with_http_info(campaign_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignApi.get_campaign_by_id ...'
+      end
+      # verify the required parameter 'campaign_id' is set
+      if @api_client.config.client_side_validation && campaign_id.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_id' when calling CampaignApi.get_campaign_by_id"
+      end
+      # resource path
+      local_var_path = '/campaign/{campaignId}'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Campaign'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CampaignApi.get_campaign_by_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignApi#get_campaign_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end