stackone_client 0.5.4 → 0.5.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stack_one/ats.rb +112 -0
  3. data/lib/stack_one/hris.rb +135 -0
  4. data/lib/stack_one/lms.rb +46 -0
  5. data/lib/stack_one/models/operations/ats_update_assessments_result_request.rb +30 -0
  6. data/lib/stack_one/models/operations/ats_update_assessments_result_response.rb +36 -0
  7. data/lib/stack_one/models/operations/ats_update_background_check_result_request.rb +30 -0
  8. data/lib/stack_one/models/operations/ats_update_background_check_result_response.rb +36 -0
  9. data/lib/stack_one/models/operations/hris_create_employee_skill_request.rb +30 -0
  10. data/lib/stack_one/models/operations/hris_create_employee_skill_response.rb +36 -0
  11. data/lib/stack_one/models/operations/hris_get_team_group_request.rb +36 -0
  12. data/lib/stack_one/models/operations/hris_get_team_group_response.rb +36 -0
  13. data/lib/stack_one/models/operations/hris_list_team_groups_queryparam_filter.rb +24 -0
  14. data/lib/stack_one/models/operations/hris_list_team_groups_request.rb +52 -0
  15. data/lib/stack_one/models/operations/hris_list_team_groups_response.rb +36 -0
  16. data/lib/stack_one/models/operations/lms_delete_user_completion_request.rb +30 -0
  17. data/lib/stack_one/models/operations/lms_delete_user_completion_response.rb +36 -0
  18. data/lib/stack_one/models/operations.rb +13 -0
  19. data/lib/stack_one/models/shared/additionaldata.rb +1 -1
  20. data/lib/stack_one/models/shared/application.rb +2 -0
  21. data/lib/stack_one/models/shared/assignment.rb +4 -2
  22. data/lib/stack_one/models/shared/atsupdateapplicationrequestdto.rb +2 -10
  23. data/lib/stack_one/models/shared/atsupdatebackgroundcheckresultrequestdto.rb +51 -0
  24. data/lib/stack_one/models/shared/atsupdatebackgroundcheckresultrequestdto_candidate.rb +27 -0
  25. data/lib/stack_one/models/shared/atsupdatebackgroundcheckresultrequestdto_result.rb +27 -0
  26. data/lib/stack_one/models/shared/atsupdatebackgroundcheckresultrequestdto_score.rb +33 -0
  27. data/lib/stack_one/models/shared/atsupdatebackgroundcheckresultrequestdto_value.rb +21 -0
  28. data/lib/stack_one/models/shared/atsupdatecandidatesassessmentsresultsrequestdto.rb +51 -0
  29. data/lib/stack_one/models/shared/atsupdatecandidatesassessmentsresultsrequestdto_candidate.rb +27 -0
  30. data/lib/stack_one/models/shared/atsupdatecandidatesassessmentsresultsrequestdto_result.rb +27 -0
  31. data/lib/stack_one/models/shared/atsupdatecandidatesassessmentsresultsrequestdto_score.rb +33 -0
  32. data/lib/stack_one/models/shared/atsupdatecandidatesassessmentsresultsrequestdto_value.rb +21 -0
  33. data/lib/stack_one/models/shared/category.rb +7 -2
  34. data/lib/stack_one/models/shared/category_schemas_level_value.rb +19 -0
  35. data/lib/stack_one/models/shared/category_schemas_value.rb +411 -4
  36. data/lib/stack_one/models/shared/category_value.rb +4 -411
  37. data/lib/stack_one/models/shared/completion.rb +4 -2
  38. data/lib/stack_one/models/shared/createcategoriesapimodel.rb +7 -2
  39. data/lib/stack_one/models/shared/createcategoriesapimodel_hierarchy.rb +27 -0
  40. data/lib/stack_one/models/shared/createcategoriesapimodel_language.rb +2 -2
  41. data/lib/stack_one/models/shared/createcategoriesapimodel_level.rb +4 -2
  42. data/lib/stack_one/models/shared/createcategoriesapimodel_schemas_level_value.rb +19 -0
  43. data/lib/stack_one/models/shared/createcategoriesapimodel_schemas_value.rb +411 -4
  44. data/lib/stack_one/models/shared/createcategoriesapimodel_value.rb +4 -411
  45. data/lib/stack_one/models/shared/createcontentapimodel.rb +5 -2
  46. data/lib/stack_one/models/shared/createskillsapimodel.rb +13 -2
  47. data/lib/stack_one/models/shared/createskillsapimodel_hierarchy.rb +27 -0
  48. data/lib/stack_one/models/shared/createskillsapimodel_language.rb +27 -0
  49. data/lib/stack_one/models/shared/createskillsapimodel_level.rb +4 -2
  50. data/lib/stack_one/models/shared/createskillsapimodel_schemas_level_value.rb +19 -0
  51. data/lib/stack_one/models/shared/createskillsapimodel_schemas_proficiency_value.rb +21 -0
  52. data/lib/stack_one/models/shared/createskillsapimodel_schemas_value.rb +426 -0
  53. data/lib/stack_one/models/shared/deleteresult.rb +30 -0
  54. data/lib/stack_one/models/shared/employee.rb +7 -2
  55. data/lib/stack_one/models/shared/hierarchy.rb +27 -0
  56. data/lib/stack_one/models/shared/hriscreateemployeerequestdto.rb +7 -2
  57. data/lib/stack_one/models/shared/hrisskillscreaterequestdto.rb +27 -0
  58. data/lib/stack_one/models/shared/hristeam.rb +48 -0
  59. data/lib/stack_one/models/shared/hristeam_type.rb +27 -0
  60. data/lib/stack_one/models/shared/hristeam_value.rb +17 -0
  61. data/lib/stack_one/models/shared/hristeamspaginated.rb +33 -0
  62. data/lib/stack_one/models/shared/hristeamsresult.rb +27 -0
  63. data/lib/stack_one/models/shared/hrisupdateemployeerequestdto.rb +7 -2
  64. data/lib/stack_one/models/shared/language.rb +2 -2
  65. data/lib/stack_one/models/shared/level.rb +4 -2
  66. data/lib/stack_one/models/shared/linkedaccount.rb +5 -2
  67. data/lib/stack_one/models/shared/lmscreateassignmentrequestdto.rb +4 -2
  68. data/lib/stack_one/models/shared/lmscreatecompletionrequestdto.rb +4 -12
  69. data/lib/stack_one/models/shared/lmsupsertcontentrequestdto.rb +5 -8
  70. data/lib/stack_one/models/shared/lmsupsertcourserequestdto.rb +2 -8
  71. data/lib/stack_one/models/shared/proficiency.rb +27 -0
  72. data/lib/stack_one/models/shared/skills.rb +13 -2
  73. data/lib/stack_one/models/shared/skills_hierarchy.rb +27 -0
  74. data/lib/stack_one/models/shared/skills_language.rb +27 -0
  75. data/lib/stack_one/models/shared/skills_level.rb +4 -2
  76. data/lib/stack_one/models/shared/skills_proficiency.rb +27 -0
  77. data/lib/stack_one/models/shared/skills_schemas_level_value.rb +19 -0
  78. data/lib/stack_one/models/shared/skills_schemas_proficiency_value.rb +21 -0
  79. data/lib/stack_one/models/shared/skills_schemas_value.rb +426 -0
  80. data/lib/stack_one/models/shared/updateemployeeapimodel.rb +7 -2
  81. data/lib/stack_one/models/shared.rb +35 -2
  82. data/lib/stack_one/sdkconfiguration.rb +3 -3
  83. metadata +48 -2
@@ -0,0 +1,17 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Shared
9
+
10
+
11
+ class HRISTeamValue < T::Enum
12
+ enums do
13
+ TEAM = new('team')
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,33 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Shared
9
+
10
+
11
+ class HRISTeamsPaginated < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+
15
+ field :data, T::Array[::StackOne::Shared::HRISTeam], { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } }
16
+
17
+ field :next_, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('next') } }
18
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
19
+ field :next_page, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('next_page') } }
20
+
21
+ field :raw, T.nilable(T::Array[::StackOne::Shared::RawResponse]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('raw') } }
22
+
23
+
24
+ sig { params(data: T::Array[::StackOne::Shared::HRISTeam], next_: T.nilable(::String), next_page: T.nilable(::String), raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void }
25
+ def initialize(data: nil, next_: nil, next_page: nil, raw: nil)
26
+ @data = data
27
+ @next_ = next_
28
+ @next_page = next_page
29
+ @raw = raw
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,27 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Shared
9
+
10
+
11
+ class HRISTeamsResult < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+
15
+ field :data, ::StackOne::Shared::HRISTeam, { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } }
16
+
17
+ field :raw, T.nilable(T::Array[::StackOne::Shared::RawResponse]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('raw') } }
18
+
19
+
20
+ sig { params(data: ::StackOne::Shared::HRISTeam, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void }
21
+ def initialize(data: nil, raw: nil)
22
+ @data = data
23
+ @raw = raw
24
+ end
25
+ end
26
+ end
27
+ end
@@ -21,7 +21,11 @@ module StackOne
21
21
  field :birthday, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('birthday'), 'decoder': Utils.datetime_from_iso_format(true) } }
22
22
  # The citizenships of the Employee
23
23
  field :citizenships, T.nilable(T::Array[::StackOne::Shared::CountryCodeEnum]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('citizenships') } }
24
+ # The employee company id
25
+ field :company_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('company_id') } }
24
26
  # The employee company name
27
+ #
28
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
25
29
  field :company_name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('company_name') } }
26
30
  # The employee custom fields
27
31
  field :custom_fields, T.nilable(T::Array[::StackOne::Shared::CustomFields]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('custom_fields') } }
@@ -89,13 +93,14 @@ module StackOne
89
93
  field :work_phone_number, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('work_phone_number') } }
90
94
 
91
95
 
92
- sig { params(avatar: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoAvatar), avatar_url: T.nilable(::String), benefits: T.nilable(T::Array[::StackOne::Shared::CreateHRISBenefit]), birthday: T.nilable(::DateTime), citizenships: T.nilable(T::Array[::StackOne::Shared::CountryCodeEnum]), company_name: T.nilable(::String), custom_fields: T.nilable(T::Array[::StackOne::Shared::CustomFields]), date_of_birth: T.nilable(::DateTime), department: T.nilable(::String), department_id: T.nilable(::String), display_name: T.nilable(::String), employee_number: T.nilable(::String), employment_contract_type: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoEmploymentContractType), employment_status: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoEmploymentStatus), employment_type: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoEmploymentType), ethnicity: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoEthnicity), first_name: T.nilable(::String), gender: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoGender), hire_date: T.nilable(::DateTime), home_location: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoHomeLocation), job_id: T.nilable(::String), job_title: T.nilable(::String), last_name: T.nilable(::String), manager_id: T.nilable(::String), marital_status: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoMaritalStatus), name: T.nilable(::String), national_identity_number: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoNationalIdentityNumber), passthrough: T.nilable(T::Hash[Symbol, ::Object]), personal_email: T.nilable(::String), personal_phone_number: T.nilable(::String), preferred_language: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoPreferredLanguage), start_date: T.nilable(::DateTime), tenure: T.nilable(::Float), termination_date: T.nilable(::DateTime), work_anniversary: T.nilable(::DateTime), work_email: T.nilable(::String), work_location: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoWorkLocation), work_phone_number: T.nilable(::String)).void }
93
- def initialize(avatar: nil, avatar_url: nil, benefits: nil, birthday: nil, citizenships: nil, company_name: nil, custom_fields: nil, date_of_birth: nil, department: nil, department_id: nil, display_name: nil, employee_number: nil, employment_contract_type: nil, employment_status: nil, employment_type: nil, ethnicity: nil, first_name: nil, gender: nil, hire_date: nil, home_location: nil, job_id: nil, job_title: nil, last_name: nil, manager_id: nil, marital_status: nil, name: nil, national_identity_number: nil, passthrough: nil, personal_email: nil, personal_phone_number: nil, preferred_language: nil, start_date: nil, tenure: nil, termination_date: nil, work_anniversary: nil, work_email: nil, work_location: nil, work_phone_number: nil)
96
+ sig { params(avatar: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoAvatar), avatar_url: T.nilable(::String), benefits: T.nilable(T::Array[::StackOne::Shared::CreateHRISBenefit]), birthday: T.nilable(::DateTime), citizenships: T.nilable(T::Array[::StackOne::Shared::CountryCodeEnum]), company_id: T.nilable(::String), company_name: T.nilable(::String), custom_fields: T.nilable(T::Array[::StackOne::Shared::CustomFields]), date_of_birth: T.nilable(::DateTime), department: T.nilable(::String), department_id: T.nilable(::String), display_name: T.nilable(::String), employee_number: T.nilable(::String), employment_contract_type: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoEmploymentContractType), employment_status: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoEmploymentStatus), employment_type: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoEmploymentType), ethnicity: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoEthnicity), first_name: T.nilable(::String), gender: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoGender), hire_date: T.nilable(::DateTime), home_location: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoHomeLocation), job_id: T.nilable(::String), job_title: T.nilable(::String), last_name: T.nilable(::String), manager_id: T.nilable(::String), marital_status: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoMaritalStatus), name: T.nilable(::String), national_identity_number: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoNationalIdentityNumber), passthrough: T.nilable(T::Hash[Symbol, ::Object]), personal_email: T.nilable(::String), personal_phone_number: T.nilable(::String), preferred_language: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoPreferredLanguage), start_date: T.nilable(::DateTime), tenure: T.nilable(::Float), termination_date: T.nilable(::DateTime), work_anniversary: T.nilable(::DateTime), work_email: T.nilable(::String), work_location: T.nilable(::StackOne::Shared::HrisUpdateEmployeeRequestDtoWorkLocation), work_phone_number: T.nilable(::String)).void }
97
+ def initialize(avatar: nil, avatar_url: nil, benefits: nil, birthday: nil, citizenships: nil, company_id: nil, company_name: nil, custom_fields: nil, date_of_birth: nil, department: nil, department_id: nil, display_name: nil, employee_number: nil, employment_contract_type: nil, employment_status: nil, employment_type: nil, ethnicity: nil, first_name: nil, gender: nil, hire_date: nil, home_location: nil, job_id: nil, job_title: nil, last_name: nil, manager_id: nil, marital_status: nil, name: nil, national_identity_number: nil, passthrough: nil, personal_email: nil, personal_phone_number: nil, preferred_language: nil, start_date: nil, tenure: nil, termination_date: nil, work_anniversary: nil, work_email: nil, work_location: nil, work_phone_number: nil)
94
98
  @avatar = avatar
95
99
  @avatar_url = avatar_url
96
100
  @benefits = benefits
97
101
  @birthday = birthday
98
102
  @citizenships = citizenships
103
+ @company_id = company_id
99
104
  @company_name = company_name
100
105
  @custom_fields = custom_fields
101
106
  @date_of_birth = date_of_birth
@@ -14,10 +14,10 @@ module StackOne
14
14
 
15
15
  field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
16
16
  # The Locale Code of the language
17
- 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) } }
17
+ 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) } }
18
18
 
19
19
 
20
- sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CategoryValue)).void }
20
+ sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CategorySchemasValue)).void }
21
21
  def initialize(source_value: nil, value: nil)
22
22
  @source_value = source_value
23
23
  @value = value
@@ -8,16 +8,18 @@ module StackOne
8
8
  module Shared
9
9
 
10
10
  # The hierarchal level of the category
11
+ #
12
+ # @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
11
13
  class Level < ::StackOne::Utils::FieldAugmented
12
14
  extend T::Sig
13
15
 
14
16
 
15
17
  field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
16
18
 
17
- 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) } }
19
+ 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) } }
18
20
 
19
21
 
20
- sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CategorySchemasValue)).void }
22
+ sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CategorySchemasLevelValue)).void }
21
23
  def initialize(source_value: nil, value: nil)
22
24
  @source_value = source_value
23
25
  @value = value
@@ -32,13 +32,15 @@ module StackOne
32
32
 
33
33
  field :origin_username, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('origin_username') } }
34
34
 
35
+ field :provider_name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('provider_name') } }
36
+
35
37
  field :setup_information, T.nilable(::StackOne::Shared::SetupInformation), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('setup_information') } }
36
38
 
37
39
  field :status_reasons, T.nilable(T::Array[::StackOne::Shared::StatusReason]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('status_reasons') } }
38
40
 
39
41
 
40
- sig { params(created_at: ::DateTime, id: ::String, origin_owner_id: ::String, origin_owner_name: ::String, provider: ::String, status: ::StackOne::Shared::LinkedAccountStatus, updated_at: ::DateTime, credentials: T.nilable(::StackOne::Shared::Credentials), label: T.nilable(::String), origin_username: T.nilable(::String), setup_information: T.nilable(::StackOne::Shared::SetupInformation), status_reasons: T.nilable(T::Array[::StackOne::Shared::StatusReason])).void }
41
- def initialize(created_at: nil, id: nil, origin_owner_id: nil, origin_owner_name: nil, provider: nil, status: nil, updated_at: nil, credentials: nil, label: nil, origin_username: nil, setup_information: nil, status_reasons: nil)
42
+ sig { params(created_at: ::DateTime, id: ::String, origin_owner_id: ::String, origin_owner_name: ::String, provider: ::String, status: ::StackOne::Shared::LinkedAccountStatus, updated_at: ::DateTime, credentials: T.nilable(::StackOne::Shared::Credentials), label: T.nilable(::String), origin_username: T.nilable(::String), provider_name: T.nilable(::String), setup_information: T.nilable(::StackOne::Shared::SetupInformation), status_reasons: T.nilable(T::Array[::StackOne::Shared::StatusReason])).void }
43
+ def initialize(created_at: nil, id: nil, origin_owner_id: nil, origin_owner_name: nil, provider: nil, status: nil, updated_at: nil, credentials: nil, label: nil, origin_username: nil, provider_name: nil, setup_information: nil, status_reasons: nil)
42
44
  @created_at = created_at
43
45
  @id = id
44
46
  @origin_owner_id = origin_owner_id
@@ -49,6 +51,7 @@ module StackOne
49
51
  @credentials = credentials
50
52
  @label = label
51
53
  @origin_username = origin_username
54
+ @provider_name = provider_name
52
55
  @setup_information = setup_information
53
56
  @status_reasons = status_reasons
54
57
  end
@@ -16,10 +16,12 @@ module StackOne
16
16
  # The date the assignment is due to be completed
17
17
  field :due_date, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('due_date') } }
18
18
  # The external reference associated with this assignment
19
+ #
20
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
19
21
  field :external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_reference') } }
20
- # The external reference of the learning object associated with this assignment
22
+ # The external reference of the learning object associated with this assignment, this is the main identifier for creating assignments.
21
23
  field :learning_object_external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('learning_object_external_reference') } }
22
- # The learning_object_id associated with this assignment
24
+ # The learning_object_id associated with this assignment. This is not required unless specified in an integration.
23
25
  field :learning_object_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('learning_object_id') } }
24
26
  # Value to pass through to the provider
25
27
  field :passthrough, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } }
@@ -21,15 +21,9 @@ module StackOne
21
21
  #
22
22
  # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
23
23
  field :content_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_id') } }
24
- # The external ID associated with this completion
25
- #
26
- # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
27
- field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_id') } }
28
- # The external reference associated with this completion
29
- field :external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_reference') } }
30
- # The external reference of the learning object associated with this completion
24
+ # The external reference of the learning object associated with this completion, this is the main identifier for creating completions.
31
25
  field :learning_object_external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('learning_object_external_reference') } }
32
- # The id of the learning object associated with this completion
26
+ # The id of the learning object associated with this completion. This is not required unless specified in an integration.
33
27
  field :learning_object_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('learning_object_id') } }
34
28
  # Value to pass through to the provider
35
29
  field :passthrough, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } }
@@ -37,13 +31,11 @@ module StackOne
37
31
  field :result, T.nilable(::StackOne::Shared::LmsCreateCompletionRequestDtoResult), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('result') } }
38
32
 
39
33
 
40
- 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 }
41
- 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)
34
+ 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 }
35
+ 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)
42
36
  @completed_at = completed_at
43
37
  @content_external_reference = content_external_reference
44
38
  @content_id = content_id
45
- @external_id = external_id
46
- @external_reference = external_reference
47
39
  @learning_object_external_reference = learning_object_external_reference
48
40
  @learning_object_id = learning_object_id
49
41
  @passthrough = passthrough
@@ -21,8 +21,6 @@ module StackOne
21
21
  field :content_type, T.nilable(::StackOne::Shared::LmsUpsertContentRequestDtoContentType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_type') } }
22
22
  # The external URL of the content
23
23
  field :content_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_url') } }
24
- # The parent IDs associated with this content
25
- field :course_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('course_ids') } }
26
24
  # The URL of the thumbnail image associated with the content.
27
25
  field :cover_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('cover_url') } }
28
26
  # The description of the content
@@ -33,10 +31,10 @@ module StackOne
33
31
  field :external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_reference') } }
34
32
  # The languages associated with this content
35
33
  field :languages, T.nilable(T::Array[::StackOne::Shared::LanguageEnum]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('languages') } }
34
+ # The mobile friendly URL of the content
35
+ field :mobile_launch_content_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('mobile_launch_content_url') } }
36
36
  # The order of the individual content within a content grouping. This is not applicable for pushing individual content.
37
37
  field :order, T.nilable(::Float), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('order') } }
38
- # The name of the content provider
39
- field :provider, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('provider') } }
40
38
  # A short description or summary for the content
41
39
  #
42
40
  # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
@@ -49,21 +47,20 @@ module StackOne
49
47
  field :unified_custom_fields, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('unified_custom_fields') } }
50
48
 
51
49
 
52
- 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 }
53
- 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)
50
+ 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]), mobile_launch_content_url: T.nilable(::String), 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 }
51
+ 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, mobile_launch_content_url: nil, order: nil, short_description: nil, skills: nil, title: nil, unified_custom_fields: nil)
54
52
  @active = active
55
53
  @additional_data = additional_data
56
54
  @categories = categories
57
55
  @content_type = content_type
58
56
  @content_url = content_url
59
- @course_ids = course_ids
60
57
  @cover_url = cover_url
61
58
  @description = description
62
59
  @duration = duration
63
60
  @external_reference = external_reference
64
61
  @languages = languages
62
+ @mobile_launch_content_url = mobile_launch_content_url
65
63
  @order = order
66
- @provider = provider
67
64
  @short_description = short_description
68
65
  @skills = skills
69
66
  @title = title
@@ -17,8 +17,6 @@ module StackOne
17
17
  field :categories, T.nilable(T::Array[::StackOne::Shared::CreateCategoriesApiModel]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('categories') } }
18
18
  # The content associated with this course
19
19
  field :content, T.nilable(T::Array[::StackOne::Shared::CreateContentApiModel]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content') } }
20
- # The child IDs associated with this course
21
- field :content_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_ids') } }
22
20
  # The URL of the thumbnail image associated with the course.
23
21
  field :cover_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('cover_url') } }
24
22
  # The description of the course
@@ -29,8 +27,6 @@ module StackOne
29
27
  field :external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_reference') } }
30
28
  # The languages associated with this course
31
29
  field :languages, T.nilable(T::Array[::StackOne::Shared::LanguageEnum]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('languages') } }
32
- # The name of the course provider
33
- field :provider, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('provider') } }
34
30
  # The skills associated with this content
35
31
  field :skills, T.nilable(T::Array[::StackOne::Shared::CreateSkillsApiModel]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('skills') } }
36
32
  # The title of the course
@@ -41,18 +37,16 @@ module StackOne
41
37
  field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('url') } }
42
38
 
43
39
 
44
- 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 }
45
- 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)
40
+ 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 }
41
+ 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)
46
42
  @active = active
47
43
  @categories = categories
48
44
  @content = content
49
- @content_ids = content_ids
50
45
  @cover_url = cover_url
51
46
  @description = description
52
47
  @duration = duration
53
48
  @external_reference = external_reference
54
49
  @languages = languages
55
- @provider = provider
56
50
  @skills = skills
57
51
  @title = title
58
52
  @unified_custom_fields = unified_custom_fields
@@ -0,0 +1,27 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Shared
9
+
10
+ # The user proficiency level of the skill ranked out of 5
11
+ class Proficiency < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+
15
+ field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
16
+
17
+ field :value, T.nilable(::StackOne::Shared::CreateSkillsApiModelSchemasProficiencyValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::CreateSkillsApiModelSchemasProficiencyValue, true) } }
18
+
19
+
20
+ sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CreateSkillsApiModelSchemasProficiencyValue)).void }
21
+ def initialize(source_value: nil, value: nil)
22
+ @source_value = source_value
23
+ @value = value
24
+ end
25
+ end
26
+ end
27
+ end
@@ -13,22 +13,33 @@ module StackOne
13
13
 
14
14
  # Whether the skill is active and therefore available for use
15
15
  field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('active') } }
16
+ # The hierarchal level of the skill
17
+ field :hierarchy, T.nilable(::StackOne::Shared::SkillsHierarchy), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('hierarchy') } }
16
18
  # The ID associated with this skill
17
19
  field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } }
20
+ # The language associated with this skill
21
+ field :language, T.nilable(::StackOne::Shared::SkillsLanguage), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('language') } }
18
22
  # The hierarchal level of the skill
23
+ #
24
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
19
25
  field :level, T.nilable(::StackOne::Shared::SkillsLevel), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('level') } }
20
26
  # The name associated with this skill
21
27
  field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('name') } }
28
+ # The user proficiency level of the skill ranked out of 5
29
+ field :proficiency, T.nilable(::StackOne::Shared::SkillsProficiency), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('proficiency') } }
22
30
  # Provider's unique identifier
23
31
  field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } }
24
32
 
25
33
 
26
- 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 }
27
- def initialize(active: nil, id: nil, level: nil, name: nil, remote_id: nil)
34
+ sig { params(active: T.nilable(T::Boolean), 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), proficiency: T.nilable(::StackOne::Shared::SkillsProficiency), remote_id: T.nilable(::String)).void }
35
+ def initialize(active: nil, hierarchy: nil, id: nil, language: nil, level: nil, name: nil, proficiency: nil, remote_id: nil)
28
36
  @active = active
37
+ @hierarchy = hierarchy
29
38
  @id = id
39
+ @language = language
30
40
  @level = level
31
41
  @name = name
42
+ @proficiency = proficiency
32
43
  @remote_id = remote_id
33
44
  end
34
45
  end
@@ -0,0 +1,27 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Shared
9
+
10
+ # The hierarchal level of the skill
11
+ class SkillsHierarchy < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+
15
+ field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
16
+
17
+ 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) } }
18
+
19
+
20
+ sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsValue)).void }
21
+ def initialize(source_value: nil, value: nil)
22
+ @source_value = source_value
23
+ @value = value
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,27 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Shared
9
+
10
+ # The language associated with this skill
11
+ class SkillsLanguage < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+
15
+ field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
16
+ # The Locale Code of the language
17
+ 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) } }
18
+
19
+
20
+ sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsSchemasValue)).void }
21
+ def initialize(source_value: nil, value: nil)
22
+ @source_value = source_value
23
+ @value = value
24
+ end
25
+ end
26
+ end
27
+ end
@@ -8,16 +8,18 @@ module StackOne
8
8
  module Shared
9
9
 
10
10
  # The hierarchal level of the skill
11
+ #
12
+ # @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
11
13
  class SkillsLevel < ::StackOne::Utils::FieldAugmented
12
14
  extend T::Sig
13
15
 
14
16
 
15
17
  field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
16
18
 
17
- 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) } }
19
+ 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) } }
18
20
 
19
21
 
20
- sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsValue)).void }
22
+ sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsSchemasLevelValue)).void }
21
23
  def initialize(source_value: nil, value: nil)
22
24
  @source_value = source_value
23
25
  @value = value
@@ -0,0 +1,27 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Shared
9
+
10
+ # The user proficiency level of the skill ranked out of 5
11
+ class SkillsProficiency < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+
15
+ field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } }
16
+
17
+ field :value, T.nilable(::StackOne::Shared::SkillsSchemasProficiencyValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::SkillsSchemasProficiencyValue, true) } }
18
+
19
+
20
+ sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::SkillsSchemasProficiencyValue)).void }
21
+ def initialize(source_value: nil, value: nil)
22
+ @source_value = source_value
23
+ @value = value
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,19 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Shared
9
+
10
+
11
+ class SkillsSchemasLevelValue < T::Enum
12
+ enums do
13
+ PRIMARY = new('primary')
14
+ SECONDARY = new('secondary')
15
+ TERTIARY = new('tertiary')
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,21 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Shared
9
+
10
+
11
+ class SkillsSchemasProficiencyValue < T::Enum
12
+ enums do
13
+ ONE = new('1')
14
+ TWO = new('2')
15
+ THREE = new('3')
16
+ FOUR = new('4')
17
+ FIVE = new('5')
18
+ end
19
+ end
20
+ end
21
+ end