rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/types/advanced_phone_information_location.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require_relative "advanced_phone_information_location_country"
+require_relative "advanced_phone_information_location_coordinates"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Comprehensive geographic and administrative location data with precise
+    #  coordinates
+    #  and timezone information for accurate localization.
+    class AdvancedPhoneInformationLocation
+      # @return [Pinnacle::Types::AdvancedPhoneInformationLocationCountry] Complete country identification and metadata.
+      attr_reader :country
+      # @return [String] Primary city or municipality associated with the phone number.
+      attr_reader :city
+      # @return [String] State, province, or primary administrative division code.
+      #  Uses standard 2-letter abbreviations where applicable.
+      attr_reader :state
+      # @return [String] Postal or ZIP code for the phone number's registered location.
+      attr_reader :zip
+      # @return [String] Primary Metropolitan Statistical Area (PMSA) code for US numbers.
+      #  Used for demographic and market analysis purposes.
+      attr_reader :metro_code
+      # @return [String] County or secondary administrative division name.
+      attr_reader :county
+      # @return [Pinnacle::Types::AdvancedPhoneInformationLocationCoordinates] Coordinates provide the precise latitude and longitude values for the phone
+      #  number’s registered location.
+      attr_reader :coordinates
+      # @return [String] IANA timezone identifier for the number’s location.
+      attr_reader :time_zone
+      # @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::AdvancedPhoneInformationLocationCountry] Complete country identification and metadata.
+      # @param city [String] Primary city or municipality associated with the phone number.
+      # @param state [String] State, province, or primary administrative division code.
+      #  Uses standard 2-letter abbreviations where applicable.
+      # @param zip [String] Postal or ZIP code for the phone number's registered location.
+      # @param metro_code [String] Primary Metropolitan Statistical Area (PMSA) code for US numbers.
+      #  Used for demographic and market analysis purposes.
+      # @param county [String] County or secondary administrative division name.
+      # @param coordinates [Pinnacle::Types::AdvancedPhoneInformationLocationCoordinates] Coordinates provide the precise latitude and longitude values for the phone
+      #  number’s registered location.
+      # @param time_zone [String] IANA timezone identifier for the number’s location.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AdvancedPhoneInformationLocation]
+      def initialize(country:, coordinates:, city: OMIT, state: OMIT, zip: OMIT, metro_code: OMIT, county: OMIT,
+                     time_zone: OMIT, additional_properties: nil)
+        @country = country
+        @city = city if city != OMIT
+        @state = state if state != OMIT
+        @zip = zip if zip != OMIT
+        @metro_code = metro_code if metro_code != OMIT
+        @county = county if county != OMIT
+        @coordinates = coordinates
+        @time_zone = time_zone if time_zone != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "country": country,
+          "city": city,
+          "state": state,
+          "zip": zip,
+          "metroCode": metro_code,
+          "county": county,
+          "coordinates": coordinates,
+          "timeZone": time_zone
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AdvancedPhoneInformationLocation
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AdvancedPhoneInformationLocation]
+      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::AdvancedPhoneInformationLocationCountry.from_json(json_object: country)
+        end
+        city = parsed_json["city"]
+        state = parsed_json["state"]
+        zip = parsed_json["zip"]
+        metro_code = parsed_json["metroCode"]
+        county = parsed_json["county"]
+        if parsed_json["coordinates"].nil?
+          coordinates = nil
+        else
+          coordinates = parsed_json["coordinates"].to_json
+          coordinates = Pinnacle::Types::AdvancedPhoneInformationLocationCoordinates.from_json(json_object: coordinates)
+        end
+        time_zone = parsed_json["timeZone"]
+        new(
+          country: country,
+          city: city,
+          state: state,
+          zip: zip,
+          metro_code: metro_code,
+          county: county,
+          coordinates: coordinates,
+          time_zone: time_zone,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AdvancedPhoneInformationLocation 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::AdvancedPhoneInformationLocationCountry.validate_raw(obj: obj.country)
+        obj.city&.is_a?(String) != false || raise("Passed value for field obj.city is not the expected type, validation failed.")
+        obj.state&.is_a?(String) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+        obj.zip&.is_a?(String) != false || raise("Passed value for field obj.zip is not the expected type, validation failed.")
+        obj.metro_code&.is_a?(String) != false || raise("Passed value for field obj.metro_code is not the expected type, validation failed.")
+        obj.county&.is_a?(String) != false || raise("Passed value for field obj.county is not the expected type, validation failed.")
+        Pinnacle::Types::AdvancedPhoneInformationLocationCoordinates.validate_raw(obj: obj.coordinates)
+        obj.time_zone&.is_a?(String) != false || raise("Passed value for field obj.time_zone is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/advanced_phone_information_location_coordinates.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Coordinates provide the precise latitude and longitude values for the phone
+    #  number’s registered location.
+    class AdvancedPhoneInformationLocationCoordinates
+      # @return [Float] Decimal degrees latitude coordinate.
+      attr_reader :latitude
+      # @return [Float] Decimal degrees longitude coordinate.
+      attr_reader :longitude
+      # @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 latitude [Float] Decimal degrees latitude coordinate.
+      # @param longitude [Float] Decimal degrees longitude coordinate.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AdvancedPhoneInformationLocationCoordinates]
+      def initialize(latitude: OMIT, longitude: OMIT, additional_properties: nil)
+        @latitude = latitude if latitude != OMIT
+        @longitude = longitude if longitude != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "latitude": latitude, "longitude": longitude }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of
+      #  AdvancedPhoneInformationLocationCoordinates
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AdvancedPhoneInformationLocationCoordinates]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        latitude = parsed_json["latitude"]
+        longitude = parsed_json["longitude"]
+        new(
+          latitude: latitude,
+          longitude: longitude,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AdvancedPhoneInformationLocationCoordinates 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.latitude&.is_a?(Float) != false || raise("Passed value for field obj.latitude is not the expected type, validation failed.")
+        obj.longitude&.is_a?(Float) != false || raise("Passed value for field obj.longitude is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/advanced_phone_information_location_country.rb

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

data/lib/rcs/types/advanced_phone_information_type.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative "detailed_phone_number_enum"
+require_relative "advanced_phone_information_type_recommendation"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Detailed classification including fraud risk and security recommendations.
+    class AdvancedPhoneInformationType
+      # @return [Pinnacle::Types::DetailedPhoneNumberEnum] Technical classification derived from carrier intelligence systems.
+      attr_reader :value
+      # @return [String] Explanation of the phone number type and service
+      attr_reader :description
+      # @return [String] Additional technical details about the service type, billing model,
+      #  and typical usage patterns for this number classification.
+      attr_reader :details
+      # @return [Pinnacle::Types::AdvancedPhoneInformationTypeRecommendation] Security recommendation based on fraud risk analysis:
+      #  - `ALLOW`: Low risk, safe for normal use.
+      #  - `BLOCK`: High risk, block or require additional verification.
+      #  - `FLAG`: Medium risk, recommend further scrutiny or monitoring.
+      attr_reader :recommendation
+      # @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 value [Pinnacle::Types::DetailedPhoneNumberEnum] Technical classification derived from carrier intelligence systems.
+      # @param description [String] Explanation of the phone number type and service
+      # @param details [String] Additional technical details about the service type, billing model,
+      #  and typical usage patterns for this number classification.
+      # @param recommendation [Pinnacle::Types::AdvancedPhoneInformationTypeRecommendation] Security recommendation based on fraud risk analysis:
+      #  - `ALLOW`: Low risk, safe for normal use.
+      #  - `BLOCK`: High risk, block or require additional verification.
+      #  - `FLAG`: Medium risk, recommend further scrutiny or monitoring.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AdvancedPhoneInformationType]
+      def initialize(value:, description:, details:, recommendation:, additional_properties: nil)
+        @value = value
+        @description = description
+        @details = details
+        @recommendation = recommendation
+        @additional_properties = additional_properties
+        @_field_set = {
+          "value": value,
+          "description": description,
+          "details": details,
+          "recommendation": recommendation
+        }
+      end
+
+      # Deserialize a JSON object to an instance of AdvancedPhoneInformationType
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AdvancedPhoneInformationType]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        value = parsed_json["value"]
+        description = parsed_json["description"]
+        details = parsed_json["details"]
+        recommendation = parsed_json["recommendation"]
+        new(
+          value: value,
+          description: description,
+          details: details,
+          recommendation: recommendation,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AdvancedPhoneInformationType 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.value.is_a?(Pinnacle::Types::DetailedPhoneNumberEnum) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+        obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+        obj.details.is_a?(String) != false || raise("Passed value for field obj.details is not the expected type, validation failed.")
+        obj.recommendation.is_a?(Pinnacle::Types::AdvancedPhoneInformationTypeRecommendation) != false || raise("Passed value for field obj.recommendation is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/advanced_phone_information_type_recommendation.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Security recommendation based on fraud risk analysis:
+    #  - `ALLOW`: Low risk, safe for normal use.
+    #  - `BLOCK`: High risk, block or require additional verification.
+    #  - `FLAG`: Medium risk, recommend further scrutiny or monitoring.
+    class AdvancedPhoneInformationTypeRecommendation
+      ALLOW = "ALLOW"
+      BLOCK = "BLOCK"
+      FLAG = "FLAG"
+    end
+  end
+end

data/lib/rcs/types/agent.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Information about an RCS agent sender in a conversation.
+    class Agent
+      # @return [String] Unique identifier for the RCS agent.
+      attr_reader :agent_id
+      # @return [String] Display name of the RCS agent.
+      attr_reader :agent_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 agent_id [String] Unique identifier for the RCS agent.
+      # @param agent_name [String] Display name of the RCS agent.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::Agent]
+      def initialize(agent_id:, agent_name:, additional_properties: nil)
+        @agent_id = agent_id
+        @agent_name = agent_name
+        @additional_properties = additional_properties
+        @_field_set = { "agentId": agent_id, "agentName": agent_name }
+      end
+
+      # Deserialize a JSON object to an instance of Agent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::Agent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        agent_id = parsed_json["agentId"]
+        agent_name = parsed_json["agentName"]
+        new(
+          agent_id: agent_id,
+          agent_name: agent_name,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of Agent 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.agent_id.is_a?(String) != false || raise("Passed value for field obj.agent_id is not the expected type, validation failed.")
+        obj.agent_name.is_a?(String) != false || raise("Passed value for field obj.agent_name is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/attach_webhook_params.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "attach_webhook_schema_webhook_id"
+require_relative "attach_webhook_schema_name"
+
+module Pinnacle
+  module Types
+    # Use this request to connect a webhook to your phone number and receive real-time
+    #  event notifications.
+    #  You can either attach one of your existing webhooks by providing its ID or
+    #  create a new webhook by specifying its name, URL, and event type.
+    class AttachWebhookParams
+      # Deserialize a JSON object to an instance of AttachWebhookParams
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AttachWebhookParams]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Pinnacle::Types::AttachWebhookSchemaWebhookId.validate_raw(obj: struct)
+          return Pinnacle::Types::AttachWebhookSchemaWebhookId.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::AttachWebhookSchemaName.validate_raw(obj: struct)
+          return Pinnacle::Types::AttachWebhookSchemaName.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::AttachWebhookSchemaWebhookId.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::AttachWebhookSchemaName.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/attach_webhook_response_webhook.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Detailed information about the attached webhook.
+    class AttachWebhookResponseWebhook
+      # @return [Integer] Unique identifier of the webhook within the account.
+      attr_reader :id
+      # @return [String] Name of the webhook.
+      attr_reader :name
+      # @return [String] The HTTPS endpoint URL where webhook events will be sent as HTTP POST requests.
+      attr_reader :url
+      # @return [String] Secret key used to verify the authenticity of incoming webhook requests. <br>
+      #  This secret key will be stored in the `PINNACLE-SIGNING-SECRET` header.
+      attr_reader :secret
+      # @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 id [Integer] Unique identifier of the webhook within the account.
+      # @param name [String] Name of the webhook.
+      # @param url [String] The HTTPS endpoint URL where webhook events will be sent as HTTP POST requests.
+      # @param secret [String] Secret key used to verify the authenticity of incoming webhook requests. <br>
+      #  This secret key will be stored in the `PINNACLE-SIGNING-SECRET` header.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::AttachWebhookResponseWebhook]
+      def initialize(id:, name:, url:, secret: OMIT, additional_properties: nil)
+        @id = id
+        @name = name
+        @url = url
+        @secret = secret if secret != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "id": id, "name": name, "url": url, "secret": secret }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AttachWebhookResponseWebhook
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::AttachWebhookResponseWebhook]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        name = parsed_json["name"]
+        url = parsed_json["url"]
+        secret = parsed_json["secret"]
+        new(
+          id: id,
+          name: name,
+          url: url,
+          secret: secret,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AttachWebhookResponseWebhook 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.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+        obj.secret&.is_a?(String) != false || raise("Passed value for field obj.secret is not the expected type, validation failed.")
+      end
+    end
+  end
+end