rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/types/phone_capabilities.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Represents the communication capabilities available for a phone number.
+    class PhoneCapabilities
+      # @return [Boolean] Whether the phone number supports MMS (multimedia messaging).
+      attr_reader :mms
+      # @return [Boolean] Whether the phone number supports SMS messaging.
+      attr_reader :sms
+      # @return [Boolean] Whether the phone number supports voice calls.
+      attr_reader :voice
+      # @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 mms [Boolean] Whether the phone number supports MMS (multimedia messaging).
+      # @param sms [Boolean] Whether the phone number supports SMS messaging.
+      # @param voice [Boolean] Whether the phone number supports voice calls.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneCapabilities]
+      def initialize(mms:, sms:, voice:, additional_properties: nil)
+        @mms = mms
+        @sms = sms
+        @voice = voice
+        @additional_properties = additional_properties
+        @_field_set = { "mms": mms, "sms": sms, "voice": voice }
+      end
+
+      # Deserialize a JSON object to an instance of PhoneCapabilities
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneCapabilities]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        mms = parsed_json["mms"]
+        sms = parsed_json["sms"]
+        voice = parsed_json["voice"]
+        new(
+          mms: mms,
+          sms: sms,
+          voice: voice,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneCapabilities 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.mms.is_a?(Boolean) != false || raise("Passed value for field obj.mms is not the expected type, validation failed.")
+        obj.sms.is_a?(Boolean) != false || raise("Passed value for field obj.sms is not the expected type, validation failed.")
+        obj.voice.is_a?(Boolean) != false || raise("Passed value for field obj.voice is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_enum.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Classification of phone number types based on their billing and geographic
+    #  properties. <br>
+    #  Determines pricing structure and availability patterns.
+    class PhoneEnum
+      LOCAL = "LOCAL"
+      TOLL_FREE = "TOLL_FREE"
+    end
+  end
+end

data/lib/rcs/types/phone_feature_enum.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Communication features and capabilities supported by a phone number. <br>
+    #  These features determine what types of communication the number can handle.
+    class PhoneFeatureEnum
+      SMS = "SMS"
+      MMS = "MMS"
+      VOICE = "VOICE"
+      FAX = "FAX"
+      EMERGENCY = "EMERGENCY"
+      HD_VOICE = "HD_VOICE"
+      INTERNATIONAL_SMS = "INTERNATIONAL_SMS"
+      LOCAL_CALLING = "LOCAL_CALLING"
+    end
+  end
+end

data/lib/rcs/types/phone_number_campaign_attach_failed_item.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class PhoneNumberCampaignAttachFailedItem
+      # @return [String] Phone number (E.164 format).
+      attr_reader :number
+      # @return [String] Error related to why the number was not attached.
+      attr_reader :error
+      # @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 (E.164 format).
+      # @param error [String] Error related to why the number was not attached.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberCampaignAttachFailedItem]
+      def initialize(number:, error:, additional_properties: nil)
+        @number = number
+        @error = error
+        @additional_properties = additional_properties
+        @_field_set = { "number": number, "error": error }
+      end
+
+      # Deserialize a JSON object to an instance of PhoneNumberCampaignAttachFailedItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberCampaignAttachFailedItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        number = parsed_json["number"]
+        error = parsed_json["error"]
+        new(
+          number: number,
+          error: error,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberCampaignAttachFailedItem 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.error.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_number_campaign_attach_phone_numbers_item.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "phone_number_campaign_attach_phone_numbers_item_campaign"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class PhoneNumberCampaignAttachPhoneNumbersItem
+      # @return [String] Phone number (E.164 format).
+      attr_reader :phone_number
+      # @return [Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItemCampaign] Campaign that the phone is now attached to.
+      attr_reader :campaign
+      # @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 phone_number [String] Phone number (E.164 format).
+      # @param campaign [Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItemCampaign] Campaign that the phone is now attached to.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItem]
+      def initialize(phone_number:, campaign:, additional_properties: nil)
+        @phone_number = phone_number
+        @campaign = campaign
+        @additional_properties = additional_properties
+        @_field_set = { "phoneNumber": phone_number, "campaign": campaign }
+      end
+
+      # Deserialize a JSON object to an instance of
+      #  PhoneNumberCampaignAttachPhoneNumbersItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        phone_number = parsed_json["phoneNumber"]
+        if parsed_json["campaign"].nil?
+          campaign = nil
+        else
+          campaign = parsed_json["campaign"].to_json
+          campaign = Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItemCampaign.from_json(json_object: campaign)
+        end
+        new(
+          phone_number: phone_number,
+          campaign: campaign,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberCampaignAttachPhoneNumbersItem 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.phone_number.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
+        Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItemCampaign.validate_raw(obj: obj.campaign)
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_number_campaign_attach_phone_numbers_item_campaign.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "messaging_profile_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Campaign that the phone is now attached to.
+    class PhoneNumberCampaignAttachPhoneNumbersItemCampaign
+      # @return [Integer] Id of the campaign.
+      attr_reader :id
+      # @return [String] Campaign's name.
+      attr_reader :name
+      # @return [Pinnacle::Types::MessagingProfileEnum]
+      attr_reader :type
+      # @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] Id of the campaign.
+      # @param name [String] Campaign's name.
+      # @param type [Pinnacle::Types::MessagingProfileEnum]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItemCampaign]
+      def initialize(id:, name:, type:, additional_properties: nil)
+        @id = id
+        @name = name
+        @type = type
+        @additional_properties = additional_properties
+        @_field_set = { "id": id, "name": name, "type": type }
+      end
+
+      # Deserialize a JSON object to an instance of
+      #  PhoneNumberCampaignAttachPhoneNumbersItemCampaign
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItemCampaign]
+      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"]
+        type = parsed_json["type"]
+        new(
+          id: id,
+          name: name,
+          type: type,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberCampaignAttachPhoneNumbersItemCampaign 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.type.is_a?(Pinnacle::Types::MessagingProfileEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_number_campaign_detach_failed_item.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class PhoneNumberCampaignDetachFailedItem
+      # @return [String] Phone number (E.164 format).
+      attr_reader :number
+      # @return [String] Error related to why the number was not detached.
+      attr_reader :error
+      # @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 (E.164 format).
+      # @param error [String] Error related to why the number was not detached.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberCampaignDetachFailedItem]
+      def initialize(number:, error:, additional_properties: nil)
+        @number = number
+        @error = error
+        @additional_properties = additional_properties
+        @_field_set = { "number": number, "error": error }
+      end
+
+      # Deserialize a JSON object to an instance of PhoneNumberCampaignDetachFailedItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberCampaignDetachFailedItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        number = parsed_json["number"]
+        error = parsed_json["error"]
+        new(
+          number: number,
+          error: error,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberCampaignDetachFailedItem 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.error.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_number_campaign_detach_phone_numbers_item.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "phone_number_campaign_detach_phone_numbers_item_campaign"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class PhoneNumberCampaignDetachPhoneNumbersItem
+      # @return [String] Phone number (E.164 format).
+      attr_reader :phone_number
+      # @return [Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItemCampaign] Campaign that the phone is now detached from.
+      attr_reader :campaign
+      # @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 phone_number [String] Phone number (E.164 format).
+      # @param campaign [Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItemCampaign] Campaign that the phone is now detached from.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItem]
+      def initialize(phone_number:, campaign:, additional_properties: nil)
+        @phone_number = phone_number
+        @campaign = campaign
+        @additional_properties = additional_properties
+        @_field_set = { "phoneNumber": phone_number, "campaign": campaign }
+      end
+
+      # Deserialize a JSON object to an instance of
+      #  PhoneNumberCampaignDetachPhoneNumbersItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        phone_number = parsed_json["phoneNumber"]
+        if parsed_json["campaign"].nil?
+          campaign = nil
+        else
+          campaign = parsed_json["campaign"].to_json
+          campaign = Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItemCampaign.from_json(json_object: campaign)
+        end
+        new(
+          phone_number: phone_number,
+          campaign: campaign,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberCampaignDetachPhoneNumbersItem 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.phone_number.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
+        Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItemCampaign.validate_raw(obj: obj.campaign)
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_number_campaign_detach_phone_numbers_item_campaign.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "messaging_profile_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Campaign that the phone is now detached from.
+    class PhoneNumberCampaignDetachPhoneNumbersItemCampaign
+      # @return [Integer] Id of the campaign.
+      attr_reader :id
+      # @return [String] Campaign's name.
+      attr_reader :name
+      # @return [Pinnacle::Types::MessagingProfileEnum]
+      attr_reader :type
+      # @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] Id of the campaign.
+      # @param name [String] Campaign's name.
+      # @param type [Pinnacle::Types::MessagingProfileEnum]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItemCampaign]
+      def initialize(id:, name:, type:, additional_properties: nil)
+        @id = id
+        @name = name
+        @type = type
+        @additional_properties = additional_properties
+        @_field_set = { "id": id, "name": name, "type": type }
+      end
+
+      # Deserialize a JSON object to an instance of
+      #  PhoneNumberCampaignDetachPhoneNumbersItemCampaign
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItemCampaign]
+      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"]
+        type = parsed_json["type"]
+        new(
+          id: id,
+          name: name,
+          type: type,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberCampaignDetachPhoneNumbersItemCampaign 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.type.is_a?(Pinnacle::Types::MessagingProfileEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/phone_number_cost.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Pricing details for the phone number.
+    class PhoneNumberCost
+      # @return [Float] Recurring monthly fee covering number ownership and basic services.
+      attr_reader :monthly
+      # @return [Float] One-time activation or setup fee charged at purchase.
+      attr_reader :upfront
+      # @return [String] Three-letter currency code for all pricing values.
+      attr_reader :currency
+      # @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 monthly [Float] Recurring monthly fee covering number ownership and basic services.
+      # @param upfront [Float] One-time activation or setup fee charged at purchase.
+      # @param currency [String] Three-letter currency code for all pricing values.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::PhoneNumberCost]
+      def initialize(monthly:, upfront:, currency:, additional_properties: nil)
+        @monthly = monthly
+        @upfront = upfront
+        @currency = currency
+        @additional_properties = additional_properties
+        @_field_set = { "monthly": monthly, "upfront": upfront, "currency": currency }
+      end
+
+      # Deserialize a JSON object to an instance of PhoneNumberCost
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::PhoneNumberCost]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        monthly = parsed_json["monthly"]
+        upfront = parsed_json["upfront"]
+        currency = parsed_json["currency"]
+        new(
+          monthly: monthly,
+          upfront: upfront,
+          currency: currency,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of PhoneNumberCost 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.monthly.is_a?(Float) != false || raise("Passed value for field obj.monthly is not the expected type, validation failed.")
+        obj.upfront.is_a?(Float) != false || raise("Passed value for field obj.upfront is not the expected type, validation failed.")
+        obj.currency.is_a?(String) != false || raise("Passed value for field obj.currency is not the expected type, validation failed.")
+      end
+    end
+  end
+end