lib/stack_one/models/shared/hrisdocumentapimodel.rb in stackone_client-0.2.18 vs lib/stack_one/models/shared/hrisdocumentapimodel.rb in stackone_client-0.2.26
- old
+ new
@@ -9,38 +9,48 @@
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 content of the file
+ # 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. Deprecated, use `url` and `file_format` one level up instead
+ #
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
field :contents, T.nilable(T::Array[::StackOne::Shared::Content]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('contents') } }
# The creation date of the file
field :created_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(true) } }
+ # The file format of the file
+ field :file_format, T.nilable(::StackOne::Shared::HrisDocumentApiModelFileFormat), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('file_format') } }
# Unique identifier
field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } }
# The name of the file
field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('name') } }
# The path where the file is stored
field :path, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('path') } }
# Provider's unique identifier
field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } }
+ # URL where the file content is located
+ field :remote_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_url') } }
# 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 }
- def initialize(category: nil, contents: nil, created_at: nil, id: nil, name: nil, path: nil, remote_id: nil, type: nil, updated_at: nil)
+ sig { params(category: T.nilable(::StackOne::Shared::HrisDocumentApiModelCategory), contents: T.nilable(T::Array[::StackOne::Shared::Content]), created_at: T.nilable(::DateTime), file_format: T.nilable(::StackOne::Shared::HrisDocumentApiModelFileFormat), id: T.nilable(::String), name: T.nilable(::String), path: T.nilable(::String), remote_id: T.nilable(::String), remote_url: T.nilable(::String), type: T.nilable(::StackOne::Shared::HrisDocumentApiModelType), updated_at: T.nilable(::DateTime)).void }
+ def initialize(category: nil, contents: nil, created_at: nil, file_format: nil, id: nil, name: nil, path: nil, remote_id: nil, remote_url: nil, type: nil, updated_at: nil)
@category = category
@contents = contents
@created_at = created_at
+ @file_format = file_format
@id = id
@name = name
@path = path
@remote_id = remote_id
+ @remote_url = remote_url
@type = type
@updated_at = updated_at
end
end
end