sendx-ruby-sdk 1.1.0 → 2.0.0

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

@@ -0,0 +1,380 @@
+=begin
+#SendX REST API
+
+## 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: hello@sendx.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'cgi'
+
+module SendX
+  class PostApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create blog post
+    # Creates a new blog post. 
+    # @param rest_e_post [RestEPost] 
+    # @param [Hash] opts the optional parameters
+    # @return [RestRPost]
+    def create_post(rest_e_post, opts = {})
+      data, _status_code, _headers = create_post_with_http_info(rest_e_post, opts)
+      data
+    end
+
+    # Create blog post
+    # Creates a new blog post. 
+    # @param rest_e_post [RestEPost] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RestRPost, Integer, Hash)>] RestRPost data, response status code and response headers
+    def create_post_with_http_info(rest_e_post, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostApi.create_post ...'
+      end
+      # verify the required parameter 'rest_e_post' is set
+      if @api_client.config.client_side_validation && rest_e_post.nil?
+        fail ArgumentError, "Missing the required parameter 'rest_e_post' when calling PostApi.create_post"
+      end
+      # resource path
+      local_var_path = '/post'
+
+      # 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(rest_e_post)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RestRPost'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"PostApi.create_post",
+        :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: PostApi#create_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete post
+    # Soft deletes a blog post.  **🎯 Key Features:** - Soft delete - Preserve data - Remove from listings 
+    # @param identifier [String] Resource identifier with prefix (e.g., &#x60;contact_BnKjkbBBS500CoBCP0oChQ&#x60;)  **Format:** &#x60;&lt;prefix&gt;_&lt;22-character-id&gt;&#x60; 
+    # @param [Hash] opts the optional parameters
+    # @return [MessageResponse]
+    def delete_post(identifier, opts = {})
+      data, _status_code, _headers = delete_post_with_http_info(identifier, opts)
+      data
+    end
+
+    # Delete post
+    # Soft deletes a blog post.  **🎯 Key Features:** - Soft delete - Preserve data - Remove from listings 
+    # @param identifier [String] Resource identifier with prefix (e.g., &#x60;contact_BnKjkbBBS500CoBCP0oChQ&#x60;)  **Format:** &#x60;&lt;prefix&gt;_&lt;22-character-id&gt;&#x60; 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MessageResponse, Integer, Hash)>] MessageResponse data, response status code and response headers
+    def delete_post_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostApi.delete_post ...'
+      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 PostApi.delete_post"
+      end
+      pattern = Regexp.new(/^[a-z_]+_[a-zA-Z0-9]{22}$/)
+      if @api_client.config.client_side_validation && identifier !~ pattern
+        fail ArgumentError, "invalid value for 'identifier' when calling PostApi.delete_post, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/post/{identifier}'.sub('{' + 'identifier' + '}', CGI.escape(identifier.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] || 'MessageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"PostApi.delete_post",
+        :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: PostApi#delete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all posts
+    # Retrieves all blog posts with pagination.  **🎯 Key Features:** - Filter by status - Search functionality - Sort options - Include metadata 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Number of posts to skip (default to 0)
+    # @option opts [Integer] :limit Maximum number of posts to return (default to 10)
+    # @return [Array<RestRPost>]
+    def get_all_posts(opts = {})
+      data, _status_code, _headers = get_all_posts_with_http_info(opts)
+      data
+    end
+
+    # Get all posts
+    # Retrieves all blog posts with pagination.  **🎯 Key Features:** - Filter by status - Search functionality - Sort options - Include metadata 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Number of posts to skip (default to 0)
+    # @option opts [Integer] :limit Maximum number of posts to return (default to 10)
+    # @return [Array<(Array<RestRPost>, Integer, Hash)>] Array<RestRPost> data, response status code and response headers
+    def get_all_posts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostApi.get_all_posts ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling PostApi.get_all_posts, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PostApi.get_all_posts, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PostApi.get_all_posts, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/post'
+
+      # 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?
+
+      # 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<RestRPost>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"PostApi.get_all_posts",
+        :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: PostApi#get_all_posts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get post by ID
+    # Retrieves a specific blog post.  **🎯 Key Features:** - Full post content - SEO metadata - Related posts - Engagement metrics 
+    # @param identifier [String] Resource identifier with prefix (e.g., &#x60;contact_BnKjkbBBS500CoBCP0oChQ&#x60;)  **Format:** &#x60;&lt;prefix&gt;_&lt;22-character-id&gt;&#x60; 
+    # @param [Hash] opts the optional parameters
+    # @return [RestRPost]
+    def get_post(identifier, opts = {})
+      data, _status_code, _headers = get_post_with_http_info(identifier, opts)
+      data
+    end
+
+    # Get post by ID
+    # Retrieves a specific blog post.  **🎯 Key Features:** - Full post content - SEO metadata - Related posts - Engagement metrics 
+    # @param identifier [String] Resource identifier with prefix (e.g., &#x60;contact_BnKjkbBBS500CoBCP0oChQ&#x60;)  **Format:** &#x60;&lt;prefix&gt;_&lt;22-character-id&gt;&#x60; 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RestRPost, Integer, Hash)>] RestRPost data, response status code and response headers
+    def get_post_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostApi.get_post ...'
+      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 PostApi.get_post"
+      end
+      pattern = Regexp.new(/^[a-z_]+_[a-zA-Z0-9]{22}$/)
+      if @api_client.config.client_side_validation && identifier !~ pattern
+        fail ArgumentError, "invalid value for 'identifier' when calling PostApi.get_post, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/post/{identifier}'.sub('{' + 'identifier' + '}', CGI.escape(identifier.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] || 'RestRPost'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"PostApi.get_post",
+        :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: PostApi#get_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update post
+    # Updates an existing blog post.  **🎯 Key Features:** - Edit content - Update metadata - Change status - Modify tags/categories 
+    # @param rest_e_post [RestEPost] 
+    # @param identifier [String] Resource identifier with prefix (e.g., &#x60;contact_BnKjkbBBS500CoBCP0oChQ&#x60;)  **Format:** &#x60;&lt;prefix&gt;_&lt;22-character-id&gt;&#x60; 
+    # @param [Hash] opts the optional parameters
+    # @return [RestRPost]
+    def update_post(rest_e_post, identifier, opts = {})
+      data, _status_code, _headers = update_post_with_http_info(rest_e_post, identifier, opts)
+      data
+    end
+
+    # Update post
+    # Updates an existing blog post.  **🎯 Key Features:** - Edit content - Update metadata - Change status - Modify tags/categories 
+    # @param rest_e_post [RestEPost] 
+    # @param identifier [String] Resource identifier with prefix (e.g., &#x60;contact_BnKjkbBBS500CoBCP0oChQ&#x60;)  **Format:** &#x60;&lt;prefix&gt;_&lt;22-character-id&gt;&#x60; 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RestRPost, Integer, Hash)>] RestRPost data, response status code and response headers
+    def update_post_with_http_info(rest_e_post, identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostApi.update_post ...'
+      end
+      # verify the required parameter 'rest_e_post' is set
+      if @api_client.config.client_side_validation && rest_e_post.nil?
+        fail ArgumentError, "Missing the required parameter 'rest_e_post' when calling PostApi.update_post"
+      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 PostApi.update_post"
+      end
+      pattern = Regexp.new(/^[a-z_]+_[a-zA-Z0-9]{22}$/)
+      if @api_client.config.client_side_validation && identifier !~ pattern
+        fail ArgumentError, "invalid value for 'identifier' when calling PostApi.update_post, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/post/{identifier}'.sub('{' + 'identifier' + '}', CGI.escape(identifier.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(rest_e_post)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RestRPost'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"PostApi.update_post",
+        :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: PostApi#update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end