rcs 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c98f78cc1ea5796ec8fc65c63be91084717c9b726b8191ad79266ddf73c34285
-  data.tar.gz: 1d4af67f770184e27a8ecfa6ddb67142c62ea935e6e035e6314ded4e7913e554
+  metadata.gz: 9ae139d400bbfa1ab360ba9c8330f3cdf286e7ef16772032ff9dba8be4b54f21
+  data.tar.gz: f2041515877561cffa19ad82eda057813788dd59f5e6423b89005197085f98ec
 SHA512:
-  metadata.gz: 1eeb298dfb7a4207d5e3effb626124e3c27275c2d96f66b48f3013ed67a1dcd6300c47961a71ec0c543ca2166d79d96e7909f2f5d1d425bac3739a16da5365a3
-  data.tar.gz: c856a7edbe4169431bcbe72ede9ddb6e21dea469579b73f60cd1cf3a9ca496e8fa6905b9fc3441bca04e06aeaf0a7c1a16f9e4e9e8addf3fcd7761a0e0be5bb3
+  metadata.gz: 9923fb9be738fd30e395689c60cddd25046dbc073bdf1af1792cb2260e7e43bdd1da99d9e74a7c8fd344d3c34aba7375cdcbb1749e8d35bad1779e759f71c574
+  data.tar.gz: fa778ca98424e492675eb4906a908b97dabeacfa4c5fe72c0f79d88ae562e00a838b94a1cafb3902bf940a0e0697cc467d77a476b45a91d50fb86e8913938954

data/lib/rcs/audiences/client.rb

@@ -0,0 +1,347 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/audiences_get_response"
+require_relative "../types/audience_count_only"
+require_relative "../types/delete_audience_response"
+require "async"
+
+module Pinnacle
+  class AudiencesClient
+    # @return [Pinnacle::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Pinnacle::RequestClient]
+    # @return [Pinnacle::AudiencesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieve an audience by ID with optional pagination.
+    #
+    # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
+    #  `aud_`, for example: `aud_abc123`.
+    # @param page [Integer] Page number. If provided with or without limit, returns paginated contacts.
+    # @param limit [Integer] Items per page. If provided with or without page, returns paginated contacts.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::AudienceWithPagination, Pinnacle::Types::AudienceCountOnly]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.audiences.get(id: "aud_abc123")
+    def get(id:, page: nil, limit: nil, request_options: nil)
+      response = @request_client.conn.get 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
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "id": id,
+          "page": page,
+          "limit": limit
+        }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
+      end
+      Pinnacle::Audiences::Types::AudiencesGetResponse.from_json(json_object: response.body)
+    end
+
+    # Create a new audience with optional initial contacts. Phone numbers that don't
+    #  exist will be auto-created as contacts.
+    #
+    # @param name [String] Audience name.
+    # @param description [String] Audience description.
+    # @param contacts [Array<String>] Optional array of phone numbers (E.164 format) or contact IDs.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::AudienceCountOnly]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.audiences.create(name: "Marketing Campaign Q1", description: "Contacts for Q1 marketing push")
+    def create(name:, description: nil, contacts: 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 || {}),
+          name: name,
+          description: description,
+          contacts: contacts
+        }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
+      end
+      Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
+    end
+
+    # Permanently delete an audience and all its contact associations.
+    #  Note: This will NOT delete the contacts themselves, only the audience and its
+    #  memberships.
+    #
+    # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
+    #  `aud_`, for example: `aud_abc123`.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::DeleteAudienceResponse]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.audiences.delete(id: "aud_abc123")
+    def delete(id:, request_options: nil)
+      response = @request_client.conn.delete 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
+        req.params = { **(request_options&.additional_query_parameters || {}), "id": id }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
+      end
+      Pinnacle::Types::DeleteAudienceResponse.from_json(json_object: response.body)
+    end
+
+    # Update audience metadata. This endpoint does NOT modify contacts.
+    #  To add or remove contacts, use the [Add
+    #  Contacts](/api-reference/audiences/add-contacts) or [Remove
+    #  Contacts](/api-reference/audiences/remove-contacts) endpoints.
+    #
+    # @param id [String] Audience ID to update. This identifier is a string that always begins with the
+    #  prefix `aud_`, for example: `aud_abc123`.
+    # @param name [String] New audience name.
+    # @param description [String] New audience description.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::AudienceCountOnly]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.audiences.update(
+    #    id: "aud_abc123",
+    #    name: "Updated Audience Name",
+    #    description: "New description"
+    #  )
+    def update(id:, name: nil, description: nil, request_options: nil)
+      response = @request_client.conn.patch 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 || {}),
+          id: id,
+          name: name,
+          description: description
+        }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
+      end
+      Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncAudiencesClient
+    # @return [Pinnacle::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Pinnacle::AsyncRequestClient]
+    # @return [Pinnacle::AsyncAudiencesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieve an audience by ID with optional pagination.
+    #
+    # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
+    #  `aud_`, for example: `aud_abc123`.
+    # @param page [Integer] Page number. If provided with or without limit, returns paginated contacts.
+    # @param limit [Integer] Items per page. If provided with or without page, returns paginated contacts.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::AudienceWithPagination, Pinnacle::Types::AudienceCountOnly]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.audiences.get(id: "aud_abc123")
+    def get(id:, page: nil, limit: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get 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
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "id": id,
+            "page": page,
+            "limit": limit
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
+        end
+        Pinnacle::Audiences::Types::AudiencesGetResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Create a new audience with optional initial contacts. Phone numbers that don't
+    #  exist will be auto-created as contacts.
+    #
+    # @param name [String] Audience name.
+    # @param description [String] Audience description.
+    # @param contacts [Array<String>] Optional array of phone numbers (E.164 format) or contact IDs.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::AudienceCountOnly]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.audiences.create(name: "Marketing Campaign Q1", description: "Contacts for Q1 marketing push")
+    def create(name:, description: nil, contacts: 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 || {}),
+            name: name,
+            description: description,
+            contacts: contacts
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
+        end
+        Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
+      end
+    end
+
+    # Permanently delete an audience and all its contact associations.
+    #  Note: This will NOT delete the contacts themselves, only the audience and its
+    #  memberships.
+    #
+    # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
+    #  `aud_`, for example: `aud_abc123`.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::DeleteAudienceResponse]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.audiences.delete(id: "aud_abc123")
+    def delete(id:, request_options: nil)
+      Async do
+        response = @request_client.conn.delete 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
+          req.params = { **(request_options&.additional_query_parameters || {}), "id": id }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
+        end
+        Pinnacle::Types::DeleteAudienceResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Update audience metadata. This endpoint does NOT modify contacts.
+    #  To add or remove contacts, use the [Add
+    #  Contacts](/api-reference/audiences/add-contacts) or [Remove
+    #  Contacts](/api-reference/audiences/remove-contacts) endpoints.
+    #
+    # @param id [String] Audience ID to update. This identifier is a string that always begins with the
+    #  prefix `aud_`, for example: `aud_abc123`.
+    # @param name [String] New audience name.
+    # @param description [String] New audience description.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::AudienceCountOnly]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.audiences.update(
+    #    id: "aud_abc123",
+    #    name: "Updated Audience Name",
+    #    description: "New description"
+    #  )
+    def update(id:, name: nil, description: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.patch 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 || {}),
+            id: id,
+            name: name,
+            description: description
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
+        end
+        Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/rcs/audiences/contacts/client.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/audience_count_only"
+require "async"
+
+module Pinnacle
+  module Audiences
+    class ContactsClient
+      # @return [Pinnacle::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::RequestClient]
+      # @return [Pinnacle::Audiences::ContactsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Remove contacts from an existing audience. This operation is idempotent.
+      #  - Only removes contacts that exist in the audience
+      #  - Contacts not in the audience are ignored
+      #
+      # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
+      #  `aud_`, for example: `aud_abc123`.
+      # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::AudienceCountOnly]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.audiences.contacts.remove(id: "aud_abc123", contacts: ["+12125551234", "co_def456"])
+      def remove(id:, contacts:, request_options: nil)
+        response = @request_client.conn.delete 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 || {}), id: id, contacts: contacts }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/audiences/contacts"
+        end
+        Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
+      end
+
+      # Add contacts to an existing audience. This operation is additive and idempotent.
+      #  - Phone numbers that don't exist will be auto-created as contacts
+      #  - Duplicate adds are ignored
+      #  - Contacts already in the audience are ignored
+      #
+      # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
+      #  `aud_`, for example: `aud_abc123`.
+      # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::AudienceCountOnly]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.audiences.contacts.add(id: "aud_abc123", contacts: ["+12125551234", "co_def456", "+13105551234"])
+      def add(id:, contacts:, request_options: nil)
+        response = @request_client.conn.patch 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 || {}), id: id, contacts: contacts }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/audiences/contacts"
+        end
+        Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncContactsClient
+      # @return [Pinnacle::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::AsyncRequestClient]
+      # @return [Pinnacle::Audiences::AsyncContactsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Remove contacts from an existing audience. This operation is idempotent.
+      #  - Only removes contacts that exist in the audience
+      #  - Contacts not in the audience are ignored
+      #
+      # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
+      #  `aud_`, for example: `aud_abc123`.
+      # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::AudienceCountOnly]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.audiences.contacts.remove(id: "aud_abc123", contacts: ["+12125551234", "co_def456"])
+      def remove(id:, contacts:, request_options: nil)
+        Async do
+          response = @request_client.conn.delete 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 || {}), id: id, contacts: contacts }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/audiences/contacts"
+          end
+          Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
+        end
+      end
+
+      # Add contacts to an existing audience. This operation is additive and idempotent.
+      #  - Phone numbers that don't exist will be auto-created as contacts
+      #  - Duplicate adds are ignored
+      #  - Contacts already in the audience are ignored
+      #
+      # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
+      #  `aud_`, for example: `aud_abc123`.
+      # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::AudienceCountOnly]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.audiences.contacts.add(id: "aud_abc123", contacts: ["+12125551234", "co_def456", "+13105551234"])
+      def add(id:, contacts:, request_options: nil)
+        Async do
+          response = @request_client.conn.patch 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 || {}), id: id, contacts: contacts }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/audiences/contacts"
+          end
+          Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/rcs/audiences/types/audiences_get_response.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../../types/audience_with_pagination"
+require_relative "../../types/audience_count_only"
+
+module Pinnacle
+  module Audiences
+    module Types
+      class AudiencesGetResponse
+        # Deserialize a JSON object to an instance of AudiencesGetResponse
+        #
+        # @param json_object [String]
+        # @return [Pinnacle::Audiences::Types::AudiencesGetResponse]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          begin
+            Pinnacle::Types::AudienceWithPagination.validate_raw(obj: struct)
+            return Pinnacle::Types::AudienceWithPagination.from_json(json_object: struct) unless struct.nil?
+
+            return nil
+          rescue StandardError
+            # noop
+          end
+          begin
+            Pinnacle::Types::AudienceCountOnly.validate_raw(obj: struct)
+            return Pinnacle::Types::AudienceCountOnly.from_json(json_object: struct) unless struct.nil?
+
+            return nil
+          rescue StandardError
+            # noop
+          end
+          struct
+        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:)
+          begin
+            return Pinnacle::Types::AudienceWithPagination.validate_raw(obj: obj)
+          rescue StandardError
+            # noop
+          end
+          begin
+            return Pinnacle::Types::AudienceCountOnly.validate_raw(obj: obj)
+          rescue StandardError
+            # noop
+          end
+          raise("Passed value matched no type within the union, validation failed.")
+        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/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

data/lib/rcs/types/sent_mms_details.rb

@@ -6,8 +6,15 @@ require "json"
 module Pinnacle
   module Types
     class SentMmsDetails
-      # @return [Array<String>] Array of unique identifiers for the sent MMS messages. This identifiers are
-      #  strings that always begin with the prefix `msg_`, for example: `msg_1234567890`.
+      # @return [Array<String>] Array of unique message identifiers for an individual MMS send. Each identifier
+      #  is a string that always begins with the prefix `msg_`, for example:
+      #  `msg_1234567890`. <br><br>
+      #  When media assets are too large to fit in a single MMS and
+      #  `options.multiple_messages` is set to true, the content is automatically split
+      #  across multiple messages. Each split message gets its own ID, and all IDs are
+      #  returned in this array. <br><br>
+      #  Note: When sending to audiences, you'll receive multiple response objects (one
+      #  per recipient), each containing its own messageIds array.
       attr_reader :message_ids
       # @return [Float] Total number of segments used across the message.
       attr_reader :segments
@@ -27,8 +34,15 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param message_ids [Array<String>] Array of unique identifiers for the sent MMS messages. This identifiers are
-      #  strings that always begin with the prefix `msg_`, for example: `msg_1234567890`.
+      # @param message_ids [Array<String>] Array of unique message identifiers for an individual MMS send. Each identifier
+      #  is a string that always begins with the prefix `msg_`, for example:
+      #  `msg_1234567890`. <br><br>
+      #  When media assets are too large to fit in a single MMS and
+      #  `options.multiple_messages` is set to true, the content is automatically split
+      #  across multiple messages. Each split message gets its own ID, and all IDs are
+      #  returned in this array. <br><br>
+      #  Note: When sending to audiences, you'll receive multiple response objects (one
+      #  per recipient), each containing its own messageIds array.
       # @param segments [Float] Total number of segments used across the message.
       # @param total_cost [Float] Total cost of sending the message.
       # @param sender [String] Sender's phone number in E.164 format.

data/lib/rcs.rb

@@ -4,6 +4,7 @@ require_relative "environment"
 require_relative "types_export"
 require_relative "requests"
 require_relative "rcs/brands/client"
+require_relative "rcs/audiences/client"
 require_relative "rcs/contacts/client"
 require_relative "rcs/conversations/client"
 require_relative "rcs/messages/client"
@@ -18,6 +19,8 @@ module Pinnacle
   class Client
     # @return [Pinnacle::BrandsClient]
     attr_reader :brands
+    # @return [Pinnacle::AudiencesClient]
+    attr_reader :audiences
     # @return [Pinnacle::ContactsClient]
     attr_reader :contacts
     # @return [Pinnacle::ConversationsClient]
@@ -53,6 +56,7 @@ module Pinnacle
         api_key: api_key
       )
       @brands = Pinnacle::BrandsClient.new(request_client: @request_client)
+      @audiences = Pinnacle::AudiencesClient.new(request_client: @request_client)
       @contacts = Pinnacle::ContactsClient.new(request_client: @request_client)
       @conversations = Pinnacle::ConversationsClient.new(request_client: @request_client)
       @messages = Pinnacle::MessagesClient.new(request_client: @request_client)
@@ -68,6 +72,8 @@ module Pinnacle
   class AsyncClient
     # @return [Pinnacle::AsyncBrandsClient]
     attr_reader :brands
+    # @return [Pinnacle::AsyncAudiencesClient]
+    attr_reader :audiences
     # @return [Pinnacle::AsyncContactsClient]
     attr_reader :contacts
     # @return [Pinnacle::AsyncConversationsClient]
@@ -103,6 +109,7 @@ module Pinnacle
         api_key: api_key
       )
       @brands = Pinnacle::AsyncBrandsClient.new(request_client: @async_request_client)
+      @audiences = Pinnacle::AsyncAudiencesClient.new(request_client: @async_request_client)
       @contacts = Pinnacle::AsyncContactsClient.new(request_client: @async_request_client)
       @conversations = Pinnacle::AsyncConversationsClient.new(request_client: @async_request_client)
       @messages = Pinnacle::AsyncMessagesClient.new(request_client: @async_request_client)

data/lib/requests.rb

@@ -43,7 +43,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.1" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.2" }
       headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end
@@ -87,7 +87,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.1" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.2" }
       headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end

data/lib/types_export.rb

@@ -2,6 +2,9 @@
 
 require_relative "rcs/brands/types/autofill_brand_options"
 require_relative "rcs/brands/types/brand_contact"
+require_relative "rcs/types/audience_with_pagination"
+require_relative "rcs/types/audience_count_only"
+require_relative "rcs/audiences/types/audiences_get_response"
 require_relative "rcs/conversations/types/conversations_list_messages_request_sort_order"
 require_relative "rcs/conversations/types/conversations_list_messages_request_direction"
 require_relative "rcs/conversations/types/conversations_list_messages_request_status"
@@ -119,6 +122,8 @@ require_relative "rcs/types/rcs_campaign_schema_extra_opt_out"
 require_relative "rcs/types/rcs_campaign_schema_extra_use_case"
 require_relative "rcs/types/extended_rcs_campaign"
 require_relative "rcs/types/contact"
+require_relative "rcs/types/pagination"
+require_relative "rcs/types/delete_audience_response"
 require_relative "rcs/types/optional_contact"
 require_relative "rcs/types/updated_contact_id"
 require_relative "rcs/types/contact_id"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcs
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - ''
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-12 00:00:00.000000000 Z
+date: 2025-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -99,6 +99,9 @@ files:
 - lib/environment.rb
 - lib/gemconfig.rb
 - lib/rcs.rb
+- lib/rcs/audiences/client.rb
+- lib/rcs/audiences/contacts/client.rb
+- lib/rcs/audiences/types/audiences_get_response.rb
 - lib/rcs/brands/client.rb
 - lib/rcs/brands/types/autofill_brand_options.rb
 - lib/rcs/brands/types/brand_contact.rb
@@ -175,6 +178,8 @@ files:
 - lib/rcs/types/attach_webhook_params.rb
 - lib/rcs/types/attach_webhook_response_webhook.rb
 - lib/rcs/types/attached_phone_number_result.rb
+- lib/rcs/types/audience_count_only.rb
+- lib/rcs/types/audience_with_pagination.rb
 - lib/rcs/types/autofill_campaign_params.rb
 - lib/rcs/types/autofill_dlc_campaign_response.rb
 - lib/rcs/types/autofill_dlc_response_keywords.rb
@@ -215,6 +220,7 @@ files:
 - lib/rcs/types/conversation_sender.rb
 - lib/rcs/types/create_and_attach_webhook_by_url_params.rb
 - lib/rcs/types/create_url_options.rb
+- lib/rcs/types/delete_audience_response.rb
 - lib/rcs/types/detached_phone_number_result.rb
 - lib/rcs/types/detached_webhook_info.rb
 - lib/rcs/types/detailed_phone_number_enum.rb
@@ -275,6 +281,7 @@ files:
 - lib/rcs/types/optional_contact.rb
 - lib/rcs/types/optional_contacts.rb
 - lib/rcs/types/options.rb
+- lib/rcs/types/pagination.rb
 - lib/rcs/types/phone.rb
 - lib/rcs/types/phone_capabilities.rb
 - lib/rcs/types/phone_enum.rb