rcs 2.0.5.pre.rc.1 → 2.0.5

data/lib/rcs/types/autofill_dlc_response_use_case.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "sub_use_case_enum"
+require_relative "dlc_campaign_use_case_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Use case for the campaign.
+    class AutofillDlcResponseUseCase
+      # @return [Array<Pinnacle::Types::SubUseCaseEnum>] Sub-use case categories.
+      attr_reader :sub
+      # @return [Pinnacle::Types::DlcCampaignUseCaseEnum]
+      attr_reader :value
+      # @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 sub [Array<Pinnacle::Types::SubUseCaseEnum>] Sub-use case categories.
+      # @param value [Pinnacle::Types::DlcCampaignUseCaseEnum]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AutofillDlcResponseUseCase]
+      def initialize(sub: OMIT, value: OMIT, additional_properties: nil)
+        @sub = sub if sub != OMIT
+        @value = value if value != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "sub": sub, "value": value }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AutofillDlcResponseUseCase
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AutofillDlcResponseUseCase]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        sub = parsed_json["sub"]
+        value = parsed_json["value"]
+        new(
+          sub: sub,
+          value: value,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AutofillDlcResponseUseCase 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.sub&.is_a?(Array) != false || raise("Passed value for field obj.sub is not the expected type, validation failed.")
+        obj.value&.is_a?(Pinnacle::Types::DlcCampaignUseCaseEnum) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/bad_request_error_body.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "zod_error"
+require_relative "error"
+
+module Pinnacle
+  module Types
+    class BadRequestErrorBody
+      # Deserialize a JSON object to an instance of BadRequestErrorBody
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BadRequestErrorBody]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Pinnacle::Types::ZodError.validate_raw(obj: struct)
+          return Pinnacle::Types::ZodError.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::Error.validate_raw(obj: struct)
+          return Pinnacle::Types::Error.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        begin
+          return Pinnacle::Types::ZodError.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::Error.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/base_rich_message.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "send_rich_message_options"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class BaseRichMessage
+      # @return [String] Your RCS agent ID which must be prefixed with 'agent_'.
+      attr_reader :from
+      # @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
+      # @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 from [String] Your RCS agent ID which must be prefixed with 'agent_'.
+      # @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::BaseRichMessage]
+      def initialize(from:, to:, options: OMIT, additional_properties: nil)
+        @from = from
+        @options = options if options != OMIT
+        @to = to
+        @additional_properties = additional_properties
+        @_field_set = { "from": from, "options": options, "to": to }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of BaseRichMessage
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BaseRichMessage]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        from = parsed_json["from"]
+        if parsed_json["options"].nil?
+          options = nil
+        else
+          options = parsed_json["options"].to_json
+          options = Pinnacle::Types::SendRichMessageOptions.from_json(json_object: options)
+        end
+        to = parsed_json["to"]
+        new(
+          from: from,
+          options: options,
+          to: to,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of BaseRichMessage 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.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
+        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
+  end
+end

data/lib/rcs/types/basic_phone_information.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative "phone_number_enum"
+require_relative "number_format"
+require_relative "basic_phone_information_location"
+require_relative "basic_phone_information_contact"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Key details about a phone number, including its validity, type, location,
+    #  carrier, and contact information.
+    #  Provides the essential data required for verification, display, and basic
+    #  analysis.
+    class BasicPhoneInformation
+      # @return [Boolean] Indicates whether the phone number is valid and capable of receiving
+      #  communications.
+      attr_reader :is_valid
+      # @return [Pinnacle::Types::PhoneNumberEnum] Classification of the phone number.
+      attr_reader :type
+      # @return [Pinnacle::Types::NumberFormat] Different standardized ways the phone number can be formatted for display.
+      attr_reader :formats
+      # @return [Pinnacle::Types::BasicPhoneInformationLocation] Geographic and political details where the phone number is registered.
+      attr_reader :location
+      # @return [String] The telecommunications carrier or service provider for the number.
+      attr_reader :carrier
+      # @return [Pinnacle::Types::BasicPhoneInformationContact] Contact information linked to the phone number registration, if available.
+      attr_reader :contact
+      # @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 is_valid [Boolean] Indicates whether the phone number is valid and capable of receiving
+      #  communications.
+      # @param type [Pinnacle::Types::PhoneNumberEnum] Classification of the phone number.
+      # @param formats [Pinnacle::Types::NumberFormat] Different standardized ways the phone number can be formatted for display.
+      # @param location [Pinnacle::Types::BasicPhoneInformationLocation] Geographic and political details where the phone number is registered.
+      # @param carrier [String] The telecommunications carrier or service provider for the number.
+      # @param contact [Pinnacle::Types::BasicPhoneInformationContact] Contact information linked to the phone number registration, if available.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::BasicPhoneInformation]
+      def initialize(is_valid:, type:, formats:, location:, carrier:, contact:, additional_properties: nil)
+        @is_valid = is_valid
+        @type = type
+        @formats = formats
+        @location = location
+        @carrier = carrier
+        @contact = contact
+        @additional_properties = additional_properties
+        @_field_set = {
+          "isValid": is_valid,
+          "type": type,
+          "formats": formats,
+          "location": location,
+          "carrier": carrier,
+          "contact": contact
+        }
+      end
+
+      # Deserialize a JSON object to an instance of BasicPhoneInformation
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BasicPhoneInformation]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        is_valid = parsed_json["isValid"]
+        type = parsed_json["type"]
+        if parsed_json["formats"].nil?
+          formats = nil
+        else
+          formats = parsed_json["formats"].to_json
+          formats = Pinnacle::Types::NumberFormat.from_json(json_object: formats)
+        end
+        if parsed_json["location"].nil?
+          location = nil
+        else
+          location = parsed_json["location"].to_json
+          location = Pinnacle::Types::BasicPhoneInformationLocation.from_json(json_object: location)
+        end
+        carrier = parsed_json["carrier"]
+        if parsed_json["contact"].nil?
+          contact = nil
+        else
+          contact = parsed_json["contact"].to_json
+          contact = Pinnacle::Types::BasicPhoneInformationContact.from_json(json_object: contact)
+        end
+        new(
+          is_valid: is_valid,
+          type: type,
+          formats: formats,
+          location: location,
+          carrier: carrier,
+          contact: contact,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of BasicPhoneInformation 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.is_valid.is_a?(Boolean) != false || raise("Passed value for field obj.is_valid is not the expected type, validation failed.")
+        obj.type.is_a?(Pinnacle::Types::PhoneNumberEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        Pinnacle::Types::NumberFormat.validate_raw(obj: obj.formats)
+        Pinnacle::Types::BasicPhoneInformationLocation.validate_raw(obj: obj.location)
+        obj.carrier.is_a?(String) != false || raise("Passed value for field obj.carrier is not the expected type, validation failed.")
+        Pinnacle::Types::BasicPhoneInformationContact.validate_raw(obj: obj.contact)
+      end
+    end
+  end
+end

data/lib/rcs/types/basic_phone_information_contact.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Contact information linked to the phone number registration, if available.
+    class BasicPhoneInformationContact
+      # @return [String] Registered name associated with the phone number.
+      attr_reader :name
+      # @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 name [String] Registered name associated with the phone number.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::BasicPhoneInformationContact]
+      def initialize(name:, additional_properties: nil)
+        @name = name
+        @additional_properties = additional_properties
+        @_field_set = { "name": name }
+      end
+
+      # Deserialize a JSON object to an instance of BasicPhoneInformationContact
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BasicPhoneInformationContact]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        name = parsed_json["name"]
+        new(name: name, additional_properties: struct)
+      end
+
+      # Serialize an instance of BasicPhoneInformationContact 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/basic_phone_information_location.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "basic_phone_information_location_country"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Geographic and political details where the phone number is registered.
+    class BasicPhoneInformationLocation
+      # @return [Pinnacle::Types::BasicPhoneInformationLocationCountry] Information about the country of registration.
+      attr_reader :country
+      # @return [String] Location description including region, state/province, and city.
+      attr_reader :place
+      # @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 country [Pinnacle::Types::BasicPhoneInformationLocationCountry] Information about the country of registration.
+      # @param place [String] Location description including region, state/province, and city.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::BasicPhoneInformationLocation]
+      def initialize(country:, place:, additional_properties: nil)
+        @country = country
+        @place = place
+        @additional_properties = additional_properties
+        @_field_set = { "country": country, "place": place }
+      end
+
+      # Deserialize a JSON object to an instance of BasicPhoneInformationLocation
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BasicPhoneInformationLocation]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["country"].nil?
+          country = nil
+        else
+          country = parsed_json["country"].to_json
+          country = Pinnacle::Types::BasicPhoneInformationLocationCountry.from_json(json_object: country)
+        end
+        place = parsed_json["place"]
+        new(
+          country: country,
+          place: place,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of BasicPhoneInformationLocation 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:)
+        Pinnacle::Types::BasicPhoneInformationLocationCountry.validate_raw(obj: obj.country)
+        obj.place.is_a?(String) != false || raise("Passed value for field obj.place is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/basic_phone_information_location_country.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Information about the country of registration.
+    class BasicPhoneInformationLocationCountry
+      # @return [String] Two-letter country code where the number is registered.
+      attr_reader :code
+      # @return [String] Full name of the country.
+      attr_reader :name
+      # @return [String] International dialing prefix for the country.
+      attr_reader :prefix
+      # @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 code [String] Two-letter country code where the number is registered.
+      # @param name [String] Full name of the country.
+      # @param prefix [String] International dialing prefix for the country.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::BasicPhoneInformationLocationCountry]
+      def initialize(code:, name:, prefix:, additional_properties: nil)
+        @code = code
+        @name = name
+        @prefix = prefix
+        @additional_properties = additional_properties
+        @_field_set = { "code": code, "name": name, "prefix": prefix }
+      end
+
+      # Deserialize a JSON object to an instance of BasicPhoneInformationLocationCountry
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BasicPhoneInformationLocationCountry]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        code = parsed_json["code"]
+        name = parsed_json["name"]
+        prefix = parsed_json["prefix"]
+        new(
+          code: code,
+          name: name,
+          prefix: prefix,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of BasicPhoneInformationLocationCountry 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.code.is_a?(String) != false || raise("Passed value for field obj.code 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.prefix.is_a?(String) != false || raise("Passed value for field obj.prefix is not the expected type, validation failed.")
+      end
+    end
+  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