sendx-ruby-sdk 1.1.0 → 2.0.0

data/lib/sendx-ruby-sdk/api/sender_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 Sender
-    # Creates a new sender in the system.
-    # @param sender_request [SenderRequest] 
+    # Create sender
+    # Adds a new sender email address. 
+    # @param rest_e_sender [RestESender] 
     # @param [Hash] opts the optional parameters
-    # @return [Sender]
-    def create_sender(sender_request, opts = {})
-      data, _status_code, _headers = create_sender_with_http_info(sender_request, opts)
+    # @return [RestRSender]
+    def create_sender(rest_e_sender, opts = {})
+      data, _status_code, _headers = create_sender_with_http_info(rest_e_sender, opts)
       data
     end
 
-    # Create Sender
-    # Creates a new sender in the system.
-    # @param sender_request [SenderRequest] 
+    # Create sender
+    # Adds a new sender email address. 
+    # @param rest_e_sender [RestESender] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Sender, Integer, Hash)>] Sender data, response status code and response headers
-    def create_sender_with_http_info(sender_request, opts = {})
+    # @return [Array<(RestRSender, Integer, Hash)>] RestRSender data, response status code and response headers
+    def create_sender_with_http_info(rest_e_sender, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SenderApi.create_sender ...'
       end
-      # verify the required parameter 'sender_request' is set
-      if @api_client.config.client_side_validation && sender_request.nil?
-        fail ArgumentError, "Missing the required parameter 'sender_request' when calling SenderApi.create_sender"
+      # verify the required parameter 'rest_e_sender' is set
+      if @api_client.config.client_side_validation && rest_e_sender.nil?
+        fail ArgumentError, "Missing the required parameter 'rest_e_sender' when calling SenderApi.create_sender"
       end
       # resource path
       local_var_path = '/sender'
@@ -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(sender_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(rest_e_sender)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Sender'
+      return_type = opts[:debug_return_type] || 'RestRSender'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
 
       new_options = opts.merge(
         :operation => :"SenderApi.create_sender",
@@ -87,25 +87,19 @@ module SendX
       return data, status_code, headers
     end
 
-    # Get All Senders
-    # Retrieve all senders for the team, with optional filters like offset, limit, and search.
+    # Get all senders
+    # Retrieves all verified sender addresses. 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :offset Number of records to skip (default to 0)
-    # @option opts [Integer] :limit Maximum number of records to return (default to 10)
-    # @option opts [String] :search Search keyword to filter senders by name or email
-    # @return [Array<SenderResponse>]
+    # @return [Array<RestRSender>]
     def get_all_senders(opts = {})
       data, _status_code, _headers = get_all_senders_with_http_info(opts)
       data
     end
 
-    # Get All Senders
-    # Retrieve all senders for the team, with optional filters like offset, limit, and search.
+    # Get all senders
+    # Retrieves all verified sender addresses. 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :offset Number of records to skip (default to 0)
-    # @option opts [Integer] :limit Maximum number of records to return (default to 10)
-    # @option opts [String] :search Search keyword to filter senders by name or email
-    # @return [Array<(Array<SenderResponse>, Integer, Hash)>] Array<SenderResponse> data, response status code and response headers
+    # @return [Array<(Array<RestRSender>, Integer, Hash)>] Array<RestRSender> data, response status code and response headers
     def get_all_senders_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SenderApi.get_all_senders ...'
@@ -115,9 +109,6 @@ module SendX
 
       # 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] || {}
@@ -131,10 +122,10 @@ module SendX
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Array<SenderResponse>'
+      return_type = opts[:debug_return_type] || 'Array<RestRSender>'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
 
       new_options = opts.merge(
         :operation => :"SenderApi.get_all_senders",

data/lib/sendx-ruby-sdk/api/tag_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 TagApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create tag
+    # Creates a new tag for contact categorization. 
+    # @param rest_e_tag [RestETag] 
+    # @param [Hash] opts the optional parameters
+    # @return [RestRTag]
+    def create_tag(rest_e_tag, opts = {})
+      data, _status_code, _headers = create_tag_with_http_info(rest_e_tag, opts)
+      data
+    end
+
+    # Create tag
+    # Creates a new tag for contact categorization. 
+    # @param rest_e_tag [RestETag] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RestRTag, Integer, Hash)>] RestRTag data, response status code and response headers
+    def create_tag_with_http_info(rest_e_tag, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagApi.create_tag ...'
+      end
+      # verify the required parameter 'rest_e_tag' is set
+      if @api_client.config.client_side_validation && rest_e_tag.nil?
+        fail ArgumentError, "Missing the required parameter 'rest_e_tag' when calling TagApi.create_tag"
+      end
+      # resource path
+      local_var_path = '/tag'
+
+      # 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_tag)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RestRTag'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"TagApi.create_tag",
+        :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: TagApi#create_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete tag
+    # Deletes a tag from the system. 
+    # @param identifier [String] Tag identifier to update
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteResponse]
+    def delete_tag(identifier, opts = {})
+      data, _status_code, _headers = delete_tag_with_http_info(identifier, opts)
+      data
+    end
+
+    # Delete tag
+    # Deletes a tag from the system. 
+    # @param identifier [String] Tag identifier to update
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteResponse, Integer, Hash)>] DeleteResponse data, response status code and response headers
+    def delete_tag_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagApi.delete_tag ...'
+      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 TagApi.delete_tag"
+      end
+      pattern = Regexp.new(/^(tag_)?[a-zA-Z0-9]{22}$/)
+      if @api_client.config.client_side_validation && identifier !~ pattern
+        fail ArgumentError, "invalid value for 'identifier' when calling TagApi.delete_tag, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/tag/{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] || 'DeleteResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"TagApi.delete_tag",
+        :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: TagApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all tags
+    # Retrieves all tags in your team. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Number of tags to skip (default to 0)
+    # @option opts [Integer] :limit Maximum number of tags to return (default to 10)
+    # @return [Array<RestRTag>]
+    def get_all_tags(opts = {})
+      data, _status_code, _headers = get_all_tags_with_http_info(opts)
+      data
+    end
+
+    # Get all tags
+    # Retrieves all tags in your team. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Number of tags to skip (default to 0)
+    # @option opts [Integer] :limit Maximum number of tags to return (default to 10)
+    # @return [Array<(Array<RestRTag>, Integer, Hash)>] Array<RestRTag> data, response status code and response headers
+    def get_all_tags_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagApi.get_all_tags ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling TagApi.get_all_tags, 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 TagApi.get_all_tags, 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 TagApi.get_all_tags, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/tag'
+
+      # 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<RestRTag>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"TagApi.get_all_tags",
+        :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: TagApi#get_all_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get tag by ID
+    # Retrieves detailed information about a specific tag. 
+    # @param identifier [String] Tag identifier to retrieve
+    # @param [Hash] opts the optional parameters
+    # @return [RestRTag]
+    def get_tag(identifier, opts = {})
+      data, _status_code, _headers = get_tag_with_http_info(identifier, opts)
+      data
+    end
+
+    # Get tag by ID
+    # Retrieves detailed information about a specific tag. 
+    # @param identifier [String] Tag identifier to retrieve
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RestRTag, Integer, Hash)>] RestRTag data, response status code and response headers
+    def get_tag_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagApi.get_tag ...'
+      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 TagApi.get_tag"
+      end
+      pattern = Regexp.new(/^(tag_)?[a-zA-Z0-9]{22}$/)
+      if @api_client.config.client_side_validation && identifier !~ pattern
+        fail ArgumentError, "invalid value for 'identifier' when calling TagApi.get_tag, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/tag/{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] || 'RestRTag'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"TagApi.get_tag",
+        :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: TagApi#get_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update tag
+    # Updates an existing tag's name. 
+    # @param rest_e_tag [RestETag] 
+    # @param identifier [String] Tag identifier to update
+    # @param [Hash] opts the optional parameters
+    # @return [RestRTag]
+    def update_tag(rest_e_tag, identifier, opts = {})
+      data, _status_code, _headers = update_tag_with_http_info(rest_e_tag, identifier, opts)
+      data
+    end
+
+    # Update tag
+    # Updates an existing tag&#39;s name. 
+    # @param rest_e_tag [RestETag] 
+    # @param identifier [String] Tag identifier to update
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RestRTag, Integer, Hash)>] RestRTag data, response status code and response headers
+    def update_tag_with_http_info(rest_e_tag, identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagApi.update_tag ...'
+      end
+      # verify the required parameter 'rest_e_tag' is set
+      if @api_client.config.client_side_validation && rest_e_tag.nil?
+        fail ArgumentError, "Missing the required parameter 'rest_e_tag' when calling TagApi.update_tag"
+      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 TagApi.update_tag"
+      end
+      pattern = Regexp.new(/^(tag_)?[a-zA-Z0-9]{22}$/)
+      if @api_client.config.client_side_validation && identifier !~ pattern
+        fail ArgumentError, "invalid value for 'identifier' when calling TagApi.update_tag, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/tag/{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_tag)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RestRTag'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['TeamApiKey']
+
+      new_options = opts.merge(
+        :operation => :"TagApi.update_tag",
+        :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: TagApi#update_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end