rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/tools/contact_card/client.rb

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "types/get_v_card_schema_options"
+require_relative "../../types/v_card_data"
+require_relative "../../types/v_card_name"
+require_relative "../../types/vcard_address"
+require_relative "../../types/vcard_phone"
+require_relative "../../types/vcard_email"
+require_relative "../../types/v_card_geo"
+require_relative "../../types/v_card_organization"
+require_relative "../../types/vcard_resource"
+require "async"
+
+module Pinnacle
+  module Tools
+    class ContactCardClient
+      # @return [Pinnacle::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::RequestClient]
+      # @return [Pinnacle::Tools::ContactCardClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Retrieve contact information as a vCard and get a presigned URL to download the
+      #  file.
+      #
+      # @param id [Integer] ID of your contact.
+      # @param options [Hash] Request of type Pinnacle::Tools::ContactCard::Types::GetVCardSchemaOptions, as a Hash
+      #   * :expires_at (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::VCardData]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.tools.contact_card.get(id: 33)
+      def get(id:, options: nil, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request_options&.additional_body_parameters || {}), id: id, options: options }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/tools/contact-card"
+        end
+        Pinnacle::Types::VCardData.from_json(json_object: response.body)
+      end
+
+      # Create a new contact card or updates an existing one with full vCard data.
+      #
+      # @param id [Integer] Unique identifier for the contact.
+      # @param formatted_name [String] Full display name for the vCard.
+      # @param name [Hash] Structured name components.Request of type Pinnacle::Types::VCardName, as a Hash
+      #   * :family_name (String)
+      #   * :given_name (String)
+      #   * :additional_names (Array<String>)
+      #   * :honorific_prefixes (Array<String>)
+      #   * :honorific_suffixes (Array<String>)
+      # @param nickname [Array<String>] Nicknames or aliases.
+      # @param birthday [String] Birthday in ISO 8601 date format (YYYY-MM-DD).
+      # @param addresses [Array<Hash>] Physical addresses.Request of type Array<Pinnacle::Types::VcardAddress>, as a Hash
+      #   * :country_name (String)
+      #   * :extended_address (String)
+      #   * :fulladdress (String)
+      #   * :locality (String)
+      #   * :postal_code (String)
+      #   * :post_office_box (String)
+      #   * :region (String)
+      #   * :street_address (String)
+      #   * :type (Array<Pinnacle::Types::VCardAddressSchemaTypeItem>)
+      # @param url [String] Website URL.
+      # @param phones [Array<Hash>] Phone numbers.Request of type Array<Pinnacle::Types::VcardPhone>, as a Hash
+      #   * :type (Array<Pinnacle::Types::VCardPhoneSchemaTypeItem>)
+      #   * :value (String)
+      # @param emails [Array<Hash>] Email addresses.Request of type Array<Pinnacle::Types::VcardEmail>, as a Hash
+      #   * :type (Array<Pinnacle::Types::VCardEmailSchemaTypeItem>)
+      #   * :value (String)
+      # @param timezone [String] Timezone (e.g., "America/New_York").
+      # @param geo [Hash] Geographic coordinates.Request of type Pinnacle::Types::VCardGeo, as a Hash
+      #   * :latitude (Float)
+      #   * :longitude (Float)
+      # @param title [String] Job title or position.
+      # @param role [String] Role or function within the organization.
+      # @param organization [Hash] Organization or company information.Request of type Pinnacle::Types::VCardOrganization, as a Hash
+      #   * :name (String)
+      #   * :units (Array<String>)
+      # @param categories [Array<String>] Categories or tags for organizing contacts.
+      # @param note [String] Additional notes or comments.
+      # @param photo [String] Contact's photo
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::VcardResource]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.tools.contact_card.upsert(photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ")
+      def upsert(id: nil, formatted_name: nil, name: nil, nickname: nil, birthday: nil, addresses: nil, url: nil,
+                 phones: nil, emails: nil, timezone: nil, geo: nil, title: nil, role: nil, organization: nil, categories: nil, note: nil, photo: nil, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            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,
+            photo: photo
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/tools/contact-card/upsert"
+        end
+        Pinnacle::Types::VcardResource.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncContactCardClient
+      # @return [Pinnacle::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::AsyncRequestClient]
+      # @return [Pinnacle::Tools::AsyncContactCardClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Retrieve contact information as a vCard and get a presigned URL to download the
+      #  file.
+      #
+      # @param id [Integer] ID of your contact.
+      # @param options [Hash] Request of type Pinnacle::Tools::ContactCard::Types::GetVCardSchemaOptions, as a Hash
+      #   * :expires_at (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::VCardData]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.tools.contact_card.get(id: 33)
+      def get(id:, options: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = { **(request_options&.additional_body_parameters || {}), id: id, options: options }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/tools/contact-card"
+          end
+          Pinnacle::Types::VCardData.from_json(json_object: response.body)
+        end
+      end
+
+      # Create a new contact card or updates an existing one with full vCard data.
+      #
+      # @param id [Integer] Unique identifier for the contact.
+      # @param formatted_name [String] Full display name for the vCard.
+      # @param name [Hash] Structured name components.Request of type Pinnacle::Types::VCardName, as a Hash
+      #   * :family_name (String)
+      #   * :given_name (String)
+      #   * :additional_names (Array<String>)
+      #   * :honorific_prefixes (Array<String>)
+      #   * :honorific_suffixes (Array<String>)
+      # @param nickname [Array<String>] Nicknames or aliases.
+      # @param birthday [String] Birthday in ISO 8601 date format (YYYY-MM-DD).
+      # @param addresses [Array<Hash>] Physical addresses.Request of type Array<Pinnacle::Types::VcardAddress>, as a Hash
+      #   * :country_name (String)
+      #   * :extended_address (String)
+      #   * :fulladdress (String)
+      #   * :locality (String)
+      #   * :postal_code (String)
+      #   * :post_office_box (String)
+      #   * :region (String)
+      #   * :street_address (String)
+      #   * :type (Array<Pinnacle::Types::VCardAddressSchemaTypeItem>)
+      # @param url [String] Website URL.
+      # @param phones [Array<Hash>] Phone numbers.Request of type Array<Pinnacle::Types::VcardPhone>, as a Hash
+      #   * :type (Array<Pinnacle::Types::VCardPhoneSchemaTypeItem>)
+      #   * :value (String)
+      # @param emails [Array<Hash>] Email addresses.Request of type Array<Pinnacle::Types::VcardEmail>, as a Hash
+      #   * :type (Array<Pinnacle::Types::VCardEmailSchemaTypeItem>)
+      #   * :value (String)
+      # @param timezone [String] Timezone (e.g., "America/New_York").
+      # @param geo [Hash] Geographic coordinates.Request of type Pinnacle::Types::VCardGeo, as a Hash
+      #   * :latitude (Float)
+      #   * :longitude (Float)
+      # @param title [String] Job title or position.
+      # @param role [String] Role or function within the organization.
+      # @param organization [Hash] Organization or company information.Request of type Pinnacle::Types::VCardOrganization, as a Hash
+      #   * :name (String)
+      #   * :units (Array<String>)
+      # @param categories [Array<String>] Categories or tags for organizing contacts.
+      # @param note [String] Additional notes or comments.
+      # @param photo [String] Contact's photo
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::VcardResource]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.tools.contact_card.upsert(photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ")
+      def upsert(id: nil, formatted_name: nil, name: nil, nickname: nil, birthday: nil, addresses: nil, url: nil,
+                 phones: nil, emails: nil, timezone: nil, geo: nil, title: nil, role: nil, organization: nil, categories: nil, note: nil, photo: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              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,
+              photo: photo
+            }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/tools/contact-card/upsert"
+          end
+          Pinnacle::Types::VcardResource.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/rcs/tools/contact_card/types/get_v_card_schema_options.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Tools
+    module ContactCard
+      module Types
+        class GetVCardSchemaOptions
+          # @return [String] Set an expiration date for your download URL in IS0 8610 format. <br>
+          #  If this field is not provided, the expiration time is defaulted to one hour
+          #  after retrieval.
+          attr_reader :expires_at
+          # @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 expires_at [String] Set an expiration date for your download URL in IS0 8610 format. <br>
+          #  If this field is not provided, the expiration time is defaulted to one hour
+          #  after retrieval.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Tools::ContactCard::Types::GetVCardSchemaOptions]
+          def initialize(expires_at: OMIT, additional_properties: nil)
+            @expires_at = expires_at if expires_at != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "expiresAt": expires_at }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of GetVCardSchemaOptions
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Tools::ContactCard::Types::GetVCardSchemaOptions]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            expires_at = parsed_json["expiresAt"]
+            new(expires_at: expires_at, additional_properties: struct)
+          end
+
+          # Serialize an instance of GetVCardSchemaOptions 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.expires_at&.is_a?(String) != false || raise("Passed value for field obj.expires_at is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rcs/tools/file/client.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "types/file_upload_schema_options"
+require_relative "../../types/upload_results"
+require "async"
+
+module Pinnacle
+  module Tools
+    class FileClient
+      # @return [Pinnacle::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::RequestClient]
+      # @return [Pinnacle::Tools::FileClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Generate presigned URLs that let you upload files directly to our storage and
+      #  allow your users to download them securely.
+      #
+      # @param content_type [String] MIME type of your file. <br>
+      #  Supported file types:
+      #  - Audio: mp3, mp4, mpeg, ogg, aac, webm, wav, 3gpp, amr
+      #  - Video: mp4, mpeg, quicktime, webm, 3gpp, H.264, m4v
+      #  - Image: jpeg, png, gif, bmp, tiff, webp
+      #  - Documents: pdf, csv, rtf, calendar, vcard
+      # @param size [Integer] Size of your file in bytes. Should be less than 100 MB.
+      # @param name [String] Name of your file.
+      # @param options [Hash] Additional configurations for your file.Request of type Pinnacle::Tools::File::Types::FileUploadSchemaOptions, as a Hash
+      #   * :download (Hash)
+      #     * :expires_at (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::UploadResults]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.tools.file.upload(
+      #    content_type: "image/jpeg",
+      #    size: 1024,
+      #    name: "test.jpg",
+      #    options: { download: { expires_at: "2025-06-30T12:00:00.000Z" } }
+      #  )
+      def upload(content_type:, size:, name: nil, options: nil, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            contentType: content_type,
+            size: size,
+            name: name,
+            options: options
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/tools/files/upload"
+        end
+        Pinnacle::Types::UploadResults.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncFileClient
+      # @return [Pinnacle::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::AsyncRequestClient]
+      # @return [Pinnacle::Tools::AsyncFileClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Generate presigned URLs that let you upload files directly to our storage and
+      #  allow your users to download them securely.
+      #
+      # @param content_type [String] MIME type of your file. <br>
+      #  Supported file types:
+      #  - Audio: mp3, mp4, mpeg, ogg, aac, webm, wav, 3gpp, amr
+      #  - Video: mp4, mpeg, quicktime, webm, 3gpp, H.264, m4v
+      #  - Image: jpeg, png, gif, bmp, tiff, webp
+      #  - Documents: pdf, csv, rtf, calendar, vcard
+      # @param size [Integer] Size of your file in bytes. Should be less than 100 MB.
+      # @param name [String] Name of your file.
+      # @param options [Hash] Additional configurations for your file.Request of type Pinnacle::Tools::File::Types::FileUploadSchemaOptions, as a Hash
+      #   * :download (Hash)
+      #     * :expires_at (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::UploadResults]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.tools.file.upload(
+      #    content_type: "image/jpeg",
+      #    size: 1024,
+      #    name: "test.jpg",
+      #    options: { download: { expires_at: "2025-06-30T12:00:00.000Z" } }
+      #  )
+      def upload(content_type:, size:, name: nil, options: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              contentType: content_type,
+              size: size,
+              name: name,
+              options: options
+            }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/tools/files/upload"
+          end
+          Pinnacle::Types::UploadResults.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/rcs/tools/file/types/file_upload_schema_options.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "file_upload_schema_options_download"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Tools
+    module File
+      module Types
+        # Additional configurations for your file.
+        class FileUploadSchemaOptions
+          # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload] Configure download settings for your uploaded file.
+          attr_reader :download
+          # @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 download [Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload] Configure download settings for your uploaded file.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptions]
+          def initialize(download: OMIT, additional_properties: nil)
+            @download = download if download != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "download": download }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of FileUploadSchemaOptions
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptions]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            if parsed_json["download"].nil?
+              download = nil
+            else
+              download = parsed_json["download"].to_json
+              download = Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload.from_json(json_object: download)
+            end
+            new(download: download, additional_properties: struct)
+          end
+
+          # Serialize an instance of FileUploadSchemaOptions 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.download.nil? || Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload.validate_raw(obj: obj.download)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rcs/tools/file/types/file_upload_schema_options_download.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Tools
+    module File
+      module Types
+        # Configure download settings for your uploaded file.
+        class FileUploadSchemaOptionsDownload
+          # @return [String] Set an expiration date for file download access.<br>
+          #  If this field is not provided, then a short permalink is generated instead.
+          attr_reader :expires_at
+          # @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 expires_at [String] Set an expiration date for file download access.<br>
+          #  If this field is not provided, then a short permalink is generated instead.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload]
+          def initialize(expires_at: OMIT, additional_properties: nil)
+            @expires_at = expires_at if expires_at != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "expiresAt": expires_at }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of FileUploadSchemaOptionsDownload
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            expires_at = parsed_json["expiresAt"]
+            new(expires_at: expires_at, additional_properties: struct)
+          end
+
+          # Serialize an instance of FileUploadSchemaOptionsDownload 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.expires_at&.is_a?(String) != false || raise("Passed value for field obj.expires_at is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end