rcs 2.0.2 → 2.0.3

data/lib/rcs/types/{rcs_base.rb → base_rich_message.rb}

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative "rcs_base_options"
+require_relative "send_rich_message_options"
 require "ostruct"
 require "json"
 
 module Pinnacle
   module Types
-    class RcsBase
+    class BaseRichMessage
       # @return [String] Your RCS agent ID which must be prefixed with 'agent_'.
       attr_reader :from
-      # @return [Pinnacle::Types::RcsBaseOptions] Configure how your RCS message is sent and tracked.
+      # @return [Pinnacle::Types::SendRichMessageOptions] Configure how your RCS message is sent and tracked.
       attr_reader :options
       # @return [String] Recipient's phone number in E.164 format.
       attr_reader :to
@@ -22,10 +22,10 @@ module Pinnacle
       OMIT = Object.new
 
       # @param from [String] Your RCS agent ID which must be prefixed with 'agent_'.
-      # @param options [Pinnacle::Types::RcsBaseOptions] Configure how your RCS message is sent and tracked.
+      # @param options [Pinnacle::Types::SendRichMessageOptions] Configure how your RCS message is sent and tracked.
       # @param to [String] Recipient's phone number in E.164 format.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsBase]
+      # @return [Pinnacle::Types::BaseRichMessage]
       def initialize(from:, to:, options: OMIT, additional_properties: nil)
         @from = from
         @options = options if options != OMIT
@@ -36,10 +36,10 @@ module Pinnacle
         end
       end
 
-      # Deserialize a JSON object to an instance of RcsBase
+      # Deserialize a JSON object to an instance of BaseRichMessage
       #
       # @param json_object [String]
-      # @return [Pinnacle::Types::RcsBase]
+      # @return [Pinnacle::Types::BaseRichMessage]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
@@ -48,7 +48,7 @@ module Pinnacle
           options = nil
         else
           options = parsed_json["options"].to_json
-          options = Pinnacle::Types::RcsBaseOptions.from_json(json_object: options)
+          options = Pinnacle::Types::SendRichMessageOptions.from_json(json_object: options)
         end
         to = parsed_json["to"]
         new(
@@ -59,7 +59,7 @@ module Pinnacle
         )
       end
 
-      # Serialize an instance of RcsBase to a JSON object
+      # Serialize an instance of BaseRichMessage to a JSON object
       #
       # @return [String]
       def to_json(*_args)
@@ -74,7 +74,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
-        obj.options.nil? || Pinnacle::Types::RcsBaseOptions.validate_raw(obj: obj.options)
+        obj.options.nil? || Pinnacle::Types::SendRichMessageOptions.validate_raw(obj: obj.options)
         obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/blast_details.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Response containing details about the scheduled blast.
+    class BlastDetails
+      # @return [String] Unique identifier for the blast. This identifier is a string that always begins
+      #  with the prefix `blast_`, for example: `blast_1234567890`.
+      attr_reader :blast_id
+      # @return [String] The audience ID the blast was sent to. This identifier is a string that always
+      #  begins with the prefix `aud_`, for example: `aud_abc123`.
+      attr_reader :audience_id
+      # @return [Integer] Total number of recipients in the audience.
+      attr_reader :total_recipients
+      # @return [Integer] Total number of messages to be sent.
+      attr_reader :total_messages
+      # @return [Integer] Total number of message segments across all messages.
+      attr_reader :total_segments
+      # @return [Float] Total estimated cost of the blast. Calculated by multiplying the number of
+      #  segments by the number of messages by the unit cost.
+      attr_reader :total_cost
+      # @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 blast_id [String] Unique identifier for the blast. This identifier is a string that always begins
+      #  with the prefix `blast_`, for example: `blast_1234567890`.
+      # @param audience_id [String] The audience ID the blast was sent to. This identifier is a string that always
+      #  begins with the prefix `aud_`, for example: `aud_abc123`.
+      # @param total_recipients [Integer] Total number of recipients in the audience.
+      # @param total_messages [Integer] Total number of messages to be sent.
+      # @param total_segments [Integer] Total number of message segments across all messages.
+      # @param total_cost [Float] Total estimated cost of the blast. Calculated by multiplying the number of
+      #  segments by the number of messages by the unit cost.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::BlastDetails]
+      def initialize(blast_id:, audience_id:, total_recipients:, total_messages:, total_segments:, total_cost:,
+                     additional_properties: nil)
+        @blast_id = blast_id
+        @audience_id = audience_id
+        @total_recipients = total_recipients
+        @total_messages = total_messages
+        @total_segments = total_segments
+        @total_cost = total_cost
+        @additional_properties = additional_properties
+        @_field_set = {
+          "blastId": blast_id,
+          "audienceId": audience_id,
+          "totalRecipients": total_recipients,
+          "totalMessages": total_messages,
+          "totalSegments": total_segments,
+          "totalCost": total_cost
+        }
+      end
+
+      # Deserialize a JSON object to an instance of BlastDetails
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BlastDetails]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        blast_id = parsed_json["blastId"]
+        audience_id = parsed_json["audienceId"]
+        total_recipients = parsed_json["totalRecipients"]
+        total_messages = parsed_json["totalMessages"]
+        total_segments = parsed_json["totalSegments"]
+        total_cost = parsed_json["totalCost"]
+        new(
+          blast_id: blast_id,
+          audience_id: audience_id,
+          total_recipients: total_recipients,
+          total_messages: total_messages,
+          total_segments: total_segments,
+          total_cost: total_cost,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of BlastDetails 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.blast_id.is_a?(String) != false || raise("Passed value for field obj.blast_id is not the expected type, validation failed.")
+        obj.audience_id.is_a?(String) != false || raise("Passed value for field obj.audience_id is not the expected type, validation failed.")
+        obj.total_recipients.is_a?(Integer) != false || raise("Passed value for field obj.total_recipients is not the expected type, validation failed.")
+        obj.total_messages.is_a?(Integer) != false || raise("Passed value for field obj.total_messages is not the expected type, validation failed.")
+        obj.total_segments.is_a?(Integer) != false || raise("Passed value for field obj.total_segments is not the expected type, validation failed.")
+        obj.total_cost.is_a?(Float) != false || raise("Passed value for field obj.total_cost is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/company_entity_type_enum.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Legal entity type of the brand.
+    class CompanyEntityTypeEnum
+      LLC = "LLC"
+      SOLE_PROPRIETORSHIP = "SOLE_PROPRIETORSHIP"
+      PARTNERSHIP = "PARTNERSHIP"
+      CORP = "CORP"
+      S_CORP = "S_CORP"
+    end
+  end
+end

data/lib/rcs/types/dlc_campaign_with_extended_brand_and_status.rb

@@ -6,6 +6,8 @@ require_relative "dlc_with_extended_brand_and_status_links"
 require_relative "dlc_with_extended_brand_and_status_options"
 require_relative "profile_status_enum"
 require_relative "dlc_with_extended_brand_and_status_use_case"
+require_relative "dlc_with_extended_brand_and_status_mno_brand_tier"
+require_relative "dlc_with_extended_brand_and_status_mno_tcr_tier"
 require "ostruct"
 require "json"
 
@@ -42,6 +44,15 @@ module Pinnacle
       attr_reader :status
       # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase] Use case for the campaign.
       attr_reader :use_case
+      # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusMnoBrandTier] The MNO brand tier for T-Mobile rate limits. Tiers range from `TOP` (highest) to
+      #  `LOW` (lowest), based on your brand's vetting score.
+      #  See [SMS Rate Limits](/guides/messages/rate-limits) for details.
+      attr_reader :mno_brand_tier
+      # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusMnoTcrTier] The MNO TCR message class for AT&T, Verizon, and other carriers. Classes `A`-`G`
+      #  are standard (based on vetting score), while `T`, `N`, and `S` are for special
+      #  use cases.
+      #  See [SMS Rate Limits](/guides/messages/rate-limits) for details.
+      attr_reader :mno_tcr_tier
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -67,10 +78,17 @@ module Pinnacle
       #  `VERIFIED`: Approved and ready to send messages. <br>
       #  `FAILED`: Issues and errors related to the campaign's details.
       # @param use_case [Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase] Use case for the campaign.
+      # @param mno_brand_tier [Pinnacle::Types::DlcWithExtendedBrandAndStatusMnoBrandTier] The MNO brand tier for T-Mobile rate limits. Tiers range from `TOP` (highest) to
+      #  `LOW` (lowest), based on your brand's vetting score.
+      #  See [SMS Rate Limits](/guides/messages/rate-limits) for details.
+      # @param mno_tcr_tier [Pinnacle::Types::DlcWithExtendedBrandAndStatusMnoTcrTier] The MNO TCR message class for AT&T, Verizon, and other carriers. Classes `A`-`G`
+      #  are standard (based on vetting score), while `T`, `N`, and `S` are for special
+      #  use cases.
+      #  See [SMS Rate Limits](/guides/messages/rate-limits) for details.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
       def initialize(auto_renew:, brand:, keywords:, options:, status:, campaign_id: OMIT, description: OMIT, links: OMIT,
-                     message_flow: OMIT, name: OMIT, sample_messages: OMIT, use_case: OMIT, additional_properties: nil)
+                     message_flow: OMIT, name: OMIT, sample_messages: OMIT, use_case: OMIT, mno_brand_tier: OMIT, mno_tcr_tier: OMIT, additional_properties: nil)
         @auto_renew = auto_renew
         @brand = brand
         @campaign_id = campaign_id if campaign_id != OMIT
@@ -83,6 +101,8 @@ module Pinnacle
         @sample_messages = sample_messages if sample_messages != OMIT
         @status = status
         @use_case = use_case if use_case != OMIT
+        @mno_brand_tier = mno_brand_tier if mno_brand_tier != OMIT
+        @mno_tcr_tier = mno_tcr_tier if mno_tcr_tier != OMIT
         @additional_properties = additional_properties
         @_field_set = {
           "autoRenew": auto_renew,
@@ -96,7 +116,9 @@ module Pinnacle
           "options": options,
           "sampleMessages": sample_messages,
           "status": status,
-          "useCase": use_case
+          "useCase": use_case,
+          "mnoBrandTier": mno_brand_tier,
+          "mnoTcrTier": mno_tcr_tier
         }.reject do |_k, v|
           v == OMIT
         end
@@ -147,6 +169,8 @@ module Pinnacle
           use_case = parsed_json["useCase"].to_json
           use_case = Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase.from_json(json_object: use_case)
         end
+        mno_brand_tier = parsed_json["mnoBrandTier"]
+        mno_tcr_tier = parsed_json["mnoTcrTier"]
         new(
           auto_renew: auto_renew,
           brand: brand,
@@ -160,6 +184,8 @@ module Pinnacle
           sample_messages: sample_messages,
           status: status,
           use_case: use_case,
+          mno_brand_tier: mno_brand_tier,
+          mno_tcr_tier: mno_tcr_tier,
           additional_properties: struct
         )
       end
@@ -190,6 +216,8 @@ module Pinnacle
         obj.sample_messages&.is_a?(Array) != false || raise("Passed value for field obj.sample_messages is not the expected type, validation failed.")
         obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.use_case.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase.validate_raw(obj: obj.use_case)
+        obj.mno_brand_tier&.is_a?(Pinnacle::Types::DlcWithExtendedBrandAndStatusMnoBrandTier) != false || raise("Passed value for field obj.mno_brand_tier is not the expected type, validation failed.")
+        obj.mno_tcr_tier&.is_a?(Pinnacle::Types::DlcWithExtendedBrandAndStatusMnoTcrTier) != false || raise("Passed value for field obj.mno_tcr_tier is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/dlc_with_extended_brand_and_status_mno_brand_tier.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # The MNO brand tier for T-Mobile rate limits. Tiers range from `TOP` (highest) to
+    #  `LOW` (lowest), based on your brand's vetting score.
+    #  See [SMS Rate Limits](/guides/messages/rate-limits) for details.
+    class DlcWithExtendedBrandAndStatusMnoBrandTier
+      TOP = "TOP"
+      HIGH_MID = "HIGH_MID"
+      LOW_MID = "LOW_MID"
+      LOW = "LOW"
+    end
+  end
+end

data/lib/rcs/types/dlc_with_extended_brand_and_status_mno_tcr_tier.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # The MNO TCR message class for AT&T, Verizon, and other carriers. Classes `A`-`G`
+    #  are standard (based on vetting score), while `T`, `N`, and `S` are for special
+    #  use cases.
+    #  See [SMS Rate Limits](/guides/messages/rate-limits) for details.
+    class DlcWithExtendedBrandAndStatusMnoTcrTier
+      A = "A"
+      B = "B"
+      C = "C"
+      D = "D"
+      E = "E"
+      F = "F"
+      G = "G"
+      N = "N"
+      T = "T"
+      S = "S"
+    end
+  end
+end

data/lib/rcs/types/extended_brand.rb

@@ -4,6 +4,7 @@ require_relative "brand_status_enum"
 require_relative "optional_contacts"
 require_relative "company_sector_enum"
 require_relative "company_type_enum"
+require_relative "company_entity_type_enum"
 require "ostruct"
 require "json"
 
@@ -48,6 +49,8 @@ module Pinnacle
       attr_reader :sector
       # @return [Pinnacle::Types::CompanyTypeEnum]
       attr_reader :type
+      # @return [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
+      attr_reader :entity_type
       # @return [String] Brand website URL.
       attr_reader :website
       # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -82,11 +85,12 @@ module Pinnacle
       # @param name [String] Legal name of the brand as registered.
       # @param sector [Pinnacle::Types::CompanySectorEnum]
       # @param type [Pinnacle::Types::CompanyTypeEnum]
+      # @param entity_type [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
       # @param website [String] Brand website URL.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::ExtendedBrand]
       def initialize(created_at:, id:, is_archived:, status:, updated_at:, address: OMIT, contact: OMIT, dba: OMIT,
-                     description: OMIT, ein: OMIT, email: OMIT, name: OMIT, sector: OMIT, type: OMIT, website: OMIT, additional_properties: nil)
+                     description: OMIT, ein: OMIT, email: OMIT, name: OMIT, sector: OMIT, type: OMIT, entity_type: OMIT, website: OMIT, additional_properties: nil)
         @created_at = created_at
         @id = id
         @is_archived = is_archived
@@ -101,6 +105,7 @@ module Pinnacle
         @name = name if name != OMIT
         @sector = sector if sector != OMIT
         @type = type if type != OMIT
+        @entity_type = entity_type if entity_type != OMIT
         @website = website if website != OMIT
         @additional_properties = additional_properties
         @_field_set = {
@@ -118,6 +123,7 @@ module Pinnacle
           "name": name,
           "sector": sector,
           "type": type,
+          "entityType": entity_type,
           "website": website
         }.reject do |_k, v|
           v == OMIT
@@ -150,6 +156,7 @@ module Pinnacle
         name = parsed_json["name"]
         sector = parsed_json["sector"]
         type = parsed_json["type"]
+        entity_type = parsed_json["entityType"]
         website = parsed_json["website"]
         new(
           created_at: created_at,
@@ -166,6 +173,7 @@ module Pinnacle
           name: name,
           sector: sector,
           type: type,
+          entity_type: entity_type,
           website: website,
           additional_properties: struct
         )
@@ -199,6 +207,7 @@ module Pinnacle
         obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         obj.sector&.is_a?(Pinnacle::Types::CompanySectorEnum) != false || raise("Passed value for field obj.sector is not the expected type, validation failed.")
         obj.type&.is_a?(Pinnacle::Types::CompanyTypeEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        obj.entity_type&.is_a?(Pinnacle::Types::CompanyEntityTypeEnum) != false || raise("Passed value for field obj.entity_type is not the expected type, validation failed.")
         obj.website&.is_a?(String) != false || raise("Passed value for field obj.website is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/extended_brand_with_vetting.rb

@@ -6,6 +6,7 @@ require_relative "brand_status_enum"
 require_relative "optional_contacts"
 require_relative "company_sector_enum"
 require_relative "company_type_enum"
+require_relative "company_entity_type_enum"
 require "ostruct"
 require "json"
 
@@ -56,6 +57,8 @@ module Pinnacle
       attr_reader :sector
       # @return [Pinnacle::Types::CompanyTypeEnum]
       attr_reader :type
+      # @return [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
+      attr_reader :entity_type
       # @return [String] Brand website URL.
       attr_reader :website
       # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -93,11 +96,12 @@ module Pinnacle
       # @param name [String] Legal name of the brand as registered.
       # @param sector [Pinnacle::Types::CompanySectorEnum]
       # @param type [Pinnacle::Types::CompanyTypeEnum]
+      # @param entity_type [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
       # @param website [String] Brand website URL.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::ExtendedBrandWithVetting]
       def initialize(vetting_history:, created_at:, id:, is_archived:, status:, updated_at:,
-                     last_tcr_vetting_date: OMIT, tcr_feedback: OMIT, address: OMIT, contact: OMIT, dba: OMIT, description: OMIT, ein: OMIT, email: OMIT, name: OMIT, sector: OMIT, type: OMIT, website: OMIT, additional_properties: nil)
+                     last_tcr_vetting_date: OMIT, tcr_feedback: OMIT, address: OMIT, contact: OMIT, dba: OMIT, description: OMIT, ein: OMIT, email: OMIT, name: OMIT, sector: OMIT, type: OMIT, entity_type: OMIT, website: OMIT, additional_properties: nil)
         @last_tcr_vetting_date = last_tcr_vetting_date if last_tcr_vetting_date != OMIT
         @tcr_feedback = tcr_feedback if tcr_feedback != OMIT
         @vetting_history = vetting_history
@@ -115,6 +119,7 @@ module Pinnacle
         @name = name if name != OMIT
         @sector = sector if sector != OMIT
         @type = type if type != OMIT
+        @entity_type = entity_type if entity_type != OMIT
         @website = website if website != OMIT
         @additional_properties = additional_properties
         @_field_set = {
@@ -135,6 +140,7 @@ module Pinnacle
           "name": name,
           "sector": sector,
           "type": type,
+          "entityType": entity_type,
           "website": website
         }.reject do |_k, v|
           v == OMIT
@@ -176,6 +182,7 @@ module Pinnacle
         name = parsed_json["name"]
         sector = parsed_json["sector"]
         type = parsed_json["type"]
+        entity_type = parsed_json["entityType"]
         website = parsed_json["website"]
         new(
           last_tcr_vetting_date: last_tcr_vetting_date,
@@ -195,6 +202,7 @@ module Pinnacle
           name: name,
           sector: sector,
           type: type,
+          entity_type: entity_type,
           website: website,
           additional_properties: struct
         )
@@ -231,6 +239,7 @@ module Pinnacle
         obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         obj.sector&.is_a?(Pinnacle::Types::CompanySectorEnum) != false || raise("Passed value for field obj.sector is not the expected type, validation failed.")
         obj.type&.is_a?(Pinnacle::Types::CompanyTypeEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        obj.entity_type&.is_a?(Pinnacle::Types::CompanyEntityTypeEnum) != false || raise("Passed value for field obj.entity_type is not the expected type, validation failed.")
         obj.website&.is_a?(String) != false || raise("Passed value for field obj.website is not the expected type, validation failed.")
       end
     end