rcs 2.0.0 → 2.0.2

data/lib/rcs/messages/rcs/client.rb

@@ -3,6 +3,8 @@
 require_relative "../../../requests"
 require_relative "../../types/rich_message"
 require_relative "types/rcs_send_response"
+require_relative "types/send_typing_indicator_schema_options"
+require_relative "../../types/send_typing_indicator_response"
 require_relative "../../types/rcs_validate_content"
 require_relative "../../types/rcs_validation_result"
 require "async"
@@ -51,6 +53,66 @@ module Pinnacle
         Pinnacle::Messages::Rcs::Types::RcsSendResponse.from_json(json_object: response.body)
       end
 
+      # Send a typing indicator from an RCS agent to a recipient.
+      #  This endpoint allows RCS agents to display a typing indicator to recipients. The
+      #  indicator is a message bubble with animated typing dots like this: <img
+      #  le.app/storage/v1/object/public/pinnacle-public-assets/ios-typing-indicator.png"
+      #  alt="Typing Indicator" style="display: inline; height: 1.5em; vertical-align:
+      #  middle; margin: 0 4px;" />
+      #  **Use Case:** Typing indicators are especially useful for providing feedback to
+      #  users while the agent is thinking or generating a response that may take some
+      #  time, creating a more engaging conversational experience.
+      #  **Expiration:** Typing indicators automatically expire after around 20 seconds
+      #  or when the agent sends a message, whichever comes first.
+      #  **Frequency:** You can send typing indicators as many times as needed, though
+      #  only one will be displayed at a time. Sending multiple typing indicators will
+      #  extend the duration of the current indicator.
+      #  > **Note:** Typing indicators are best-effort hints, not delivery-guaranteed
+      #  state. The platform is allowed to coalesce or drop them, and the client UI
+      #  decides when to show/hide.
+      #
+      # @param agent_id [String] The unique identifier of the RCS agent sending the typing indicator. <br>
+      #  Format: `agent_` followed by alphanumeric characters (e.g., `agent_pinnacle`).
+      # @param to [String] The recipient's phone number in E.164 format. <br>
+      #  Must include country code with a leading plus sign (e.g., `+14155551234`).
+      # @param options [Hash] Configure how your typing indicator is sent.Request of type Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions, as a Hash
+      #   * :test_mode (Boolean)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::SendTypingIndicatorResponse]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.rcs.send_typing(
+      #    agent_id: "agent_pinnacle",
+      #    to: "+14154746461",
+      #    options: { test_mode: false }
+      #  )
+      def send_typing(agent_id:, to:, options: nil, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            agentId: agent_id,
+            to: to,
+            options: options
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/messages/typing"
+        end
+        Pinnacle::Types::SendTypingIndicatorResponse.from_json(json_object: response.body)
+      end
+
       # Validate RCS message content without sending it.
       #
       # @param request [Pinnacle::Types::RcsTextContent, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RcsCards]
@@ -126,6 +188,68 @@ module Pinnacle
         end
       end
 
+      # Send a typing indicator from an RCS agent to a recipient.
+      #  This endpoint allows RCS agents to display a typing indicator to recipients. The
+      #  indicator is a message bubble with animated typing dots like this: <img
+      #  le.app/storage/v1/object/public/pinnacle-public-assets/ios-typing-indicator.png"
+      #  alt="Typing Indicator" style="display: inline; height: 1.5em; vertical-align:
+      #  middle; margin: 0 4px;" />
+      #  **Use Case:** Typing indicators are especially useful for providing feedback to
+      #  users while the agent is thinking or generating a response that may take some
+      #  time, creating a more engaging conversational experience.
+      #  **Expiration:** Typing indicators automatically expire after around 20 seconds
+      #  or when the agent sends a message, whichever comes first.
+      #  **Frequency:** You can send typing indicators as many times as needed, though
+      #  only one will be displayed at a time. Sending multiple typing indicators will
+      #  extend the duration of the current indicator.
+      #  > **Note:** Typing indicators are best-effort hints, not delivery-guaranteed
+      #  state. The platform is allowed to coalesce or drop them, and the client UI
+      #  decides when to show/hide.
+      #
+      # @param agent_id [String] The unique identifier of the RCS agent sending the typing indicator. <br>
+      #  Format: `agent_` followed by alphanumeric characters (e.g., `agent_pinnacle`).
+      # @param to [String] The recipient's phone number in E.164 format. <br>
+      #  Must include country code with a leading plus sign (e.g., `+14155551234`).
+      # @param options [Hash] Configure how your typing indicator is sent.Request of type Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions, as a Hash
+      #   * :test_mode (Boolean)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::SendTypingIndicatorResponse]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.rcs.send_typing(
+      #    agent_id: "agent_pinnacle",
+      #    to: "+14154746461",
+      #    options: { test_mode: false }
+      #  )
+      def send_typing(agent_id:, to:, options: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              agentId: agent_id,
+              to: to,
+              options: options
+            }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/messages/typing"
+          end
+          Pinnacle::Types::SendTypingIndicatorResponse.from_json(json_object: response.body)
+        end
+      end
+
       # Validate RCS message content without sending it.
       #
       # @param request [Pinnacle::Types::RcsTextContent, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RcsCards]

data/lib/rcs/messages/rcs/types/send_typing_indicator_schema_options.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Messages
+    module Rcs
+      module Types
+        # Configure how your typing indicator is sent.
+        class SendTypingIndicatorSchemaOptions
+          # @return [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+          #  debugging.
+          attr_reader :test_mode
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param test_mode [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+          #  debugging.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions]
+          def initialize(test_mode: OMIT, additional_properties: nil)
+            @test_mode = test_mode if test_mode != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "test_mode": test_mode }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of SendTypingIndicatorSchemaOptions
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            test_mode = parsed_json["test_mode"]
+            new(test_mode: test_mode, additional_properties: struct)
+          end
+
+          # Serialize an instance of SendTypingIndicatorSchemaOptions to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.test_mode&.is_a?(Boolean) != false || raise("Passed value for field obj.test_mode is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rcs/types/audience_count_only.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class AudienceCountOnly
+      # @return [String] Audience public ID. This identifier is a string that always begins with the
+      #  prefix `aud_`, for example: `aud_abc123`.
+      attr_reader :id
+      # @return [String] Audience name.
+      attr_reader :name
+      # @return [String] Audience description.
+      attr_reader :description
+      # @return [Integer] Total number of contacts in audience.
+      #  Use the [Get Audience](/api-reference/audiences/get) endpoint with the
+      #  pagination parameters to get the audience with its contacts.
+      attr_reader :contact_count
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param id [String] Audience public ID. This identifier is a string that always begins with the
+      #  prefix `aud_`, for example: `aud_abc123`.
+      # @param name [String] Audience name.
+      # @param description [String] Audience description.
+      # @param contact_count [Integer] Total number of contacts in audience.
+      #  Use the [Get Audience](/api-reference/audiences/get) endpoint with the
+      #  pagination parameters to get the audience with its contacts.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AudienceCountOnly]
+      def initialize(id:, name:, description:, contact_count:, additional_properties: nil)
+        @id = id
+        @name = name
+        @description = description
+        @contact_count = contact_count
+        @additional_properties = additional_properties
+        @_field_set = { "id": id, "name": name, "description": description, "contactCount": contact_count }
+      end
+
+      # Deserialize a JSON object to an instance of AudienceCountOnly
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AudienceCountOnly]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        name = parsed_json["name"]
+        description = parsed_json["description"]
+        contact_count = parsed_json["contactCount"]
+        new(
+          id: id,
+          name: name,
+          description: description,
+          contact_count: contact_count,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AudienceCountOnly to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+        obj.contact_count.is_a?(Integer) != false || raise("Passed value for field obj.contact_count is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/audience_with_pagination.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative "contact"
+require_relative "pagination"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class AudienceWithPagination
+      # @return [String] Audience public ID. This identifier is a string that always begins with the
+      #  prefix `aud_`, for example: `aud_abc123`.
+      attr_reader :id
+      # @return [String] Audience name.
+      attr_reader :name
+      # @return [String] Audience description.
+      attr_reader :description
+      # @return [Array<Pinnacle::Types::Contact>] Array of contact objects (paginated).
+      attr_reader :contacts
+      # @return [Integer] Total number of contacts in audience.
+      attr_reader :contact_count
+      # @return [Pinnacle::Types::Pagination]
+      attr_reader :pagination
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param id [String] Audience public ID. This identifier is a string that always begins with the
+      #  prefix `aud_`, for example: `aud_abc123`.
+      # @param name [String] Audience name.
+      # @param description [String] Audience description.
+      # @param contacts [Array<Pinnacle::Types::Contact>] Array of contact objects (paginated).
+      # @param contact_count [Integer] Total number of contacts in audience.
+      # @param pagination [Pinnacle::Types::Pagination]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AudienceWithPagination]
+      def initialize(id:, name:, description:, contacts:, contact_count:, pagination:, additional_properties: nil)
+        @id = id
+        @name = name
+        @description = description
+        @contacts = contacts
+        @contact_count = contact_count
+        @pagination = pagination
+        @additional_properties = additional_properties
+        @_field_set = {
+          "id": id,
+          "name": name,
+          "description": description,
+          "contacts": contacts,
+          "contactCount": contact_count,
+          "pagination": pagination
+        }
+      end
+
+      # Deserialize a JSON object to an instance of AudienceWithPagination
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AudienceWithPagination]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        name = parsed_json["name"]
+        description = parsed_json["description"]
+        contacts = parsed_json["contacts"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::Contact.from_json(json_object: item)
+        end
+        contact_count = parsed_json["contactCount"]
+        if parsed_json["pagination"].nil?
+          pagination = nil
+        else
+          pagination = parsed_json["pagination"].to_json
+          pagination = Pinnacle::Types::Pagination.from_json(json_object: pagination)
+        end
+        new(
+          id: id,
+          name: name,
+          description: description,
+          contacts: contacts,
+          contact_count: contact_count,
+          pagination: pagination,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AudienceWithPagination to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+        obj.contacts.is_a?(Array) != false || raise("Passed value for field obj.contacts is not the expected type, validation failed.")
+        obj.contact_count.is_a?(Integer) != false || raise("Passed value for field obj.contact_count is not the expected type, validation failed.")
+        Pinnacle::Types::Pagination.validate_raw(obj: obj.pagination)
+      end
+    end
+  end
+end

data/lib/rcs/types/delete_audience_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class DeleteAudienceResponse
+      # @return [Boolean] Indicates successful deletion.
+      attr_reader :success
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param success [Boolean] Indicates successful deletion.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::DeleteAudienceResponse]
+      def initialize(success:, additional_properties: nil)
+        @success = success
+        @additional_properties = additional_properties
+        @_field_set = { "success": success }
+      end
+
+      # Deserialize a JSON object to an instance of DeleteAudienceResponse
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::DeleteAudienceResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        success = parsed_json["success"]
+        new(success: success, additional_properties: struct)
+      end
+
+      # Serialize an instance of DeleteAudienceResponse to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.success.is_a?(Boolean) != false || raise("Passed value for field obj.success is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/options.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require_relative "message_schedule"
+require_relative "tracking"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Configure how your RCS message is sent and tracked.
+    class Options
+      # @return [Pinnacle::Types::MessageSchedule]
+      attr_reader :schedule
+      # @return [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+      #  debugging.
+      attr_reader :test_mode
+      # @return [Pinnacle::Types::Tracking]
+      attr_reader :tracking
+      # @return [Boolean] Media files and card media will be transcoded to a supported RCS format. This
+      #  adds a small delay to sending the message. Ignored for rich text messages.
+      attr_reader :transcode
+      # @return [Boolean] Validate your message for any unsupported files. <br>
+      #  If failed, errors will be thrown and the message will not send.
+      attr_reader :validate
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param schedule [Pinnacle::Types::MessageSchedule]
+      # @param test_mode [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+      #  debugging.
+      # @param tracking [Pinnacle::Types::Tracking]
+      # @param transcode [Boolean] Media files and card media will be transcoded to a supported RCS format. This
+      #  adds a small delay to sending the message. Ignored for rich text messages.
+      # @param validate [Boolean] Validate your message for any unsupported files. <br>
+      #  If failed, errors will be thrown and the message will not send.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::Options]
+      def initialize(schedule: OMIT, test_mode: OMIT, tracking: OMIT, transcode: OMIT, validate: OMIT,
+                     additional_properties: nil)
+        @schedule = schedule if schedule != OMIT
+        @test_mode = test_mode if test_mode != OMIT
+        @tracking = tracking if tracking != OMIT
+        @transcode = transcode if transcode != OMIT
+        @validate = validate if validate != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "schedule": schedule,
+          "test_mode": test_mode,
+          "tracking": tracking,
+          "transcode": transcode,
+          "validate": validate
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of Options
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::Options]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["schedule"].nil?
+          schedule = nil
+        else
+          schedule = parsed_json["schedule"].to_json
+          schedule = Pinnacle::Types::MessageSchedule.from_json(json_object: schedule)
+        end
+        test_mode = parsed_json["test_mode"]
+        tracking = parsed_json["tracking"]
+        transcode = parsed_json["transcode"]
+        validate = parsed_json["validate"]
+        new(
+          schedule: schedule,
+          test_mode: test_mode,
+          tracking: tracking,
+          transcode: transcode,
+          validate: validate,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of Options to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.schedule.nil? || Pinnacle::Types::MessageSchedule.validate_raw(obj: obj.schedule)
+        obj.test_mode&.is_a?(Boolean) != false || raise("Passed value for field obj.test_mode is not the expected type, validation failed.")
+        obj.tracking&.is_a?(Pinnacle::Types::Tracking) != false || raise("Passed value for field obj.tracking is not the expected type, validation failed.")
+        obj.transcode&.is_a?(Boolean) != false || raise("Passed value for field obj.transcode is not the expected type, validation failed.")
+        obj.validate&.is_a?(Boolean) != false || raise("Passed value for field obj.validate is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/pagination.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class Pagination
+      # @return [Integer] Current page number (1-indexed).
+      attr_reader :page
+      # @return [Integer] Items per page (max 100, default 50).
+      attr_reader :limit
+      # @return [Integer] Total number of contacts in the audience.
+      attr_reader :total
+      # @return [Boolean] Whether more pages exist.
+      attr_reader :has_more
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param page [Integer] Current page number (1-indexed).
+      # @param limit [Integer] Items per page (max 100, default 50).
+      # @param total [Integer] Total number of contacts in the audience.
+      # @param has_more [Boolean] Whether more pages exist.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::Pagination]
+      def initialize(page:, limit:, total:, has_more:, additional_properties: nil)
+        @page = page
+        @limit = limit
+        @total = total
+        @has_more = has_more
+        @additional_properties = additional_properties
+        @_field_set = { "page": page, "limit": limit, "total": total, "hasMore": has_more }
+      end
+
+      # Deserialize a JSON object to an instance of Pagination
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::Pagination]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        page = parsed_json["page"]
+        limit = parsed_json["limit"]
+        total = parsed_json["total"]
+        has_more = parsed_json["hasMore"]
+        new(
+          page: page,
+          limit: limit,
+          total: total,
+          has_more: has_more,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of Pagination to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.page.is_a?(Integer) != false || raise("Passed value for field obj.page is not the expected type, validation failed.")
+        obj.limit.is_a?(Integer) != false || raise("Passed value for field obj.limit is not the expected type, validation failed.")
+        obj.total.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+        obj.has_more.is_a?(Boolean) != false || raise("Passed value for field obj.has_more is not the expected type, validation failed.")
+      end
+    end
+  end
+end