rcs 1.0.18 → 2.0.0.pre.rc.2

data/lib/rcs/types/conversation.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require_relative "campaign_query"
+require_relative "conversation_contact"
+require_relative "conversation_sender"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Conversation that was found.
+    class Conversation
+      # @return [Integer] Identifier for the brand associated with this conversation.
+      attr_reader :brand_id
+      # @return [Pinnacle::Types::CampaignQuery] Campaign information if this conversation is part of a marketing campaign.
+      attr_reader :campaign
+      # @return [Pinnacle::Types::ConversationContact] Contact information for the recipient in a conversation.
+      attr_reader :contact
+      # @return [String] ISO 8601 timestamp when the conversation was created.
+      attr_reader :created_at
+      # @return [Integer] Unique identifier for the conversation.
+      attr_reader :id
+      # @return [String] Free-form notes or comments about the conversation.
+      attr_reader :notes
+      # @return [Pinnacle::Types::ConversationSender] The sender of messages in this conversation. Can be:
+      #  - A phone number with its capabilities and metadata
+      #  - An RCS agent with ID and name
+      #  - `null` if no sender is associated
+      attr_reader :sender
+      # @return [String] ISO 8601 timestamp when the conversation was last updated.
+      attr_reader :updated_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 brand_id [Integer] Identifier for the brand associated with this conversation.
+      # @param campaign [Pinnacle::Types::CampaignQuery] Campaign information if this conversation is part of a marketing campaign.
+      # @param contact [Pinnacle::Types::ConversationContact] Contact information for the recipient in a conversation.
+      # @param created_at [String] ISO 8601 timestamp when the conversation was created.
+      # @param id [Integer] Unique identifier for the conversation.
+      # @param notes [String] Free-form notes or comments about the conversation.
+      # @param sender [Pinnacle::Types::ConversationSender] The sender of messages in this conversation. Can be:
+      #  - A phone number with its capabilities and metadata
+      #  - An RCS agent with ID and name
+      #  - `null` if no sender is associated
+      # @param updated_at [String] ISO 8601 timestamp when the conversation was last updated.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::Conversation]
+      def initialize(contact:, created_at:, id:, notes:, updated_at:, brand_id: OMIT, campaign: OMIT, sender: OMIT,
+                     additional_properties: nil)
+        @brand_id = brand_id if brand_id != OMIT
+        @campaign = campaign if campaign != OMIT
+        @contact = contact
+        @created_at = created_at
+        @id = id
+        @notes = notes
+        @sender = sender if sender != OMIT
+        @updated_at = updated_at
+        @additional_properties = additional_properties
+        @_field_set = {
+          "brandId": brand_id,
+          "campaign": campaign,
+          "contact": contact,
+          "createdAt": created_at,
+          "id": id,
+          "notes": notes,
+          "sender": sender,
+          "updatedAt": updated_at
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of Conversation
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::Conversation]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        brand_id = parsed_json["brandId"]
+        if parsed_json["campaign"].nil?
+          campaign = nil
+        else
+          campaign = parsed_json["campaign"].to_json
+          campaign = Pinnacle::Types::CampaignQuery.from_json(json_object: campaign)
+        end
+        if parsed_json["contact"].nil?
+          contact = nil
+        else
+          contact = parsed_json["contact"].to_json
+          contact = Pinnacle::Types::ConversationContact.from_json(json_object: contact)
+        end
+        created_at = parsed_json["createdAt"]
+        id = parsed_json["id"]
+        notes = parsed_json["notes"]
+        if parsed_json["sender"].nil?
+          sender = nil
+        else
+          sender = parsed_json["sender"].to_json
+          sender = Pinnacle::Types::ConversationSender.from_json(json_object: sender)
+        end
+        updated_at = parsed_json["updatedAt"]
+        new(
+          brand_id: brand_id,
+          campaign: campaign,
+          contact: contact,
+          created_at: created_at,
+          id: id,
+          notes: notes,
+          sender: sender,
+          updated_at: updated_at,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of Conversation 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.brand_id&.is_a?(Integer) != false || raise("Passed value for field obj.brand_id is not the expected type, validation failed.")
+        obj.campaign.nil? || Pinnacle::Types::CampaignQuery.validate_raw(obj: obj.campaign)
+        Pinnacle::Types::ConversationContact.validate_raw(obj: obj.contact)
+        obj.created_at.is_a?(String) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.notes.is_a?(String) != false || raise("Passed value for field obj.notes is not the expected type, validation failed.")
+        obj.sender.nil? || Pinnacle::Types::ConversationSender.validate_raw(obj: obj.sender)
+        obj.updated_at.is_a?(String) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/conversation_contact.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Contact information for the recipient in a conversation.
+    class ConversationContact
+      # @return [Integer] Unique identifier for the contact.
+      attr_reader :id
+      # @return [String] The contact's phone number in E.164 format.
+      attr_reader :phone_number
+      # @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 for the contact.
+      # @param phone_number [String] The contact's phone number in E.164 format.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ConversationContact]
+      def initialize(id:, phone_number:, additional_properties: nil)
+        @id = id
+        @phone_number = phone_number
+        @additional_properties = additional_properties
+        @_field_set = { "id": id, "phoneNumber": phone_number }
+      end
+
+      # Deserialize a JSON object to an instance of ConversationContact
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ConversationContact]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        phone_number = parsed_json["phoneNumber"]
+        new(
+          id: id,
+          phone_number: phone_number,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ConversationContact 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.phone_number.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/conversation_list.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "conversation"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Response for list conversation.
+    class ConversationList
+      # @return [Integer] Total number of conversations matching the filter.
+      attr_reader :count
+      # @return [Array<Pinnacle::Types::Conversation>]
+      attr_reader :conversations
+      # @return [Boolean] Indicates if more conversations are available beyond the current page.
+      attr_reader :has_more
+      # @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 count [Integer] Total number of conversations matching the filter.
+      # @param conversations [Array<Pinnacle::Types::Conversation>]
+      # @param has_more [Boolean] Indicates if more conversations are available beyond the current page.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ConversationList]
+      def initialize(count:, conversations:, has_more:, additional_properties: nil)
+        @count = count
+        @conversations = conversations
+        @has_more = has_more
+        @additional_properties = additional_properties
+        @_field_set = { "count": count, "conversations": conversations, "hasMore": has_more }
+      end
+
+      # Deserialize a JSON object to an instance of ConversationList
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ConversationList]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        count = parsed_json["count"]
+        conversations = parsed_json["conversations"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::Conversation.from_json(json_object: item)
+        end
+        has_more = parsed_json["hasMore"]
+        new(
+          count: count,
+          conversations: conversations,
+          has_more: has_more,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ConversationList 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.count.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
+        obj.conversations.is_a?(Array) != false || raise("Passed value for field obj.conversations is not the expected type, validation failed.")
+        obj.has_more.is_a?(Boolean) != false || raise("Passed value for field obj.has_more is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/conversation_sender.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "phone"
+require_relative "agent"
+
+module Pinnacle
+  module Types
+    # The sender of messages in this conversation. Can be:
+    #  - A phone number with its capabilities and metadata
+    #  - An RCS agent with ID and name
+    #  - `null` if no sender is associated
+    class ConversationSender
+      # Deserialize a JSON object to an instance of ConversationSender
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ConversationSender]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Pinnacle::Types::Phone.validate_raw(obj: struct)
+          return Pinnacle::Types::Phone.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::Agent.validate_raw(obj: struct)
+          return Pinnacle::Types::Agent.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::Phone.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::Agent.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/create_url_options.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class CreateUrlOptions
+      # @return [String] Expiration date in ISO 8601 format for the shortened URL. <br>
+      #  If omitted, then a permalink is generated instead.
+      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 expires_at [String] Expiration date in ISO 8601 format for the shortened URL. <br>
+      #  If omitted, then a permalink is generated instead.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::CreateUrlOptions]
+      def initialize(expires_at: OMIT, additional_properties: nil)
+        @expires_at = expires_at if expires_at != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "expiresAt": expires_at }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of CreateUrlOptions
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::CreateUrlOptions]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        expires_at = parsed_json["expiresAt"]
+        new(expires_at: expires_at, additional_properties: struct)
+      end
+
+      # Serialize an instance of CreateUrlOptions 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.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/detached_phone_number_result.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "phone_number_campaign_detach_phone_numbers_item"
+require_relative "phone_number_campaign_detach_failed_item"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class DetachedPhoneNumberResult
+      # @return [Array<Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItem>] List of phone numbers.
+      attr_reader :phone_numbers
+      # @return [Array<Pinnacle::Types::PhoneNumberCampaignDetachFailedItem>] List of numbers that were not failed to be detached.
+      attr_reader :failed
+      # @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_numbers [Array<Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItem>] List of phone numbers.
+      # @param failed [Array<Pinnacle::Types::PhoneNumberCampaignDetachFailedItem>] List of numbers that were not failed to be detached.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::DetachedPhoneNumberResult]
+      def initialize(phone_numbers:, failed:, additional_properties: nil)
+        @phone_numbers = phone_numbers
+        @failed = failed
+        @additional_properties = additional_properties
+        @_field_set = { "phoneNumbers": phone_numbers, "failed": failed }
+      end
+
+      # Deserialize a JSON object to an instance of DetachedPhoneNumberResult
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::DetachedPhoneNumberResult]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        phone_numbers = parsed_json["phoneNumbers"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItem.from_json(json_object: item)
+        end
+        failed = parsed_json["failed"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::PhoneNumberCampaignDetachFailedItem.from_json(json_object: item)
+        end
+        new(
+          phone_numbers: phone_numbers,
+          failed: failed,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of DetachedPhoneNumberResult 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_numbers.is_a?(Array) != false || raise("Passed value for field obj.phone_numbers is not the expected type, validation failed.")
+        obj.failed.is_a?(Array) != false || raise("Passed value for field obj.failed is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/detached_webhook_info.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class DetachedWebhookInfo
+      # @return [String] Confirmation message.
+      attr_reader :message
+      # @return [Integer] ID of the detached webhook.
+      attr_reader :webhook_id
+      # @return [String] Phone number the webhook was detached from in E.164 format.
+      attr_reader :phone_number
+      # @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] Confirmation message.
+      # @param webhook_id [Integer] ID of the detached webhook.
+      # @param phone_number [String] Phone number the webhook was detached from in E.164 format.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::DetachedWebhookInfo]
+      def initialize(message:, webhook_id:, phone_number:, additional_properties: nil)
+        @message = message
+        @webhook_id = webhook_id
+        @phone_number = phone_number
+        @additional_properties = additional_properties
+        @_field_set = { "message": message, "webhookId": webhook_id, "phoneNumber": phone_number }
+      end
+
+      # Deserialize a JSON object to an instance of DetachedWebhookInfo
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::DetachedWebhookInfo]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        message = parsed_json["message"]
+        webhook_id = parsed_json["webhookId"]
+        phone_number = parsed_json["phoneNumber"]
+        new(
+          message: message,
+          webhook_id: webhook_id,
+          phone_number: phone_number,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of DetachedWebhookInfo 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.webhook_id.is_a?(Integer) != false || raise("Passed value for field obj.webhook_id 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.")
+      end
+    end
+  end
+end

data/lib/rcs/types/detailed_phone_number_enum.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Classification of the phone number type based on Telesign’s taxonomy.
+    #  Indicates the phone’s service category, such as mobile, fixed line, toll-free,
+    #  or VOIP,
+    #  along with special types like prepaid, pager, or restricted premium.
+    #  The "INVALID" type denotes an unrecognized or improperly formatted number.
+    class DetailedPhoneNumberEnum
+      FIXED_LINE = "FIXED_LINE"
+      INVALID = "INVALID"
+      MOBILE = "MOBILE"
+      OTHER = "OTHER"
+      PAGER = "PAGER"
+      PAYPHONE = "PAYPHONE"
+      PERSONAL = "PERSONAL"
+      PREPAID = "PREPAID"
+      RESTRICTED_PREMIUM = "RESTRICTED_PREMIUM"
+      TOLL_FREE = "TOLL_FREE"
+      VOICEMAIL = "VOICEMAIL"
+      VOIP = "VOIP"
+    end
+  end
+end

data/lib/rcs/types/dlc_assignment_status_enum.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Current assignment status of the phone number to this campaign.
+    #  `ASSIGNED`: Number assigned and ready to send messages.
+    #  `PENDING_ASSIGNMENT`: In the process of being assigned.
+    #  `PENDING_UNASSIGNMENT`: In the process of being unassigned.
+    #  `FAILED_ASSIGNMENT`: Failed to assign the number.
+    #  `FAILED_UNASSIGNMENT`: Failed to unassign the number.
+    class DlcAssignmentStatusEnum
+      ASSIGNED = "ASSIGNED"
+      FAILED_ASSIGNMENT = "FAILED_ASSIGNMENT"
+      FAILED_UNASSIGNMENT = "FAILED_UNASSIGNMENT"
+      PENDING_ASSIGNMENT = "PENDING_ASSIGNMENT"
+      PENDING_UNASSIGNMENT = "PENDING_UNASSIGNMENT"
+    end
+  end
+end