rcs 2.0.4 → 2.0.5.pre.rc.1

data/lib/rcs/types/rcs_campaign_schema_traffic.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class RcsCampaignSchemaTraffic
-      # @return [Integer] Estimated monthly website visitors.
-      attr_reader :monthly_website
-      # @return [Integer] Estimated monthly RCS messages sent.
-      attr_reader :monthly_rcs_estimate
-      # @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_website [Integer] Estimated monthly website visitors.
-      # @param monthly_rcs_estimate [Integer] Estimated monthly RCS messages sent.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsCampaignSchemaTraffic]
-      def initialize(monthly_website: OMIT, monthly_rcs_estimate: OMIT, additional_properties: nil)
-        @monthly_website = monthly_website if monthly_website != OMIT
-        @monthly_rcs_estimate = monthly_rcs_estimate if monthly_rcs_estimate != OMIT
-        @additional_properties = additional_properties
-        @_field_set = {
-          "monthlyWebsite": monthly_website,
-          "monthlyRcsEstimate": monthly_rcs_estimate
-        }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of RcsCampaignSchemaTraffic
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsCampaignSchemaTraffic]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        monthly_website = parsed_json["monthlyWebsite"]
-        monthly_rcs_estimate = parsed_json["monthlyRcsEstimate"]
-        new(
-          monthly_website: monthly_website,
-          monthly_rcs_estimate: monthly_rcs_estimate,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of RcsCampaignSchemaTraffic 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_website&.is_a?(Integer) != false || raise("Passed value for field obj.monthly_website is not the expected type, validation failed.")
-        obj.monthly_rcs_estimate&.is_a?(Integer) != false || raise("Passed value for field obj.monthly_rcs_estimate is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/rcs_campaign_schema_use_case.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rcs_campaign_use_case_enum"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Use case classification for the campaign.
-    class RcsCampaignSchemaUseCase
-      # @return [String] Detailed summary of what the brand is and how this agent will be used.
-      attr_reader :behavior
-      # @return [Pinnacle::Types::RcsCampaignUseCaseEnum]
-      attr_reader :value
-      # @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 behavior [String] Detailed summary of what the brand is and how this agent will be used.
-      # @param value [Pinnacle::Types::RcsCampaignUseCaseEnum]
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsCampaignSchemaUseCase]
-      def initialize(behavior: OMIT, value: OMIT, additional_properties: nil)
-        @behavior = behavior if behavior != OMIT
-        @value = value if value != OMIT
-        @additional_properties = additional_properties
-        @_field_set = { "behavior": behavior, "value": value }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of RcsCampaignSchemaUseCase
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsCampaignSchemaUseCase]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        behavior = parsed_json["behavior"]
-        value = parsed_json["value"]
-        new(
-          behavior: behavior,
-          value: value,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of RcsCampaignSchemaUseCase 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.behavior&.is_a?(String) != false || raise("Passed value for field obj.behavior is not the expected type, validation failed.")
-        obj.value&.is_a?(Pinnacle::Types::RcsCampaignUseCaseEnum) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/rcs_campaign_status.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "profile_status_enum"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Response for get RCS campaign status.
-    class RcsCampaignStatus
-      # @return [Array<String>] List of errors that occured.
-      attr_reader :errors
-      # @return [String] The unique identifier of the RCS campaign. This identifier is a string that
-      #  always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
-      attr_reader :id
-      # @return [Pinnacle::Types::ProfileStatusEnum] Current review status of the RCS campaign. <br>
-      #  `INCOMPLETE`: Not submitted.<br>
-      #  `IN REVIEW`: Being reviewed by carriers.<br>
-      #  `VERIFIED`: Approved and ready to send messages.<br>
-      #  `FAILED`: Issues and errors related to the campaign's details. See
-      #  [errors](rcs-campaign#response.body.errors) for these potential issues.<br>
-      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 id [String] The unique identifier of the RCS campaign. This identifier is a string that
-      #  always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
-      # @param status [Pinnacle::Types::ProfileStatusEnum] Current review status of the RCS campaign. <br>
-      #  `INCOMPLETE`: Not submitted.<br>
-      #  `IN REVIEW`: Being reviewed by carriers.<br>
-      #  `VERIFIED`: Approved and ready to send messages.<br>
-      #  `FAILED`: Issues and errors related to the campaign's details. See
-      #  [errors](rcs-campaign#response.body.errors) for these potential issues.<br>
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsCampaignStatus]
-      def initialize(errors:, id:, status:, additional_properties: nil)
-        @errors = errors
-        @id = id
-        @status = status
-        @additional_properties = additional_properties
-        @_field_set = { "errors": errors, "id": id, "status": status }
-      end
-
-      # Deserialize a JSON object to an instance of RcsCampaignStatus
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsCampaignStatus]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        errors = parsed_json["errors"]
-        id = parsed_json["id"]
-        status = parsed_json["status"]
-        new(
-          errors: errors,
-          id: id,
-          status: status,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of RcsCampaignStatus 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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-        obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/rcs_campaign_use_case_enum.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Types
-    # The primary use case classification for this campaign.
-    class RcsCampaignUseCaseEnum
-      ENTERTAINMENT = "ENTERTAINMENT"
-      SHOPPING_AND_RETAIL = "SHOPPING_AND_RETAIL"
-      GAMES = "GAMES"
-      NEWS = "NEWS"
-      HEALTH = "HEALTH"
-      UTILITIES = "UTILITIES"
-      FINANCE = "FINANCE"
-      SPORTS = "SPORTS"
-      SOCIAL = "SOCIAL"
-      FOOD_AND_BEVERAGE = "FOOD_AND_BEVERAGE"
-      UNCATEGORIZED = "UNCATEGORIZED"
-      TRAVEL = "TRAVEL"
-      PRODUCTIVITY = "PRODUCTIVITY"
-      OTHER = "OTHER"
-    end
-  end
-end

data/lib/rcs/types/rcs_capabilities_result.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Types
-    RCS_CAPABILITIES_RESULT = Hash
-  end
-end

data/lib/rcs/types/rcs_capability.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rcs_capability_cards"
-require_relative "rcs_capability_actions"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # RCS capabilities for a phone number
-    class RcsCapability
-      # @return [Pinnacle::Types::RcsCapabilityCards]
-      attr_reader :cards
-      # @return [Pinnacle::Types::RcsCapabilityActions] Supported button action types inside the rich cards or quick replies. Each key
-      #  is a button action type that defines a specific button type in the Pinnacle API.
-      attr_reader :actions
-      # @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 cards [Pinnacle::Types::RcsCapabilityCards]
-      # @param actions [Pinnacle::Types::RcsCapabilityActions] Supported button action types inside the rich cards or quick replies. Each key
-      #  is a button action type that defines a specific button type in the Pinnacle API.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsCapability]
-      def initialize(cards:, actions:, additional_properties: nil)
-        @cards = cards
-        @actions = actions
-        @additional_properties = additional_properties
-        @_field_set = { "cards": cards, "actions": actions }
-      end
-
-      # Deserialize a JSON object to an instance of RcsCapability
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsCapability]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        if parsed_json["cards"].nil?
-          cards = nil
-        else
-          cards = parsed_json["cards"].to_json
-          cards = Pinnacle::Types::RcsCapabilityCards.from_json(json_object: cards)
-        end
-        if parsed_json["actions"].nil?
-          actions = nil
-        else
-          actions = parsed_json["actions"].to_json
-          actions = Pinnacle::Types::RcsCapabilityActions.from_json(json_object: actions)
-        end
-        new(
-          cards: cards,
-          actions: actions,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of RcsCapability 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::RcsCapabilityCards.validate_raw(obj: obj.cards)
-        Pinnacle::Types::RcsCapabilityActions.validate_raw(obj: obj.actions)
-      end
-    end
-  end
-end

data/lib/rcs/types/rcs_capability_actions.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Supported button action types inside the rich cards or quick replies. Each key
-    #  is a button action type that defines a specific button type in the Pinnacle API.
-    class RcsCapabilityActions
-      # @return [Boolean] Buttons that open URLs are supported
-      attr_reader :open_url
-      # @return [Boolean] Buttons that make phone calls are supported
-      attr_reader :call
-      # @return [Boolean] Buttons that trigger actions are supported
-      attr_reader :trigger
-      # @return [Boolean] Buttons that request user location are supported
-      attr_reader :request_user_location
-      # @return [Boolean] Buttons are supported
-      attr_reader :schedule_event
-      # @return [Boolean] Buttons that send location are supported
-      attr_reader :send_location
-      # @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 open_url [Boolean] Buttons that open URLs are supported
-      # @param call [Boolean] Buttons that make phone calls are supported
-      # @param trigger [Boolean] Buttons that trigger actions are supported
-      # @param request_user_location [Boolean] Buttons that request user location are supported
-      # @param schedule_event [Boolean] Buttons are supported
-      # @param send_location [Boolean] Buttons that send location are supported
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsCapabilityActions]
-      def initialize(open_url:, call:, trigger:, request_user_location:, schedule_event:, send_location:,
-                     additional_properties: nil)
-        @open_url = open_url
-        @call = call
-        @trigger = trigger
-        @request_user_location = request_user_location
-        @schedule_event = schedule_event
-        @send_location = send_location
-        @additional_properties = additional_properties
-        @_field_set = {
-          "openUrl": open_url,
-          "call": call,
-          "trigger": trigger,
-          "requestUserLocation": request_user_location,
-          "scheduleEvent": schedule_event,
-          "sendLocation": send_location
-        }
-      end
-
-      # Deserialize a JSON object to an instance of RcsCapabilityActions
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsCapabilityActions]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        open_url = parsed_json["openUrl"]
-        call = parsed_json["call"]
-        trigger = parsed_json["trigger"]
-        request_user_location = parsed_json["requestUserLocation"]
-        schedule_event = parsed_json["scheduleEvent"]
-        send_location = parsed_json["sendLocation"]
-        new(
-          open_url: open_url,
-          call: call,
-          trigger: trigger,
-          request_user_location: request_user_location,
-          schedule_event: schedule_event,
-          send_location: send_location,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of RcsCapabilityActions 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.open_url.is_a?(Boolean) != false || raise("Passed value for field obj.open_url is not the expected type, validation failed.")
-        obj.call.is_a?(Boolean) != false || raise("Passed value for field obj.call is not the expected type, validation failed.")
-        obj.trigger.is_a?(Boolean) != false || raise("Passed value for field obj.trigger is not the expected type, validation failed.")
-        obj.request_user_location.is_a?(Boolean) != false || raise("Passed value for field obj.request_user_location is not the expected type, validation failed.")
-        obj.schedule_event.is_a?(Boolean) != false || raise("Passed value for field obj.schedule_event is not the expected type, validation failed.")
-        obj.send_location.is_a?(Boolean) != false || raise("Passed value for field obj.send_location is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/rcs_capability_cards.rb

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

data/lib/rcs/types/rcs_cards_content.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rcs_cards_content_cards_item"
-require_relative "rich_button"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Message containing cards, each with its own title, subtitle, and/or buttons.
-    #  Quick replies can also be added. <br>
-    #  See (supported file
-    #  types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
-    class RcsCardsContent
-      # @return [Array<Pinnacle::Types::RcsCardsContentCardsItem>] Collection of cards attached to the message.
-      attr_reader :cards
-      # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
-      attr_reader :quick_replies
-      # @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 cards [Array<Pinnacle::Types::RcsCardsContentCardsItem>] Collection of cards attached to the message.
-      # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsCardsContent]
-      def initialize(cards:, quick_replies:, additional_properties: nil)
-        @cards = cards
-        @quick_replies = quick_replies
-        @additional_properties = additional_properties
-        @_field_set = { "cards": cards, "quickReplies": quick_replies }
-      end
-
-      # Deserialize a JSON object to an instance of RcsCardsContent
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsCardsContent]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        cards = parsed_json["cards"]&.map do |item|
-          item = item.to_json
-          Pinnacle::Types::RcsCardsContentCardsItem.from_json(json_object: item)
-        end
-        quick_replies = parsed_json["quickReplies"]&.map do |item|
-          item = item.to_json
-          Pinnacle::Types::RichButton.from_json(json_object: item)
-        end
-        new(
-          cards: cards,
-          quick_replies: quick_replies,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of RcsCardsContent 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.cards.is_a?(Array) != false || raise("Passed value for field obj.cards is not the expected type, validation failed.")
-        obj.quick_replies.is_a?(Array) != false || raise("Passed value for field obj.quick_replies is not the expected type, validation failed.")
-      end
-    end
-  end
-end