stackone_client 0.5.3 → 0.5.5

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

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+
+    class HRISTeamsResult < ::StackOne::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :data, ::StackOne::Shared::HRISTeam, { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } }
+
+      field :raw, T.nilable(T::Array[::StackOne::Shared::RawResponse]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('raw') } }
+
+
+      sig { params(data: ::StackOne::Shared::HRISTeam, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void }
+      def initialize(data: nil, raw: nil)
+        @data = data
+        @raw = raw
+      end
+    end
+  end
+end

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

@@ -14,10 +14,10 @@ module StackOne
 
       field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
       # The Locale Code of the language
-      field :value, T.nilable(::StackOne::Shared::CategoryValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::CategoryValue, true) } }
+      field :value, T.nilable(::StackOne::Shared::CategorySchemasValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::CategorySchemasValue, true) } }
 
 
-      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CategoryValue)).void }
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CategorySchemasValue)).void }
       def initialize(source_value: nil, value: nil)
         @source_value = source_value
         @value = value

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

@@ -8,16 +8,18 @@ module StackOne
   module Shared
   
     # The hierarchal level of the category
+    # 
+    # @deprecated  class: This will be removed in a future release, please migrate away from it as soon as possible.
     class Level < ::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::CategorySchemasValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::CategorySchemasValue, true) } }
+      field :value, T.nilable(::StackOne::Shared::CategorySchemasLevelValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::CategorySchemasLevelValue, true) } }
 
 
-      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CategorySchemasValue)).void }
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CategorySchemasLevelValue)).void }
       def initialize(source_value: nil, value: nil)
         @source_value = source_value
         @value = value

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

@@ -16,10 +16,12 @@ module StackOne
       # The date the assignment is due to be completed
       field :due_date, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('due_date') } }
       # The external reference associated with this assignment
+      # 
+      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
       field :external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_reference') } }
-      # The external reference of the learning object associated with this assignment
+      # The external reference of the learning object associated with this assignment, this is the main identifier for creating assignments.
       field :learning_object_external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('learning_object_external_reference') } }
-      # The learning_object_id associated with this assignment
+      # The learning_object_id associated with this assignment. This is not required unless specified in an integration.
       field :learning_object_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('learning_object_id') } }
       # Value to pass through to the provider
       field :passthrough, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } }

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

@@ -21,15 +21,9 @@ module StackOne
       # 
       # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
       field :content_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_id') } }
-      # The external ID associated with this completion
-      # 
-      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
-      field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_id') } }
-      # The external reference associated with this completion
-      field :external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_reference') } }
-      # The external reference of the learning object associated with this completion
+      # The external reference of the learning object associated with this completion, this is the main identifier for creating completions.
       field :learning_object_external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('learning_object_external_reference') } }
-      # The id of the learning object associated with this completion
+      # The id of the learning object associated with this completion. This is not required unless specified in an integration.
       field :learning_object_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('learning_object_id') } }
       # Value to pass through to the provider
       field :passthrough, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } }
@@ -37,13 +31,11 @@ module StackOne
       field :result, T.nilable(::StackOne::Shared::LmsCreateCompletionRequestDtoResult), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('result') } }
 
 
-      sig { params(completed_at: T.nilable(::String), content_external_reference: T.nilable(::String), content_id: T.nilable(::String), external_id: T.nilable(::String), external_reference: T.nilable(::String), learning_object_external_reference: T.nilable(::String), learning_object_id: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), result: T.nilable(::StackOne::Shared::LmsCreateCompletionRequestDtoResult)).void }
-      def initialize(completed_at: nil, content_external_reference: nil, content_id: nil, external_id: nil, external_reference: nil, learning_object_external_reference: nil, learning_object_id: nil, passthrough: nil, result: nil)
+      sig { params(completed_at: T.nilable(::String), content_external_reference: T.nilable(::String), content_id: T.nilable(::String), learning_object_external_reference: T.nilable(::String), learning_object_id: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), result: T.nilable(::StackOne::Shared::LmsCreateCompletionRequestDtoResult)).void }
+      def initialize(completed_at: nil, content_external_reference: nil, content_id: nil, learning_object_external_reference: nil, learning_object_id: nil, passthrough: nil, result: nil)
         @completed_at = completed_at
         @content_external_reference = content_external_reference
         @content_id = content_id
-        @external_id = external_id
-        @external_reference = external_reference
         @learning_object_external_reference = learning_object_external_reference
         @learning_object_id = learning_object_id
         @passthrough = passthrough

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

@@ -21,8 +21,6 @@ module StackOne
       field :content_type, T.nilable(::StackOne::Shared::LmsUpsertContentRequestDtoContentType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_type') } }
       # The external URL of the content
       field :content_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_url') } }
-      # The parent IDs associated with this content
-      field :course_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('course_ids') } }
       # The URL of the thumbnail image associated with the content.
       field :cover_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('cover_url') } }
       # The description of the content
@@ -35,8 +33,6 @@ module StackOne
       field :languages, T.nilable(T::Array[::StackOne::Shared::LanguageEnum]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('languages') } }
       # The order of the individual content within a content grouping. This is not applicable for pushing individual content.
       field :order, T.nilable(::Float), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('order') } }
-      # The name of the content provider
-      field :provider, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('provider') } }
       # A short description or summary for the content
       # 
       # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
@@ -49,21 +45,19 @@ module StackOne
       field :unified_custom_fields, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('unified_custom_fields') } }
 
 
-      sig { params(active: T.nilable(T::Boolean), additional_data: T.nilable(T::Array[::StackOne::Shared::AdditionalData]), categories: T.nilable(T::Array[::StackOne::Shared::CreateCategoriesApiModel]), content_type: T.nilable(::StackOne::Shared::LmsUpsertContentRequestDtoContentType), content_url: T.nilable(::String), course_ids: T.nilable(T::Array[::String]), cover_url: T.nilable(::String), description: T.nilable(::String), duration: T.nilable(::String), external_reference: T.nilable(::String), languages: T.nilable(T::Array[::StackOne::Shared::LanguageEnum]), order: T.nilable(::Float), provider: T.nilable(::String), short_description: T.nilable(::String), skills: T.nilable(T::Array[::StackOne::Shared::CreateSkillsApiModel]), title: T.nilable(::String), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object])).void }
-      def initialize(active: nil, additional_data: nil, categories: nil, content_type: nil, content_url: nil, course_ids: nil, cover_url: nil, description: nil, duration: nil, external_reference: nil, languages: nil, order: nil, provider: nil, short_description: nil, skills: nil, title: nil, unified_custom_fields: nil)
+      sig { params(active: T.nilable(T::Boolean), additional_data: T.nilable(T::Array[::StackOne::Shared::AdditionalData]), categories: T.nilable(T::Array[::StackOne::Shared::CreateCategoriesApiModel]), content_type: T.nilable(::StackOne::Shared::LmsUpsertContentRequestDtoContentType), content_url: T.nilable(::String), cover_url: T.nilable(::String), description: T.nilable(::String), duration: T.nilable(::String), external_reference: T.nilable(::String), languages: T.nilable(T::Array[::StackOne::Shared::LanguageEnum]), order: T.nilable(::Float), short_description: T.nilable(::String), skills: T.nilable(T::Array[::StackOne::Shared::CreateSkillsApiModel]), title: T.nilable(::String), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object])).void }
+      def initialize(active: nil, additional_data: nil, categories: nil, content_type: nil, content_url: nil, cover_url: nil, description: nil, duration: nil, external_reference: nil, languages: nil, order: nil, short_description: nil, skills: nil, title: nil, unified_custom_fields: nil)
         @active = active
         @additional_data = additional_data
         @categories = categories
         @content_type = content_type
         @content_url = content_url
-        @course_ids = course_ids
         @cover_url = cover_url
         @description = description
         @duration = duration
         @external_reference = external_reference
         @languages = languages
         @order = order
-        @provider = provider
         @short_description = short_description
         @skills = skills
         @title = title

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

@@ -17,8 +17,6 @@ module StackOne
       field :categories, T.nilable(T::Array[::StackOne::Shared::CreateCategoriesApiModel]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('categories') } }
       # The content associated with this course
       field :content, T.nilable(T::Array[::StackOne::Shared::CreateContentApiModel]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content') } }
-      # The child IDs associated with this course
-      field :content_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_ids') } }
       # The URL of the thumbnail image associated with the course.
       field :cover_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('cover_url') } }
       # The description of the course
@@ -29,8 +27,6 @@ module StackOne
       field :external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_reference') } }
       # The languages associated with this course
       field :languages, T.nilable(T::Array[::StackOne::Shared::LanguageEnum]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('languages') } }
-      # The name of the course provider
-      field :provider, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('provider') } }
       # The skills associated with this content
       field :skills, T.nilable(T::Array[::StackOne::Shared::CreateSkillsApiModel]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('skills') } }
       # The title of the course
@@ -41,18 +37,16 @@ module StackOne
       field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('url') } }
 
 
-      sig { params(active: T.nilable(T::Boolean), categories: T.nilable(T::Array[::StackOne::Shared::CreateCategoriesApiModel]), content: T.nilable(T::Array[::StackOne::Shared::CreateContentApiModel]), content_ids: T.nilable(T::Array[::String]), cover_url: T.nilable(::String), description: T.nilable(::String), duration: T.nilable(::String), external_reference: T.nilable(::String), languages: T.nilable(T::Array[::StackOne::Shared::LanguageEnum]), provider: T.nilable(::String), skills: T.nilable(T::Array[::StackOne::Shared::CreateSkillsApiModel]), title: T.nilable(::String), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object]), url: T.nilable(::String)).void }
-      def initialize(active: nil, categories: nil, content: nil, content_ids: nil, cover_url: nil, description: nil, duration: nil, external_reference: nil, languages: nil, provider: nil, skills: nil, title: nil, unified_custom_fields: nil, url: nil)
+      sig { params(active: T.nilable(T::Boolean), categories: T.nilable(T::Array[::StackOne::Shared::CreateCategoriesApiModel]), content: T.nilable(T::Array[::StackOne::Shared::CreateContentApiModel]), cover_url: T.nilable(::String), description: T.nilable(::String), duration: T.nilable(::String), external_reference: T.nilable(::String), languages: T.nilable(T::Array[::StackOne::Shared::LanguageEnum]), skills: T.nilable(T::Array[::StackOne::Shared::CreateSkillsApiModel]), title: T.nilable(::String), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object]), url: T.nilable(::String)).void }
+      def initialize(active: nil, categories: nil, content: nil, cover_url: nil, description: nil, duration: nil, external_reference: nil, languages: nil, skills: nil, title: nil, unified_custom_fields: nil, url: nil)
         @active = active
         @categories = categories
         @content = content
-        @content_ids = content_ids
         @cover_url = cover_url
         @description = description
         @duration = duration
         @external_reference = external_reference
         @languages = languages
-        @provider = provider
         @skills = skills
         @title = title
         @unified_custom_fields = unified_custom_fields

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

@@ -13,9 +13,17 @@ module StackOne
 
       # Whether the skill is active and therefore available for use
       field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('active') } }
+      # The user competency level of the skill ranked out of 5
+      field :competency, T.nilable(::StackOne::Shared::SkillsCompetency), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('competency') } }
+      # The hierarchal level of the skill
+      field :hierarchy, T.nilable(::StackOne::Shared::SkillsHierarchy), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('hierarchy') } }
       # The ID associated with this skill
       field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } }
+      # The language associated with this skill
+      field :language, T.nilable(::StackOne::Shared::SkillsLanguage), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('language') } }
       # The hierarchal level of the skill
+      # 
+      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
       field :level, T.nilable(::StackOne::Shared::SkillsLevel), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('level') } }
       # The name associated with this skill
       field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('name') } }
@@ -23,10 +31,13 @@ module StackOne
       field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } }
 
 
-      sig { params(active: T.nilable(T::Boolean), id: T.nilable(::String), level: T.nilable(::StackOne::Shared::SkillsLevel), name: T.nilable(::String), remote_id: T.nilable(::String)).void }
-      def initialize(active: nil, id: nil, level: nil, name: nil, remote_id: nil)
+      sig { params(active: T.nilable(T::Boolean), competency: T.nilable(::StackOne::Shared::SkillsCompetency), hierarchy: T.nilable(::StackOne::Shared::SkillsHierarchy), id: T.nilable(::String), language: T.nilable(::StackOne::Shared::SkillsLanguage), level: T.nilable(::StackOne::Shared::SkillsLevel), name: T.nilable(::String), remote_id: T.nilable(::String)).void }
+      def initialize(active: nil, competency: nil, hierarchy: nil, id: nil, language: nil, level: nil, name: nil, remote_id: nil)
         @active = active
+        @competency = competency
+        @hierarchy = hierarchy
         @id = id
+        @language = language
         @level = level
         @name = name
         @remote_id = remote_id

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

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+    # The user competency level of the skill ranked out of 5
+    class SkillsCompetency < ::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::SkillsValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::SkillsValue, true) } }
+
+
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsValue)).void }
+      def initialize(source_value: nil, value: nil)
+        @source_value = source_value
+        @value = value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+    # The hierarchal level of the skill
+    class SkillsHierarchy < ::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::SkillsSchemasValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::SkillsSchemasValue, true) } }
+
+
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsSchemasValue)).void }
+      def initialize(source_value: nil, value: nil)
+        @source_value = source_value
+        @value = value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module StackOne
+  module Shared
+  
+    # The language associated with this skill
+    class SkillsLanguage < ::StackOne::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
+      # The Locale Code of the language
+      field :value, T.nilable(::StackOne::Shared::SkillsSchemasLanguageValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::SkillsSchemasLanguageValue, true) } }
+
+
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsSchemasLanguageValue)).void }
+      def initialize(source_value: nil, value: nil)
+        @source_value = source_value
+        @value = value
+      end
+    end
+  end
+end

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

@@ -8,16 +8,18 @@ module StackOne
   module Shared
   
     # The hierarchal level of the skill
+    # 
+    # @deprecated  class: This will be removed in a future release, please migrate away from it as soon as possible.
     class SkillsLevel < ::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::SkillsValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::SkillsValue, true) } }
+      field :value, T.nilable(::StackOne::Shared::SkillsSchemasLevelValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::SkillsSchemasLevelValue, true) } }
 
 
-      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsValue)).void }
+      sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsSchemasLevelValue)).void }
       def initialize(source_value: nil, value: nil)
         @source_value = source_value
         @value = value