rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/types/campaign_validation_result.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "campaign_validation_response_errors_item"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class CampaignValidationResult
+      # @return [Array<Pinnacle::Types::CampaignValidationResponseErrorsItem>] List of validation errors.
+      attr_reader :errors
+      # @return [Boolean] Whether the campaign is valid or not.
+      attr_reader :is_valid
+      # @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<Pinnacle::Types::CampaignValidationResponseErrorsItem>] List of validation errors.
+      # @param is_valid [Boolean] Whether the campaign is valid or not.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::CampaignValidationResult]
+      def initialize(errors:, is_valid:, additional_properties: nil)
+        @errors = errors
+        @is_valid = is_valid
+        @additional_properties = additional_properties
+        @_field_set = { "errors": errors, "is_valid": is_valid }
+      end
+
+      # Deserialize a JSON object to an instance of CampaignValidationResult
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::CampaignValidationResult]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        errors = parsed_json["errors"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::CampaignValidationResponseErrorsItem.from_json(json_object: item)
+        end
+        is_valid = parsed_json["is_valid"]
+        new(
+          errors: errors,
+          is_valid: is_valid,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of CampaignValidationResult 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.is_valid.is_a?(Boolean) != false || raise("Passed value for field obj.is_valid is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/click_action.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "click_action_data"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class ClickAction
+      # @return [String] Title of the button or quick reply that was clicked on.
+      attr_reader :button
+      # @return [Pinnacle::Types::ClickActionData] Payload received from the button interaction.
+      attr_reader :data
+      # @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 button [String] Title of the button or quick reply that was clicked on.
+      # @param data [Pinnacle::Types::ClickActionData] Payload received from the button interaction.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ClickAction]
+      def initialize(button:, data:, additional_properties: nil)
+        @button = button
+        @data = data
+        @additional_properties = additional_properties
+        @_field_set = { "button": button, "data": data }
+      end
+
+      # Deserialize a JSON object to an instance of ClickAction
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ClickAction]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        button = parsed_json["button"]
+        if parsed_json["data"].nil?
+          data = nil
+        else
+          data = parsed_json["data"].to_json
+          data = Pinnacle::Types::ClickActionData.from_json(json_object: data)
+        end
+        new(
+          button: button,
+          data: data,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ClickAction 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.button.is_a?(String) != false || raise("Passed value for field obj.button is not the expected type, validation failed.")
+        Pinnacle::Types::ClickActionData.validate_raw(obj: obj.data)
+      end
+    end
+  end
+end

data/lib/rcs/types/click_action_data.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "click_action_data_metadata"
+
+module Pinnacle
+  module Types
+    # Payload received from the button interaction.
+    class ClickActionData
+      # Deserialize a JSON object to an instance of ClickActionData
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ClickActionData]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Pinnacle::Types::ClickActionDataMetadata.validate_raw(obj: struct)
+          return Pinnacle::Types::ClickActionDataMetadata.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          return 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::ClickActionDataMetadata.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/click_action_data_metadata.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Data that is attached to the button. <br>
+    #  This is only returned when `trigger` buttons are pressed.
+    class ClickActionDataMetadata
+      # @return [String] Additional metadata attached to the interaction.
+      attr_reader :metadata
+      # @return [String] Payload associated with the button.
+      attr_reader :payload
+      # @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 metadata [String] Additional metadata attached to the interaction.
+      # @param payload [String] Payload associated with the button.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ClickActionDataMetadata]
+      def initialize(metadata:, payload:, additional_properties: nil)
+        @metadata = metadata
+        @payload = payload
+        @additional_properties = additional_properties
+        @_field_set = { "metadata": metadata, "payload": payload }
+      end
+
+      # Deserialize a JSON object to an instance of ClickActionDataMetadata
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ClickActionDataMetadata]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        metadata = parsed_json["metadata"]
+        payload = parsed_json["payload"]
+        new(
+          metadata: metadata,
+          payload: payload,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ClickActionDataMetadata 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.metadata.is_a?(String) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+        obj.payload.is_a?(String) != false || raise("Passed value for field obj.payload is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/company_sector_enum.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Industry the Brand operates in.
+    class CompanySectorEnum
+      AGRICULTURE = "AGRICULTURE"
+      COMMUNICATION = "COMMUNICATION"
+      CONSTRUCTION = "CONSTRUCTION"
+      EDUCATION = "EDUCATION"
+      ENERGY = "ENERGY"
+      ENTERTAINMENT = "ENTERTAINMENT"
+      FINANCIAL = "FINANCIAL"
+      GAMBLING = "GAMBLING"
+      GOVERNMENT = "GOVERNMENT"
+      HEALTHCARE = "HEALTHCARE"
+      HOSPITALITY = "HOSPITALITY"
+      INSURANCE = "INSURANCE"
+      MANUFACTURING = "MANUFACTURING"
+      NGO = "NGO"
+      REAL_ESTATE = "REAL_ESTATE"
+      RETAIL = "RETAIL"
+      TECHNOLOGY = "TECHNOLOGY"
+    end
+  end
+end

data/lib/rcs/types/company_type_enum.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Legal structure of the brand.
+    class CompanyTypeEnum
+      GOVERNMENT = "GOVERNMENT"
+      NON_PROFIT = "NON_PROFIT"
+      PRIVATE_PROFIT = "PRIVATE_PROFIT"
+      PUBLIC_PROFIT = "PUBLIC_PROFIT"
+      SOLE_PROPRIETOR = "SOLE_PROPRIETOR"
+    end
+  end
+end

data/lib/rcs/types/configured_webhook.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "attach_webhook_response_webhook"
+require_relative "webhook_event_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Confirmation that a webhook has been successfully attached to the specified
+    #  phone number.
+    #  Includes detailed webhook information, the subscribed event type, and the
+    #  associated phone number.
+    class ConfiguredWebhook
+      # @return [Pinnacle::Types::AttachWebhookResponseWebhook] Detailed information about the attached webhook.
+      attr_reader :webhook
+      # @return [Pinnacle::Types::WebhookEventEnum] Specific event type configured for this webhook attachment.
+      attr_reader :event
+      # @return [String] Phone number in E.164 format that is linked to the webhook.
+      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 webhook [Pinnacle::Types::AttachWebhookResponseWebhook] Detailed information about the attached webhook.
+      # @param event [Pinnacle::Types::WebhookEventEnum] Specific event type configured for this webhook attachment.
+      # @param phone_number [String] Phone number in E.164 format that is linked to the webhook.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ConfiguredWebhook]
+      def initialize(webhook:, event:, phone_number:, additional_properties: nil)
+        @webhook = webhook
+        @event = event
+        @phone_number = phone_number
+        @additional_properties = additional_properties
+        @_field_set = { "webhook": webhook, "event": event, "phoneNumber": phone_number }
+      end
+
+      # Deserialize a JSON object to an instance of ConfiguredWebhook
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ConfiguredWebhook]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["webhook"].nil?
+          webhook = nil
+        else
+          webhook = parsed_json["webhook"].to_json
+          webhook = Pinnacle::Types::AttachWebhookResponseWebhook.from_json(json_object: webhook)
+        end
+        event = parsed_json["event"]
+        phone_number = parsed_json["phoneNumber"]
+        new(
+          webhook: webhook,
+          event: event,
+          phone_number: phone_number,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ConfiguredWebhook 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::AttachWebhookResponseWebhook.validate_raw(obj: obj.webhook)
+        obj.event.is_a?(Pinnacle::Types::WebhookEventEnum) != false || raise("Passed value for field obj.event 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/contact.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class Contact
+      # @return [String] Additional information about the contact.
+      attr_reader :description
+      # @return [String] Contact's email address, if available.
+      attr_reader :email
+      # @return [Integer] Unique ID of the contact.
+      attr_reader :id
+      # @return [String] Full name of the contact, if available.
+      attr_reader :name
+      # @return [String] Contact's phone number in E.164 format.
+      attr_reader :phone_number
+      # @return [Array<String>] List of tags associated with the contact.
+      attr_reader :tags
+      # @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] Additional information about the contact.
+      # @param email [String] Contact's email address, if available.
+      # @param id [Integer] Unique ID of the contact.
+      # @param name [String] Full name of the contact, if available.
+      # @param phone_number [String] Contact's phone number in E.164 format.
+      # @param tags [Array<String>] List of tags associated with the contact.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::Contact]
+      def initialize(id:, phone_number:, description: OMIT, email: OMIT, name: OMIT, tags: OMIT,
+                     additional_properties: nil)
+        @description = description if description != OMIT
+        @email = email if email != OMIT
+        @id = id
+        @name = name if name != OMIT
+        @phone_number = phone_number
+        @tags = tags if tags != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "description": description,
+          "email": email,
+          "id": id,
+          "name": name,
+          "phoneNumber": phone_number,
+          "tags": tags
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of Contact
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::Contact]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        description = parsed_json["description"]
+        email = parsed_json["email"]
+        id = parsed_json["id"]
+        name = parsed_json["name"]
+        phone_number = parsed_json["phoneNumber"]
+        tags = parsed_json["tags"]
+        new(
+          description: description,
+          email: email,
+          id: id,
+          name: name,
+          phone_number: phone_number,
+          tags: tags,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of Contact 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.email&.is_a?(String) != false || raise("Passed value for field obj.email 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.name&.is_a?(String) != false || raise("Passed value for field obj.name 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.")
+        obj.tags&.is_a?(Array) != false || raise("Passed value for field obj.tags is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/contact_id.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class ContactId
+      # @return [Integer] Unique ID of the created contact.
+      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 [Integer] Unique ID of the created contact.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ContactId]
+      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 ContactId
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ContactId]
+      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 ContactId 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.")
+      end
+    end
+  end
+end