rcs 2.0.3 → 2.0.5.pre.rc.1

data/lib/rcs/types/mms_validation_response_segments.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "mms_validation_response_segments_value_item"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Details about how the MMS content would be segmented for delivery.
-    class MmsValidationResponseSegments
-      # @return [Integer] Number of segments this message would be split into.
-      attr_reader :count
-      # @return [Array<String>] List of unsupported media files included in the message. <br>
-      #  This may be because the file is unreachable or not supported by the MMS
-      #  protocol. See [supported file
-      #  types](https://app.pinnacle.sh/supported-file-types?type=MMS).
-      attr_reader :unsupported_files
-      # @return [Array<Pinnacle::Types::MmsValidationResponseSegmentsValueItem>] Message segments with its content breakdown.
-      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 count [Integer] Number of segments this message would be split into.
-      # @param unsupported_files [Array<String>] List of unsupported media files included in the message. <br>
-      #  This may be because the file is unreachable or not supported by the MMS
-      #  protocol. See [supported file
-      #  types](https://app.pinnacle.sh/supported-file-types?type=MMS).
-      # @param value [Array<Pinnacle::Types::MmsValidationResponseSegmentsValueItem>] Message segments with its content breakdown.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::MmsValidationResponseSegments]
-      def initialize(count:, unsupported_files:, value:, additional_properties: nil)
-        @count = count
-        @unsupported_files = unsupported_files
-        @value = value
-        @additional_properties = additional_properties
-        @_field_set = { "count": count, "unsupportedFiles": unsupported_files, "value": value }
-      end
-
-      # Deserialize a JSON object to an instance of MmsValidationResponseSegments
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::MmsValidationResponseSegments]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        count = parsed_json["count"]
-        unsupported_files = parsed_json["unsupportedFiles"]
-        value = parsed_json["value"]&.map do |item|
-          item = item.to_json
-          Pinnacle::Types::MmsValidationResponseSegmentsValueItem.from_json(json_object: item)
-        end
-        new(
-          count: count,
-          unsupported_files: unsupported_files,
-          value: value,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of MmsValidationResponseSegments to a JSON object
-      #
-      # @return [String]
-      def to_json(*_args)
-        @_field_set&.to_json
-      end
-
-      # Leveraged for Union-type generation, validate_raw attempts to parse the given
-      #  hash and check each fields type against the current object's property
-      #  definitions.
-      #
-      # @param obj [Object]
-      # @return [Void]
-      def self.validate_raw(obj:)
-        obj.count.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
-        obj.unsupported_files.is_a?(Array) != false || raise("Passed value for field obj.unsupported_files is not the expected type, validation failed.")
-        obj.value.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/mms_validation_response_segments_value_item.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class MmsValidationResponseSegmentsValueItem
-      # @return [Array<String>] Media file URLs that would be included in this segment.
-      attr_reader :files
-      # @return [Integer] Size of this segment in bytes.
-      attr_reader :size
-      # @return [String] Text content in this segment.
-      attr_reader :text
-      # @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 files [Array<String>] Media file URLs that would be included in this segment.
-      # @param size [Integer] Size of this segment in bytes.
-      # @param text [String] Text content in this segment.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::MmsValidationResponseSegmentsValueItem]
-      def initialize(files:, size:, text:, additional_properties: nil)
-        @files = files
-        @size = size
-        @text = text
-        @additional_properties = additional_properties
-        @_field_set = { "files": files, "size": size, "text": text }
-      end
-
-      # Deserialize a JSON object to an instance of
-      #  MmsValidationResponseSegmentsValueItem
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::MmsValidationResponseSegmentsValueItem]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        files = parsed_json["files"]
-        size = parsed_json["size"]
-        text = parsed_json["text"]
-        new(
-          files: files,
-          size: size,
-          text: text,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of MmsValidationResponseSegmentsValueItem 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.files.is_a?(Array) != false || raise("Passed value for field obj.files is not the expected type, validation failed.")
-        obj.size.is_a?(Integer) != false || raise("Passed value for field obj.size is not the expected type, validation failed.")
-        obj.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/mms_validation_result.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "mms_validation_response_segments"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class MmsValidationResult
-      # @return [Pinnacle::Types::MmsValidationResponseSegments] Details about how the MMS content would be segmented for delivery.
-      attr_reader :segments
-      # @return [Float] Total price of this message. Calculated by multiplying the number of segments by
-      #  the unit cost.
-      attr_reader :total
-      # @return [Float] Cost of each segment.
-      attr_reader :unit
-      # @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 segments [Pinnacle::Types::MmsValidationResponseSegments] Details about how the MMS content would be segmented for delivery.
-      # @param total [Float] Total price of this message. Calculated by multiplying the number of segments by
-      #  the unit cost.
-      # @param unit [Float] Cost of each segment.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::MmsValidationResult]
-      def initialize(segments:, total:, unit:, additional_properties: nil)
-        @segments = segments
-        @total = total
-        @unit = unit
-        @additional_properties = additional_properties
-        @_field_set = { "segments": segments, "total": total, "unit": unit }
-      end
-
-      # Deserialize a JSON object to an instance of MmsValidationResult
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::MmsValidationResult]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        if parsed_json["segments"].nil?
-          segments = nil
-        else
-          segments = parsed_json["segments"].to_json
-          segments = Pinnacle::Types::MmsValidationResponseSegments.from_json(json_object: segments)
-        end
-        total = parsed_json["total"]
-        unit = parsed_json["unit"]
-        new(
-          segments: segments,
-          total: total,
-          unit: unit,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of MmsValidationResult 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::MmsValidationResponseSegments.validate_raw(obj: obj.segments)
-        obj.total.is_a?(Float) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
-        obj.unit.is_a?(Float) != false || raise("Passed value for field obj.unit is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/not_found_error_body.rb

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

data/lib/rcs/types/number_format.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Multiple formatting representations of the same phone number for different use
-    #  cases.
-    #  Provides flexibility for display, storage, and integration requirements.
-    class NumberFormat
-      # @return [String] Phone number in E.164 format with country code prefix.
-      attr_reader :international
-      # @return [String] Phone number formatted according to national conventions. <br>
-      #  Includes parentheses, spaces, and dashes as commonly used in the country.
-      attr_reader :national
-      # @return [String] Phone number with only digits, no formatting or country code prefix.
-      attr_reader :raw
-      # @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 international [String] Phone number in E.164 format with country code prefix.
-      # @param national [String] Phone number formatted according to national conventions. <br>
-      #  Includes parentheses, spaces, and dashes as commonly used in the country.
-      # @param raw [String] Phone number with only digits, no formatting or country code prefix.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::NumberFormat]
-      def initialize(international:, national:, raw:, additional_properties: nil)
-        @international = international
-        @national = national
-        @raw = raw
-        @additional_properties = additional_properties
-        @_field_set = { "international": international, "national": national, "raw": raw }
-      end
-
-      # Deserialize a JSON object to an instance of NumberFormat
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::NumberFormat]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        international = parsed_json["international"]
-        national = parsed_json["national"]
-        raw = parsed_json["raw"]
-        new(
-          international: international,
-          national: national,
-          raw: raw,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of NumberFormat 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.international.is_a?(String) != false || raise("Passed value for field obj.international is not the expected type, validation failed.")
-        obj.national.is_a?(String) != false || raise("Passed value for field obj.national is not the expected type, validation failed.")
-        obj.raw.is_a?(String) != false || raise("Passed value for field obj.raw is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/opt_in_method_enum.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Types
-    # Opt in options.
-    class OptInMethodEnum
-      DIGITAL = "DIGITAL"
-      PAPER = "PAPER"
-      TEXT = "TEXT"
-      VERBAL = "VERBAL"
-    end
-  end
-end

data/lib/rcs/types/optional_brand_info.rb

@@ -1,154 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "optional_contacts"
-require_relative "company_sector_enum"
-require_relative "company_type_enum"
-require_relative "company_entity_type_enum"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class OptionalBrandInfo
-      # @return [String] Primary brand address where this brand is located.
-      attr_reader :address
-      # @return [Pinnacle::Types::OptionalContacts]
-      attr_reader :contact
-      # @return [String] "Doing Business As" name - the public name this brand operates under.
-      attr_reader :dba
-      # @return [String] Brief description of what this brand does.
-      attr_reader :description
-      # @return [String] Employer Identification Number (EIN) assigned by the IRS.
-      attr_reader :ein
-      # @return [String] Main contact email address for this brand.
-      attr_reader :email
-      # @return [String] Legal name of the brand as registered.
-      attr_reader :name
-      # @return [Pinnacle::Types::CompanySectorEnum]
-      attr_reader :sector
-      # @return [Pinnacle::Types::CompanyTypeEnum]
-      attr_reader :type
-      # @return [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
-      attr_reader :entity_type
-      # @return [String] Brand website URL.
-      attr_reader :website
-      # @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 address [String] Primary brand address where this brand is located.
-      # @param contact [Pinnacle::Types::OptionalContacts]
-      # @param dba [String] "Doing Business As" name - the public name this brand operates under.
-      # @param description [String] Brief description of what this brand does.
-      # @param ein [String] Employer Identification Number (EIN) assigned by the IRS.
-      # @param email [String] Main contact email address for this brand.
-      # @param name [String] Legal name of the brand as registered.
-      # @param sector [Pinnacle::Types::CompanySectorEnum]
-      # @param type [Pinnacle::Types::CompanyTypeEnum]
-      # @param entity_type [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
-      # @param website [String] Brand website URL.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::OptionalBrandInfo]
-      def initialize(address: OMIT, contact: OMIT, dba: OMIT, description: OMIT, ein: OMIT, email: OMIT, name: OMIT,
-                     sector: OMIT, type: OMIT, entity_type: OMIT, website: OMIT, additional_properties: nil)
-        @address = address if address != OMIT
-        @contact = contact if contact != OMIT
-        @dba = dba if dba != OMIT
-        @description = description if description != OMIT
-        @ein = ein if ein != OMIT
-        @email = email if email != OMIT
-        @name = name if name != OMIT
-        @sector = sector if sector != OMIT
-        @type = type if type != OMIT
-        @entity_type = entity_type if entity_type != OMIT
-        @website = website if website != OMIT
-        @additional_properties = additional_properties
-        @_field_set = {
-          "address": address,
-          "contact": contact,
-          "dba": dba,
-          "description": description,
-          "ein": ein,
-          "email": email,
-          "name": name,
-          "sector": sector,
-          "type": type,
-          "entityType": entity_type,
-          "website": website
-        }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of OptionalBrandInfo
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::OptionalBrandInfo]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        address = parsed_json["address"]
-        if parsed_json["contact"].nil?
-          contact = nil
-        else
-          contact = parsed_json["contact"].to_json
-          contact = Pinnacle::Types::OptionalContacts.from_json(json_object: contact)
-        end
-        dba = parsed_json["dba"]
-        description = parsed_json["description"]
-        ein = parsed_json["ein"]
-        email = parsed_json["email"]
-        name = parsed_json["name"]
-        sector = parsed_json["sector"]
-        type = parsed_json["type"]
-        entity_type = parsed_json["entityType"]
-        website = parsed_json["website"]
-        new(
-          address: address,
-          contact: contact,
-          dba: dba,
-          description: description,
-          ein: ein,
-          email: email,
-          name: name,
-          sector: sector,
-          type: type,
-          entity_type: entity_type,
-          website: website,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of OptionalBrandInfo 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.address&.is_a?(String) != false || raise("Passed value for field obj.address is not the expected type, validation failed.")
-        obj.contact.nil? || Pinnacle::Types::OptionalContacts.validate_raw(obj: obj.contact)
-        obj.dba&.is_a?(String) != false || raise("Passed value for field obj.dba 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.ein&.is_a?(String) != false || raise("Passed value for field obj.ein 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-        obj.sector&.is_a?(Pinnacle::Types::CompanySectorEnum) != false || raise("Passed value for field obj.sector is not the expected type, validation failed.")
-        obj.type&.is_a?(Pinnacle::Types::CompanyTypeEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
-        obj.entity_type&.is_a?(Pinnacle::Types::CompanyEntityTypeEnum) != false || raise("Passed value for field obj.entity_type is not the expected type, validation failed.")
-        obj.website&.is_a?(String) != false || raise("Passed value for field obj.website is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/optional_contact.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class OptionalContact
-      # @return [String] New notes or details for your contact.
-      attr_reader :description
-      # @return [String] New email address for your contact.
-      attr_reader :email
-      # @return [String] New name for your contact.
-      attr_reader :name
-      # @return [Array<String>] New tags for your 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] New notes or details for your contact.
-      # @param email [String] New email address for your contact.
-      # @param name [String] New name for your contact.
-      # @param tags [Array<String>] New tags for your contact.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::OptionalContact]
-      def initialize(description: OMIT, email: OMIT, name: OMIT, tags: OMIT, additional_properties: nil)
-        @description = description if description != OMIT
-        @email = email if email != OMIT
-        @name = name if name != OMIT
-        @tags = tags if tags != OMIT
-        @additional_properties = additional_properties
-        @_field_set = { "description": description, "email": email, "name": name, "tags": tags }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of OptionalContact
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::OptionalContact]
-      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"]
-        name = parsed_json["name"]
-        tags = parsed_json["tags"]
-        new(
-          description: description,
-          email: email,
-          name: name,
-          tags: tags,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of OptionalContact 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.name&.is_a?(String) != false || raise("Passed value for field obj.name 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