rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/types/phone_number_details.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "phone_enum"
+require_relative "phone_number_cost"
+require_relative "phone_feature_enum"
+require_relative "phone_number_region"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Details of a phone number available for purchase.
+    #  Includes all essential data required for acquisition and operational planning.
+    class PhoneNumberDetails
+      # @return [String] Phone number in E.164 format.
+      attr_reader :number
+      # @return [Pinnacle::Types::PhoneEnum] Classification that defines the number's billing model and geographic scope.
+      attr_reader :phone_type
+      # @return [Pinnacle::Types::PhoneNumberCost] Pricing details for the phone number.
+      attr_reader :cost
+      # @return [Array<Pinnacle::Types::PhoneFeatureEnum>] Supported communication capabilities associated with the number.
+      attr_reader :features
+      # @return [Pinnacle::Types::PhoneNumberRegion] Geographic and routing information for the phone number.
+      attr_reader :region
+      # @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 number [String] Phone number in E.164 format.
+      # @param phone_type [Pinnacle::Types::PhoneEnum] Classification that defines the number's billing model and geographic scope.
+      # @param cost [Pinnacle::Types::PhoneNumberCost] Pricing details for the phone number.
+      # @param features [Array<Pinnacle::Types::PhoneFeatureEnum>] Supported communication capabilities associated with the number.
+      # @param region [Pinnacle::Types::PhoneNumberRegion] Geographic and routing information for the phone number.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberDetails]
+      def initialize(number:, phone_type:, cost:, features:, region:, additional_properties: nil)
+        @number = number
+        @phone_type = phone_type
+        @cost = cost
+        @features = features
+        @region = region
+        @additional_properties = additional_properties
+        @_field_set = {
+          "number": number,
+          "phone_type": phone_type,
+          "cost": cost,
+          "features": features,
+          "region": region
+        }
+      end
+
+      # Deserialize a JSON object to an instance of PhoneNumberDetails
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberDetails]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        number = parsed_json["number"]
+        phone_type = parsed_json["phone_type"]
+        if parsed_json["cost"].nil?
+          cost = nil
+        else
+          cost = parsed_json["cost"].to_json
+          cost = Pinnacle::Types::PhoneNumberCost.from_json(json_object: cost)
+        end
+        features = parsed_json["features"]
+        if parsed_json["region"].nil?
+          region = nil
+        else
+          region = parsed_json["region"].to_json
+          region = Pinnacle::Types::PhoneNumberRegion.from_json(json_object: region)
+        end
+        new(
+          number: number,
+          phone_type: phone_type,
+          cost: cost,
+          features: features,
+          region: region,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberDetails 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.number.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
+        obj.phone_type.is_a?(Pinnacle::Types::PhoneEnum) != false || raise("Passed value for field obj.phone_type is not the expected type, validation failed.")
+        Pinnacle::Types::PhoneNumberCost.validate_raw(obj: obj.cost)
+        obj.features.is_a?(Array) != false || raise("Passed value for field obj.features is not the expected type, validation failed.")
+        Pinnacle::Types::PhoneNumberRegion.validate_raw(obj: obj.region)
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_number_enum.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # The classification of the phone number based on its service type. <br>
+    #  Determines the billing, usage, and routing characteristics.
+    class PhoneNumberEnum
+      LANDLINE = "LANDLINE"
+      MOBILE = "MOBILE"
+      SATELLITE = "SATELLITE"
+      PREMIUM = "PREMIUM"
+      PAGING = "PAGING"
+      SPECIAL = "SPECIAL"
+      TOLL_FREE = "TOLL_FREE"
+      UNKNOWN = "UNKNOWN"
+    end
+  end
+end

data/lib/rcs/types/phone_number_region.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Geographic and routing information for the phone number.
+    class PhoneNumberRegion
+      # @return [String] Two-letter country code where the number is registered.
+      attr_reader :country
+      # @return [String] State or province code applicable to local numbers.
+      attr_reader :state
+      # @return [String] Primary city or metropolitan area served by the number.
+      attr_reader :city
+      # @return [String] Telecommunications rate center used for call routing and billing,
+      #  defining local calling area boundaries.
+      attr_reader :rate_center
+      # @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 [String] Two-letter country code where the number is registered.
+      # @param state [String] State or province code applicable to local numbers.
+      # @param city [String] Primary city or metropolitan area served by the number.
+      # @param rate_center [String] Telecommunications rate center used for call routing and billing,
+      #  defining local calling area boundaries.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberRegion]
+      def initialize(country:, state: OMIT, city: OMIT, rate_center: OMIT, additional_properties: nil)
+        @country = country
+        @state = state if state != OMIT
+        @city = city if city != OMIT
+        @rate_center = rate_center if rate_center != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "country": country,
+          "state": state,
+          "city": city,
+          "rateCenter": rate_center
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of PhoneNumberRegion
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberRegion]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        country = parsed_json["country"]
+        state = parsed_json["state"]
+        city = parsed_json["city"]
+        rate_center = parsed_json["rateCenter"]
+        new(
+          country: country,
+          state: state,
+          city: city,
+          rate_center: rate_center,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberRegion 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.country.is_a?(String) != false || raise("Passed value for field obj.country 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.city&.is_a?(String) != false || raise("Passed value for field obj.city is not the expected type, validation failed.")
+        obj.rate_center&.is_a?(String) != false || raise("Passed value for field obj.rate_center is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_number_status.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "phone_number_status_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Response for get phone number status.
+    class PhoneNumberStatus
+      # @return [Array<String>] List of errors that occured.
+      attr_reader :errors
+      # @return [String] Phone number in E164 format that is in review
+      attr_reader :phone_number
+      # @return [Pinnacle::Types::PhoneNumberStatusEnum] Current status of the phone number. <br>
+      #  `PENDING`: Not active during the one or more of the following: purchase pending,
+      #  brand or campaign pending verification, and pending assignment to a campaign. To
+      #  use a number, make sure to [attach it](../phone-numbers/attach-campaign) to an
+      #  active campaign. <br>
+      #  `ACTIVE`: Number is ready to send messages. <br>
+      #  `FAILURE`: Errors occurred while activating this number. See the [errors
+      #  field](phone-number#response.body.errors).
+      attr_reader :status
+      # @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 errors [Array<String>] List of errors that occured.
+      # @param phone_number [String] Phone number in E164 format that is in review
+      # @param status [Pinnacle::Types::PhoneNumberStatusEnum] Current status of the phone number. <br>
+      #  `PENDING`: Not active during the one or more of the following: purchase pending,
+      #  brand or campaign pending verification, and pending assignment to a campaign. To
+      #  use a number, make sure to [attach it](../phone-numbers/attach-campaign) to an
+      #  active campaign. <br>
+      #  `ACTIVE`: Number is ready to send messages. <br>
+      #  `FAILURE`: Errors occurred while activating this number. See the [errors
+      #  field](phone-number#response.body.errors).
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberStatus]
+      def initialize(errors:, phone_number:, status:, additional_properties: nil)
+        @errors = errors
+        @phone_number = phone_number
+        @status = status
+        @additional_properties = additional_properties
+        @_field_set = { "errors": errors, "phoneNumber": phone_number, "status": status }
+      end
+
+      # Deserialize a JSON object to an instance of PhoneNumberStatus
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberStatus]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        errors = parsed_json["errors"]
+        phone_number = parsed_json["phoneNumber"]
+        status = parsed_json["status"]
+        new(
+          errors: errors,
+          phone_number: phone_number,
+          status: status,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberStatus 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.")
+        obj.phone_number.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
+        obj.status.is_a?(Pinnacle::Types::PhoneNumberStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_number_status_enum.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Current status of the phone number.
+    #  `PENDING`: Not active during the one or more of the following: purchase pending,
+    #  brand or campaign pending verification, and pending assignment to a campaign.
+    #  `ACTIVE`: Number is ready to send messages.
+    #  `FAILURE`: Errors occurred while activating this number.
+    class PhoneNumberStatusEnum
+      PENDING = "PENDING"
+      ACTIVE = "ACTIVE"
+      FAILURE = "FAILURE"
+    end
+  end
+end

data/lib/rcs/types/pinnacle_file_upload_metadata.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class PinnacleFileUploadMetadata
+      # @return [String] Name of the uploaded file.
+      attr_reader :file_name
+      # @return [String] MIME type of the file.
+      attr_reader :content_type
+      # @return [String] Expiration date in ISO 8601 format for file download access.<br>
+      #  Null indicates that `download.expiresAt` was not provided and the expiration
+      #  time is defaulted to one hour after uploading.
+      attr_reader :expires_at
+      # @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 file_name [String] Name of the uploaded file.
+      # @param content_type [String] MIME type of the file.
+      # @param expires_at [String] Expiration date in ISO 8601 format for file download access.<br>
+      #  Null indicates that `download.expiresAt` was not provided and the expiration
+      #  time is defaulted to one hour after uploading.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PinnacleFileUploadMetadata]
+      def initialize(file_name:, content_type:, expires_at: OMIT, additional_properties: nil)
+        @file_name = file_name
+        @content_type = content_type
+        @expires_at = expires_at if expires_at != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "fileName": file_name,
+          "contentType": content_type,
+          "expiresAt": expires_at
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of PinnacleFileUploadMetadata
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PinnacleFileUploadMetadata]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        file_name = parsed_json["fileName"]
+        content_type = parsed_json["contentType"]
+        expires_at = parsed_json["expiresAt"]
+        new(
+          file_name: file_name,
+          content_type: content_type,
+          expires_at: expires_at,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PinnacleFileUploadMetadata 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.file_name.is_a?(String) != false || raise("Passed value for field obj.file_name is not the expected type, validation failed.")
+        obj.content_type.is_a?(String) != false || raise("Passed value for field obj.content_type is not the expected type, validation failed.")
+        obj.expires_at&.is_a?(String) != false || raise("Passed value for field obj.expires_at is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/pinnacle_url_config.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class PinnacleUrlConfig
+      # @return [String] Destination URL that your shortened link redirects to.
+      attr_reader :to
+      # @return [String] Expiration date for your shortened link in ISO 8601 format, or null if it's
+      #  permanent.
+      attr_reader :expires_at
+      # @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 to [String] Destination URL that your shortened link redirects to.
+      # @param expires_at [String] Expiration date for your shortened link in ISO 8601 format, or null if it's
+      #  permanent.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PinnacleUrlConfig]
+      def initialize(to:, expires_at: OMIT, additional_properties: nil)
+        @to = to
+        @expires_at = expires_at if expires_at != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "to": to, "expiresAt": expires_at }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of PinnacleUrlConfig
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PinnacleUrlConfig]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        to = parsed_json["to"]
+        expires_at = parsed_json["expiresAt"]
+        new(
+          to: to,
+          expires_at: expires_at,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PinnacleUrlConfig 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.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
+        obj.expires_at&.is_a?(String) != false || raise("Passed value for field obj.expires_at is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/profile_status_enum.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Current review status of the campaign.
+    #  `INCOMPLETE`: Not submitted.
+    #  `IN REVIEW`: Being reviewed by carriers.
+    #  `VERIFIED`: Approved and ready to send messages.
+    #  `FAILED`: Issues and errors related to the campaign's details.
+    class ProfileStatusEnum
+      INCOMPLETE = "INCOMPLETE"
+      IN_REVIEW = "IN REVIEW"
+      VERIFIED = "VERIFIED"
+      FAILED = "FAILED"
+    end
+  end
+end

data/lib/rcs/types/purchased_number.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "buy_response_capabilities"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Details of a phone number that has been successfully purchased and provisioned.
+    #  Includes all communication capabilities currently enabled for immediate use.
+    class PurchasedNumber
+      # @return [String] Purchased phone number in E.164 format.
+      attr_reader :number
+      # @return [Pinnacle::Types::BuyResponseCapabilities] Enabled communication features for the phone number.
+      attr_reader :capabilities
+      # @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 number [String] Purchased phone number in E.164 format.
+      # @param capabilities [Pinnacle::Types::BuyResponseCapabilities] Enabled communication features for the phone number.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PurchasedNumber]
+      def initialize(number:, capabilities:, additional_properties: nil)
+        @number = number
+        @capabilities = capabilities
+        @additional_properties = additional_properties
+        @_field_set = { "number": number, "capabilities": capabilities }
+      end
+
+      # Deserialize a JSON object to an instance of PurchasedNumber
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PurchasedNumber]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        number = parsed_json["number"]
+        if parsed_json["capabilities"].nil?
+          capabilities = nil
+        else
+          capabilities = parsed_json["capabilities"].to_json
+          capabilities = Pinnacle::Types::BuyResponseCapabilities.from_json(json_object: capabilities)
+        end
+        new(
+          number: number,
+          capabilities: capabilities,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PurchasedNumber 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.number.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
+        Pinnacle::Types::BuyResponseCapabilities.validate_raw(obj: obj.capabilities)
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "rcs_text"
+require_relative "rcs_media"
+require_relative "rcs_card"
+
+module Pinnacle
+  module Types
+    class Rcs
+      # Deserialize a JSON object to an instance of Rcs
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::Rcs]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Pinnacle::Types::RcsText.validate_raw(obj: struct)
+          return Pinnacle::Types::RcsText.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::RcsMedia.validate_raw(obj: struct)
+          return Pinnacle::Types::RcsMedia.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::RcsCard.validate_raw(obj: struct)
+          return Pinnacle::Types::RcsCard.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::RcsText.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::RcsMedia.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::RcsCard.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end