rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/types/rcs_campaign_schema_agent_websites_item.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class RcsCampaignSchemaAgentWebsitesItem
+      # @return [String] Url attached to the agent.
+      attr_reader :url
+      # @return [String] Label for the url.
+      attr_reader :label
+      # @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 url [String] Url attached to the agent.
+      # @param label [String] Label for the url.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCampaignSchemaAgentWebsitesItem]
+      def initialize(url: OMIT, label: OMIT, additional_properties: nil)
+        @url = url if url != OMIT
+        @label = label if label != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "url": url, "label": label }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsCampaignSchemaAgentWebsitesItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCampaignSchemaAgentWebsitesItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        url = parsed_json["url"]
+        label = parsed_json["label"]
+        new(
+          url: url,
+          label: label,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCampaignSchemaAgentWebsitesItem 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.url&.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+        obj.label&.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_campaign_schema_extra_agent.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require_relative "rcs_campaign_schema_extra_agent_emails_item"
+require_relative "rcs_campaign_schema_extra_agent_phones_item"
+require_relative "rcs_campaign_schema_extra_agent_websites_item"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Agent configured to the campaign.
+    class RcsCampaignSchemaExtraAgent
+      # @return [String] Color of the agent's buttons.
+      attr_reader :color
+      # @return [String] Description of the agent.
+      attr_reader :description
+      # @return [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentEmailsItem>] List of emails.
+      attr_reader :emails
+      # @return [String] Link to the agent's hero.
+      attr_reader :hero_url
+      # @return [String] Link to the agent's icon.
+      attr_reader :icon_url
+      # @return [String] Name of the agent.
+      attr_reader :name
+      # @return [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentPhonesItem>] List of phone numbers.
+      attr_reader :phones
+      # @return [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentWebsitesItem>] List of urls.
+      attr_reader :websites
+      # @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 color [String] Color of the agent's buttons.
+      # @param description [String] Description of the agent.
+      # @param emails [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentEmailsItem>] List of emails.
+      # @param hero_url [String] Link to the agent's hero.
+      # @param icon_url [String] Link to the agent's icon.
+      # @param name [String] Name of the agent.
+      # @param phones [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentPhonesItem>] List of phone numbers.
+      # @param websites [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentWebsitesItem>] List of urls.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraAgent]
+      def initialize(color: OMIT, description: OMIT, emails: OMIT, hero_url: OMIT, icon_url: OMIT, name: OMIT,
+                     phones: OMIT, websites: OMIT, additional_properties: nil)
+        @color = color if color != OMIT
+        @description = description if description != OMIT
+        @emails = emails if emails != OMIT
+        @hero_url = hero_url if hero_url != OMIT
+        @icon_url = icon_url if icon_url != OMIT
+        @name = name if name != OMIT
+        @phones = phones if phones != OMIT
+        @websites = websites if websites != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "color": color,
+          "description": description,
+          "emails": emails,
+          "heroUrl": hero_url,
+          "iconUrl": icon_url,
+          "name": name,
+          "phones": phones,
+          "websites": websites
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsCampaignSchemaExtraAgent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraAgent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        color = parsed_json["color"]
+        description = parsed_json["description"]
+        emails = parsed_json["emails"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsCampaignSchemaExtraAgentEmailsItem.from_json(json_object: item)
+        end
+        hero_url = parsed_json["heroUrl"]
+        icon_url = parsed_json["iconUrl"]
+        name = parsed_json["name"]
+        phones = parsed_json["phones"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsCampaignSchemaExtraAgentPhonesItem.from_json(json_object: item)
+        end
+        websites = parsed_json["websites"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsCampaignSchemaExtraAgentWebsitesItem.from_json(json_object: item)
+        end
+        new(
+          color: color,
+          description: description,
+          emails: emails,
+          hero_url: hero_url,
+          icon_url: icon_url,
+          name: name,
+          phones: phones,
+          websites: websites,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCampaignSchemaExtraAgent 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.color&.is_a?(String) != false || raise("Passed value for field obj.color is not the expected type, validation failed.")
+        obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+        obj.emails&.is_a?(Array) != false || raise("Passed value for field obj.emails is not the expected type, validation failed.")
+        obj.hero_url&.is_a?(String) != false || raise("Passed value for field obj.hero_url is not the expected type, validation failed.")
+        obj.icon_url&.is_a?(String) != false || raise("Passed value for field obj.icon_url 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.phones&.is_a?(Array) != false || raise("Passed value for field obj.phones is not the expected type, validation failed.")
+        obj.websites&.is_a?(Array) != false || raise("Passed value for field obj.websites is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_campaign_schema_extra_agent_emails_item.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class RcsCampaignSchemaExtraAgentEmailsItem
+      # @return [String] Email attached to the agent.
+      attr_reader :email
+      # @return [String] Label for the email.
+      attr_reader :label
+      # @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 email [String] Email attached to the agent.
+      # @param label [String] Label for the email.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraAgentEmailsItem]
+      def initialize(email: OMIT, label: OMIT, additional_properties: nil)
+        @email = email if email != OMIT
+        @label = label if label != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "email": email, "label": label }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of
+      #  RcsCampaignSchemaExtraAgentEmailsItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraAgentEmailsItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        email = parsed_json["email"]
+        label = parsed_json["label"]
+        new(
+          email: email,
+          label: label,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCampaignSchemaExtraAgentEmailsItem 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.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+        obj.label&.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_campaign_schema_extra_agent_phones_item.rb

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

data/lib/rcs/types/rcs_campaign_schema_extra_agent_websites_item.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class RcsCampaignSchemaExtraAgentWebsitesItem
+      # @return [String] Label for the url.
+      attr_reader :label
+      # @return [String] Url attached to the agent.
+      attr_reader :url
+      # @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 label [String] Label for the url.
+      # @param url [String] Url attached to the agent.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraAgentWebsitesItem]
+      def initialize(label: OMIT, url: OMIT, additional_properties: nil)
+        @label = label if label != OMIT
+        @url = url if url != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "label": label, "url": url }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of
+      #  RcsCampaignSchemaExtraAgentWebsitesItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraAgentWebsitesItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        label = parsed_json["label"]
+        url = parsed_json["url"]
+        new(
+          label: label,
+          url: url,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCampaignSchemaExtraAgentWebsitesItem 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.label&.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
+        obj.url&.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_campaign_schema_extra_links.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Legal documentation links.
+    class RcsCampaignSchemaExtraLinks
+      # @return [String] Privacy policy URL.
+      attr_reader :privacy_policy
+      # @return [String] Terms of service URL.
+      attr_reader :terms_of_service
+      # @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 privacy_policy [String] Privacy policy URL.
+      # @param terms_of_service [String] Terms of service URL.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraLinks]
+      def initialize(privacy_policy: OMIT, terms_of_service: OMIT, additional_properties: nil)
+        @privacy_policy = privacy_policy if privacy_policy != OMIT
+        @terms_of_service = terms_of_service if terms_of_service != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "privacyPolicy": privacy_policy, "termsOfService": terms_of_service }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsCampaignSchemaExtraLinks
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraLinks]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        privacy_policy = parsed_json["privacyPolicy"]
+        terms_of_service = parsed_json["termsOfService"]
+        new(
+          privacy_policy: privacy_policy,
+          terms_of_service: terms_of_service,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCampaignSchemaExtraLinks 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.privacy_policy&.is_a?(String) != false || raise("Passed value for field obj.privacy_policy is not the expected type, validation failed.")
+        obj.terms_of_service&.is_a?(String) != false || raise("Passed value for field obj.terms_of_service is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_campaign_schema_extra_opt_in.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "rcs_campaign_opt_in_method_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Opt-in configuration.
+    class RcsCampaignSchemaExtraOptIn
+      # @return [Pinnacle::Types::RcsCampaignOptInMethodEnum]
+      attr_reader :method
+      # @return [String] Message shown to users explaining what they are agreeing to when opting in.
+      attr_reader :terms_and_conditions
+      # @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 method [Pinnacle::Types::RcsCampaignOptInMethodEnum]
+      # @param terms_and_conditions [String] Message shown to users explaining what they are agreeing to when opting in.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraOptIn]
+      def initialize(method: OMIT, terms_and_conditions: OMIT, additional_properties: nil)
+        @method = method if method != OMIT
+        @terms_and_conditions = terms_and_conditions if terms_and_conditions != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "method": method, "termsAndConditions": terms_and_conditions }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsCampaignSchemaExtraOptIn
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraOptIn]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        method = parsed_json["method"]
+        terms_and_conditions = parsed_json["termsAndConditions"]
+        new(
+          method: method,
+          terms_and_conditions: terms_and_conditions,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCampaignSchemaExtraOptIn 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.method&.is_a?(Pinnacle::Types::RcsCampaignOptInMethodEnum) != false || raise("Passed value for field obj.method is not the expected type, validation failed.")
+        obj.terms_and_conditions&.is_a?(String) != false || raise("Passed value for field obj.terms_and_conditions is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_campaign_schema_extra_opt_out.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Opt-out configuration.
+    class RcsCampaignSchemaExtraOptOut
+      # @return [String] Description for the keyword.
+      attr_reader :description
+      # @return [Array<String>] Keywords to opt-out.
+      attr_reader :keywords
+      # @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 description [String] Description for the keyword.
+      # @param keywords [Array<String>] Keywords to opt-out.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraOptOut]
+      def initialize(description: OMIT, keywords: OMIT, additional_properties: nil)
+        @description = description if description != OMIT
+        @keywords = keywords if keywords != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "description": description, "keywords": keywords }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsCampaignSchemaExtraOptOut
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCampaignSchemaExtraOptOut]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        description = parsed_json["description"]
+        keywords = parsed_json["keywords"]
+        new(
+          description: description,
+          keywords: keywords,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCampaignSchemaExtraOptOut 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.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+        obj.keywords&.is_a?(Array) != false || raise("Passed value for field obj.keywords is not the expected type, validation failed.")
+      end
+    end
+  end
+end