rcs 2.0.0.pre.rc.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 262806a75a52a70e37dd92a0036ba70af3a59aa98ea132dd60f2dad6cbe2c95a
-  data.tar.gz: 5dcd700d3f9a65f9dfa3bd4551773fb8fa6789f39e998b053eef877fc95daf70
+  metadata.gz: 0b62f856fc547382d4d1cf18aa5d06d9746cc02480ed3890318a707c2fba8794
+  data.tar.gz: 9403e66a841948733781b0eddade27c3108cf169e13af030edfe309fea50b530
 SHA512:
-  metadata.gz: af03848b61375c06cd367fa1b2609616568daba7e7858e377e7f03cfb68f34f9d26b9681bbd9eb94164e48a35219db9932a260feebe59d4f0317243e4ee42e38
-  data.tar.gz: 82b3b96ff4b841b1cd3078487f938d01105639414d0bb0950728081aec53b0cd93ea570f8596445c7886d0fee6e38a492bfd6df60040bb82a1b87233ee588d96
+  metadata.gz: 1fcb90da1af1f5cbbc8c429f225199b402f3738455295a21570169cd5a2c77464f57378e90d0bed2f297980d18bcd6c6dac92df7a842f96b8e695c4d05f14592
+  data.tar.gz: 4553c27971714a7fbd92a07002e0e75248463a4dacb30a89a2f9eb570599795bcebba4764f6234c84832b8632b56cf7408ceebebf9cbf4438721a3c1650ac359

data/lib/rcs/brands/client.rb

@@ -83,8 +83,9 @@ module Pinnacle
     # @param description [String] Brief description of what the brand does.
     # @param ein [String] Brand's Employer Identification Number (EIN) assigned by the IRS.
     # @param email [String] Main contact email address for the brand.
-    # @param id [Integer] Brand ID - include only when updating an existing brand, omit to create a new
-    #  one.
+    # @param id [String] The unique identifier of the brand you want to update.
+    #  <br><br> This identifier is a string that always begins with the prefix `b_`,
+    #  for example: `b_1234567890`.
     # @param name [String] Legal name of the brand as registered.
     # @param sector [Pinnacle::Types::CompanySectorEnum] Industry the brand operates in.
     # @param type [Pinnacle::Types::CompanyTypeEnum] Legal structure of the brand.
@@ -104,7 +105,7 @@ module Pinnacle
     #    description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
     #    ein: "88-1234567",
     #    email: "founders@trypinnacle.app",
-    #    id: 1,
+    #    id: "b_1234567890",
     #    name: "Pinnacle",
     #    sector: TECHNOLOGY,
     #    type: PRIVATE_PROFIT,
@@ -144,7 +145,9 @@ module Pinnacle
 
     # Retrieve detailed information for a specific brand in your account by ID.
     #
-    # @param id [Integer] ID of an existing brand in your account that you want to retrieve.
+    # @param id [String] The unique identifier of the brand you want to retrieve from your account.
+    #  <br><br> This identifier is a string that always begins with the prefix `b_`,
+    #  for example: `b_1234567890`.
     # @param hide_ein [Boolean] Optional flag to mask the Employer Identification Number in the response for
     #  security purposes.<br>
     #  When you set this to true, the EIN value will be replaced with a masked
@@ -157,7 +160,7 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.brands.get(id: 1)
+    #  api.brands.get(id: "b_1234567890")
     def get(id:, hide_ein: 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?
@@ -178,9 +181,10 @@ module Pinnacle
 
     # Submit your brand for review and approval by the compliance team.
     #
-    # @param brand_id [Integer] The unique identifier of the brand you want to submit for review. <br>
-    #  Must correspond to an existing brand in your account that is ready for
-    #  submission.
+    # @param brand_id [String] The unique identifier of the brand you want to submit for review. <br><br>
+    #  This identifier is a string that always begins with the prefix `b_`, for
+    #  example: `b_1234567890` and must correspond to an existing brand in your account
+    #  that is ready for submission.
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Types::SubmissionResults]
     # @example
@@ -189,7 +193,7 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.brands.submit(brand_id: 1)
+    #  api.brands.submit(brand_id: "b_1234567890")
     def submit(brand_id:, 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?
@@ -281,8 +285,10 @@ module Pinnacle
     # Submit a brand for external vetting verification to enhance your brand's trust
     #  score and improved message delivery rates.
     #
-    # @param brand_id [Integer] The unique identifier of the brand to vet. <br>
-    #  The brand must be already registered before it can be vetted.
+    # @param brand_id [String] The unique identifier of the brand to vet. <br>
+    #  This identifier is a string that always begins with the prefix `b_`, for
+    #  example: `b_1234567890` and must correspond to an existing brand in your account
+    #  that is ready for vetting.
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Types::VettingResults]
     # @example
@@ -291,7 +297,7 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.brands.vet(brand_id: 1)
+    #  api.brands.vet(brand_id: "b_1234567890")
     def vet(brand_id:, 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?
@@ -386,8 +392,9 @@ module Pinnacle
     # @param description [String] Brief description of what the brand does.
     # @param ein [String] Brand's Employer Identification Number (EIN) assigned by the IRS.
     # @param email [String] Main contact email address for the brand.
-    # @param id [Integer] Brand ID - include only when updating an existing brand, omit to create a new
-    #  one.
+    # @param id [String] The unique identifier of the brand you want to update.
+    #  <br><br> This identifier is a string that always begins with the prefix `b_`,
+    #  for example: `b_1234567890`.
     # @param name [String] Legal name of the brand as registered.
     # @param sector [Pinnacle::Types::CompanySectorEnum] Industry the brand operates in.
     # @param type [Pinnacle::Types::CompanyTypeEnum] Legal structure of the brand.
@@ -407,7 +414,7 @@ module Pinnacle
     #    description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
     #    ein: "88-1234567",
     #    email: "founders@trypinnacle.app",
-    #    id: 1,
+    #    id: "b_1234567890",
     #    name: "Pinnacle",
     #    sector: TECHNOLOGY,
     #    type: PRIVATE_PROFIT,
@@ -449,7 +456,9 @@ module Pinnacle
 
     # Retrieve detailed information for a specific brand in your account by ID.
     #
-    # @param id [Integer] ID of an existing brand in your account that you want to retrieve.
+    # @param id [String] The unique identifier of the brand you want to retrieve from your account.
+    #  <br><br> This identifier is a string that always begins with the prefix `b_`,
+    #  for example: `b_1234567890`.
     # @param hide_ein [Boolean] Optional flag to mask the Employer Identification Number in the response for
     #  security purposes.<br>
     #  When you set this to true, the EIN value will be replaced with a masked
@@ -462,7 +471,7 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.brands.get(id: 1)
+    #  api.brands.get(id: "b_1234567890")
     def get(id:, hide_ein: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
@@ -485,9 +494,10 @@ module Pinnacle
 
     # Submit your brand for review and approval by the compliance team.
     #
-    # @param brand_id [Integer] The unique identifier of the brand you want to submit for review. <br>
-    #  Must correspond to an existing brand in your account that is ready for
-    #  submission.
+    # @param brand_id [String] The unique identifier of the brand you want to submit for review. <br><br>
+    #  This identifier is a string that always begins with the prefix `b_`, for
+    #  example: `b_1234567890` and must correspond to an existing brand in your account
+    #  that is ready for submission.
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Types::SubmissionResults]
     # @example
@@ -496,7 +506,7 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.brands.submit(brand_id: 1)
+    #  api.brands.submit(brand_id: "b_1234567890")
     def submit(brand_id:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
@@ -592,8 +602,10 @@ module Pinnacle
     # Submit a brand for external vetting verification to enhance your brand's trust
     #  score and improved message delivery rates.
     #
-    # @param brand_id [Integer] The unique identifier of the brand to vet. <br>
-    #  The brand must be already registered before it can be vetted.
+    # @param brand_id [String] The unique identifier of the brand to vet. <br>
+    #  This identifier is a string that always begins with the prefix `b_`, for
+    #  example: `b_1234567890` and must correspond to an existing brand in your account
+    #  that is ready for vetting.
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Types::VettingResults]
     # @example
@@ -602,7 +614,7 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.brands.vet(brand_id: 1)
+    #  api.brands.vet(brand_id: "b_1234567890")
     def vet(brand_id:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|

data/lib/rcs/campaigns/dlc/client.rb

@@ -30,7 +30,7 @@ module Pinnacle
       #
       # @param request [Hash] Request of type Pinnacle::Types::AutofillCampaignParams, as a Hash
       #   * :additional_info (String)
-      #   * :campaign_id (Integer)
+      #   * :campaign_id (String)
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::AutofillDlcCampaignResponse]
       # @example
@@ -39,7 +39,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.dlc.autofill(request: { additional_info: "Please autofill missing DLC campaign fields using my brand profile", campaign_id: 161 })
+      #  api.campaigns.dlc.autofill(request: { additional_info: "Please autofill missing campaign fields using my brand profile", campaign_id: "dlc_1234567890" })
       def autofill(request:, 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?
@@ -60,7 +60,8 @@ module Pinnacle
 
       # Retrieve 10DLC campaign.
       #
-      # @param campaign_id [Integer] Unique identifier of the 10DLC campaign.
+      # @param campaign_id [String] Unique identifier of the 10DLC campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
       # @example
@@ -69,7 +70,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.dlc.get(campaign_id: 28)
+      #  api.campaigns.dlc.get(campaign_id: "dlc_1234567890")
       def get(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?
@@ -92,7 +93,9 @@ module Pinnacle
 
       # Submit your 10DLC campaign for approval and activation with carriers.
       #
-      # @param campaign_id [Integer] Unique identifier of the 10DLC campaign to submit.
+      # @param campaign_id [String] Unique identifier of the 10DLC campaign to submit.
+      #  <br><br> This identifier is a string that always begins with the prefix `dlc_`,
+      #  for example: `dlc_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignSubmissionResult]
       # @example
@@ -101,7 +104,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.dlc.submit(campaign_id: 161)
+      #  api.campaigns.dlc.submit(campaign_id: "dlc_1234567890")
       def submit(campaign_id:, 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?
@@ -126,8 +129,10 @@ module Pinnacle
       #  Omit campaignId to create a campaign.
       #
       # @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 [Hash] Keyword response configuration.Request of type Pinnacle::Campaigns::Dlc::Types::UpsertDlcCampaignKeywords, as a Hash
       #   * :help (Hash)
@@ -165,9 +170,9 @@ module Pinnacle
       #  )
       #  api.campaigns.dlc.upsert(
       #    auto_renew: true,
-      #    brand: 1,
-      #    campaign_id: 161,
-      #    keywords: { help: { message: "Reply HELP for assistance, STOP to opt-out", values: ["HELP", "INFO", "SUPPORT"] }, opt_in: { message: "Welcome! You're now subscribed to Pinnacle.", values: ["JOIN", "START", "SUBSCRIBE"] }, opt_out: { message: "You've been unsubscribed. Reply START to rejoin.", values: ["STOP", "QUIT", "UNSUBSCRIBE"] } },
+      #    brand: "b_1234567890",
+      #    campaign_id: "dlc_1234567890",
+      #    keywords: { help: { message: "Reply HELP for assistance, STOP to opt-out", values: ["HELP", "INFO", "SUPPORT"] }, opt_in: { message: "Welcome. You are now subscribed to Pinnacle.", values: ["JOIN", "START", "SUBSCRIBE"] }, opt_out: { message: "You have been unsubscribed. Reply START to rejoin.", values: ["STOP", "QUIT", "UNSUBSCRIBE"] } },
       #    links: { privacy_policy: "https://www.pinnacle.sh/privacy", terms_of_service: "https://www.pinnacle.sh/terms" },
       #    message_flow: "Customer initiates -> Automated response -> Agent follow-up if needed",
       #    name: "Account Notifications",
@@ -212,7 +217,7 @@ module Pinnacle
       #
       # @param request [Hash] Request of type Pinnacle::Types::ValidateCampaignParams, as a Hash
       #   * :additional_info (String)
-      #   * :campaign_id (Integer)
+      #   * :campaign_id (String)
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignValidationResult]
       # @example
@@ -221,7 +226,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.dlc.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: 161 })
+      #  api.campaigns.dlc.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: "dlc_1234567890" })
       def validate(request:, 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?
@@ -256,7 +261,7 @@ module Pinnacle
       #
       # @param request [Hash] Request of type Pinnacle::Types::AutofillCampaignParams, as a Hash
       #   * :additional_info (String)
-      #   * :campaign_id (Integer)
+      #   * :campaign_id (String)
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::AutofillDlcCampaignResponse]
       # @example
@@ -265,7 +270,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.dlc.autofill(request: { additional_info: "Please autofill missing DLC campaign fields using my brand profile", campaign_id: 161 })
+      #  api.campaigns.dlc.autofill(request: { additional_info: "Please autofill missing campaign fields using my brand profile", campaign_id: "dlc_1234567890" })
       def autofill(request:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
@@ -288,7 +293,8 @@ module Pinnacle
 
       # Retrieve 10DLC campaign.
       #
-      # @param campaign_id [Integer] Unique identifier of the 10DLC campaign.
+      # @param campaign_id [String] Unique identifier of the 10DLC campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
       # @example
@@ -297,7 +303,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.dlc.get(campaign_id: 28)
+      #  api.campaigns.dlc.get(campaign_id: "dlc_1234567890")
       def get(campaign_id:, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
@@ -322,7 +328,9 @@ module Pinnacle
 
       # Submit your 10DLC campaign for approval and activation with carriers.
       #
-      # @param campaign_id [Integer] Unique identifier of the 10DLC campaign to submit.
+      # @param campaign_id [String] Unique identifier of the 10DLC campaign to submit.
+      #  <br><br> This identifier is a string that always begins with the prefix `dlc_`,
+      #  for example: `dlc_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignSubmissionResult]
       # @example
@@ -331,7 +339,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.dlc.submit(campaign_id: 161)
+      #  api.campaigns.dlc.submit(campaign_id: "dlc_1234567890")
       def submit(campaign_id:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
@@ -358,8 +366,10 @@ module Pinnacle
       #  Omit campaignId to create a campaign.
       #
       # @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 [Hash] Keyword response configuration.Request of type Pinnacle::Campaigns::Dlc::Types::UpsertDlcCampaignKeywords, as a Hash
       #   * :help (Hash)
@@ -397,9 +407,9 @@ module Pinnacle
       #  )
       #  api.campaigns.dlc.upsert(
       #    auto_renew: true,
-      #    brand: 1,
-      #    campaign_id: 161,
-      #    keywords: { help: { message: "Reply HELP for assistance, STOP to opt-out", values: ["HELP", "INFO", "SUPPORT"] }, opt_in: { message: "Welcome! You're now subscribed to Pinnacle.", values: ["JOIN", "START", "SUBSCRIBE"] }, opt_out: { message: "You've been unsubscribed. Reply START to rejoin.", values: ["STOP", "QUIT", "UNSUBSCRIBE"] } },
+      #    brand: "b_1234567890",
+      #    campaign_id: "dlc_1234567890",
+      #    keywords: { help: { message: "Reply HELP for assistance, STOP to opt-out", values: ["HELP", "INFO", "SUPPORT"] }, opt_in: { message: "Welcome. You are now subscribed to Pinnacle.", values: ["JOIN", "START", "SUBSCRIBE"] }, opt_out: { message: "You have been unsubscribed. Reply START to rejoin.", values: ["STOP", "QUIT", "UNSUBSCRIBE"] } },
       #    links: { privacy_policy: "https://www.pinnacle.sh/privacy", terms_of_service: "https://www.pinnacle.sh/terms" },
       #    message_flow: "Customer initiates -> Automated response -> Agent follow-up if needed",
       #    name: "Account Notifications",
@@ -446,7 +456,7 @@ module Pinnacle
       #
       # @param request [Hash] Request of type Pinnacle::Types::ValidateCampaignParams, as a Hash
       #   * :additional_info (String)
-      #   * :campaign_id (Integer)
+      #   * :campaign_id (String)
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignValidationResult]
       # @example
@@ -455,7 +465,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.dlc.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: 161 })
+      #  api.campaigns.dlc.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: "dlc_1234567890" })
       def validate(request:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|

data/lib/rcs/campaigns/rcs/client.rb

@@ -31,7 +31,7 @@ module Pinnacle
       #
       # @param request [Hash] Request of type Pinnacle::Types::AutofillCampaignParams, as a Hash
       #   * :additional_info (String)
-      #   * :campaign_id (Integer)
+      #   * :campaign_id (String)
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Campaigns::Rcs::Types::RcsAutofillResponse]
       # @example
@@ -40,7 +40,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.rcs.autofill(request: { additional_info: "Please autofill missing DLC campaign fields using my brand profile", campaign_id: 161 })
+      #  api.campaigns.rcs.autofill(request: { additional_info: "Please autofill missing campaign fields using my brand profile", campaign_id: "dlc_1234567890" })
       def autofill(request:, 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?
@@ -61,7 +61,7 @@ module Pinnacle
 
       # Retrieve RCS campaign.
       #
-      # @param campaign_id [Integer] Unique identifier of the RCS campaign.
+      # @param campaign_id [String] Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::ExtendedRcsCampaign]
       # @example
@@ -70,7 +70,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.rcs.get(campaign_id: 161)
+      #  api.campaigns.rcs.get(campaign_id: "rcs_1234567890")
       def get(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?
@@ -93,7 +93,8 @@ module Pinnacle
 
       # Submit your RCS campaign for approval and activation with carriers.
       #
-      # @param campaign_id [Integer] Unique identifier of the RCS campaign to retrieve.
+      # @param campaign_id [String] Unique identifier of the RCS campaign to retrieve. Must begin with the prefix
+      #  `rcs_`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignSubmissionResult]
       # @example
@@ -102,7 +103,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.rcs.submit(campaign_id: 161)
+      #  api.campaigns.rcs.submit(campaign_id: "rcs_1234567890")
       def submit(campaign_id:, 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?
@@ -138,8 +139,8 @@ module Pinnacle
       # @param brand_verification_url [String] Link to document verifying the brand's name. This may be the certificate of
       #  incorporation, business license, or other relevant document. You can typically
       #  find this on the Secretary of State website.
-      # @param brand [Integer] Unique identifier for the brand.
-      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param brand [String] Unique identifier for the brand.
+      # @param campaign_id [String] Unique identifier for the campaign.
       # @param expected_agent_responses [Array<String>] List of what the agent might say to users (1-5 required).
       # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsLinks, as a Hash
       #   * :privacy_policy (String)
@@ -164,7 +165,8 @@ module Pinnacle
       #  api.campaigns.rcs.upsert(
       #    agent: { color: "#000000", description: "Engaging campaigns with RBM – next-gen SMS marketing with rich content and better analytics.", emails: [{ email: "founders@trypinnacle.app", label: "Email Us" }], hero_url: "https://agent-logos.storage.googleapis.com/_/m0bk9mmw7kfynqiKSPfsaoc6", icon_url: "https://agent-logos.storage.googleapis.com/_/m0bk9gvlDunZEw1krfruZmw3", name: "Pinnacle Software Development", phones: [{ label: "Contact us directly", phone: "+14154467821" }], websites: [{ label: "Get started with Pinnacle", url: "https://www.trypinnacle.app/" }] },
       #    brand_verification_url: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
-      #    brand: 2,
+      #    brand: "b_1234567890",
+      #    campaign_id: "rcs_1234567890",
       #    expected_agent_responses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
       #    links: { privacy_policy: "https://www.trypinnacle.app/privacy", terms_of_service: "https://www.trypinnacle.app/terms" },
       #    opt_in: { method_: WEBSITE, terms_and_conditions: "Would you like to subscribe to Pinnacle?" },
@@ -206,7 +208,7 @@ module Pinnacle
       #
       # @param request [Hash] Request of type Pinnacle::Types::ValidateCampaignParams, as a Hash
       #   * :additional_info (String)
-      #   * :campaign_id (Integer)
+      #   * :campaign_id (String)
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignValidationResult]
       # @example
@@ -215,7 +217,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.rcs.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: 161 })
+      #  api.campaigns.rcs.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: "dlc_1234567890" })
       def validate(request:, 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?
@@ -250,7 +252,7 @@ module Pinnacle
       #
       # @param request [Hash] Request of type Pinnacle::Types::AutofillCampaignParams, as a Hash
       #   * :additional_info (String)
-      #   * :campaign_id (Integer)
+      #   * :campaign_id (String)
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Campaigns::Rcs::Types::RcsAutofillResponse]
       # @example
@@ -259,7 +261,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.rcs.autofill(request: { additional_info: "Please autofill missing DLC campaign fields using my brand profile", campaign_id: 161 })
+      #  api.campaigns.rcs.autofill(request: { additional_info: "Please autofill missing campaign fields using my brand profile", campaign_id: "dlc_1234567890" })
       def autofill(request:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
@@ -282,7 +284,7 @@ module Pinnacle
 
       # Retrieve RCS campaign.
       #
-      # @param campaign_id [Integer] Unique identifier of the RCS campaign.
+      # @param campaign_id [String] Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::ExtendedRcsCampaign]
       # @example
@@ -291,7 +293,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.rcs.get(campaign_id: 161)
+      #  api.campaigns.rcs.get(campaign_id: "rcs_1234567890")
       def get(campaign_id:, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
@@ -316,7 +318,8 @@ module Pinnacle
 
       # Submit your RCS campaign for approval and activation with carriers.
       #
-      # @param campaign_id [Integer] Unique identifier of the RCS campaign to retrieve.
+      # @param campaign_id [String] Unique identifier of the RCS campaign to retrieve. Must begin with the prefix
+      #  `rcs_`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignSubmissionResult]
       # @example
@@ -325,7 +328,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.rcs.submit(campaign_id: 161)
+      #  api.campaigns.rcs.submit(campaign_id: "rcs_1234567890")
       def submit(campaign_id:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
@@ -363,8 +366,8 @@ module Pinnacle
       # @param brand_verification_url [String] Link to document verifying the brand's name. This may be the certificate of
       #  incorporation, business license, or other relevant document. You can typically
       #  find this on the Secretary of State website.
-      # @param brand [Integer] Unique identifier for the brand.
-      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param brand [String] Unique identifier for the brand.
+      # @param campaign_id [String] Unique identifier for the campaign.
       # @param expected_agent_responses [Array<String>] List of what the agent might say to users (1-5 required).
       # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsLinks, as a Hash
       #   * :privacy_policy (String)
@@ -389,7 +392,8 @@ module Pinnacle
       #  api.campaigns.rcs.upsert(
       #    agent: { color: "#000000", description: "Engaging campaigns with RBM – next-gen SMS marketing with rich content and better analytics.", emails: [{ email: "founders@trypinnacle.app", label: "Email Us" }], hero_url: "https://agent-logos.storage.googleapis.com/_/m0bk9mmw7kfynqiKSPfsaoc6", icon_url: "https://agent-logos.storage.googleapis.com/_/m0bk9gvlDunZEw1krfruZmw3", name: "Pinnacle Software Development", phones: [{ label: "Contact us directly", phone: "+14154467821" }], websites: [{ label: "Get started with Pinnacle", url: "https://www.trypinnacle.app/" }] },
       #    brand_verification_url: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
-      #    brand: 2,
+      #    brand: "b_1234567890",
+      #    campaign_id: "rcs_1234567890",
       #    expected_agent_responses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
       #    links: { privacy_policy: "https://www.trypinnacle.app/privacy", terms_of_service: "https://www.trypinnacle.app/terms" },
       #    opt_in: { method_: WEBSITE, terms_and_conditions: "Would you like to subscribe to Pinnacle?" },
@@ -433,7 +437,7 @@ module Pinnacle
       #
       # @param request [Hash] Request of type Pinnacle::Types::ValidateCampaignParams, as a Hash
       #   * :additional_info (String)
-      #   * :campaign_id (Integer)
+      #   * :campaign_id (String)
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignValidationResult]
       # @example
@@ -442,7 +446,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.campaigns.rcs.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: 161 })
+      #  api.campaigns.rcs.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: "dlc_1234567890" })
       def validate(request:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|

data/lib/rcs/campaigns/rcs/types/rcs_autofill_response.rb

@@ -13,11 +13,11 @@ module Pinnacle
     module Rcs
       module Types
         class RcsAutofillResponse
-          # @return [Integer]
+          # @return [String]
           attr_reader :brand
           # @return [Pinnacle::Types::RcsCampaignSchemaAgent] Agent configured to the campaign.
           attr_reader :agent
-          # @return [Integer] Unique identifier for the campaign.
+          # @return [String] Unique identifier for the campaign.
           attr_reader :campaign_id
           # @return [String] Link to document verifying the brand's name. This may be the certificate of
           #  incorporation, business license, or other relevant document. You can typically
@@ -41,9 +41,9 @@ module Pinnacle
 
           OMIT = Object.new
 
-          # @param brand [Integer]
+          # @param brand [String]
           # @param agent [Pinnacle::Types::RcsCampaignSchemaAgent] Agent configured to the campaign.
-          # @param campaign_id [Integer] Unique identifier for the campaign.
+          # @param campaign_id [String] Unique identifier for the campaign.
           # @param brand_verification_url [String] Link to document verifying the brand's name. This may be the certificate of
           #  incorporation, business license, or other relevant document. You can typically
           #  find this on the Secretary of State website.
@@ -150,9 +150,9 @@ module Pinnacle
           # @param obj [Object]
           # @return [Void]
           def self.validate_raw(obj:)
-            obj.brand&.is_a?(Integer) != false || raise("Passed value for field obj.brand 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.agent.nil? || Pinnacle::Types::RcsCampaignSchemaAgent.validate_raw(obj: obj.agent)
-            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.")
             obj.brand_verification_url&.is_a?(String) != false || raise("Passed value for field obj.brand_verification_url is not the expected type, validation failed.")
             obj.expected_agent_responses&.is_a?(Array) != false || raise("Passed value for field obj.expected_agent_responses is not the expected type, validation failed.")
             obj.links.nil? || Pinnacle::Types::RcsCampaignSchemaLinks.validate_raw(obj: obj.links)