stackone_client 0.2.19 → 0.2.20

data/lib/stack_one/models/shared/contactscustomfields_type.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+    # The type of the custom field.
+    class ContactsCustomFieldsType < ::StackOne::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
+
+      field :value, T.nilable(::StackOne::Shared::ContactsCustomFieldsValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::ContactsCustomFieldsValue, true) } }
+
+
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::ContactsCustomFieldsValue)).void }
+      def initialize(source_value: nil, value: nil)
+        @source_value = source_value
+        @value = value
+      end
+    end
+  end
+end

data/lib/stack_one/models/shared/contactscustomfields_value.rb

@@ -0,0 +1,23 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+
+    class ContactsCustomFieldsValue < T::Enum
+      enums do
+        DATE = new('date')
+        FLOAT = new('float')
+        INTEGER = new('integer')
+        LIST = new('list')
+        TEXT = new('text')
+        UNMAPPED_VALUE = new('unmapped_value')
+      end
+    end
+
+  end
+end

data/lib/stack_one/models/shared/content.rb

@@ -13,7 +13,7 @@ module StackOne
 
       # The file format of the file
       field :file_format, T.nilable(::StackOne::Shared::FileFormat), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('file_format') } }
-      # Unified URL where the file content is located
+      # Unified download URL for retrieving file content.
       field :unified_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('unified_url') } }
       # URL where the file content is located
       field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('url') } }

data/lib/stack_one/models/shared/content_value.rb

@@ -7,7 +7,7 @@
 module StackOne
   module Shared
   
-
+    # ContentValue - The file format of the file, expressed as a file extension
     class ContentValue < T::Enum
       enums do
         UNMAPPED_VALUE = new('unmapped_value')

data/lib/stack_one/models/shared/document.rb

@@ -12,7 +12,7 @@ module StackOne
       extend T::Sig
 
       # The category of the file
-      field :category, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('category') } }
+      field :category, T.nilable(::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoCategory), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('category') } }
       # The content of the file
       field :contents, T.nilable(T::Array[::StackOne::Shared::Content]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('contents') } }
       # The creation date of the file
@@ -29,7 +29,7 @@ module StackOne
       field :updated_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('updated_at'), 'decoder': Utils.datetime_from_iso_format(true) } }
 
 
-      sig { params(category: T.nilable(::String), contents: T.nilable(T::Array[::StackOne::Shared::Content]), created_at: T.nilable(::DateTime), id: T.nilable(::String), name: T.nilable(::String), path: T.nilable(::String), remote_id: T.nilable(::String), updated_at: T.nilable(::DateTime)).void }
+      sig { params(category: T.nilable(::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoCategory), contents: T.nilable(T::Array[::StackOne::Shared::Content]), created_at: T.nilable(::DateTime), id: T.nilable(::String), name: T.nilable(::String), path: T.nilable(::String), remote_id: T.nilable(::String), updated_at: T.nilable(::DateTime)).void }
       def initialize(category: nil, contents: nil, created_at: nil, id: nil, name: nil, path: nil, remote_id: nil, updated_at: nil)
         @category = category
         @contents = contents

data/lib/stack_one/models/shared/file_format.rb

@@ -13,7 +13,7 @@ module StackOne
 
 
       field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
-
+      # The file format of the file, expressed as a file extension
       field :value, T.nilable(::StackOne::Shared::ContentValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::ContentValue, true) } }
 
 

data/lib/stack_one/models/shared/hriscreateworkeligibilityrequestdto_category.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+    # The category of the file
+    class HrisCreateWorkEligibilityRequestDtoCategory < ::StackOne::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
+      # The category of the file
+      field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value') } }
+
+
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::String)).void }
+      def initialize(source_value: nil, value: nil)
+        @source_value = source_value
+        @value = value
+      end
+    end
+  end
+end

data/lib/stack_one/models/shared/hrisdocumentapimodel.rb

@@ -11,8 +11,8 @@ module StackOne
     class HrisDocumentApiModel < ::StackOne::Utils::FieldAugmented
       extend T::Sig
 
-      # The category of the file
-      field :category, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('category') } }
+      # The category of the the document
+      field :category, T.nilable(::StackOne::Shared::HrisDocumentApiModelCategory), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('category') } }
       # The content of the file
       field :contents, T.nilable(T::Array[::StackOne::Shared::Content]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('contents') } }
       # The creation date of the file
@@ -26,12 +26,14 @@ module StackOne
       # Provider's unique identifier
       field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } }
       # The content type of the document
+      # 
+      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
       field :type, T.nilable(::StackOne::Shared::HrisDocumentApiModelType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('type') } }
       # The update date of the file
       field :updated_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('updated_at'), 'decoder': Utils.datetime_from_iso_format(true) } }
 
 
-      sig { params(category: T.nilable(::String), contents: T.nilable(T::Array[::StackOne::Shared::Content]), created_at: T.nilable(::DateTime), id: T.nilable(::String), name: T.nilable(::String), path: T.nilable(::String), remote_id: T.nilable(::String), type: T.nilable(::StackOne::Shared::HrisDocumentApiModelType), updated_at: T.nilable(::DateTime)).void }
+      sig { params(category: T.nilable(::StackOne::Shared::HrisDocumentApiModelCategory), contents: T.nilable(T::Array[::StackOne::Shared::Content]), created_at: T.nilable(::DateTime), id: T.nilable(::String), name: T.nilable(::String), path: T.nilable(::String), remote_id: T.nilable(::String), type: T.nilable(::StackOne::Shared::HrisDocumentApiModelType), updated_at: T.nilable(::DateTime)).void }
       def initialize(category: nil, contents: nil, created_at: nil, id: nil, name: nil, path: nil, remote_id: nil, type: nil, updated_at: nil)
         @category = category
         @contents = contents

data/lib/stack_one/models/shared/hrisdocumentapimodel_category.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+    # The category of the the document
+    class HrisDocumentApiModelCategory < ::StackOne::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
+      # The category of the file
+      field :value, T.nilable(::StackOne::Shared::HrisDocumentApiModelValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::HrisDocumentApiModelValue, true) } }
+
+
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::HrisDocumentApiModelValue)).void }
+      def initialize(source_value: nil, value: nil)
+        @source_value = source_value
+        @value = value
+      end
+    end
+  end
+end

data/lib/stack_one/models/shared/hrisdocumentapimodel_schemas_value.rb

@@ -0,0 +1,40 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+    # HrisDocumentApiModelSchemasValue - The category of the file
+    class HrisDocumentApiModelSchemasValue < T::Enum
+      enums do
+        APPLICATION = new('application')
+        ACADEMIC = new('academic')
+        CONTRACT = new('contract')
+        CERTIFICATES = new('certificates')
+        VISA = new('visa')
+        PASSPORT = new('passport')
+        DRIVER_LICENSE = new('driver_license')
+        PAYSLIP = new('payslip')
+        PAYROLL = new('payroll')
+        APPRAISAL = new('appraisal')
+        RESUME = new('resume')
+        POLICY = new('policy')
+        OFFER_LETTER = new('offer_letter')
+        POLICY_AGREEMENT = new('policy_agreement')
+        HOME_ADDRESS = new('home_address')
+        NATIONAL_ID = new('national_id')
+        CONFIDENTIAL = new('confidential')
+        SIGNED = new('signed')
+        SHARED = new('shared')
+        OTHER = new('other')
+        BENEFIT = new('benefit')
+        ID_VERIFICATION = new('id_verification')
+        UNMAPPED_VALUE = new('unmapped_value')
+      end
+    end
+
+  end
+end

data/lib/stack_one/models/shared/hrisdocumentapimodel_type.rb

@@ -8,16 +8,18 @@ module StackOne
   module Shared
   
     # The content type of the document
+    # 
+    # @deprecated  class: This will be removed in a future release, please migrate away from it as soon as possible.
     class HrisDocumentApiModelType < ::StackOne::Utils::FieldAugmented
       extend T::Sig
 
 
       field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
+      # The category of the file
+      field :value, T.nilable(::StackOne::Shared::HrisDocumentApiModelSchemasValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::HrisDocumentApiModelSchemasValue, true) } }
 
-      field :value, T.nilable(::StackOne::Shared::HrisDocumentApiModelValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::HrisDocumentApiModelValue, true) } }
 
-
-      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::HrisDocumentApiModelValue)).void }
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::HrisDocumentApiModelSchemasValue)).void }
       def initialize(source_value: nil, value: nil)
         @source_value = source_value
         @value = value

data/lib/stack_one/models/shared/hrisdocumentapimodel_value.rb

@@ -7,7 +7,7 @@
 module StackOne
   module Shared
   
-
+    # HrisDocumentApiModelValue - The category of the file
     class HrisDocumentApiModelValue < T::Enum
       enums do
         APPLICATION = new('application')
@@ -26,6 +26,9 @@ module StackOne
         POLICY_AGREEMENT = new('policy_agreement')
         HOME_ADDRESS = new('home_address')
         NATIONAL_ID = new('national_id')
+        CONFIDENTIAL = new('confidential')
+        SIGNED = new('signed')
+        SHARED = new('shared')
         OTHER = new('other')
         BENEFIT = new('benefit')
         ID_VERIFICATION = new('id_verification')

data/lib/stack_one/models/shared/hrisdocumentsuploadrequestdto.rb

@@ -0,0 +1,39 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+
+    class HrisDocumentsUploadRequestDto < ::StackOne::Utils::FieldAugmented
+      extend T::Sig
+
+      # The category to be associated with the file to be uploaded. Id will take precedence over name.
+      field :category, T.nilable(::StackOne::Shared::HrisDocumentsUploadRequestDtoCategory), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('category') } }
+      # The confidentiality level of the file to be uploaded
+      field :confidential, T.nilable(::StackOne::Shared::Confidential), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('confidential') } }
+      # The base64 encoded content of the file to upload
+      field :content, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content') } }
+      # The file format of the file
+      field :file_format, T.nilable(::StackOne::Shared::HrisDocumentsUploadRequestDtoFileFormat), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('file_format') } }
+      # The filename of the file to upload
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('name') } }
+      # The path for the file to be uploaded to
+      field :path, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('path') } }
+
+
+      sig { params(category: T.nilable(::StackOne::Shared::HrisDocumentsUploadRequestDtoCategory), confidential: T.nilable(::StackOne::Shared::Confidential), content: T.nilable(::String), file_format: T.nilable(::StackOne::Shared::HrisDocumentsUploadRequestDtoFileFormat), name: T.nilable(::String), path: T.nilable(::String)).void }
+      def initialize(category: nil, confidential: nil, content: nil, file_format: nil, name: nil, path: nil)
+        @category = category
+        @confidential = confidential
+        @content = content
+        @file_format = file_format
+        @name = name
+        @path = path
+      end
+    end
+  end
+end

data/lib/stack_one/models/shared/hrisdocumentsuploadrequestdto_category.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+    # The category to be associated with the file to be uploaded. Id will take precedence over name.
+    class HrisDocumentsUploadRequestDtoCategory < ::StackOne::Utils::FieldAugmented
+      extend T::Sig
+
+      # The provider specific category for associating uploaded files, if provided, the value will be ignored.
+      field :source_value, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
+      # The category name to associate with the file
+      field :value, T.nilable(::StackOne::Shared::HrisDocumentsUploadRequestDtoValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::HrisDocumentsUploadRequestDtoValue, true) } }
+
+
+      sig { params(source_value: T.nilable(::String), value: T.nilable(::StackOne::Shared::HrisDocumentsUploadRequestDtoValue)).void }
+      def initialize(source_value: nil, value: nil)
+        @source_value = source_value
+        @value = value
+      end
+    end
+  end
+end

data/lib/stack_one/models/shared/hrisdocumentsuploadrequestdto_file_format.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+    # The file format of the file
+    class HrisDocumentsUploadRequestDtoFileFormat < ::StackOne::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
+      # The file format of the file, expressed as a file extension
+      field :value, T.nilable(::StackOne::Shared::HrisDocumentsUploadRequestDtoSchemasFileFormatValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::HrisDocumentsUploadRequestDtoSchemasFileFormatValue, true) } }
+
+
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::HrisDocumentsUploadRequestDtoSchemasFileFormatValue)).void }
+      def initialize(source_value: nil, value: nil)
+        @source_value = source_value
+        @value = value
+      end
+    end
+  end
+end