rcs 2.0.5 → 2.0.7

data/lib/rcs/types/toll_free_campaign_with_extended_brand_and_status.rb

@@ -1,195 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "extended_brand"
-require_relative "profile_status_enum"
-require_relative "toll_free_campaign_schema_keywords"
-require_relative "toll_free_campaign_schema_links"
-require_relative "message_volume_enum"
-require_relative "toll_free_campaign_schema_opt_in"
-require_relative "toll_free_campaign_schema_options"
-require_relative "toll_free_campaign_schema_use_case"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class TollFreeCampaignWithExtendedBrandAndStatus
-      # @return [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
-      attr_reader :brand
-      # @return [Pinnacle::Types::ProfileStatusEnum] Current review status of the brand.<br>
-      #  `INCOMPLETE`: Has not been submitted.<br>
-      #  `PENDING`: Currently being reviewed.<br>
-      #  `VERIFIED`: Verified and good to go.<br>
-      #  `VETTED`: Brand has been vetted by an external provider and has received vetting
-      #  scores.
-      attr_reader :status
-      # @return [String] Unique identifier for the campaign. Must begin with the prefix `tf_`.
-      attr_reader :campaign_id
-      # @return [Pinnacle::Types::TollFreeCampaignSchemaKeywords] Keyword response configuration.
-      attr_reader :keywords
-      # @return [Pinnacle::Types::TollFreeCampaignSchemaLinks] Legal documentation links.
-      attr_reader :links
-      # @return [Pinnacle::Types::MessageVolumeEnum]
-      attr_reader :monthly_volume
-      # @return [String] Display name of the campaign.
-      attr_reader :name
-      # @return [Pinnacle::Types::TollFreeCampaignSchemaOptIn] Opt-in keyword settings.
-      attr_reader :opt_in
-      # @return [Pinnacle::Types::TollFreeCampaignSchemaOptions] Campaign configuration options.
-      attr_reader :options
-      # @return [String] Explain message that would be sent.
-      attr_reader :production_message_content
-      # @return [Pinnacle::Types::TollFreeCampaignSchemaUseCase] Use case classification for the campaign.
-      attr_reader :use_case
-      # @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 [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
-      # @param status [Pinnacle::Types::ProfileStatusEnum] Current review status of the brand.<br>
-      #  `INCOMPLETE`: Has not been submitted.<br>
-      #  `PENDING`: Currently being reviewed.<br>
-      #  `VERIFIED`: Verified and good to go.<br>
-      #  `VETTED`: Brand has been vetted by an external provider and has received vetting
-      #  scores.
-      # @param campaign_id [String] Unique identifier for the campaign. Must begin with the prefix `tf_`.
-      # @param keywords [Pinnacle::Types::TollFreeCampaignSchemaKeywords] Keyword response configuration.
-      # @param links [Pinnacle::Types::TollFreeCampaignSchemaLinks] Legal documentation links.
-      # @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
-      # @param name [String] Display name of the campaign.
-      # @param opt_in [Pinnacle::Types::TollFreeCampaignSchemaOptIn] Opt-in keyword settings.
-      # @param options [Pinnacle::Types::TollFreeCampaignSchemaOptions] Campaign configuration options.
-      # @param production_message_content [String] Explain message that would be sent.
-      # @param use_case [Pinnacle::Types::TollFreeCampaignSchemaUseCase] Use case classification for the campaign.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus]
-      def initialize(brand:, status:, campaign_id: OMIT, keywords: OMIT, links: OMIT, monthly_volume: OMIT, name: OMIT,
-                     opt_in: OMIT, options: OMIT, production_message_content: OMIT, use_case: OMIT, additional_properties: nil)
-        @brand = brand
-        @status = status
-        @campaign_id = campaign_id if campaign_id != OMIT
-        @keywords = keywords if keywords != OMIT
-        @links = links if links != OMIT
-        @monthly_volume = monthly_volume if monthly_volume != OMIT
-        @name = name if name != OMIT
-        @opt_in = opt_in if opt_in != OMIT
-        @options = options if options != OMIT
-        @production_message_content = production_message_content if production_message_content != OMIT
-        @use_case = use_case if use_case != OMIT
-        @additional_properties = additional_properties
-        @_field_set = {
-          "brand": brand,
-          "status": status,
-          "campaignId": campaign_id,
-          "keywords": keywords,
-          "links": links,
-          "monthlyVolume": monthly_volume,
-          "name": name,
-          "optIn": opt_in,
-          "options": options,
-          "productionMessageContent": production_message_content,
-          "useCase": use_case
-        }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of
-      #  TollFreeCampaignWithExtendedBrandAndStatus
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        if parsed_json["brand"].nil?
-          brand = nil
-        else
-          brand = parsed_json["brand"].to_json
-          brand = Pinnacle::Types::ExtendedBrand.from_json(json_object: brand)
-        end
-        status = parsed_json["status"]
-        campaign_id = parsed_json["campaignId"]
-        if parsed_json["keywords"].nil?
-          keywords = nil
-        else
-          keywords = parsed_json["keywords"].to_json
-          keywords = Pinnacle::Types::TollFreeCampaignSchemaKeywords.from_json(json_object: keywords)
-        end
-        if parsed_json["links"].nil?
-          links = nil
-        else
-          links = parsed_json["links"].to_json
-          links = Pinnacle::Types::TollFreeCampaignSchemaLinks.from_json(json_object: links)
-        end
-        monthly_volume = parsed_json["monthlyVolume"]
-        name = parsed_json["name"]
-        if parsed_json["optIn"].nil?
-          opt_in = nil
-        else
-          opt_in = parsed_json["optIn"].to_json
-          opt_in = Pinnacle::Types::TollFreeCampaignSchemaOptIn.from_json(json_object: opt_in)
-        end
-        if parsed_json["options"].nil?
-          options = nil
-        else
-          options = parsed_json["options"].to_json
-          options = Pinnacle::Types::TollFreeCampaignSchemaOptions.from_json(json_object: options)
-        end
-        production_message_content = parsed_json["productionMessageContent"]
-        if parsed_json["useCase"].nil?
-          use_case = nil
-        else
-          use_case = parsed_json["useCase"].to_json
-          use_case = Pinnacle::Types::TollFreeCampaignSchemaUseCase.from_json(json_object: use_case)
-        end
-        new(
-          brand: brand,
-          status: status,
-          campaign_id: campaign_id,
-          keywords: keywords,
-          links: links,
-          monthly_volume: monthly_volume,
-          name: name,
-          opt_in: opt_in,
-          options: options,
-          production_message_content: production_message_content,
-          use_case: use_case,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of TollFreeCampaignWithExtendedBrandAndStatus 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::ExtendedBrand.validate_raw(obj: obj.brand)
-        obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
-        obj.campaign_id&.is_a?(String) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
-        obj.keywords.nil? || Pinnacle::Types::TollFreeCampaignSchemaKeywords.validate_raw(obj: obj.keywords)
-        obj.links.nil? || Pinnacle::Types::TollFreeCampaignSchemaLinks.validate_raw(obj: obj.links)
-        obj.monthly_volume&.is_a?(Pinnacle::Types::MessageVolumeEnum) != false || raise("Passed value for field obj.monthly_volume 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.opt_in.nil? || Pinnacle::Types::TollFreeCampaignSchemaOptIn.validate_raw(obj: obj.opt_in)
-        obj.options.nil? || Pinnacle::Types::TollFreeCampaignSchemaOptions.validate_raw(obj: obj.options)
-        obj.production_message_content&.is_a?(String) != false || raise("Passed value for field obj.production_message_content is not the expected type, validation failed.")
-        obj.use_case.nil? || Pinnacle::Types::TollFreeCampaignSchemaUseCase.validate_raw(obj: obj.use_case)
-      end
-    end
-  end
-end

data/lib/rcs/types/toll_free_status_enum.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Types
-    # Current assignment status of the toll free number to this campaign.
-    #  `IN_PROGRESS`: Being reviewed.
-    #  `WAITING_FOR_PROVIDER`: Being reviewed by our toll-free vendor.
-    #  `WAITING_FOR_TELECO`: Final review by carriers before number is live.
-    #  `VERIFIED`: Verified and ready to send messages.
-    #  `REJECTED`: Issues were found related to your campaign.
-    class TollFreeStatusEnum
-      WAITING_FOR_PROVIDER = "WAITING_FOR_PROVIDER"
-      WAITING_FOR_CUSTOMER = "WAITING_FOR_CUSTOMER"
-      WAITING_FOR_TELECO = "WAITING_FOR_TELECO"
-      IN_PROGRESS = "IN_PROGRESS"
-      VERIFIED = "VERIFIED"
-      REJECTED = "REJECTED"
-    end
-  end
-end

data/lib/rcs/types/tracking.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Types
-    # Enable tracking on sent messages. If not provided, messages are not tracked. You
-    #  will not be able to react to these messages unless you provide the
-    #  [options.force](./react#request.body.options.force) field.
-    #  `ID` - Append an explicit ID at the end of the message for tracking. Users will
-    #  see this ID. <br>
-    #  `HIDDEN` - Invisible IDs are sent with messages for tracking. Will not be
-    #  visible to users but will lead to slightly longer message lengths.
-    class Tracking
-      ID = "ID"
-      HIDDEN = "HIDDEN"
-    end
-  end
-end

data/lib/rcs/types/updated_contact_id.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class UpdatedContactId
-      # @return [String] Unique ID of the updated contact. This identifier is a string that always begins
-      #  with the prefix `co_`, for example: `co_1234567890`.
-      attr_reader :id
-      # @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 [String] Unique ID of the updated contact. This identifier is a string that always begins
-      #  with the prefix `co_`, for example: `co_1234567890`.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::UpdatedContactId]
-      def initialize(id:, additional_properties: nil)
-        @id = id
-        @additional_properties = additional_properties
-        @_field_set = { "id": id }
-      end
-
-      # Deserialize a JSON object to an instance of UpdatedContactId
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::UpdatedContactId]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        id = parsed_json["id"]
-        new(id: id, additional_properties: struct)
-      end
-
-      # Serialize an instance of UpdatedContactId 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?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/upload_results.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "pinnacle_file_upload_metadata"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class UploadResults
-      # @return [String] Presigned URL for uploading your file to storage.
-      attr_reader :upload_url
-      # @return [String] Presigned URL for downloading your file.
-      attr_reader :download_url
-      # @return [Pinnacle::Types::PinnacleFileUploadMetadata]
-      attr_reader :metadata
-      # @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 upload_url [String] Presigned URL for uploading your file to storage.
-      # @param download_url [String] Presigned URL for downloading your file.
-      # @param metadata [Pinnacle::Types::PinnacleFileUploadMetadata]
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::UploadResults]
-      def initialize(upload_url:, download_url:, metadata:, additional_properties: nil)
-        @upload_url = upload_url
-        @download_url = download_url
-        @metadata = metadata
-        @additional_properties = additional_properties
-        @_field_set = { "uploadUrl": upload_url, "downloadUrl": download_url, "metadata": metadata }
-      end
-
-      # Deserialize a JSON object to an instance of UploadResults
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::UploadResults]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        upload_url = parsed_json["uploadUrl"]
-        download_url = parsed_json["downloadUrl"]
-        if parsed_json["metadata"].nil?
-          metadata = nil
-        else
-          metadata = parsed_json["metadata"].to_json
-          metadata = Pinnacle::Types::PinnacleFileUploadMetadata.from_json(json_object: metadata)
-        end
-        new(
-          upload_url: upload_url,
-          download_url: download_url,
-          metadata: metadata,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of UploadResults 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.upload_url.is_a?(String) != false || raise("Passed value for field obj.upload_url is not the expected type, validation failed.")
-        obj.download_url.is_a?(String) != false || raise("Passed value for field obj.download_url is not the expected type, validation failed.")
-        Pinnacle::Types::PinnacleFileUploadMetadata.validate_raw(obj: obj.metadata)
-      end
-    end
-  end
-end

data/lib/rcs/types/user_event.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "user_event_conversation"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Represents an event triggered by a user such as when they start typing.
-    class UserEvent
-      # @return [String] Type of user event.
-      attr_reader :type
-      # @return [String] Timestamp when the user event started in ISO 8601 format.
-      attr_reader :started_at
-      # @return [Pinnacle::Types::UserEventConversation] Conversation metadata containing the conversation ID, sender, and recipient
-      #  information.
-      attr_reader :conversation
-      # @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 type [String] Type of user event.
-      # @param started_at [String] Timestamp when the user event started in ISO 8601 format.
-      # @param conversation [Pinnacle::Types::UserEventConversation] Conversation metadata containing the conversation ID, sender, and recipient
-      #  information.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::UserEvent]
-      def initialize(type:, started_at:, conversation:, additional_properties: nil)
-        @type = type
-        @started_at = started_at
-        @conversation = conversation
-        @additional_properties = additional_properties
-        @_field_set = { "type": type, "startedAt": started_at, "conversation": conversation }
-      end
-
-      # Deserialize a JSON object to an instance of UserEvent
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::UserEvent]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        type = parsed_json["type"]
-        started_at = parsed_json["startedAt"]
-        if parsed_json["conversation"].nil?
-          conversation = nil
-        else
-          conversation = parsed_json["conversation"].to_json
-          conversation = Pinnacle::Types::UserEventConversation.from_json(json_object: conversation)
-        end
-        new(
-          type: type,
-          started_at: started_at,
-          conversation: conversation,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of UserEvent 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
-        obj.started_at.is_a?(String) != false || raise("Passed value for field obj.started_at is not the expected type, validation failed.")
-        Pinnacle::Types::UserEventConversation.validate_raw(obj: obj.conversation)
-      end
-    end
-  end
-end

data/lib/rcs/types/user_event_conversation.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Conversation metadata containing the conversation ID, sender, and recipient
-    #  information.
-    class UserEventConversation
-      # @return [Integer] Unique identifier for the conversation. To get more conversation details, use
-      #  the [POST /conversations/get](/api-reference/conversations/get) endpoint.
-      attr_reader :id
-      # @return [String] Phone number of the user who triggered the event.
-      attr_reader :from
-      # @return [String] Agent ID that the user is interacting with.
-      attr_reader :to
-      # @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 conversation. To get more conversation details, use
-      #  the [POST /conversations/get](/api-reference/conversations/get) endpoint.
-      # @param from [String] Phone number of the user who triggered the event.
-      # @param to [String] Agent ID that the user is interacting with.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::UserEventConversation]
-      def initialize(id:, from:, to:, additional_properties: nil)
-        @id = id
-        @from = from
-        @to = to
-        @additional_properties = additional_properties
-        @_field_set = { "id": id, "from": from, "to": to }
-      end
-
-      # Deserialize a JSON object to an instance of UserEventConversation
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::UserEventConversation]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        id = parsed_json["id"]
-        from = parsed_json["from"]
-        to = parsed_json["to"]
-        new(
-          id: id,
-          from: from,
-          to: to,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of UserEventConversation 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.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
-        obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/v_card_address_schema_type_item.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Types
-    class VCardAddressSchemaTypeItem
-      DOM = "DOM"
-      INTL = "INTL"
-      POSTAL = "POSTAL"
-      PARCEL = "PARCEL"
-      HOME = "HOME"
-      WORK = "WORK"
-      PREF = "PREF"
-    end
-  end
-end