rcs 2.0.0.pre.rc.5 → 2.0.1

data/lib/rcs/status/get/client.rb

@@ -22,7 +22,9 @@ module Pinnacle
 
       # Retrieve a brand's status.
       #
-      # @param brand_id [Integer] ID of the brand.
+      # @param brand_id [String] The unique identifier of the brand you want to retrieve the status for. This
+      #  identifier is a string that always begins with the prefix `b_`, for example:
+      #  `b_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::BrandStatus]
       # @example
@@ -31,7 +33,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.status.get.brand(brand_id: 28)
+      #  api.status.get.brand(brand_id: "b_1234567890")
       def brand(brand_id:, 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?
@@ -54,7 +56,9 @@ module Pinnacle
 
       # Retrieve a toll-free campaign's status.
       #
-      # @param campaign_id [Integer] ID of the toll-free campaign.
+      # @param campaign_id [String] The unique identifier of the toll-free campaign you want to retrieve the status
+      #  for. This identifier is a string that always begins with the prefix `tf_`, for
+      #  example: `tf_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::TollFreeCampaignStatus]
       # @example
@@ -63,7 +67,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.status.get.toll_free(campaign_id: 28)
+      #  api.status.get.toll_free(campaign_id: "tf_1234567890")
       def toll_free(campaign_id:, 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?
@@ -86,7 +90,9 @@ module Pinnacle
 
       # Retrieve a 10DLC campaign's status.
       #
-      # @param campaign_id [Integer] ID of the 10DLC campaign.
+      # @param campaign_id [String] The unique identifier of the 10DLC campaign you want to retrieve the status for.
+      #  This identifier is a string that always begins with the prefix `dlc_`, for
+      #  example: `dlc_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DlcCampaignStatus]
       # @example
@@ -95,7 +101,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.status.get.dlc(campaign_id: 28)
+      #  api.status.get.dlc(campaign_id: "dlc_1234567890")
       def dlc(campaign_id:, 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?
@@ -118,7 +124,9 @@ module Pinnacle
 
       # Retrieve a RCS campaign's status.
       #
-      # @param campaign_id [Integer] ID of the campaign.
+      # @param campaign_id [String] The unique identifier of the RCS campaign you want to retrieve the status for.
+      #  This identifier is a string that always begins with the prefix `rcs_`, for
+      #  example: `rcs_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::RcsCampaignStatus]
       # @example
@@ -127,7 +135,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.status.get.rcs(campaign_id: 28)
+      #  api.status.get.rcs(campaign_id: "rcs_1234567890")
       def rcs(campaign_id:, 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?
@@ -194,7 +202,9 @@ module Pinnacle
 
       # Retrieve a brand's status.
       #
-      # @param brand_id [Integer] ID of the brand.
+      # @param brand_id [String] The unique identifier of the brand you want to retrieve the status for. This
+      #  identifier is a string that always begins with the prefix `b_`, for example:
+      #  `b_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::BrandStatus]
       # @example
@@ -203,7 +213,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.status.get.brand(brand_id: 28)
+      #  api.status.get.brand(brand_id: "b_1234567890")
       def brand(brand_id:, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
@@ -228,7 +238,9 @@ module Pinnacle
 
       # Retrieve a toll-free campaign's status.
       #
-      # @param campaign_id [Integer] ID of the toll-free campaign.
+      # @param campaign_id [String] The unique identifier of the toll-free campaign you want to retrieve the status
+      #  for. This identifier is a string that always begins with the prefix `tf_`, for
+      #  example: `tf_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::TollFreeCampaignStatus]
       # @example
@@ -237,7 +249,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.status.get.toll_free(campaign_id: 28)
+      #  api.status.get.toll_free(campaign_id: "tf_1234567890")
       def toll_free(campaign_id:, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
@@ -262,7 +274,9 @@ module Pinnacle
 
       # Retrieve a 10DLC campaign's status.
       #
-      # @param campaign_id [Integer] ID of the 10DLC campaign.
+      # @param campaign_id [String] The unique identifier of the 10DLC campaign you want to retrieve the status for.
+      #  This identifier is a string that always begins with the prefix `dlc_`, for
+      #  example: `dlc_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DlcCampaignStatus]
       # @example
@@ -271,7 +285,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.status.get.dlc(campaign_id: 28)
+      #  api.status.get.dlc(campaign_id: "dlc_1234567890")
       def dlc(campaign_id:, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
@@ -296,7 +310,9 @@ module Pinnacle
 
       # Retrieve a RCS campaign's status.
       #
-      # @param campaign_id [Integer] ID of the campaign.
+      # @param campaign_id [String] The unique identifier of the RCS campaign you want to retrieve the status for.
+      #  This identifier is a string that always begins with the prefix `rcs_`, for
+      #  example: `rcs_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::RcsCampaignStatus]
       # @example
@@ -305,7 +321,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.status.get.rcs(campaign_id: 28)
+      #  api.status.get.rcs(campaign_id: "rcs_1234567890")
       def rcs(campaign_id:, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|

data/lib/rcs/tools/contact_card/client.rb

@@ -25,9 +25,11 @@ module Pinnacle
       end
 
       # Retrieve contact information as a vCard and get a presigned URL to download the
-      #  file.
+      #  file. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a
+      #  media file.
       #
-      # @param id [Integer] ID of your contact.
+      # @param id [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       # @param options [Hash] Request of type Pinnacle::Tools::ContactCard::Types::GetVCardSchemaOptions, as a Hash
       #   * :expires_at (String)
       # @param request_options [Pinnacle::RequestOptions]
@@ -38,7 +40,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.tools.contact_card.get(id: 33)
+      #  api.tools.contact_card.get(id: "cc_1234567890")
       def get(id:, 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?
@@ -58,8 +60,11 @@ module Pinnacle
       end
 
       # Create a new contact card or updates an existing one with full vCard data.
+      #  Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media
+      #  file.
       #
-      # @param id [Integer] Unique identifier for the contact.
+      # @param id [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       # @param formatted_name [String] Full display name for the vCard.
       # @param name [Hash] Structured name components.Request of type Pinnacle::Types::VCardName, as a Hash
       #   * :family_name (String)
@@ -157,9 +162,11 @@ module Pinnacle
       end
 
       # Retrieve contact information as a vCard and get a presigned URL to download the
-      #  file.
+      #  file. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a
+      #  media file.
       #
-      # @param id [Integer] ID of your contact.
+      # @param id [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       # @param options [Hash] Request of type Pinnacle::Tools::ContactCard::Types::GetVCardSchemaOptions, as a Hash
       #   * :expires_at (String)
       # @param request_options [Pinnacle::RequestOptions]
@@ -170,7 +177,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.tools.contact_card.get(id: 33)
+      #  api.tools.contact_card.get(id: "cc_1234567890")
       def get(id:, options: nil, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
@@ -192,8 +199,11 @@ module Pinnacle
       end
 
       # Create a new contact card or updates an existing one with full vCard data.
+      #  Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media
+      #  file.
       #
-      # @param id [Integer] Unique identifier for the contact.
+      # @param id [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       # @param formatted_name [String] Full display name for the vCard.
       # @param name [Hash] Structured name components.Request of type Pinnacle::Types::VCardName, as a Hash
       #   * :family_name (String)

data/lib/rcs/tools/file/client.rb

@@ -3,6 +3,8 @@
 require_relative "../../../requests"
 require_relative "types/upload_file_options"
 require_relative "../../types/upload_results"
+require_relative "../../types/refreshed_file"
+require "json"
 require "async"
 
 module Pinnacle
@@ -29,6 +31,7 @@ module Pinnacle
       # @param size [Integer] Size of your file in bytes. Should be less than 100 MB.
       # @param name [String] Name of your file.
       # @param options [Hash] Additional configurations for your file.Request of type Pinnacle::Tools::File::Types::UploadFileOptions, as a Hash
+      #   * :delete_at (String)
       #   * :download (Hash)
       #     * :expires_at (String)
       # @param request_options [Pinnacle::RequestOptions]
@@ -43,7 +46,7 @@ module Pinnacle
       #    content_type: "image/jpeg",
       #    size: 1024,
       #    name: "test.jpg",
-      #    options: { download: { expires_at: "2025-06-30T12:00:00.000Z" } }
+      #    options: { delete_at: "2025-12-31T23:59:59Z", download: { expires_at: "2025-06-30T12:00:00.000Z" } }
       #  )
       def upload(content_type:, size:, name: nil, options: nil, request_options: nil)
         response = @request_client.conn.post do |req|
@@ -68,6 +71,48 @@ module Pinnacle
         end
         Pinnacle::Types::UploadResults.from_json(json_object: response.body)
       end
+
+      # Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access
+      #  time.
+      #  <Callout type="info">
+      #  This only works for presigned download URLs. At this moment, you cannot
+      #  refresh a presigned upload URL, generate a new one instead.
+      #  </Callout>
+      #
+      # @param urls [Array<String>] Array of file URLs to refresh for extended access. Provided URLs must be
+      #  presigned URLs (i.e.
+      #  `https://server.trypinnacle.app/storage/v1/object/sign/...`). Invalid or
+      #  external URLs will be returned unchanged in the response.
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Array<Pinnacle::Types::RefreshedFile>]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.tools.file.refresh(urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"])
+      def refresh(urls:, 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 || {}), urls: urls }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/tools/files/refresh"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RefreshedFile.from_json(json_object: item)
+        end
+      end
     end
 
     class AsyncFileClient
@@ -92,6 +137,7 @@ module Pinnacle
       # @param size [Integer] Size of your file in bytes. Should be less than 100 MB.
       # @param name [String] Name of your file.
       # @param options [Hash] Additional configurations for your file.Request of type Pinnacle::Tools::File::Types::UploadFileOptions, as a Hash
+      #   * :delete_at (String)
       #   * :download (Hash)
       #     * :expires_at (String)
       # @param request_options [Pinnacle::RequestOptions]
@@ -106,7 +152,7 @@ module Pinnacle
       #    content_type: "image/jpeg",
       #    size: 1024,
       #    name: "test.jpg",
-      #    options: { download: { expires_at: "2025-06-30T12:00:00.000Z" } }
+      #    options: { delete_at: "2025-12-31T23:59:59Z", download: { expires_at: "2025-06-30T12:00:00.000Z" } }
       #  )
       def upload(content_type:, size:, name: nil, options: nil, request_options: nil)
         Async do
@@ -133,6 +179,50 @@ module Pinnacle
           Pinnacle::Types::UploadResults.from_json(json_object: response.body)
         end
       end
+
+      # Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access
+      #  time.
+      #  <Callout type="info">
+      #  This only works for presigned download URLs. At this moment, you cannot
+      #  refresh a presigned upload URL, generate a new one instead.
+      #  </Callout>
+      #
+      # @param urls [Array<String>] Array of file URLs to refresh for extended access. Provided URLs must be
+      #  presigned URLs (i.e.
+      #  `https://server.trypinnacle.app/storage/v1/object/sign/...`). Invalid or
+      #  external URLs will be returned unchanged in the response.
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Array<Pinnacle::Types::RefreshedFile>]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.tools.file.refresh(urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"])
+      def refresh(urls:, 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 || {}), urls: urls }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/tools/files/refresh"
+          end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do |item|
+            item = item.to_json
+            Pinnacle::Types::RefreshedFile.from_json(json_object: item)
+          end
+        end
+      end
     end
   end
 end

data/lib/rcs/tools/file/types/upload_file_options.rb

@@ -10,6 +10,12 @@ module Pinnacle
       module Types
         # Additional configurations for your file.
         class UploadFileOptions
+          # @return [String] Set a deletion date for your file in ISO 8601 format. After this date, the file
+          #  will be automatically deleted from our storage.<br>
+          #  If this field is not provided, the file will not be deleted. You can still
+          #  schedule deletion or delete the file manually in the Storage page in the
+          #  dashboard.
+          attr_reader :delete_at
           # @return [Pinnacle::Tools::File::Types::DownloadOptions] Configure download settings for your uploaded file.
           attr_reader :download
           # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -20,13 +26,19 @@ module Pinnacle
 
           OMIT = Object.new
 
+          # @param delete_at [String] Set a deletion date for your file in ISO 8601 format. After this date, the file
+          #  will be automatically deleted from our storage.<br>
+          #  If this field is not provided, the file will not be deleted. You can still
+          #  schedule deletion or delete the file manually in the Storage page in the
+          #  dashboard.
           # @param download [Pinnacle::Tools::File::Types::DownloadOptions] Configure download settings for your uploaded file.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [Pinnacle::Tools::File::Types::UploadFileOptions]
-          def initialize(download: OMIT, additional_properties: nil)
+          def initialize(delete_at: OMIT, download: OMIT, additional_properties: nil)
+            @delete_at = delete_at if delete_at != OMIT
             @download = download if download != OMIT
             @additional_properties = additional_properties
-            @_field_set = { "download": download }.reject do |_k, v|
+            @_field_set = { "deleteAt": delete_at, "download": download }.reject do |_k, v|
               v == OMIT
             end
           end
@@ -38,13 +50,18 @@ module Pinnacle
           def self.from_json(json_object:)
             struct = JSON.parse(json_object, object_class: OpenStruct)
             parsed_json = JSON.parse(json_object)
+            delete_at = parsed_json["deleteAt"]
             if parsed_json["download"].nil?
               download = nil
             else
               download = parsed_json["download"].to_json
               download = Pinnacle::Tools::File::Types::DownloadOptions.from_json(json_object: download)
             end
-            new(download: download, additional_properties: struct)
+            new(
+              delete_at: delete_at,
+              download: download,
+              additional_properties: struct
+            )
           end
 
           # Serialize an instance of UploadFileOptions to a JSON object
@@ -61,6 +78,7 @@ module Pinnacle
           # @param obj [Object]
           # @return [Void]
           def self.validate_raw(obj:)
+            obj.delete_at&.is_a?(String) != false || raise("Passed value for field obj.delete_at is not the expected type, validation failed.")
             obj.download.nil? || Pinnacle::Tools::File::Types::DownloadOptions.validate_raw(obj: obj.download)
           end
         end

data/lib/rcs/tools/url/client.rb

@@ -86,7 +86,8 @@ module Pinnacle
         Pinnacle::Types::ShortenedUrlWithClickData.from_json(json_object: response.body)
       end
 
-      # Update the destination or configuration of an existing shortened URL.
+      # Update the destination or expiration date of an existing shortened URL. Expiring
+      #  links cannot be updated into a permalink.
       #
       # @param link_id [String] Unique identifier from your shortened URL. For example, for
       #  `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
@@ -204,7 +205,8 @@ module Pinnacle
         end
       end
 
-      # Update the destination or configuration of an existing shortened URL.
+      # Update the destination or expiration date of an existing shortened URL. Expiring
+      #  links cannot be updated into a permalink.
       #
       # @param link_id [String] Unique identifier from your shortened URL. For example, for
       #  `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>

data/lib/rcs/types/attach_webhook_by_id_params.rb

@@ -8,8 +8,8 @@ module Pinnacle
   module Types
     # Attach a webhook you’ve already created in your account to this phone number.
     class AttachWebhookByIdParams
-      # @return [Integer] The unique ID of the webhook you want to attach.<br>
-      #  Make sure this webhook is active and able to receive event notifications.
+      # @return [String] The unique ID of the webhook you want to attach. This identifier is a string
+      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
       attr_reader :webhook_id
       # @return [Pinnacle::Types::WebhookEventEnum] Select the event type that will trigger this webhook. <br>
       #  Set to null if you want to listen to all event types for this phone number. <br>
@@ -23,8 +23,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param webhook_id [Integer] The unique ID of the webhook you want to attach.<br>
-      #  Make sure this webhook is active and able to receive event notifications.
+      # @param webhook_id [String] The unique ID of the webhook you want to attach. This identifier is a string
+      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
       # @param event [Pinnacle::Types::WebhookEventEnum] Select the event type that will trigger this webhook. <br>
       #  Set to null if you want to listen to all event types for this phone number. <br>
       #  Defaults to null.
@@ -69,7 +69,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.webhook_id.is_a?(Integer) != false || raise("Passed value for field obj.webhook_id is not the expected type, validation failed.")
+        obj.webhook_id.is_a?(String) != false || raise("Passed value for field obj.webhook_id is not the expected type, validation failed.")
         obj.event&.is_a?(Pinnacle::Types::WebhookEventEnum) != false || raise("Passed value for field obj.event is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/attach_webhook_response_webhook.rb

@@ -7,7 +7,8 @@ module Pinnacle
   module Types
     # Detailed information about the attached webhook.
     class AttachWebhookResponseWebhook
-      # @return [Integer] Unique identifier of the webhook within the account.
+      # @return [String] Unique identifier of the webhook within the account. This identifier is a string
+      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
       attr_reader :id
       # @return [String] Name of the webhook.
       attr_reader :name
@@ -24,7 +25,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [Integer] Unique identifier of the webhook within the account.
+      # @param id [String] Unique identifier of the webhook within the account. This identifier is a string
+      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
       # @param name [String] Name of the webhook.
       # @param url [String] The HTTPS endpoint URL where webhook events will be sent as HTTP POST requests.
       # @param secret [String] Secret key used to verify the authenticity of incoming webhook requests. <br>
@@ -76,7 +78,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        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.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
         obj.secret&.is_a?(String) != false || raise("Passed value for field obj.secret is not the expected type, validation failed.")

data/lib/rcs/types/autofill_campaign_params.rb

@@ -8,7 +8,13 @@ module Pinnacle
     class AutofillCampaignParams
       # @return [String] Any additional information you want to provide.
       attr_reader :additional_info
-      # @return [Integer] Campaign ID.
+      # @return [String] Unique identifier for the campaign.
+      #  - When autofilling 10DLC campaigns, it must begin with the prefix `dlc_` (e.g.,
+      #  `dlc_1234567890`)
+      #  - When autofilling Toll-Free campaigns, it must begin with the prefix `tf_`
+      #  (e.g., `tf_1234567890`)
+      #  - When autofilling RCS campaigns, it must begin with the prefix `rcs_` (e.g.,
+      #  `rcs_1234567890`)
       attr_reader :campaign_id
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -19,7 +25,13 @@ module Pinnacle
       OMIT = Object.new
 
       # @param additional_info [String] Any additional information you want to provide.
-      # @param campaign_id [Integer] Campaign ID.
+      # @param campaign_id [String] Unique identifier for the campaign.
+      #  - When autofilling 10DLC campaigns, it must begin with the prefix `dlc_` (e.g.,
+      #  `dlc_1234567890`)
+      #  - When autofilling Toll-Free campaigns, it must begin with the prefix `tf_`
+      #  (e.g., `tf_1234567890`)
+      #  - When autofilling RCS campaigns, it must begin with the prefix `rcs_` (e.g.,
+      #  `rcs_1234567890`)
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::AutofillCampaignParams]
       def initialize(additional_info: OMIT, campaign_id: OMIT, additional_properties: nil)
@@ -62,7 +74,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.additional_info&.is_a?(String) != false || raise("Passed value for field obj.additional_info is not the expected type, validation failed.")
-        obj.campaign_id&.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
+        obj.campaign_id&.is_a?(String) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/autofill_dlc_campaign_response.rb

@@ -12,9 +12,11 @@ module Pinnacle
     class AutofillDlcCampaignResponse
       # @return [Boolean] Whether the campaign renews automatically.
       attr_reader :auto_renew
-      # @return [Integer] Brand id.
+      # @return [String] Brand id. This identifier is a string that always begins with the prefix `b_`,
+      #  for example: `b_1234567890`.
       attr_reader :brand
-      # @return [Integer] Unique identifier for the campaign.
+      # @return [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       attr_reader :campaign_id
       # @return [String] Description of the campaign.
       attr_reader :description
@@ -41,8 +43,10 @@ module Pinnacle
       OMIT = Object.new
 
       # @param auto_renew [Boolean] Whether the campaign renews automatically.
-      # @param brand [Integer] Brand id.
-      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param brand [String] Brand id. This identifier is a string that always begins with the prefix `b_`,
+      #  for example: `b_1234567890`.
+      # @param campaign_id [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       # @param description [String] Description of the campaign.
       # @param keywords [Pinnacle::Types::AutofillDlcResponseKeywords] Keyword response configuration.
       # @param links [Pinnacle::Types::AutofillDlcResponseLinks] Legal documentation links.
@@ -153,8 +157,8 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.auto_renew.is_a?(Boolean) != false || raise("Passed value for field obj.auto_renew is not the expected type, validation failed.")
-        obj.brand&.is_a?(Integer) != false || raise("Passed value for field obj.brand is not the expected type, validation failed.")
-        obj.campaign_id&.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
+        obj.brand&.is_a?(String) != false || raise("Passed value for field obj.brand is not the expected type, validation failed.")
+        obj.campaign_id&.is_a?(String) != false || raise("Passed value for field obj.campaign_id 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.keywords.nil? || Pinnacle::Types::AutofillDlcResponseKeywords.validate_raw(obj: obj.keywords)
         obj.links.nil? || Pinnacle::Types::AutofillDlcResponseLinks.validate_raw(obj: obj.links)

data/lib/rcs/types/autofill_dlc_response_keywords.rb

@@ -29,14 +29,12 @@ module Pinnacle
       # @param opt_out [Pinnacle::Types::AutofillDlcResponseKeywordsOptOut] Opt-out keyword settings.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::AutofillDlcResponseKeywords]
-      def initialize(help: OMIT, opt_in: OMIT, opt_out: OMIT, additional_properties: nil)
-        @help = help if help != OMIT
-        @opt_in = opt_in if opt_in != OMIT
-        @opt_out = opt_out if opt_out != OMIT
+      def initialize(help:, opt_in:, opt_out:, additional_properties: nil)
+        @help = help
+        @opt_in = opt_in
+        @opt_out = opt_out
         @additional_properties = additional_properties
-        @_field_set = { "HELP": help, "OPT_IN": opt_in, "OPT_OUT": opt_out }.reject do |_k, v|
-          v == OMIT
-        end
+        @_field_set = { "HELP": help, "OPT_IN": opt_in, "OPT_OUT": opt_out }
       end
 
       # Deserialize a JSON object to an instance of AutofillDlcResponseKeywords
@@ -86,9 +84,9 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.help.nil? || Pinnacle::Types::AutofillDlcResponseKeywordsHelp.validate_raw(obj: obj.help)
-        obj.opt_in.nil? || Pinnacle::Types::AutofillDlcResponseKeywordsOptIn.validate_raw(obj: obj.opt_in)
-        obj.opt_out.nil? || Pinnacle::Types::AutofillDlcResponseKeywordsOptOut.validate_raw(obj: obj.opt_out)
+        Pinnacle::Types::AutofillDlcResponseKeywordsHelp.validate_raw(obj: obj.help)
+        Pinnacle::Types::AutofillDlcResponseKeywordsOptIn.validate_raw(obj: obj.opt_in)
+        Pinnacle::Types::AutofillDlcResponseKeywordsOptOut.validate_raw(obj: obj.opt_out)
       end
     end
   end

data/lib/rcs/types/autofill_dlc_response_keywords_help.rb

@@ -23,9 +23,9 @@ module Pinnacle
       # @param values [Array<String>] Keywords that trigger help response.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::AutofillDlcResponseKeywordsHelp]
-      def initialize(message: OMIT, values: OMIT, additional_properties: nil)
+      def initialize(values:, message: OMIT, additional_properties: nil)
         @message = message if message != OMIT
-        @values = values if values != OMIT
+        @values = values
         @additional_properties = additional_properties
         @_field_set = { "message": message, "values": values }.reject do |_k, v|
           v == OMIT
@@ -63,7 +63,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
-        obj.values&.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
+        obj.values.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
       end
     end
   end