sendx-ruby-sdk 1.1.0 → 2.0.0

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

@@ -1,12 +1,12 @@
 =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> 
+## SendX REST API Documentation  ## 🚀 Introduction  The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.  **Key Features:** - 🔒 **Security**: Team-based authentication with optional member-level access - 🎯 **Resource-Oriented**: RESTful design with clear resource boundaries - 📊 **Rich Data Models**: Three-layer model system (Input/Output/Internal) - 🔗 **Relationships**: Automatic prefix handling for resource relationships - 📈 **Scalable**: Built for high-volume email marketing operations  ## 🏗️ Architecture Overview  SendX uses a three-layer model architecture:  1. **Input Models** (`RestE*`): For API requests 2. **Output Models** (`RestR*`): For API responses with prefixed IDs 3. **Internal Models**: Core business logic (not exposed in API)  ## 🔐 Security & Authentication  SendX uses API key authentication:  ### Team API Key ```http X-Team-ApiKey: YOUR_TEAM_API_KEY ``` - **Required for all requests** - Team-level access to resources - Available in SendX Settings → Team API Key  ## 🆔 Encrypted ID System  SendX uses encrypted IDs for security and better developer experience:  - **Internal IDs**: Sequential integers (not exposed) - **Encrypted IDs**: 22-character alphanumeric strings - **Prefixed IDs**: Resource-type prefixes in API responses (`contact_<22-char-id>`)  ### ID Format  **All resource IDs follow this pattern:** ``` <resource_prefix>_<22_character_alphanumeric_string> ```  **Example:** ```json {   \"id\": \"contact_BnKjkbBBS500CoBCP0oChQ\",   \"lists\": [\"list_OcuxJHdiAvujmwQVJfd3ss\", \"list_0tOFLp5RgV7s3LNiHrjGYs\"],   \"tags\": [\"tag_UhsDkjL772Qbj5lWtT62VK\", \"tag_fL7t9lsnZ9swvx2HrtQ9wM\"] } ```  ## 📚 Resource Prefixes  | Resource | Prefix | Example | |----------|--------|---------| | Contact | `contact_` | `contact_BnKjkbBBS500CoBCP0oChQ` | | Campaign | `campaign_` | `campaign_LUE9BTxmksSmqHWbh96zsn` | | List | `list_` | `list_OcuxJHdiAvujmwQVJfd3ss` | | Tag | `tag_` | `tag_UhsDkjL772Qbj5lWtT62VK` | | Sender | `sender_` | `sender_4vK3WFhMgvOwUNyaL4QxCD` | | Template | `template_` | `template_f3lJvTEhSjKGVb5Lwc5SWS` | | Custom Field | `field_` | `field_MnuqBAG2NPLm7PZMWbjQxt` | | Webhook | `webhook_` | `webhook_9l154iiXlZoPo7vngmamee` | | Post | `post_` | `post_XyZ123aBc456DeF789GhI` | | Post Category | `post_category_` | `post_category_YzS1wOU20yw87UUHKxMzwn` | | Post Tag | `post_tag_` | `post_tag_123XyZ456AbC` | | Member | `member_` | `member_JkL012MnO345PqR678` |  ## 🎯 Best Practices  ### Error Handling - **Always check status codes**: 2xx = success, 4xx = client error, 5xx = server error - **Read error messages**: Descriptive messages help debug issues - **Handle rate limits**: Respect API rate limits for optimal performance  ### Data Validation - **Email format**: Must be valid email addresses - **Required fields**: Check documentation for mandatory fields - **Field lengths**: Respect maximum length constraints  ### Performance - **Pagination**: Use offset/limit for large datasets - **Batch operations**: Process multiple items when supported - **Caching**: Cache responses when appropriate  ## 🛠️ SDKs & Integration  Official SDKs available for: - [Golang](https://github.com/sendx/sendx-go-sdk) - [Python](https://github.com/sendx/sendx-python-sdk) - [Ruby](https://github.com/sendx/sendx-ruby-sdk) - [Java](https://github.com/sendx/sendx-java-sdk) - [PHP](https://github.com/sendx/sendx-php-sdk) - [JavaScript](https://github.com/sendx/sendx-javascript-sdk)  ## 📞 Support  Need help? Contact us: - 💬 **Website Chat**: Available on sendx.io - 📧 **Email**: hello@sendx.io - 📚 **Documentation**: Full guides at help.sendx.io  ---  **API Endpoint:** `https://api.sendx.io/api/v1/rest`  [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In Postman\" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/33476323-44b198b0-5219-4619-a01f-cfc24d573885?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D33476323-44b198b0-5219-4619-a01f-cfc24d573885%26entityType%3Dcollection%26workspaceId%3D6b1e4f65-96a9-4136-9512-6266c852517e) 
 
 The version of the OpenAPI document: 1.0.0
-Contact: support@sendx.io
+Contact: hello@sendx.io
 Generated by: https://openapi-generator.tech
-Generator version: 7.8.0
+Generator version: 7.13.0
 
 =end
 
@@ -19,28 +19,28 @@ module SendX
     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
+    # Create campaign
+    # Creates a new email campaign. 
+    # @param rest_e_campaign [RestECampaign] 
     # @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)
+    # @return [RestRCampaign]
+    def create_campaign(rest_e_campaign, opts = {})
+      data, _status_code, _headers = create_campaign_with_http_info(rest_e_campaign, opts)
       data
     end
 
-    # Create Campaign
-    # Create a new email campaign
-    # @param campaign_request [CampaignRequest] The campaign content
+    # Create campaign
+    # Creates a new email campaign. 
+    # @param rest_e_campaign [RestECampaign] 
     # @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 = {})
+    # @return [Array<(RestRCampaign, Integer, Hash)>] RestRCampaign data, response status code and response headers
+    def create_campaign_with_http_info(rest_e_campaign, 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"
+      # verify the required parameter 'rest_e_campaign' is set
+      if @api_client.config.client_side_validation && rest_e_campaign.nil?
+        fail ArgumentError, "Missing the required parameter 'rest_e_campaign' when calling CampaignApi.create_campaign"
       end
       # resource path
       local_var_path = '/campaign'
@@ -62,13 +62,13 @@ module SendX
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(rest_e_campaign)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'CreateResponse'
+      return_type = opts[:debug_return_type] || 'RestRCampaign'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
 
       new_options = opts.merge(
         :operation => :"CampaignApi.create_campaign",
@@ -87,31 +87,36 @@ module SendX
       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
+    # Delete campaign
+    # Deletes a campaign. 
+    # @param identifier [String] Campaign identifier 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)
+    # @return [DeleteResponse]
+    def delete_campaign(identifier, opts = {})
+      data, _status_code, _headers = delete_campaign_with_http_info(identifier, opts)
       data
     end
 
-    # Delete Campaign
-    # Deletes a specific campaign by its campaignId.
-    # @param campaign_id [String] The ID of the campaign to delete
+    # Delete campaign
+    # Deletes a campaign. 
+    # @param identifier [String] Campaign identifier 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 = {})
+    # @return [Array<(DeleteResponse, Integer, Hash)>] DeleteResponse data, response status code and response headers
+    def delete_campaign_with_http_info(identifier, 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"
+      # 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 CampaignApi.delete_campaign"
       end
+      pattern = Regexp.new(/^(campaign_)?[a-zA-Z0-9]{22}$/)
+      if @api_client.config.client_side_validation && identifier !~ pattern
+        fail ArgumentError, "invalid value for 'identifier' when calling CampaignApi.delete_campaign, must conform to the pattern #{pattern}."
+      end
+
       # resource path
-      local_var_path = '/campaign/{campaignId}'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
+      local_var_path = '/campaign/{identifier}'.sub('{' + 'identifier' + '}', CGI.escape(identifier.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -128,10 +133,10 @@ module SendX
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'DeleteCampaign200Response'
+      return_type = opts[:debug_return_type] || 'DeleteResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
 
       new_options = opts.merge(
         :operation => :"CampaignApi.delete_campaign",
@@ -150,102 +155,44 @@ module SendX
       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
+    # Get all campaigns
+    # Retrieves a paginated list of all campaigns. 
     # @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)
+    # @option opts [Integer] :offset Number of campaigns to skip (default to 0)
+    # @option opts [Integer] :limit Maximum number of campaigns to return (default to 10)
+    # @option opts [String] :campaign_type Filter by campaign type (default to 'all')
+    # @return [Array<RestRCampaign>]
+    def get_all_campaigns(opts = {})
+      data, _status_code, _headers = get_all_campaigns_with_http_info(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
+    # Get all campaigns
+    # Retrieves a paginated list of all campaigns. 
     # @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 = {})
+    # @option opts [Integer] :offset Number of campaigns to skip (default to 0)
+    # @option opts [Integer] :limit Maximum number of campaigns to return (default to 10)
+    # @option opts [String] :campaign_type Filter by campaign type (default to 'all')
+    # @return [Array<(Array<RestRCampaign>, Integer, Hash)>] Array<RestRCampaign> 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.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"
+        @api_client.config.logger.debug 'Calling API: CampaignApi.get_all_campaigns ...'
       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"
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling CampaignApi.get_all_campaigns, must be greater than or equal to 0.'
       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
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CampaignApi.get_all_campaigns, must be smaller than or equal to 100.'
       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}"
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CampaignApi.get_all_campaigns, must be greater than or equal to 1.'
       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 ...'
+      allowable_values = ["all", "draft", "scheduled", "sent"]
+      if @api_client.config.client_side_validation && opts[:'campaign_type'] && !allowable_values.include?(opts[:'campaign_type'])
+        fail ArgumentError, "invalid value for \"campaign_type\", must be one of #{allowable_values}"
       end
       # resource path
       local_var_path = '/campaign'
@@ -254,7 +201,7 @@ module SendX
       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?
+      query_params[:'campaignType'] = opts[:'campaign_type'] if !opts[:'campaign_type'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -268,10 +215,10 @@ module SendX
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Array<Campaign>'
+      return_type = opts[:debug_return_type] || 'Array<RestRCampaign>'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
 
       new_options = opts.merge(
         :operation => :"CampaignApi.get_all_campaigns",
@@ -290,31 +237,36 @@ module SendX
       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.
+    # Get campaign by ID
+    # Retrieves detailed information about a specific campaign. 
+    # @param identifier [String] Campaign identifier - &#x60;campaign_IMBoxK2iB5sUdgiNOjqAMA&#x60; 
     # @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)
+    # @return [RestRCampaign]
+    def get_campaign(identifier, opts = {})
+      data, _status_code, _headers = get_campaign_with_http_info(identifier, 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.
+    # Get campaign by ID
+    # Retrieves detailed information about a specific campaign. 
+    # @param identifier [String] Campaign identifier - &#x60;campaign_IMBoxK2iB5sUdgiNOjqAMA&#x60; 
     # @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 = {})
+    # @return [Array<(RestRCampaign, Integer, Hash)>] RestRCampaign data, response status code and response headers
+    def get_campaign_with_http_info(identifier, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CampaignApi.get_campaign_by_id ...'
+        @api_client.config.logger.debug 'Calling API: CampaignApi.get_campaign ...'
+      end
+      # 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 CampaignApi.get_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.get_campaign_by_id"
+      pattern = Regexp.new(/^(campaign_)?[a-zA-Z0-9]{22}$/)
+      if @api_client.config.client_side_validation && identifier !~ pattern
+        fail ArgumentError, "invalid value for 'identifier' when calling CampaignApi.get_campaign, must conform to the pattern #{pattern}."
       end
+
       # resource path
-      local_var_path = '/campaign/{campaignId}'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
+      local_var_path = '/campaign/{identifier}'.sub('{' + 'identifier' + '}', CGI.escape(identifier.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -331,13 +283,13 @@ module SendX
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Campaign'
+      return_type = opts[:debug_return_type] || 'RestRCampaign'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
 
       new_options = opts.merge(
-        :operation => :"CampaignApi.get_campaign_by_id",
+        :operation => :"CampaignApi.get_campaign",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -348,7 +300,7 @@ module SendX
 
       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}"
+        @api_client.config.logger.debug "API called: CampaignApi#get_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end