rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/{send/types/send_sms_response.rb → types/autofill_dlc_response_keywords_opt_in.rb}

@@ -4,12 +4,13 @@ require "ostruct"
 require "json"
 
 module Pinnacle
-  class Send
-    class SendSmsResponse
-      # @return [String] The unique ID of the sent message.
-      attr_reader :message_id
-      # @return [String] A message indicating the status of the sent message.
+  module Types
+    # Opt-in keyword settings.
+    class AutofillDlcResponseKeywordsOptIn
+      # @return [String] Response message for opt-in keywords.
       attr_reader :message
+      # @return [Array<String>] Keywords that trigger opt-in.
+      attr_reader :values
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -18,34 +19,34 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param message_id [String] The unique ID of the sent message.
-      # @param message [String] A message indicating the status of the sent message.
+      # @param message [String] Response message for opt-in keywords.
+      # @param values [Array<String>] Keywords that trigger opt-in.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Send::SendSmsResponse]
-      def initialize(message_id:, message:, additional_properties: nil)
-        @message_id = message_id
+      # @return [Pinnacle::Types::AutofillDlcResponseKeywordsOptIn]
+      def initialize(message:, values:, additional_properties: nil)
         @message = message
+        @values = values
         @additional_properties = additional_properties
-        @_field_set = { "messageId": message_id, "message": message }
+        @_field_set = { "message": message, "values": values }
       end
 
-      # Deserialize a JSON object to an instance of SendSmsResponse
+      # Deserialize a JSON object to an instance of AutofillDlcResponseKeywordsOptIn
       #
       # @param json_object [String]
-      # @return [Pinnacle::Send::SendSmsResponse]
+      # @return [Pinnacle::Types::AutofillDlcResponseKeywordsOptIn]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        message_id = parsed_json["messageId"]
         message = parsed_json["message"]
+        values = parsed_json["values"]
         new(
-          message_id: message_id,
           message: message,
+          values: values,
           additional_properties: struct
         )
       end
 
-      # Serialize an instance of SendSmsResponse to a JSON object
+      # Serialize an instance of AutofillDlcResponseKeywordsOptIn to a JSON object
       #
       # @return [String]
       def to_json(*_args)
@@ -59,8 +60,8 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.message_id.is_a?(String) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
         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.")
       end
     end
   end

data/lib/rcs/types/autofill_dlc_response_keywords_opt_out.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Opt-out keyword settings.
+    class AutofillDlcResponseKeywordsOptOut
+      # @return [String] Response message for opt-out keywords.
+      attr_reader :message
+      # @return [Array<String>] Keywords that trigger opt-out.
+      attr_reader :values
+      # @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 message [String] Response message for opt-out keywords.
+      # @param values [Array<String>] Keywords that trigger opt-out.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AutofillDlcResponseKeywordsOptOut]
+      def initialize(message: OMIT, values: OMIT, additional_properties: nil)
+        @message = message if message != OMIT
+        @values = values if values != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "message": message, "values": values }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AutofillDlcResponseKeywordsOptOut
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AutofillDlcResponseKeywordsOptOut]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        message = parsed_json["message"]
+        values = parsed_json["values"]
+        new(
+          message: message,
+          values: values,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AutofillDlcResponseKeywordsOptOut 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.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.")
+      end
+    end
+  end
+end

data/lib/rcs/types/autofill_dlc_response_links.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Legal documentation links.
+    class AutofillDlcResponseLinks
+      # @return [String] Privacy policy URL.
+      attr_reader :privacy_policy
+      # @return [String] Terms of service URL.
+      attr_reader :terms_of_service
+      # @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 privacy_policy [String] Privacy policy URL.
+      # @param terms_of_service [String] Terms of service URL.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AutofillDlcResponseLinks]
+      def initialize(privacy_policy: OMIT, terms_of_service: OMIT, additional_properties: nil)
+        @privacy_policy = privacy_policy if privacy_policy != OMIT
+        @terms_of_service = terms_of_service if terms_of_service != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "privacyPolicy": privacy_policy, "termsOfService": terms_of_service }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AutofillDlcResponseLinks
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AutofillDlcResponseLinks]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        privacy_policy = parsed_json["privacyPolicy"]
+        terms_of_service = parsed_json["termsOfService"]
+        new(
+          privacy_policy: privacy_policy,
+          terms_of_service: terms_of_service,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AutofillDlcResponseLinks 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.privacy_policy&.is_a?(String) != false || raise("Passed value for field obj.privacy_policy is not the expected type, validation failed.")
+        obj.terms_of_service&.is_a?(String) != false || raise("Passed value for field obj.terms_of_service is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/autofill_dlc_response_options.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Campaign configuration options.
+    class AutofillDlcResponseOptions
+      # @return [Boolean] Whether the campaign uses affiliate marketing.
+      attr_reader :affiliate_marketing
+      # @return [Boolean] Whether the campaign is age-gated.
+      attr_reader :age_gated
+      # @return [Boolean] Whether the campaign involves direct lending.
+      attr_reader :direct_lending
+      # @return [String] Link embedded in campaign message.
+      attr_reader :embedded_link
+      # @return [Boolean] Whether messages include phone numbers.
+      attr_reader :embedded_phone
+      # @return [Boolean] Whether the campaign uses number pooling.
+      attr_reader :number_pooling
+      # @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 affiliate_marketing [Boolean] Whether the campaign uses affiliate marketing.
+      # @param age_gated [Boolean] Whether the campaign is age-gated.
+      # @param direct_lending [Boolean] Whether the campaign involves direct lending.
+      # @param embedded_link [String] Link embedded in campaign message.
+      # @param embedded_phone [Boolean] Whether messages include phone numbers.
+      # @param number_pooling [Boolean] Whether the campaign uses number pooling.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AutofillDlcResponseOptions]
+      def initialize(affiliate_marketing: OMIT, age_gated: OMIT, direct_lending: OMIT, embedded_link: OMIT,
+                     embedded_phone: OMIT, number_pooling: OMIT, additional_properties: nil)
+        @affiliate_marketing = affiliate_marketing if affiliate_marketing != OMIT
+        @age_gated = age_gated if age_gated != OMIT
+        @direct_lending = direct_lending if direct_lending != OMIT
+        @embedded_link = embedded_link if embedded_link != OMIT
+        @embedded_phone = embedded_phone if embedded_phone != OMIT
+        @number_pooling = number_pooling if number_pooling != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "affiliateMarketing": affiliate_marketing,
+          "ageGated": age_gated,
+          "directLending": direct_lending,
+          "embeddedLink": embedded_link,
+          "embeddedPhone": embedded_phone,
+          "numberPooling": number_pooling
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AutofillDlcResponseOptions
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AutofillDlcResponseOptions]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        affiliate_marketing = parsed_json["affiliateMarketing"]
+        age_gated = parsed_json["ageGated"]
+        direct_lending = parsed_json["directLending"]
+        embedded_link = parsed_json["embeddedLink"]
+        embedded_phone = parsed_json["embeddedPhone"]
+        number_pooling = parsed_json["numberPooling"]
+        new(
+          affiliate_marketing: affiliate_marketing,
+          age_gated: age_gated,
+          direct_lending: direct_lending,
+          embedded_link: embedded_link,
+          embedded_phone: embedded_phone,
+          number_pooling: number_pooling,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AutofillDlcResponseOptions 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.affiliate_marketing&.is_a?(Boolean) != false || raise("Passed value for field obj.affiliate_marketing is not the expected type, validation failed.")
+        obj.age_gated&.is_a?(Boolean) != false || raise("Passed value for field obj.age_gated is not the expected type, validation failed.")
+        obj.direct_lending&.is_a?(Boolean) != false || raise("Passed value for field obj.direct_lending is not the expected type, validation failed.")
+        obj.embedded_link&.is_a?(String) != false || raise("Passed value for field obj.embedded_link is not the expected type, validation failed.")
+        obj.embedded_phone&.is_a?(Boolean) != false || raise("Passed value for field obj.embedded_phone is not the expected type, validation failed.")
+        obj.number_pooling&.is_a?(Boolean) != false || raise("Passed value for field obj.number_pooling is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -1,57 +1,56 @@
 # frozen_string_literal: true
 
-require "ostruct"
 require "json"
+require_relative "zod_error"
+require_relative "error"
 
 module Pinnacle
-  class BadRequestErrorBody
-    # @return [Array<String>]
-    attr_reader :errors
-    # @return [OpenStruct] Additional properties unmapped to the current class definition
-    attr_reader :additional_properties
-    # @return [Object]
-    attr_reader :_field_set
-    protected :_field_set
+  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?
 
-    OMIT = Object.new
+          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?
 
-    # @param errors [Array<String>]
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::BadRequestErrorBody]
-    def initialize(errors: OMIT, additional_properties: nil)
-      @errors = errors if errors != OMIT
-      @additional_properties = additional_properties
-      @_field_set = { "errors": errors }.reject do |_k, v|
-        v == OMIT
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
       end
-    end
-
-    # Deserialize a JSON object to an instance of BadRequestErrorBody
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::BadRequestErrorBody]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      errors = parsed_json["errors"]
-      new(errors: errors, additional_properties: struct)
-    end
 
-    # Serialize an instance of BadRequestErrorBody 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.errors&.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
+      # 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/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