rcs 1.0.18 → 2.0.0.pre.rc.1

data/lib/rcs/types/validate_campaign_params.rb

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

data/lib/rcs/types/validation_error_details.rb

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

data/lib/rcs/types/validation_results.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "validation_error_details"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class ValidationResults
+      # @return [Array<Pinnacle::Types::ValidationErrorDetails>] List of validation errors, if any.
+      attr_reader :errors
+      # @return [Boolean] Whether the brand data is valid.
+      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::ValidationErrorDetails>] List of validation errors, if any.
+      # @param is_valid [Boolean] Whether the brand data is valid.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ValidationResults]
+      def initialize(errors:, is_valid:, additional_properties: nil)
+        @errors = errors
+        @is_valid = is_valid
+        @additional_properties = additional_properties
+        @_field_set = { "errors": errors, "isValid": is_valid }
+      end
+
+      # Deserialize a JSON object to an instance of ValidationResults
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ValidationResults]
+      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::ValidationErrorDetails.from_json(json_object: item)
+        end
+        is_valid = parsed_json["isValid"]
+        new(
+          errors: errors,
+          is_valid: is_valid,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ValidationResults 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/vcard.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+require_relative "v_card_name"
+require_relative "vcard_address"
+require_relative "vcard_phone"
+require_relative "vcard_email"
+require_relative "v_card_geo"
+require_relative "v_card_organization"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class Vcard
+      # @return [Integer] Unique identifier for the contact.
+      attr_reader :id
+      # @return [String] Full display name for the vCard.
+      attr_reader :formatted_name
+      # @return [Pinnacle::Types::VCardName] Structured name components.
+      attr_reader :name
+      # @return [Array<String>] Nicknames or aliases.
+      attr_reader :nickname
+      # @return [String] Birthday in ISO 8601 date format (YYYY-MM-DD).
+      attr_reader :birthday
+      # @return [Array<Pinnacle::Types::VcardAddress>] Physical addresses.
+      attr_reader :addresses
+      # @return [String] Website URL.
+      attr_reader :url
+      # @return [Array<Pinnacle::Types::VcardPhone>] Phone numbers.
+      attr_reader :phones
+      # @return [Array<Pinnacle::Types::VcardEmail>] Email addresses.
+      attr_reader :emails
+      # @return [String] Timezone (e.g., "America/New_York").
+      attr_reader :timezone
+      # @return [Pinnacle::Types::VCardGeo] Geographic coordinates.
+      attr_reader :geo
+      # @return [String] Job title or position.
+      attr_reader :title
+      # @return [String] Role or function within the organization.
+      attr_reader :role
+      # @return [Pinnacle::Types::VCardOrganization] Organization or company information.
+      attr_reader :organization
+      # @return [Array<String>] Categories or tags for organizing contacts.
+      attr_reader :categories
+      # @return [String] Additional notes or comments.
+      attr_reader :note
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param id [Integer] Unique identifier for the contact.
+      # @param formatted_name [String] Full display name for the vCard.
+      # @param name [Pinnacle::Types::VCardName] Structured name components.
+      # @param nickname [Array<String>] Nicknames or aliases.
+      # @param birthday [String] Birthday in ISO 8601 date format (YYYY-MM-DD).
+      # @param addresses [Array<Pinnacle::Types::VcardAddress>] Physical addresses.
+      # @param url [String] Website URL.
+      # @param phones [Array<Pinnacle::Types::VcardPhone>] Phone numbers.
+      # @param emails [Array<Pinnacle::Types::VcardEmail>] Email addresses.
+      # @param timezone [String] Timezone (e.g., "America/New_York").
+      # @param geo [Pinnacle::Types::VCardGeo] Geographic coordinates.
+      # @param title [String] Job title or position.
+      # @param role [String] Role or function within the organization.
+      # @param organization [Pinnacle::Types::VCardOrganization] Organization or company information.
+      # @param categories [Array<String>] Categories or tags for organizing contacts.
+      # @param note [String] Additional notes or comments.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::Vcard]
+      def initialize(id: OMIT, formatted_name: OMIT, name: OMIT, nickname: OMIT, birthday: OMIT, addresses: OMIT,
+                     url: OMIT, phones: OMIT, emails: OMIT, timezone: OMIT, geo: OMIT, title: OMIT, role: OMIT, organization: OMIT, categories: OMIT, note: OMIT, additional_properties: nil)
+        @id = id if id != OMIT
+        @formatted_name = formatted_name if formatted_name != OMIT
+        @name = name if name != OMIT
+        @nickname = nickname if nickname != OMIT
+        @birthday = birthday if birthday != OMIT
+        @addresses = addresses if addresses != OMIT
+        @url = url if url != OMIT
+        @phones = phones if phones != OMIT
+        @emails = emails if emails != OMIT
+        @timezone = timezone if timezone != OMIT
+        @geo = geo if geo != OMIT
+        @title = title if title != OMIT
+        @role = role if role != OMIT
+        @organization = organization if organization != OMIT
+        @categories = categories if categories != OMIT
+        @note = note if note != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "id": id,
+          "formattedName": formatted_name,
+          "name": name,
+          "nickname": nickname,
+          "birthday": birthday,
+          "addresses": addresses,
+          "url": url,
+          "phones": phones,
+          "emails": emails,
+          "timezone": timezone,
+          "geo": geo,
+          "title": title,
+          "role": role,
+          "organization": organization,
+          "categories": categories,
+          "note": note
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of Vcard
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::Vcard]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        formatted_name = parsed_json["formattedName"]
+        if parsed_json["name"].nil?
+          name = nil
+        else
+          name = parsed_json["name"].to_json
+          name = Pinnacle::Types::VCardName.from_json(json_object: name)
+        end
+        nickname = parsed_json["nickname"]
+        birthday = parsed_json["birthday"]
+        addresses = parsed_json["addresses"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::VcardAddress.from_json(json_object: item)
+        end
+        url = parsed_json["url"]
+        phones = parsed_json["phones"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::VcardPhone.from_json(json_object: item)
+        end
+        emails = parsed_json["emails"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::VcardEmail.from_json(json_object: item)
+        end
+        timezone = parsed_json["timezone"]
+        if parsed_json["geo"].nil?
+          geo = nil
+        else
+          geo = parsed_json["geo"].to_json
+          geo = Pinnacle::Types::VCardGeo.from_json(json_object: geo)
+        end
+        title = parsed_json["title"]
+        role = parsed_json["role"]
+        if parsed_json["organization"].nil?
+          organization = nil
+        else
+          organization = parsed_json["organization"].to_json
+          organization = Pinnacle::Types::VCardOrganization.from_json(json_object: organization)
+        end
+        categories = parsed_json["categories"]
+        note = parsed_json["note"]
+        new(
+          id: id,
+          formatted_name: formatted_name,
+          name: name,
+          nickname: nickname,
+          birthday: birthday,
+          addresses: addresses,
+          url: url,
+          phones: phones,
+          emails: emails,
+          timezone: timezone,
+          geo: geo,
+          title: title,
+          role: role,
+          organization: organization,
+          categories: categories,
+          note: note,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of Vcard to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.id&.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.formatted_name&.is_a?(String) != false || raise("Passed value for field obj.formatted_name is not the expected type, validation failed.")
+        obj.name.nil? || Pinnacle::Types::VCardName.validate_raw(obj: obj.name)
+        obj.nickname&.is_a?(Array) != false || raise("Passed value for field obj.nickname is not the expected type, validation failed.")
+        obj.birthday&.is_a?(String) != false || raise("Passed value for field obj.birthday is not the expected type, validation failed.")
+        obj.addresses&.is_a?(Array) != false || raise("Passed value for field obj.addresses 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.")
+        obj.phones&.is_a?(Array) != false || raise("Passed value for field obj.phones 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.timezone&.is_a?(String) != false || raise("Passed value for field obj.timezone is not the expected type, validation failed.")
+        obj.geo.nil? || Pinnacle::Types::VCardGeo.validate_raw(obj: obj.geo)
+        obj.title&.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+        obj.role&.is_a?(String) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
+        obj.organization.nil? || Pinnacle::Types::VCardOrganization.validate_raw(obj: obj.organization)
+        obj.categories&.is_a?(Array) != false || raise("Passed value for field obj.categories is not the expected type, validation failed.")
+        obj.note&.is_a?(String) != false || raise("Passed value for field obj.note is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/vcard_address.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require_relative "v_card_address_schema_type_item"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class VcardAddress
+      # @return [String] Country name.
+      attr_reader :country_name
+      # @return [String] Extended address information (apartment, suite, etc.).
+      attr_reader :extended_address
+      # @return [String] Complete formatted address as a single string.
+      attr_reader :fulladdress
+      # @return [String] City or locality.
+      attr_reader :locality
+      # @return [String] ZIP code or postal code.
+      attr_reader :postal_code
+      # @return [String] P.O. Box number.
+      attr_reader :post_office_box
+      # @return [String] State, province, or region.
+      attr_reader :region
+      # @return [String] Street address or street name and number.
+      attr_reader :street_address
+      # @return [Array<Pinnacle::Types::VCardAddressSchemaTypeItem>] Address type classifications.
+      attr_reader :type
+      # @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 country_name [String] Country name.
+      # @param extended_address [String] Extended address information (apartment, suite, etc.).
+      # @param fulladdress [String] Complete formatted address as a single string.
+      # @param locality [String] City or locality.
+      # @param postal_code [String] ZIP code or postal code.
+      # @param post_office_box [String] P.O. Box number.
+      # @param region [String] State, province, or region.
+      # @param street_address [String] Street address or street name and number.
+      # @param type [Array<Pinnacle::Types::VCardAddressSchemaTypeItem>] Address type classifications.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::VcardAddress]
+      def initialize(country_name: OMIT, extended_address: OMIT, fulladdress: OMIT, locality: OMIT, postal_code: OMIT,
+                     post_office_box: OMIT, region: OMIT, street_address: OMIT, type: OMIT, additional_properties: nil)
+        @country_name = country_name if country_name != OMIT
+        @extended_address = extended_address if extended_address != OMIT
+        @fulladdress = fulladdress if fulladdress != OMIT
+        @locality = locality if locality != OMIT
+        @postal_code = postal_code if postal_code != OMIT
+        @post_office_box = post_office_box if post_office_box != OMIT
+        @region = region if region != OMIT
+        @street_address = street_address if street_address != OMIT
+        @type = type if type != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "countryName": country_name,
+          "extendedAddress": extended_address,
+          "fulladdress": fulladdress,
+          "locality": locality,
+          "postalCode": postal_code,
+          "postOfficeBox": post_office_box,
+          "region": region,
+          "streetAddress": street_address,
+          "type": type
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of VcardAddress
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::VcardAddress]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        country_name = parsed_json["countryName"]
+        extended_address = parsed_json["extendedAddress"]
+        fulladdress = parsed_json["fulladdress"]
+        locality = parsed_json["locality"]
+        postal_code = parsed_json["postalCode"]
+        post_office_box = parsed_json["postOfficeBox"]
+        region = parsed_json["region"]
+        street_address = parsed_json["streetAddress"]
+        type = parsed_json["type"]
+        new(
+          country_name: country_name,
+          extended_address: extended_address,
+          fulladdress: fulladdress,
+          locality: locality,
+          postal_code: postal_code,
+          post_office_box: post_office_box,
+          region: region,
+          street_address: street_address,
+          type: type,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of VcardAddress 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.country_name&.is_a?(String) != false || raise("Passed value for field obj.country_name is not the expected type, validation failed.")
+        obj.extended_address&.is_a?(String) != false || raise("Passed value for field obj.extended_address is not the expected type, validation failed.")
+        obj.fulladdress&.is_a?(String) != false || raise("Passed value for field obj.fulladdress is not the expected type, validation failed.")
+        obj.locality&.is_a?(String) != false || raise("Passed value for field obj.locality is not the expected type, validation failed.")
+        obj.postal_code&.is_a?(String) != false || raise("Passed value for field obj.postal_code is not the expected type, validation failed.")
+        obj.post_office_box&.is_a?(String) != false || raise("Passed value for field obj.post_office_box is not the expected type, validation failed.")
+        obj.region&.is_a?(String) != false || raise("Passed value for field obj.region is not the expected type, validation failed.")
+        obj.street_address&.is_a?(String) != false || raise("Passed value for field obj.street_address is not the expected type, validation failed.")
+        obj.type&.is_a?(Array) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      end
+    end
+  end
+end