From 3cc80767c12688570717171f46588dc458d00190 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Mon, 6 Jan 2025 09:03:12 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.462.2 --- .speakeasy/gen.lock | 136 +++++++++--------- .speakeasy/workflow.lock | 14 +- RELEASES.md | 12 +- codeSamples.yaml | 34 ++--- .../atsgetassessmentspackageresponse.md | 14 +- .../atsgetassessmentsrequestresponse.md | 14 +- .../atsgetassessmentsresultresponse.md | 14 +- .../atslistassessmentspackagesresponse.md | 14 +- .../operations/lmslistassignmentsrequest.md | 26 ++-- .../operations/lmslistcompletionsrequest.md | 22 +-- .../lmslistuserassignmentsrequest.md | 28 ++-- .../lmslistusercompletionsrequest.md | 24 ++-- docs/models/shared/assessmentorder.md | 15 ++ ...hment.md => assessmentorderapplication.md} | 8 +- .../assessmentorderapplicationstatus.md | 9 ++ ...ndidate.md => assessmentordercandidate.md} | 2 +- docs/models/shared/assessmentorderjob.md | 12 ++ ...tapimodel.md => assessmentorderpackage.md} | 2 +- ...rderresult.md => assessmentorderresult.md} | 4 +- ...sordervalue.md => assessmentordervalue.md} | 2 +- ...smentspackages.md => assessmentpackage.md} | 2 +- ...nated.md => assessmentpackagepaginated.md} | 4 +- docs/models/shared/assessmentpackageresult.md | 9 ++ docs/models/shared/assessmentresult.md | 17 +++ ...didate.md => assessmentresultcandidate.md} | 2 +- docs/models/shared/assessmentresultsresult.md | 9 ++ ...sultsvalue.md => assessmentresultvalue.md} | 2 +- docs/models/shared/assessmentsorder.md | 15 -- .../shared/assessmentsorderapplication.md | 11 -- docs/models/shared/assessmentsorderjob.md | 12 -- .../shared/assessmentspackagesresult.md | 9 -- ...ssessmentsrequestsjobhiringteamapimodel.md | 13 -- docs/models/shared/assessmentsresults.md | 17 --- .../models/shared/assessmentsresultsresult.md | 9 -- docs/models/shared/assignment.md | 1 + ...createbackgroundcheckpackagesrequestdto.md | 12 +- ...rderapplicationstatus.md => attachment.md} | 6 +- docs/models/shared/attachmentcontenttype.md | 9 ++ ...sattachmentvalue.md => attachmentvalue.md} | 2 +- docs/models/shared/backgroundcheckorderjob.md | 14 +- .../shared/backgroundcheckorderpackage.md | 14 +- docs/models/shared/backgroundcheckpackage.md | 14 +- docs/models/shared/backgroundcheckresult.md | 17 +++ ...e.md => backgroundcheckresultcandidate.md} | 2 +- ...type.md => backgroundcheckresultresult.md} | 6 +- ...score.md => backgroundcheckresultscore.md} | 2 +- .../shared/backgroundcheckresultsresult.md | 16 +-- .../backgroundcheckresultsresultresult.md | 9 -- ...value.md => backgroundcheckresultvalue.md} | 2 +- docs/models/shared/categoryvalue.md | 3 +- docs/models/shared/completion.md | 1 + .../models/shared/createcategoriesapimodel.md | 10 +- .../shared/createcategoriesapimodellevel.md | 11 ++ .../shared/createcategoriesapimodelvalue.md | 10 ++ ...ssessmentspackages.md => createpackage.md} | 2 +- docs/models/shared/createskillsapimodel.md | 10 +- .../shared/createskillsapimodellevel.md | 11 ++ .../shared/createskillsapimodelvalue.md | 10 ++ .../shared/lmscreateassignmentrequestdto.md | 1 + .../shared/lmscreatecollectionrequestdto.md | 4 +- .../shared/lmscreatecompletionrequestdto.md | 1 + .../shared/lmsupsertcontentrequestdto.md | 4 +- .../shared/lmsupsertcourserequestdto.md | 4 +- docs/models/shared/result.md | 8 +- docs/models/shared/skillsvalue.md | 3 +- docs/sdks/ats/README.md | 14 +- docs/sdks/lms/README.md | 78 ++++++---- gen.yaml | 2 +- lib/stack_one/ats.rb | 16 +-- .../ats_get_assessments_package_response.rb | 8 +- .../ats_get_assessments_request_response.rb | 8 +- .../ats_get_assessments_result_response.rb | 8 +- .../ats_list_assessments_packages_response.rb | 8 +- lib/stack_one/models/shared.rb | 54 +++---- ...assessmentsorder.rb => assessmentorder.rb} | 12 +- ...tion.rb => assessmentorder_application.rb} | 6 +- ... => assessmentorder_application_status.rb} | 6 +- ...didate.rb => assessmentorder_candidate.rb} | 2 +- ...ntsorder_job.rb => assessmentorder_job.rb} | 6 +- ...apimodel.rb => assessmentorder_package.rb} | 2 +- ...rder_value.rb => assessmentorder_value.rb} | 4 +- ...ultsresult.rb => assessmentorderresult.rb} | 6 +- ...smentspackages.rb => assessmentpackage.rb} | 2 +- ...nated.rb => assessmentpackagepaginated.rb} | 6 +- ...esresult.rb => assessmentpackageresult.rb} | 6 +- ...essmentsresults.rb => assessmentresult.rb} | 8 +- ...idate.rb => assessmentresult_candidate.rb} | 2 +- ...lts_value.rb => assessmentresult_value.rb} | 4 +- ...erresult.rb => assessmentresultsresult.rb} | 6 +- ...ssessmentsrequestsjobhiringteamapimodel.rb | 39 ----- lib/stack_one/models/shared/assignment.rb | 7 +- ...createbackgroundcheckpackagesrequestdto.rb | 4 +- ...assessmentsattachment.rb => attachment.rb} | 6 +- ...ent_type.rb => attachment_content_type.rb} | 6 +- ...ttachment_value.rb => attachment_value.rb} | 4 +- .../models/shared/backgroundcheckorder_job.rb | 4 +- .../shared/backgroundcheckorder_package.rb | 4 +- .../models/shared/backgroundcheckpackage.rb | 4 +- .../models/shared/backgroundcheckresult.rb | 51 +++++++ ....rb => backgroundcheckresult_candidate.rb} | 2 +- ...ult.rb => backgroundcheckresult_result.rb} | 6 +- ...core.rb => backgroundcheckresult_score.rb} | 2 +- ...alue.rb => backgroundcheckresult_value.rb} | 4 +- .../shared/backgroundcheckresultsresult.rb | 42 ++---- lib/stack_one/models/shared/category_value.rb | 1 + lib/stack_one/models/shared/completion.rb | 7 +- .../models/shared/createcategoriesapimodel.rb | 10 +- .../shared/createcategoriesapimodel_level.rb | 27 ++++ .../shared/createcategoriesapimodel_value.rb | 19 +++ ...ssessmentspackages.rb => createpackage.rb} | 2 +- .../models/shared/createskillsapimodel.rb | 10 +- .../shared/createskillsapimodel_level.rb | 27 ++++ .../shared/createskillsapimodel_value.rb | 19 +++ .../shared/lmscreateassignmentrequestdto.rb | 7 +- .../shared/lmscreatecompletionrequestdto.rb | 7 +- .../shared/lmsupsertcourserequestdto.rb | 4 +- lib/stack_one/models/shared/result.rb | 4 +- lib/stack_one/models/shared/skills_value.rb | 1 + lib/stack_one/sdkconfiguration.rb | 6 +- stackone_client.gemspec | 2 +- 120 files changed, 783 insertions(+), 585 deletions(-) create mode 100644 docs/models/shared/assessmentorder.md rename docs/models/shared/{assessmentsattachment.md => assessmentorderapplication.md} (52%) create mode 100644 docs/models/shared/assessmentorderapplicationstatus.md rename docs/models/shared/{assessmentsordercandidate.md => assessmentordercandidate.md} (99%) create mode 100644 docs/models/shared/assessmentorderjob.md rename docs/models/shared/{assessmentspackagestestapimodel.md => assessmentorderpackage.md} (98%) rename docs/models/shared/{assessmentsorderresult.md => assessmentorderresult.md} (88%) rename docs/models/shared/{assessmentsordervalue.md => assessmentordervalue.md} (98%) rename docs/models/shared/{assessmentspackages.md => assessmentpackage.md} (99%) rename docs/models/shared/{assessmentspackagespaginated.md => assessmentpackagepaginated.md} (94%) create mode 100644 docs/models/shared/assessmentpackageresult.md create mode 100644 docs/models/shared/assessmentresult.md rename docs/models/shared/{assessmentsresultscandidate.md => assessmentresultcandidate.md} (97%) create mode 100644 docs/models/shared/assessmentresultsresult.md rename docs/models/shared/{assessmentsresultsvalue.md => assessmentresultvalue.md} (89%) delete mode 100644 docs/models/shared/assessmentsorder.md delete mode 100644 docs/models/shared/assessmentsorderapplication.md delete mode 100644 docs/models/shared/assessmentsorderjob.md delete mode 100644 docs/models/shared/assessmentspackagesresult.md delete mode 100644 docs/models/shared/assessmentsrequestsjobhiringteamapimodel.md delete mode 100644 docs/models/shared/assessmentsresults.md delete mode 100644 docs/models/shared/assessmentsresultsresult.md rename docs/models/shared/{assessmentsorderapplicationstatus.md => attachment.md} (65%) create mode 100644 docs/models/shared/attachmentcontenttype.md rename docs/models/shared/{assessmentsattachmentvalue.md => attachmentvalue.md} (87%) create mode 100644 docs/models/shared/backgroundcheckresult.md rename docs/models/shared/{backgroundcheckresultsresultcandidate.md => backgroundcheckresultcandidate.md} (96%) rename docs/models/shared/{assessmentsattachmentcontenttype.md => backgroundcheckresultresult.md} (81%) rename docs/models/shared/{backgroundcheckresultsresultscore.md => backgroundcheckresultscore.md} (96%) delete mode 100644 docs/models/shared/backgroundcheckresultsresultresult.md rename docs/models/shared/{backgroundcheckresultsresultvalue.md => backgroundcheckresultvalue.md} (85%) create mode 100644 docs/models/shared/createcategoriesapimodellevel.md create mode 100644 docs/models/shared/createcategoriesapimodelvalue.md rename docs/models/shared/{createassessmentspackages.md => createpackage.md} (98%) create mode 100644 docs/models/shared/createskillsapimodellevel.md create mode 100644 docs/models/shared/createskillsapimodelvalue.md rename lib/stack_one/models/shared/{assessmentsorder.rb => assessmentorder.rb} (59%) rename lib/stack_one/models/shared/{assessmentsorder_application.rb => assessmentorder_application.rb} (74%) rename lib/stack_one/models/shared/{assessmentsorder_application_status.rb => assessmentorder_application_status.rb} (61%) rename lib/stack_one/models/shared/{assessmentsorder_candidate.rb => assessmentorder_candidate.rb} (96%) rename lib/stack_one/models/shared/{assessmentsorder_job.rb => assessmentorder_job.rb} (76%) rename lib/stack_one/models/shared/{assessmentspackagestestapimodel.rb => assessmentorder_package.rb} (93%) rename lib/stack_one/models/shared/{assessmentsorder_value.rb => assessmentorder_value.rb} (90%) rename lib/stack_one/models/shared/{assessmentsresultsresult.rb => assessmentorderresult.rb} (56%) rename lib/stack_one/models/shared/{assessmentspackages.rb => assessmentpackage.rb} (94%) rename lib/stack_one/models/shared/{assessmentspackagespaginated.rb => assessmentpackagepaginated.rb} (72%) rename lib/stack_one/models/shared/{assessmentspackagesresult.rb => assessmentpackageresult.rb} (56%) rename lib/stack_one/models/shared/{assessmentsresults.rb => assessmentresult.rb} (76%) rename lib/stack_one/models/shared/{assessmentsresults_candidate.rb => assessmentresult_candidate.rb} (92%) rename lib/stack_one/models/shared/{assessmentsresults_value.rb => assessmentresult_value.rb} (76%) rename lib/stack_one/models/shared/{assessmentsorderresult.rb => assessmentresultsresult.rb} (74%) delete mode 100644 lib/stack_one/models/shared/assessmentsrequestsjobhiringteamapimodel.rb rename lib/stack_one/models/shared/{assessmentsattachment.rb => attachment.rb} (62%) rename lib/stack_one/models/shared/{assessmentsattachment_content_type.rb => attachment_content_type.rb} (60%) rename lib/stack_one/models/shared/{assessmentsattachment_value.rb => attachment_value.rb} (69%) create mode 100644 lib/stack_one/models/shared/backgroundcheckresult.rb rename lib/stack_one/models/shared/{backgroundcheckresultsresult_candidate.rb => backgroundcheckresult_candidate.rb} (91%) rename lib/stack_one/models/shared/{backgroundcheckresultsresult_result.rb => backgroundcheckresult_result.rb} (65%) rename lib/stack_one/models/shared/{backgroundcheckresultsresult_score.rb => backgroundcheckresult_score.rb} (93%) rename lib/stack_one/models/shared/{backgroundcheckresultsresult_value.rb => backgroundcheckresult_value.rb} (73%) create mode 100644 lib/stack_one/models/shared/createcategoriesapimodel_level.rb create mode 100644 lib/stack_one/models/shared/createcategoriesapimodel_value.rb rename lib/stack_one/models/shared/{createassessmentspackages.rb => createpackage.rb} (90%) create mode 100644 lib/stack_one/models/shared/createskillsapimodel_level.rb create mode 100644 lib/stack_one/models/shared/createskillsapimodel_value.rb diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index fbdce8c9..a0dba331 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,20 +1,20 @@ lockVersion: 2.0.0 id: 482384cc-3b98-4ced-bd0b-14aa8b3e0053 management: - docChecksum: 860d0ebc1320d471850e3c34c6cdd82d + docChecksum: 1c7375d37e7d13f070e8b2187005a5d7 docVersion: 1.0.0 - speakeasyVersion: 1.460.3 - generationVersion: 2.484.0 - releaseVersion: 0.4.4 - configChecksum: 17ee00204b36f84a4fef37bcadcca13f + speakeasyVersion: 1.462.2 + generationVersion: 2.486.1 + releaseVersion: 0.5.0 + configChecksum: fea1c23038ec0842637761aa0ba09886 repoURL: https://github.com/StackOneHQ/stackone-client-ruby.git repoSubDirectory: . installationURL: https://github.com/StackOneHQ/stackone-client-ruby published: true features: ruby: - core: 3.4.5 - deprecations: 2.81.1 + core: 3.5.0 + deprecations: 2.81.2 examples: 2.81.3 flattening: 2.81.1 globalSecurity: 2.81.7 @@ -498,25 +498,21 @@ generatedFiles: - docs/models/shared/applicationspaginated.md - docs/models/shared/applicationstatus.md - docs/models/shared/applicationvalue.md - - docs/models/shared/assessmentsattachment.md - - docs/models/shared/assessmentsattachmentcontenttype.md - - docs/models/shared/assessmentsattachmentvalue.md - - docs/models/shared/assessmentsorder.md - - docs/models/shared/assessmentsorderapplication.md - - docs/models/shared/assessmentsorderapplicationstatus.md - - docs/models/shared/assessmentsordercandidate.md - - docs/models/shared/assessmentsorderjob.md - - docs/models/shared/assessmentsorderresult.md - - docs/models/shared/assessmentsordervalue.md - - docs/models/shared/assessmentspackages.md - - docs/models/shared/assessmentspackagespaginated.md - - docs/models/shared/assessmentspackagesresult.md - - docs/models/shared/assessmentspackagestestapimodel.md - - docs/models/shared/assessmentsrequestsjobhiringteamapimodel.md - - docs/models/shared/assessmentsresults.md - - docs/models/shared/assessmentsresultscandidate.md - - docs/models/shared/assessmentsresultsresult.md - - docs/models/shared/assessmentsresultsvalue.md + - docs/models/shared/assessmentorder.md + - docs/models/shared/assessmentorderapplication.md + - docs/models/shared/assessmentorderapplicationstatus.md + - docs/models/shared/assessmentordercandidate.md + - docs/models/shared/assessmentorderjob.md + - docs/models/shared/assessmentorderpackage.md + - docs/models/shared/assessmentorderresult.md + - docs/models/shared/assessmentordervalue.md + - docs/models/shared/assessmentpackage.md + - docs/models/shared/assessmentpackagepaginated.md + - docs/models/shared/assessmentpackageresult.md + - docs/models/shared/assessmentresult.md + - docs/models/shared/assessmentresultcandidate.md + - docs/models/shared/assessmentresultsresult.md + - docs/models/shared/assessmentresultvalue.md - docs/models/shared/assignment.md - docs/models/shared/assignmentresult.md - docs/models/shared/assignmentschemasvalue.md @@ -556,6 +552,9 @@ generatedFiles: - docs/models/shared/atsupdatejobrequestdtoconfidential.md - docs/models/shared/atsupdatejobrequestdtojobstatus.md - docs/models/shared/atsupdatejobrequestdtovalue.md + - docs/models/shared/attachment.md + - docs/models/shared/attachmentcontenttype.md + - docs/models/shared/attachmentvalue.md - docs/models/shared/avatar.md - docs/models/shared/backgroundcheckorder.md - docs/models/shared/backgroundcheckorderapplication.md @@ -570,11 +569,12 @@ generatedFiles: - docs/models/shared/backgroundcheckpackage.md - docs/models/shared/backgroundcheckpackagepaginated.md - docs/models/shared/backgroundcheckpackageresult.md + - docs/models/shared/backgroundcheckresult.md + - docs/models/shared/backgroundcheckresultcandidate.md + - docs/models/shared/backgroundcheckresultresult.md + - docs/models/shared/backgroundcheckresultscore.md - docs/models/shared/backgroundcheckresultsresult.md - - docs/models/shared/backgroundcheckresultsresultcandidate.md - - docs/models/shared/backgroundcheckresultsresultresult.md - - docs/models/shared/backgroundcheckresultsresultscore.md - - docs/models/shared/backgroundcheckresultsresultvalue.md + - docs/models/shared/backgroundcheckresultvalue.md - docs/models/shared/batchresultapimodel.md - docs/models/shared/benefittype.md - docs/models/shared/campaign.md @@ -639,8 +639,9 @@ generatedFiles: - docs/models/shared/createanswer.md - docs/models/shared/createanswertype.md - docs/models/shared/createanswervalue.md - - docs/models/shared/createassessmentspackages.md - docs/models/shared/createcategoriesapimodel.md + - docs/models/shared/createcategoriesapimodellevel.md + - docs/models/shared/createcategoriesapimodelvalue.md - docs/models/shared/createcontentapimodel.md - docs/models/shared/createcostcenterapimodel.md - docs/models/shared/createemploymentapimodel.md @@ -654,10 +655,13 @@ generatedFiles: - docs/models/shared/createhrisbenefitvalue.md - docs/models/shared/createmessage.md - docs/models/shared/createmessagevalue.md + - docs/models/shared/createpackage.md - docs/models/shared/createquestionnaire.md - docs/models/shared/createresult.md - docs/models/shared/createresultdataapimodel.md - docs/models/shared/createskillsapimodel.md + - docs/models/shared/createskillsapimodellevel.md + - docs/models/shared/createskillsapimodelvalue.md - docs/models/shared/credentials.md - docs/models/shared/crmcreatecontactrequestdto.md - docs/models/shared/customfielddefinition.md @@ -1626,25 +1630,21 @@ generatedFiles: - lib/stack_one/models/shared/applicationattachment_value.rb - lib/stack_one/models/shared/applicationresult.rb - lib/stack_one/models/shared/applicationspaginated.rb - - lib/stack_one/models/shared/assessmentsattachment.rb - - lib/stack_one/models/shared/assessmentsattachment_content_type.rb - - lib/stack_one/models/shared/assessmentsattachment_value.rb - - lib/stack_one/models/shared/assessmentsorder.rb - - lib/stack_one/models/shared/assessmentsorder_application.rb - - lib/stack_one/models/shared/assessmentsorder_application_status.rb - - lib/stack_one/models/shared/assessmentsorder_candidate.rb - - lib/stack_one/models/shared/assessmentsorder_job.rb - - lib/stack_one/models/shared/assessmentsorder_value.rb - - lib/stack_one/models/shared/assessmentsorderresult.rb - - lib/stack_one/models/shared/assessmentspackages.rb - - lib/stack_one/models/shared/assessmentspackagespaginated.rb - - lib/stack_one/models/shared/assessmentspackagesresult.rb - - lib/stack_one/models/shared/assessmentspackagestestapimodel.rb - - lib/stack_one/models/shared/assessmentsrequestsjobhiringteamapimodel.rb - - lib/stack_one/models/shared/assessmentsresults.rb - - lib/stack_one/models/shared/assessmentsresults_candidate.rb - - lib/stack_one/models/shared/assessmentsresults_value.rb - - lib/stack_one/models/shared/assessmentsresultsresult.rb + - lib/stack_one/models/shared/assessmentorder.rb + - lib/stack_one/models/shared/assessmentorder_application.rb + - lib/stack_one/models/shared/assessmentorder_application_status.rb + - lib/stack_one/models/shared/assessmentorder_candidate.rb + - lib/stack_one/models/shared/assessmentorder_job.rb + - lib/stack_one/models/shared/assessmentorder_package.rb + - lib/stack_one/models/shared/assessmentorder_value.rb + - lib/stack_one/models/shared/assessmentorderresult.rb + - lib/stack_one/models/shared/assessmentpackage.rb + - lib/stack_one/models/shared/assessmentpackagepaginated.rb + - lib/stack_one/models/shared/assessmentpackageresult.rb + - lib/stack_one/models/shared/assessmentresult.rb + - lib/stack_one/models/shared/assessmentresult_candidate.rb + - lib/stack_one/models/shared/assessmentresult_value.rb + - lib/stack_one/models/shared/assessmentresultsresult.rb - lib/stack_one/models/shared/assignment.rb - lib/stack_one/models/shared/assignment_schemas_value.rb - lib/stack_one/models/shared/assignment_value.rb @@ -1684,6 +1684,9 @@ generatedFiles: - lib/stack_one/models/shared/atsupdatejobrequestdto_confidential.rb - lib/stack_one/models/shared/atsupdatejobrequestdto_job_status.rb - lib/stack_one/models/shared/atsupdatejobrequestdto_value.rb + - lib/stack_one/models/shared/attachment.rb + - lib/stack_one/models/shared/attachment_content_type.rb + - lib/stack_one/models/shared/attachment_value.rb - lib/stack_one/models/shared/avatar.rb - lib/stack_one/models/shared/backgroundcheckorder.rb - lib/stack_one/models/shared/backgroundcheckorder_application.rb @@ -1698,11 +1701,12 @@ generatedFiles: - lib/stack_one/models/shared/backgroundcheckpackage.rb - lib/stack_one/models/shared/backgroundcheckpackagepaginated.rb - lib/stack_one/models/shared/backgroundcheckpackageresult.rb + - lib/stack_one/models/shared/backgroundcheckresult.rb + - lib/stack_one/models/shared/backgroundcheckresult_candidate.rb + - lib/stack_one/models/shared/backgroundcheckresult_result.rb + - lib/stack_one/models/shared/backgroundcheckresult_score.rb + - lib/stack_one/models/shared/backgroundcheckresult_value.rb - lib/stack_one/models/shared/backgroundcheckresultsresult.rb - - lib/stack_one/models/shared/backgroundcheckresultsresult_candidate.rb - - lib/stack_one/models/shared/backgroundcheckresultsresult_result.rb - - lib/stack_one/models/shared/backgroundcheckresultsresult_score.rb - - lib/stack_one/models/shared/backgroundcheckresultsresult_value.rb - lib/stack_one/models/shared/batchresultapimodel.rb - lib/stack_one/models/shared/benefit_type.rb - lib/stack_one/models/shared/campaign.rb @@ -1767,8 +1771,9 @@ generatedFiles: - lib/stack_one/models/shared/createanswer.rb - lib/stack_one/models/shared/createanswer_type.rb - lib/stack_one/models/shared/createanswer_value.rb - - lib/stack_one/models/shared/createassessmentspackages.rb - lib/stack_one/models/shared/createcategoriesapimodel.rb + - lib/stack_one/models/shared/createcategoriesapimodel_level.rb + - lib/stack_one/models/shared/createcategoriesapimodel_value.rb - lib/stack_one/models/shared/createcontentapimodel.rb - lib/stack_one/models/shared/createcostcenterapimodel.rb - lib/stack_one/models/shared/createemploymentapimodel.rb @@ -1782,10 +1787,13 @@ generatedFiles: - lib/stack_one/models/shared/createhrisbenefit_value.rb - lib/stack_one/models/shared/createmessage.rb - lib/stack_one/models/shared/createmessage_value.rb + - lib/stack_one/models/shared/createpackage.rb - lib/stack_one/models/shared/createquestionnaire.rb - lib/stack_one/models/shared/createresult.rb - lib/stack_one/models/shared/createresultdataapimodel.rb - lib/stack_one/models/shared/createskillsapimodel.rb + - lib/stack_one/models/shared/createskillsapimodel_level.rb + - lib/stack_one/models/shared/createskillsapimodel_value.rb - lib/stack_one/models/shared/credentials.rb - lib/stack_one/models/shared/crmcreatecontactrequestdto.rb - lib/stack_one/models/shared/customfielddefinition.rb @@ -3869,7 +3877,7 @@ examples: "": parameters: query: - fields: "id,remote_id,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" + fields: "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} updated_after: "2020-01-01T00:00:00.000Z" user_id: "c28xyrc55866bvuv" @@ -3895,7 +3903,7 @@ examples: "": parameters: query: - fields: "id,remote_id,external_id,remote_external_id,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" + fields: "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} updated_after: "2020-01-01T00:00:00.000Z" user_id: "746359" @@ -3947,7 +3955,7 @@ examples: path: id: "" query: - fields: "id,remote_id,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" + fields: "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} updated_after: "2020-01-01T00:00:00.000Z" user_id: "c28xyrc55866bvuv" @@ -3963,7 +3971,7 @@ examples: path: id: "" query: - fields: "id,remote_id,external_id,remote_external_id,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" + fields: "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} updated_after: "2020-01-01T00:00:00.000Z" user_id: "746359" @@ -4003,7 +4011,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"active": true, "categories": [{"name": "Information-Technology"}], "content_url": "https://www.youtube.com/watch?v=16873", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "cover_url": "https://www.googledrive.com/?v=16873", "description": "This video acts as learning content for software engineers.", "duration": "P3Y6M4DT12H30M5S", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "languages": [], "order": 1, "skills": [{"id": "16873-IT345", "name": "Information-Technology", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "title": "Software Engineer Lv 1", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}} + application/json: {"active": true, "categories": [{"name": "Information-Technology"}], "content_url": "https://www.youtube.com/watch?v=16873", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "cover_url": "https://www.googledrive.com/?v=16873", "description": "This video acts as learning content for software engineers.", "duration": "P3Y6M4DT12H30M5S", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "languages": [], "order": 1, "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "title": "Software Engineer Lv 1", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}} responses: "201": application/json: {"data": {"external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "message": "Record created successfully.", "statusCode": 201, "timestamp": "2021-01-01T01:01:01.000Z"} @@ -4439,7 +4447,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"items": [{"active": true, "categories": [{"name": "Information-Technology"}], "content": [{"content_url": "https://www.youtube.com/watch?v=16873", "description": "This video acts as learning content for software engineers.", "title": "Software Engineer Lv 1"}], "content_ids": ["16873-SOFTWARE-ENG-Content"], "cover_url": "https://www.googledrive.com/?v=16873", "description": "This course acts as learning content for software engineers.", "duration": "P3Y6M4DT12H30M5S", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "languages": [{"value": "en_GB"}, {"value": "en_GB"}], "skills": [{"id": "16873-IT345", "name": "Information-Technology", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "title": "Software Engineer Lv 1", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "url": "https://www.linkedinlearning.com/?v=16873"}, {"active": true, "categories": [{"name": "Information-Technology"}], "content": [{"content_url": "https://www.youtube.com/watch?v=16873", "description": "This video acts as learning content for software engineers.", "title": "Software Engineer Lv 1"}], "content_ids": ["16873-SOFTWARE-ENG-Content"], "cover_url": "https://www.googledrive.com/?v=16873", "description": "This course acts as learning content for software engineers.", "duration": "P3Y6M4DT12H30M5S", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "languages": [], "skills": [{"id": "16873-IT345", "name": "Information-Technology", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "title": "Software Engineer Lv 1", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "url": "https://www.linkedinlearning.com/?v=16873"}]} + application/json: {"items": [{"active": true, "categories": [{"name": "Information-Technology"}], "content": [{"content_url": "https://www.youtube.com/watch?v=16873", "description": "This video acts as learning content for software engineers.", "title": "Software Engineer Lv 1"}], "content_ids": ["16873-SOFTWARE-ENG-Content"], "cover_url": "https://www.googledrive.com/?v=16873", "description": "This course acts as learning content for software engineers.", "duration": "P3Y6M4DT12H30M5S", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "languages": [{"value": "en_GB"}, {"value": "en_GB"}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "title": "Software Engineer Lv 1", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "url": "https://www.linkedinlearning.com/?v=16873"}, {"active": true, "categories": [{"name": "Information-Technology"}], "content": [{"content_url": "https://www.youtube.com/watch?v=16873", "description": "This video acts as learning content for software engineers.", "title": "Software Engineer Lv 1"}], "content_ids": ["16873-SOFTWARE-ENG-Content"], "cover_url": "https://www.googledrive.com/?v=16873", "description": "This course acts as learning content for software engineers.", "duration": "P3Y6M4DT12H30M5S", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "languages": [], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "title": "Software Engineer Lv 1", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "url": "https://www.linkedinlearning.com/?v=16873"}]} responses: "202": application/json: {"errors": [["Missing field: name"], [], []], "message": "Batch operation accepted", "statusCode": 202, "timestamp": "2021-01-01T01:01:01.000Z"} @@ -4449,7 +4457,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"active": true, "categories": [{"name": "Information-Technology"}], "content": [{"content_url": "https://www.youtube.com/watch?v=16873", "description": "This video acts as learning content for software engineers.", "title": "Software Engineer Lv 1"}], "content_ids": ["16873-SOFTWARE-ENG-Content"], "cover_url": "https://www.googledrive.com/?v=16873", "description": "This course acts as learning content for software engineers.", "duration": "P3Y6M4DT12H30M5S", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "languages": [{"value": "en_GB"}], "skills": [{"id": "16873-IT345", "name": "Information-Technology", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "title": "Software Engineer Lv 1", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "url": "https://www.linkedinlearning.com/?v=16873"} + application/json: {"active": true, "categories": [{"name": "Information-Technology"}], "content": [{"content_url": "https://www.youtube.com/watch?v=16873", "description": "This video acts as learning content for software engineers.", "title": "Software Engineer Lv 1"}], "content_ids": ["16873-SOFTWARE-ENG-Content"], "cover_url": "https://www.googledrive.com/?v=16873", "description": "This course acts as learning content for software engineers.", "duration": "P3Y6M4DT12H30M5S", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "languages": [{"value": "en_GB"}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "title": "Software Engineer Lv 1", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "url": "https://www.linkedinlearning.com/?v=16873"} responses: "201": application/json: {"data": {"external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "message": "Record created successfully.", "statusCode": 201, "timestamp": "2021-01-01T01:01:01.000Z"} @@ -4531,7 +4539,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"description": "Standard background package for hires", "name": "Standard Background Check", "passthrough": {"other_known_names": "John Doe"}, "tests": [{"description": "Skills test to gauge a candidate's proficiency in job-specific skills", "name": "Test 1"}, {"description": "Skills test to gauge a candidate's proficiency in job-specific skills", "name": "Test 1"}]} + application/json: {"description": "Skills test to gauge a candidate's proficiency in job-specific skills", "name": "Test 1", "passthrough": {"other_known_names": "John Doe"}, "tests": [{"description": "Skills test to gauge a candidate's proficiency in job-specific skills", "name": "Test 1"}, {"description": "Skills test to gauge a candidate's proficiency in job-specific skills", "name": "Test 1"}]} responses: "201": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "message": "Record created successfully.", "statusCode": 201, "timestamp": "2021-01-01T01:01:01.000Z"} @@ -4570,7 +4578,7 @@ examples: x-account-id: "" responses: "200": - application/json: {"attachments": [{"content_type": {"source_value": "Text", "value": "text"}, "url": "http://example.com/resume.pdf"}, {"content_type": {"source_value": "Text", "value": "text"}, "url": "http://example.com/resume.pdf"}, {"content_type": {"source_value": "Text", "value": "text"}, "url": "http://example.com/resume.pdf"}], "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "profile_url": "https://exmaple.com/candidate?id=xyz"}, "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "result": {"source_value": "Passed", "value": "passed"}, "result_url": "https://exmaple.com/result?id=xyz", "start_date": "2021-01-01T01:01:01.000Z", "submission_date": "2021-01-01T01:01:01.000Z", "summary": "Test is passed"} + application/json: {"data": {"attachments": [{"content_type": {"source_value": "Text", "value": "text"}, "url": "http://example.com/resume.pdf"}, {"content_type": {"source_value": "Text", "value": "text"}, "url": "http://example.com/resume.pdf"}, {"content_type": {"source_value": "Text", "value": "text"}, "url": "http://example.com/resume.pdf"}], "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "profile_url": "https://exmaple.com/candidate?id=xyz", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "result": {"source_value": "Passed", "value": "passed"}, "result_url": "https://exmaple.com/result?id=xyz", "score": {"label": "Percentage", "max": "100", "min": "0", "value": "80"}, "start_date": "2021-01-01T01:01:01.000Z", "submission_date": "2021-01-01T01:01:01.000Z", "summary": "Test is passed"}} ats_list_background_check_packages: "": parameters: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 170c330d..24f5d413 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.460.3 +speakeasyVersion: 1.462.2 sources: my-source: sourceNamespace: my-source - sourceRevisionDigest: sha256:c370989de9108811487581faace998058379ba4edd52ebd4b7f8ce1368205799 - sourceBlobDigest: sha256:423f4972fa43bd9840a43bafc482fc5680ad077658053d13fe881c9388145161 + sourceRevisionDigest: sha256:e38496881728bcb295809709f1077839e8a46291a0dc9a6452f5792297296726 + sourceBlobDigest: sha256:24a2cac83ead0f1440d63b0549f0b544b1a50f9ca4a87ffe48f8d5dc90a09d92 tags: - latest - - speakeasy-sdk-regen-1735549280 + - speakeasy-sdk-regen-1736154080 - 1.0.0 targets: StackOneRubyClient: source: my-source sourceNamespace: my-source - sourceRevisionDigest: sha256:c370989de9108811487581faace998058379ba4edd52ebd4b7f8ce1368205799 - sourceBlobDigest: sha256:423f4972fa43bd9840a43bafc482fc5680ad077658053d13fe881c9388145161 + sourceRevisionDigest: sha256:e38496881728bcb295809709f1077839e8a46291a0dc9a6452f5792297296726 + sourceBlobDigest: sha256:24a2cac83ead0f1440d63b0549f0b544b1a50f9ca4a87ffe48f8d5dc90a09d92 codeSamplesNamespace: code-samples-ruby-stackonerubyclient - codeSamplesRevisionDigest: sha256:aeb7b54f74c821363eb9b4540877543755deba8c8e5bac86a88c5f65b9e35394 + codeSamplesRevisionDigest: sha256:263d3142d1f9b4839014e7d2119cb8f93106b65862ee16283b7b2bd7dc0701bb workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index c58ae672..34e045e3 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -638,4 +638,14 @@ Based on: ### Generated - [ruby v0.4.4] . ### Releases -- [Ruby Gems v0.4.4] https://rubygems.org/gems/stackone_client/versions/0.4.4 - . \ No newline at end of file +- [Ruby Gems v0.4.4] https://rubygems.org/gems/stackone_client/versions/0.4.4 - . + +## 2025-01-06 09:01:15 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.462.2 (2.486.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [ruby v0.5.0] . +### Releases +- [Ruby Gems v0.5.0] https://rubygems.org/gems/stackone_client/versions/0.5.0 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index e891abb3..ee14d0cb 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -158,25 +158,25 @@ actions: x-codeSamples: - lang: ruby label: ats_get_assessments_request - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetAssessmentsRequestRequest.new(\n id: \"\",\n fields_: \"id,remote_id,package,application,job,candidate,requester,results_update_url\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_assessments_request(req)\n\nif ! res.assessments_order_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetAssessmentsRequestRequest.new(\n id: \"\",\n fields_: \"id,remote_id,package,application,job,candidate,requester,results_update_url\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_assessments_request(req)\n\nif ! res.assessment_order_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/ats/assessments/orders/{id}/results"]["get"] update: x-codeSamples: - lang: ruby label: ats_get_assessments_result - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetAssessmentsResultRequest.new(\n id: \"\",\n fields_: \"id,remote_id,candidate,score,start_date,submission_date,summary,result,result_url,attachments\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_assessments_result(req)\n\nif ! res.assessments_results_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetAssessmentsResultRequest.new(\n id: \"\",\n fields_: \"id,remote_id,candidate,score,start_date,submission_date,summary,result,result_url,attachments\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_assessments_result(req)\n\nif ! res.assessment_results_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/ats/assessments/packages"]["get"] update: x-codeSamples: - lang: ruby label: ats_list_assessments_packages - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListAssessmentsPackagesRequest.new(\n filter: ::StackOne::Operations::AtsListAssessmentsPackagesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_assessments_packages(req)\n\nif ! res.assessments_packages_paginated.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListAssessmentsPackagesRequest.new(\n filter: ::StackOne::Operations::AtsListAssessmentsPackagesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_assessments_packages(req)\n\nif ! res.assessment_package_paginated.nil?\n # handle response\nend" - target: $["paths"]["/unified/ats/assessments/packages/{id}"]["get"] update: x-codeSamples: - lang: ruby label: ats_get_assessments_package - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetAssessmentsPackageRequest.new(\n id: \"\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_assessments_package(req)\n\nif ! res.assessments_packages_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetAssessmentsPackageRequest.new(\n id: \"\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_assessments_package(req)\n\nif ! res.assessment_package_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/ats/background_checks/orders"]["get"] update: x-codeSamples: @@ -206,7 +206,7 @@ actions: x-codeSamples: - lang: ruby label: ats_create_background_check_package - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.ats.create_background_check_package(x_account_id=\"\", ats_create_background_check_packages_request_dto=::StackOne::Shared::AtsCreateBackgroundCheckPackagesRequestDto.new(\n name: \"Standard Background Check\",\n description: \"Standard background package for hires\",\n tests: [\n ::StackOne::Shared::CreateAssessmentsPackages.new(\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n ),\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n))\n\nif ! res.create_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.ats.create_background_check_package(x_account_id=\"\", ats_create_background_check_packages_request_dto=::StackOne::Shared::AtsCreateBackgroundCheckPackagesRequestDto.new(\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n tests: [\n ::StackOne::Shared::CreatePackage.new(\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n ),\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n))\n\nif ! res.create_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/ats/background_checks/packages/{id}"]["get"] update: x-codeSamples: @@ -818,7 +818,7 @@ actions: x-codeSamples: - lang: ruby label: lms_list_assignments - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::LmsListAssignmentsRequest.new(\n fields_: \"id,remote_id,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference\",\n filter: ::StackOne::Operations::LmsListAssignmentsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n user_id: \"c28xyrc55866bvuv\",\n remote_user_id: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n x_account_id: \"\",\n)\n \nres = s.lms.list_assignments(req)\n\nif ! res.assignments_paginated.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::LmsListAssignmentsRequest.new(\n fields_: \"id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference\",\n filter: ::StackOne::Operations::LmsListAssignmentsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n user_id: \"c28xyrc55866bvuv\",\n remote_user_id: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n x_account_id: \"\",\n)\n \nres = s.lms.list_assignments(req)\n\nif ! res.assignments_paginated.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/assignments/{id}"]["get"] update: x-codeSamples: @@ -842,19 +842,19 @@ actions: x-codeSamples: - lang: ruby label: lms_create_collection - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.create_collection(x_account_id=\"\", lms_create_collection_request_dto=::StackOne::Shared::LmsCreateCollectionRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-collection-1\",\n learning_object_ids: [\n \"16873-SOFTWARE-ENG-COURSE\",\n \"16874-SOFTWARE-ENG-COURSE\",\n ],\n remote_learning_object_ids: [\n \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"e3cb75bf-aa84-466e-a6c1-b8322b257a49\",\n ],\n title: \"Software Engineer Lv 1 Collection\",\n description: \"This collection acts as learning pathway for software engineers.\",\n cover_url: \"https://www.googledrive.com/?v=16873\",\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n name: \"Technology\",\n ),\n ],\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n name: \"Technology\",\n ),\n ],\n))\n\nif ! res.create_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.create_collection(x_account_id=\"\", lms_create_collection_request_dto=::StackOne::Shared::LmsCreateCollectionRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-collection-1\",\n learning_object_ids: [\n \"16873-SOFTWARE-ENG-COURSE\",\n \"16874-SOFTWARE-ENG-COURSE\",\n ],\n remote_learning_object_ids: [\n \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"e3cb75bf-aa84-466e-a6c1-b8322b257a49\",\n ],\n title: \"Software Engineer Lv 1 Collection\",\n description: \"This collection acts as learning pathway for software engineers.\",\n cover_url: \"https://www.googledrive.com/?v=16873\",\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n id: \"16873-IT345\",\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n name: \"Information-Technology\",\n ),\n ],\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"16873-IT345\",\n name: \"Information-Technology\",\n ),\n ],\n))\n\nif ! res.create_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/collections/{id}"]["patch"] update: x-codeSamples: - lang: ruby label: lms_update_collection - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.update_collection(id=\"\", x_account_id=\"\", lms_create_collection_request_dto=::StackOne::Shared::LmsCreateCollectionRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-collection-1\",\n learning_object_ids: [\n \"16873-SOFTWARE-ENG-COURSE\",\n \"16874-SOFTWARE-ENG-COURSE\",\n ],\n remote_learning_object_ids: [\n \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"e3cb75bf-aa84-466e-a6c1-b8322b257a49\",\n ],\n title: \"Software Engineer Lv 1 Collection\",\n description: \"This collection acts as learning pathway for software engineers.\",\n cover_url: \"https://www.googledrive.com/?v=16873\",\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n name: \"Technology\",\n ),\n ],\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n name: \"Technology\",\n ),\n ],\n))\n\nif ! res.update_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.update_collection(id=\"\", x_account_id=\"\", lms_create_collection_request_dto=::StackOne::Shared::LmsCreateCollectionRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-collection-1\",\n learning_object_ids: [\n \"16873-SOFTWARE-ENG-COURSE\",\n \"16874-SOFTWARE-ENG-COURSE\",\n ],\n remote_learning_object_ids: [\n \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"e3cb75bf-aa84-466e-a6c1-b8322b257a49\",\n ],\n title: \"Software Engineer Lv 1 Collection\",\n description: \"This collection acts as learning pathway for software engineers.\",\n cover_url: \"https://www.googledrive.com/?v=16873\",\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n id: \"16873-IT345\",\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n name: \"Information-Technology\",\n ),\n ],\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"16873-IT345\",\n name: \"Information-Technology\",\n ),\n ],\n))\n\nif ! res.update_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/completions"]["get"] update: x-codeSamples: - lang: ruby label: lms_list_completions - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::LmsListCompletionsRequest.new(\n fields_: \"id,remote_id,external_id,remote_external_id,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference\",\n filter: ::StackOne::Operations::LmsListCompletionsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.lms.list_completions(req)\n\nif ! res.completions_paginated.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::LmsListCompletionsRequest.new(\n fields_: \"id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference\",\n filter: ::StackOne::Operations::LmsListCompletionsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.lms.list_completions(req)\n\nif ! res.completions_paginated.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/completions/{id}"]["get"] update: x-codeSamples: @@ -872,13 +872,13 @@ actions: x-codeSamples: - lang: ruby label: lms_upsert_content - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.upsert_content(x_account_id=\"\", lms_upsert_content_request_dto=::StackOne::Shared::LmsUpsertContentRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n course_ids: [\n \"16873-SOFTWARE-ENG-COURSE\",\n ],\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n short_description: \"This course is a valuable resource and acts as learning content for...\",\n languages: [\n ::StackOne::Shared::LanguageEnum.new(\n value: ::StackOne::Shared::LanguageEnumValue::EN_GB,\n ),\n ],\n content_url: \"https://www.youtube.com/watch?v=16873\",\n cover_url: \"https://www.googledrive.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"cx2367ndc8dgsbjhka9ry4\",\n remote_id: \"SE-001\",\n name: \"Software Engineering\",\n ),\n ],\n order: 1.0,\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n name: \"Technology\",\n ),\n ],\n))\n\nif ! res.upsert_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.upsert_content(x_account_id=\"\", lms_upsert_content_request_dto=::StackOne::Shared::LmsUpsertContentRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n course_ids: [\n \"16873-SOFTWARE-ENG-COURSE\",\n ],\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n short_description: \"This course is a valuable resource and acts as learning content for...\",\n languages: [\n ::StackOne::Shared::LanguageEnum.new(\n value: ::StackOne::Shared::LanguageEnumValue::EN_GB,\n ),\n ],\n content_url: \"https://www.youtube.com/watch?v=16873\",\n cover_url: \"https://www.googledrive.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"12345\",\n name: \"Sales Techniques\",\n ),\n ],\n order: 1.0,\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n id: \"16873-IT345\",\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n name: \"Information-Technology\",\n ),\n ],\n))\n\nif ! res.upsert_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/content/batch"]["post"] update: x-codeSamples: - lang: ruby label: lms_batch_upsert_content - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.batch_upsert_content(x_account_id=\"\", lms_batch_upsert_content_request_dto=::StackOne::Shared::LmsBatchUpsertContentRequestDto.new(\n items: [\n ::StackOne::Shared::LmsUpsertContentRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n course_ids: [\n \"16873-SOFTWARE-ENG-COURSE\",\n ],\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n short_description: \"This course is a valuable resource and acts as learning content for...\",\n languages: [\n ::StackOne::Shared::LanguageEnum.new(\n value: ::StackOne::Shared::LanguageEnumValue::EN_GB,\n ),\n ],\n content_url: \"https://www.youtube.com/watch?v=16873\",\n cover_url: \"https://www.googledrive.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"cx2367ndc8dgsbjhka9ry4\",\n remote_id: \"SE-001\",\n name: \"Software Engineering\",\n ),\n ],\n order: 1.0,\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n name: \"Technology\",\n ),\n ],\n ),\n ],\n))\n\nif ! res.batch_result_api_model.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.batch_upsert_content(x_account_id=\"\", lms_batch_upsert_content_request_dto=::StackOne::Shared::LmsBatchUpsertContentRequestDto.new(\n items: [\n ::StackOne::Shared::LmsUpsertContentRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n course_ids: [\n \"16873-SOFTWARE-ENG-COURSE\",\n ],\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n short_description: \"This course is a valuable resource and acts as learning content for...\",\n languages: [\n ::StackOne::Shared::LanguageEnum.new(\n value: ::StackOne::Shared::LanguageEnumValue::EN_GB,\n ),\n ],\n content_url: \"https://www.youtube.com/watch?v=16873\",\n cover_url: \"https://www.googledrive.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"12345\",\n name: \"Sales Techniques\",\n ),\n ],\n order: 1.0,\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n id: \"16873-IT345\",\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n name: \"Information-Technology\",\n ),\n ],\n ),\n ],\n))\n\nif ! res.batch_result_api_model.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/content/{id}"]["get"] update: x-codeSamples: @@ -896,13 +896,13 @@ actions: x-codeSamples: - lang: ruby label: lms_upsert_course - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.upsert_course(x_account_id=\"\", lms_upsert_course_request_dto=::StackOne::Shared::LmsUpsertCourseRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n content_ids: [\n \"16873-SOFTWARE-ENG-Content\",\n ],\n title: \"Software Engineer Lv 1\",\n description: \"This course acts as learning content for software engineers.\",\n languages: [\n ::StackOne::Shared::LanguageEnum.new(\n value: ::StackOne::Shared::LanguageEnumValue::EN_GB,\n ),\n ],\n cover_url: \"https://www.googledrive.com/?v=16873\",\n url: \"https://www.linkedinlearning.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"cx2367ndc8dgsbjhka9ry4\",\n remote_id: \"SE-001\",\n name: \"Software Engineering\",\n ),\n ],\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n name: \"Technology\",\n ),\n ],\n content: [\n ::StackOne::Shared::CreateContentApiModel.new(\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n content_url: \"https://www.youtube.com/watch?v=16873\",\n order: 1.0,\n ),\n ],\n))\n\nif ! res.upsert_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.upsert_course(x_account_id=\"\", lms_upsert_course_request_dto=::StackOne::Shared::LmsUpsertCourseRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n content_ids: [\n \"16873-SOFTWARE-ENG-Content\",\n ],\n title: \"Software Engineer Lv 1\",\n description: \"This course acts as learning content for software engineers.\",\n languages: [\n ::StackOne::Shared::LanguageEnum.new(\n value: ::StackOne::Shared::LanguageEnumValue::EN_GB,\n ),\n ],\n cover_url: \"https://www.googledrive.com/?v=16873\",\n url: \"https://www.linkedinlearning.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n id: \"16873-IT345\",\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n name: \"Information-Technology\",\n ),\n ],\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"16873-IT345\",\n name: \"Information-Technology\",\n ),\n ],\n content: [\n ::StackOne::Shared::CreateContentApiModel.new(\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n content_url: \"https://www.youtube.com/watch?v=16873\",\n order: 1.0,\n ),\n ],\n))\n\nif ! res.upsert_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/courses/batch"]["post"] update: x-codeSamples: - lang: ruby label: lms_batch_upsert_course - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.batch_upsert_course(x_account_id=\"\", lms_batch_upsert_course_request_dto=::StackOne::Shared::LmsBatchUpsertCourseRequestDto.new(\n items: [\n ::StackOne::Shared::LmsUpsertCourseRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n content_ids: [\n \"16873-SOFTWARE-ENG-Content\",\n ],\n title: \"Software Engineer Lv 1\",\n description: \"This course acts as learning content for software engineers.\",\n languages: [\n ::StackOne::Shared::LanguageEnum.new(\n value: ::StackOne::Shared::LanguageEnumValue::EN_GB,\n ),\n ],\n cover_url: \"https://www.googledrive.com/?v=16873\",\n url: \"https://www.linkedinlearning.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"cx2367ndc8dgsbjhka9ry4\",\n remote_id: \"SE-001\",\n name: \"Software Engineering\",\n ),\n ],\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n name: \"Technology\",\n ),\n ],\n content: [\n ::StackOne::Shared::CreateContentApiModel.new(\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n content_url: \"https://www.youtube.com/watch?v=16873\",\n order: 1.0,\n ),\n ],\n ),\n ],\n))\n\nif ! res.batch_result_api_model.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.batch_upsert_course(x_account_id=\"\", lms_batch_upsert_course_request_dto=::StackOne::Shared::LmsBatchUpsertCourseRequestDto.new(\n items: [\n ::StackOne::Shared::LmsUpsertCourseRequestDto.new(\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n external_reference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n content_ids: [\n \"16873-SOFTWARE-ENG-Content\",\n ],\n title: \"Software Engineer Lv 1\",\n description: \"This course acts as learning content for software engineers.\",\n languages: [\n ::StackOne::Shared::LanguageEnum.new(\n value: ::StackOne::Shared::LanguageEnumValue::EN_GB,\n ),\n ],\n cover_url: \"https://www.googledrive.com/?v=16873\",\n url: \"https://www.linkedinlearning.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n categories: [\n ::StackOne::Shared::CreateCategoriesApiModel.new(\n id: \"16873-IT345\",\n unified_custom_fields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n name: \"Information-Technology\",\n ),\n ],\n skills: [\n ::StackOne::Shared::CreateSkillsApiModel.new(\n id: \"16873-IT345\",\n name: \"Information-Technology\",\n ),\n ],\n content: [\n ::StackOne::Shared::CreateContentApiModel.new(\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n content_url: \"https://www.youtube.com/watch?v=16873\",\n order: 1.0,\n ),\n ],\n ),\n ],\n))\n\nif ! res.batch_result_api_model.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/courses/{id}"]["get"] update: x-codeSamples: @@ -938,13 +938,13 @@ actions: x-codeSamples: - lang: ruby label: lms_list_user_assignments - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::LmsListUserAssignmentsRequest.new(\n id: \"\",\n fields_: \"id,remote_id,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference\",\n filter: ::StackOne::Operations::LmsListUserAssignmentsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n user_id: \"c28xyrc55866bvuv\",\n remote_user_id: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n x_account_id: \"\",\n)\n \nres = s.lms.list_user_assignments(req)\n\nif ! res.assignments_paginated.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::LmsListUserAssignmentsRequest.new(\n id: \"\",\n fields_: \"id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference\",\n filter: ::StackOne::Operations::LmsListUserAssignmentsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n user_id: \"c28xyrc55866bvuv\",\n remote_user_id: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n x_account_id: \"\",\n)\n \nres = s.lms.list_user_assignments(req)\n\nif ! res.assignments_paginated.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/users/{id}/assignments"]["post"] update: x-codeSamples: - lang: ruby label: lms_create_user_assignment - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.create_user_assignment(id=\"\", x_account_id=\"\", lms_create_assignment_request_dto=::StackOne::Shared::LmsCreateAssignmentRequestDto.new(\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n learning_object_id: \"e3gd34-23tr21-er234-345er56\",\n learning_object_external_reference: \"learning-content-123\",\n progress: 40,\n created_at: \"2021-07-21T14:00:00.000Z\",\n due_date: \"2021-07-21T14:00:00.000Z\",\n status: ::StackOne::Shared::LmsCreateAssignmentRequestDtoStatus.new(\n value: ::StackOne::Shared::LmsCreateAssignmentRequestDtoValue::PENDING,\n ),\n))\n\nif ! res.create_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.create_user_assignment(id=\"\", x_account_id=\"\", lms_create_assignment_request_dto=::StackOne::Shared::LmsCreateAssignmentRequestDto.new(\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n external_reference: \"e3gd34-23tr21-er234-345er56\",\n learning_object_id: \"e3gd34-23tr21-er234-345er56\",\n learning_object_external_reference: \"learning-content-123\",\n progress: 40,\n created_at: \"2021-07-21T14:00:00.000Z\",\n due_date: \"2021-07-21T14:00:00.000Z\",\n status: ::StackOne::Shared::LmsCreateAssignmentRequestDtoStatus.new(\n value: ::StackOne::Shared::LmsCreateAssignmentRequestDtoValue::PENDING,\n ),\n))\n\nif ! res.create_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/users/{id}/assignments/{subResourceId}"]["get"] update: x-codeSamples: @@ -956,13 +956,13 @@ actions: x-codeSamples: - lang: ruby label: lms_list_user_completions - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::LmsListUserCompletionsRequest.new(\n id: \"\",\n fields_: \"id,remote_id,external_id,remote_external_id,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference\",\n filter: ::StackOne::Operations::LmsListUserCompletionsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.lms.list_user_completions(req)\n\nif ! res.completions_paginated.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::LmsListUserCompletionsRequest.new(\n id: \"\",\n fields_: \"id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference\",\n filter: ::StackOne::Operations::LmsListUserCompletionsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.lms.list_user_completions(req)\n\nif ! res.completions_paginated.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/users/{id}/completions"]["post"] update: x-codeSamples: - lang: ruby label: lms_create_user_completion - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.create_user_completion(id=\"\", x_account_id=\"\", lms_create_completion_request_dto=::StackOne::Shared::LmsCreateCompletionRequestDto.new(\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n completed_at: \"2021-07-21T14:00:00.000Z\",\n learning_object_id: \"e3gd34-23tr21-er234-345er56\",\n learning_object_external_reference: \"learning-content-123\",\n))\n\nif ! res.create_result.nil?\n # handle response\nend" + source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n password: \"\",\n )\n)\n\n \nres = s.lms.create_user_completion(id=\"\", x_account_id=\"\", lms_create_completion_request_dto=::StackOne::Shared::LmsCreateCompletionRequestDto.new(\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n external_reference: \"e3gd34-23tr21-er234-345er56\",\n completed_at: \"2021-07-21T14:00:00.000Z\",\n learning_object_id: \"e3gd34-23tr21-er234-345er56\",\n learning_object_external_reference: \"learning-content-123\",\n))\n\nif ! res.create_result.nil?\n # handle response\nend" - target: $["paths"]["/unified/lms/users/{id}/completions/{subResourceId}"]["get"] update: x-codeSamples: diff --git a/docs/models/operations/atsgetassessmentspackageresponse.md b/docs/models/operations/atsgetassessmentspackageresponse.md index 6679532d..0525fe32 100644 --- a/docs/models/operations/atsgetassessmentspackageresponse.md +++ b/docs/models/operations/atsgetassessmentspackageresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `assessments_packages_result` | [T.nilable(::StackOne::Shared::AssessmentsPackagesResult)](../../models/shared/assessmentspackagesresult.md) | :heavy_minus_sign: | The assessments package with the given identifier was retrieved. | -| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | -| `headers` | T::Hash[Symbol, T::Array<*::String*>] | :heavy_check_mark: | N/A | -| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `assessment_package_result` | [T.nilable(::StackOne::Shared::AssessmentPackageResult)](../../models/shared/assessmentpackageresult.md) | :heavy_minus_sign: | The assessments package with the given identifier was retrieved. | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `headers` | T::Hash[Symbol, T::Array<*::String*>] | :heavy_check_mark: | N/A | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/atsgetassessmentsrequestresponse.md b/docs/models/operations/atsgetassessmentsrequestresponse.md index dce37dd6..7527d715 100644 --- a/docs/models/operations/atsgetassessmentsrequestresponse.md +++ b/docs/models/operations/atsgetassessmentsrequestresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `assessments_order_result` | [T.nilable(::StackOne::Shared::AssessmentsOrderResult)](../../models/shared/assessmentsorderresult.md) | :heavy_minus_sign: | The assessments order with the given identifier was retrieved. | -| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | -| `headers` | T::Hash[Symbol, T::Array<*::String*>] | :heavy_check_mark: | N/A | -| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `assessment_order_result` | [T.nilable(::StackOne::Shared::AssessmentOrderResult)](../../models/shared/assessmentorderresult.md) | :heavy_minus_sign: | The assessments order with the given identifier was retrieved. | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `headers` | T::Hash[Symbol, T::Array<*::String*>] | :heavy_check_mark: | N/A | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/atsgetassessmentsresultresponse.md b/docs/models/operations/atsgetassessmentsresultresponse.md index 2493420f..d2c0250f 100644 --- a/docs/models/operations/atsgetassessmentsresultresponse.md +++ b/docs/models/operations/atsgetassessmentsresultresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `assessments_results_result` | [T.nilable(::StackOne::Shared::AssessmentsResultsResult)](../../models/shared/assessmentsresultsresult.md) | :heavy_minus_sign: | The assessments result with the given identifier was retrieved. | -| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | -| `headers` | T::Hash[Symbol, T::Array<*::String*>] | :heavy_check_mark: | N/A | -| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `assessment_results_result` | [T.nilable(::StackOne::Shared::AssessmentResultsResult)](../../models/shared/assessmentresultsresult.md) | :heavy_minus_sign: | The assessments result with the given identifier was retrieved. | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `headers` | T::Hash[Symbol, T::Array<*::String*>] | :heavy_check_mark: | N/A | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/atslistassessmentspackagesresponse.md b/docs/models/operations/atslistassessmentspackagesresponse.md index 941d60f8..16d197d0 100644 --- a/docs/models/operations/atslistassessmentspackagesresponse.md +++ b/docs/models/operations/atslistassessmentspackagesresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `assessments_packages_paginated` | [T.nilable(::StackOne::Shared::AssessmentsPackagesPaginated)](../../models/shared/assessmentspackagespaginated.md) | :heavy_minus_sign: | The list of assessments packages was retrieved. | -| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | -| `headers` | T::Hash[Symbol, T::Array<*::String*>] | :heavy_check_mark: | N/A | -| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `assessment_package_paginated` | [T.nilable(::StackOne::Shared::AssessmentPackagePaginated)](../../models/shared/assessmentpackagepaginated.md) | :heavy_minus_sign: | The list of assessments packages was retrieved. | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `headers` | T::Hash[Symbol, T::Array<*::String*>] | :heavy_check_mark: | N/A | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/lmslistassignmentsrequest.md b/docs/models/operations/lmslistassignmentsrequest.md index aae04292..3b18db16 100644 --- a/docs/models/operations/lmslistassignmentsrequest.md +++ b/docs/models/operations/lmslistassignmentsrequest.md @@ -3,16 +3,16 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference | -| `filter` | [T.nilable(::StackOne::Operations::LmsListAssignmentsQueryParamFilter)](../../models/operations/lmslistassignmentsqueryparamfilter.md) | :heavy_minus_sign: | LMS Assignment Filter | | -| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | -| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | -| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | -| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | -| `remote_user_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier of the user related to the assignment | e3cb75bf-aa84-466e-a6c1-b8322b257a48 | -| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | -| `user_id` | *T.nilable(::String)* | :heavy_minus_sign: | The user ID associated with this assignment | c28xyrc55866bvuv | -| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference | +| `filter` | [T.nilable(::StackOne::Operations::LmsListAssignmentsQueryParamFilter)](../../models/operations/lmslistassignmentsqueryparamfilter.md) | :heavy_minus_sign: | LMS Assignment Filter | | +| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | +| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | +| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | +| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `remote_user_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier of the user related to the assignment | e3cb75bf-aa84-466e-a6c1-b8322b257a48 | +| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | +| `user_id` | *T.nilable(::String)* | :heavy_minus_sign: | The user ID associated with this assignment | c28xyrc55866bvuv | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file diff --git a/docs/models/operations/lmslistcompletionsrequest.md b/docs/models/operations/lmslistcompletionsrequest.md index c779033c..926584b7 100644 --- a/docs/models/operations/lmslistcompletionsrequest.md +++ b/docs/models/operations/lmslistcompletionsrequest.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,external_id,remote_external_id,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference | -| `filter` | [T.nilable(::StackOne::Operations::LmsListCompletionsQueryParamFilter)](../../models/operations/lmslistcompletionsqueryparamfilter.md) | :heavy_minus_sign: | LMS Completions Filter | | -| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | -| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | -| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | -| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | -| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | -| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference | +| `filter` | [T.nilable(::StackOne::Operations::LmsListCompletionsQueryParamFilter)](../../models/operations/lmslistcompletionsqueryparamfilter.md) | :heavy_minus_sign: | LMS Completions Filter | | +| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | +| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | +| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | +| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file diff --git a/docs/models/operations/lmslistuserassignmentsrequest.md b/docs/models/operations/lmslistuserassignmentsrequest.md index 853371ea..6a793291 100644 --- a/docs/models/operations/lmslistuserassignmentsrequest.md +++ b/docs/models/operations/lmslistuserassignmentsrequest.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference | -| `filter` | [T.nilable(::StackOne::Operations::LmsListUserAssignmentsQueryParamFilter)](../../models/operations/lmslistuserassignmentsqueryparamfilter.md) | :heavy_minus_sign: | LMS Assignment Filter | | -| `id` | *::String* | :heavy_check_mark: | N/A | | -| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | -| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | -| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | -| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | -| `remote_user_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier of the user related to the assignment | e3cb75bf-aa84-466e-a6c1-b8322b257a48 | -| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | -| `user_id` | *T.nilable(::String)* | :heavy_minus_sign: | The user ID associated with this assignment | c28xyrc55866bvuv | -| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference | +| `filter` | [T.nilable(::StackOne::Operations::LmsListUserAssignmentsQueryParamFilter)](../../models/operations/lmslistuserassignmentsqueryparamfilter.md) | :heavy_minus_sign: | LMS Assignment Filter | | +| `id` | *::String* | :heavy_check_mark: | N/A | | +| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | +| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | +| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | +| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `remote_user_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier of the user related to the assignment | e3cb75bf-aa84-466e-a6c1-b8322b257a48 | +| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | +| `user_id` | *T.nilable(::String)* | :heavy_minus_sign: | The user ID associated with this assignment | c28xyrc55866bvuv | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file diff --git a/docs/models/operations/lmslistusercompletionsrequest.md b/docs/models/operations/lmslistusercompletionsrequest.md index 998c224a..3a9b5679 100644 --- a/docs/models/operations/lmslistusercompletionsrequest.md +++ b/docs/models/operations/lmslistusercompletionsrequest.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,external_id,remote_external_id,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference | -| `filter` | [T.nilable(::StackOne::Operations::LmsListUserCompletionsQueryParamFilter)](../../models/operations/lmslistusercompletionsqueryparamfilter.md) | :heavy_minus_sign: | LMS Completions Filter | | -| `id` | *::String* | :heavy_check_mark: | N/A | | -| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | -| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | -| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | -| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | -| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | -| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference | +| `filter` | [T.nilable(::StackOne::Operations::LmsListUserCompletionsQueryParamFilter)](../../models/operations/lmslistusercompletionsqueryparamfilter.md) | :heavy_minus_sign: | LMS Completions Filter | | +| `id` | *::String* | :heavy_check_mark: | N/A | | +| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | +| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | +| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | +| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file diff --git a/docs/models/shared/assessmentorder.md b/docs/models/shared/assessmentorder.md new file mode 100644 index 00000000..a91f7aa9 --- /dev/null +++ b/docs/models/shared/assessmentorder.md @@ -0,0 +1,15 @@ +# AssessmentOrder + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `application` | [T.nilable(::StackOne::Shared::AssessmentOrderApplication)](../../models/shared/assessmentorderapplication.md) | :heavy_minus_sign: | N/A | | +| `candidate` | [T.nilable(::StackOne::Shared::AssessmentOrderCandidate)](../../models/shared/assessmentordercandidate.md) | :heavy_minus_sign: | N/A | | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `job` | [T.nilable(::StackOne::Shared::AssessmentOrderJob)](../../models/shared/assessmentorderjob.md) | :heavy_minus_sign: | N/A | | +| `package` | [T.nilable(::StackOne::Shared::AssessmentOrderPackage)](../../models/shared/assessmentorderpackage.md) | :heavy_minus_sign: | N/A | | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `requester` | [T.nilable(::StackOne::Shared::Requester)](../../models/shared/requester.md) | :heavy_minus_sign: | N/A | | +| `results_update_url` | *T.nilable(::String)* | :heavy_minus_sign: | Results update url | https://exmaple.com/integrations/results/update | \ No newline at end of file diff --git a/docs/models/shared/assessmentsattachment.md b/docs/models/shared/assessmentorderapplication.md similarity index 52% rename from docs/models/shared/assessmentsattachment.md rename to docs/models/shared/assessmentorderapplication.md index a322501a..87bfdfbe 100644 --- a/docs/models/shared/assessmentsattachment.md +++ b/docs/models/shared/assessmentorderapplication.md @@ -1,9 +1,11 @@ -# AssessmentsAttachment +# AssessmentOrderApplication ## Fields | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | [T.nilable(::StackOne::Shared::AssessmentsAttachmentContentType)](../../models/shared/assessmentsattachmentcontenttype.md) | :heavy_minus_sign: | N/A | | -| `url` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the attachment. | http://example.com/resume.pdf | \ No newline at end of file +| `application_status` | [T.nilable(::StackOne::Shared::AssessmentOrderApplicationStatus)](../../models/shared/assessmentorderapplicationstatus.md) | :heavy_minus_sign: | N/A | | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | \ No newline at end of file diff --git a/docs/models/shared/assessmentorderapplicationstatus.md b/docs/models/shared/assessmentorderapplicationstatus.md new file mode 100644 index 00000000..1ad2c844 --- /dev/null +++ b/docs/models/shared/assessmentorderapplicationstatus.md @@ -0,0 +1,9 @@ +# AssessmentOrderApplicationStatus + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the application status. | Hired | +| `value` | [T.nilable(::StackOne::Shared::AssessmentOrderValue)](../../models/shared/assessmentordervalue.md) | :heavy_minus_sign: | The status of the application. | hired | \ No newline at end of file diff --git a/docs/models/shared/assessmentsordercandidate.md b/docs/models/shared/assessmentordercandidate.md similarity index 99% rename from docs/models/shared/assessmentsordercandidate.md rename to docs/models/shared/assessmentordercandidate.md index eaa46abd..ddec6c8a 100644 --- a/docs/models/shared/assessmentsordercandidate.md +++ b/docs/models/shared/assessmentordercandidate.md @@ -1,4 +1,4 @@ -# AssessmentsOrderCandidate +# AssessmentOrderCandidate ## Fields diff --git a/docs/models/shared/assessmentorderjob.md b/docs/models/shared/assessmentorderjob.md new file mode 100644 index 00000000..108b5460 --- /dev/null +++ b/docs/models/shared/assessmentorderjob.md @@ -0,0 +1,12 @@ +# AssessmentOrderJob + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `hiring_team` | T::Array<[::StackOne::Shared::JobHiringTeam](../../models/shared/jobhiringteam.md)> | :heavy_minus_sign: | Hiring team for the job. | | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `title` | *T.nilable(::String)* | :heavy_minus_sign: | Title of the job | Software Engineer | \ No newline at end of file diff --git a/docs/models/shared/assessmentspackagestestapimodel.md b/docs/models/shared/assessmentorderpackage.md similarity index 98% rename from docs/models/shared/assessmentspackagestestapimodel.md rename to docs/models/shared/assessmentorderpackage.md index 998d7c60..a7ed6977 100644 --- a/docs/models/shared/assessmentspackagestestapimodel.md +++ b/docs/models/shared/assessmentorderpackage.md @@ -1,4 +1,4 @@ -# AssessmentsPackagesTestApiModel +# AssessmentOrderPackage ## Fields diff --git a/docs/models/shared/assessmentsorderresult.md b/docs/models/shared/assessmentorderresult.md similarity index 88% rename from docs/models/shared/assessmentsorderresult.md rename to docs/models/shared/assessmentorderresult.md index 8249d66b..d33e07be 100644 --- a/docs/models/shared/assessmentsorderresult.md +++ b/docs/models/shared/assessmentorderresult.md @@ -1,9 +1,9 @@ -# AssessmentsOrderResult +# AssessmentOrderResult ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `data` | [::StackOne::Shared::AssessmentsOrder](../../models/shared/assessmentsorder.md) | :heavy_check_mark: | N/A | +| `data` | [::StackOne::Shared::AssessmentOrder](../../models/shared/assessmentorder.md) | :heavy_check_mark: | N/A | | `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/assessmentsordervalue.md b/docs/models/shared/assessmentordervalue.md similarity index 98% rename from docs/models/shared/assessmentsordervalue.md rename to docs/models/shared/assessmentordervalue.md index 21f8efac..28662392 100644 --- a/docs/models/shared/assessmentsordervalue.md +++ b/docs/models/shared/assessmentordervalue.md @@ -1,4 +1,4 @@ -# AssessmentsOrderValue +# AssessmentOrderValue The status of the application. diff --git a/docs/models/shared/assessmentspackages.md b/docs/models/shared/assessmentpackage.md similarity index 99% rename from docs/models/shared/assessmentspackages.md rename to docs/models/shared/assessmentpackage.md index d21fee4e..c8c1da41 100644 --- a/docs/models/shared/assessmentspackages.md +++ b/docs/models/shared/assessmentpackage.md @@ -1,4 +1,4 @@ -# AssessmentsPackages +# AssessmentPackage ## Fields diff --git a/docs/models/shared/assessmentspackagespaginated.md b/docs/models/shared/assessmentpackagepaginated.md similarity index 94% rename from docs/models/shared/assessmentspackagespaginated.md rename to docs/models/shared/assessmentpackagepaginated.md index d69d9f85..cebe60c6 100644 --- a/docs/models/shared/assessmentspackagespaginated.md +++ b/docs/models/shared/assessmentpackagepaginated.md @@ -1,11 +1,11 @@ -# AssessmentsPackagesPaginated +# AssessmentPackagePaginated ## Fields | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `data` | T::Array<[::StackOne::Shared::AssessmentsPackages](../../models/shared/assessmentspackages.md)> | :heavy_check_mark: | N/A | +| `data` | T::Array<[::StackOne::Shared::AssessmentPackage](../../models/shared/assessmentpackage.md)> | :heavy_check_mark: | N/A | | `next_` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | | ~~`next_page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/assessmentpackageresult.md b/docs/models/shared/assessmentpackageresult.md new file mode 100644 index 00000000..60178d72 --- /dev/null +++ b/docs/models/shared/assessmentpackageresult.md @@ -0,0 +1,9 @@ +# AssessmentPackageResult + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `data` | [::StackOne::Shared::AssessmentPackage](../../models/shared/assessmentpackage.md) | :heavy_check_mark: | N/A | +| `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/assessmentresult.md b/docs/models/shared/assessmentresult.md new file mode 100644 index 00000000..3d7ea7a0 --- /dev/null +++ b/docs/models/shared/assessmentresult.md @@ -0,0 +1,17 @@ +# AssessmentResult + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `attachments` | T::Array<[::StackOne::Shared::Attachment](../../models/shared/attachment.md)> | :heavy_minus_sign: | N/A | | +| `candidate` | [T.nilable(::StackOne::Shared::AssessmentResultCandidate)](../../models/shared/assessmentresultcandidate.md) | :heavy_minus_sign: | N/A | | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `result` | [T.nilable(::StackOne::Shared::Result)](../../models/shared/result.md) | :heavy_minus_sign: | N/A | | +| `result_url` | *T.nilable(::String)* | :heavy_minus_sign: | The test`s result url | https://exmaple.com/result?id=xyz | +| `score` | [T.nilable(::StackOne::Shared::Score)](../../models/shared/score.md) | :heavy_minus_sign: | N/A | | +| `start_date` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | The start date of the candidate test | 2021-01-01T01:01:01.000Z | +| `submission_date` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | The submission date of the candidate test | 2021-01-01T01:01:01.000Z | +| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | The summary about the result of the test | Test is passed | \ No newline at end of file diff --git a/docs/models/shared/assessmentsresultscandidate.md b/docs/models/shared/assessmentresultcandidate.md similarity index 97% rename from docs/models/shared/assessmentsresultscandidate.md rename to docs/models/shared/assessmentresultcandidate.md index e04ea97b..d715e953 100644 --- a/docs/models/shared/assessmentsresultscandidate.md +++ b/docs/models/shared/assessmentresultcandidate.md @@ -1,4 +1,4 @@ -# AssessmentsResultsCandidate +# AssessmentResultCandidate ## Fields diff --git a/docs/models/shared/assessmentresultsresult.md b/docs/models/shared/assessmentresultsresult.md new file mode 100644 index 00000000..ace1ee62 --- /dev/null +++ b/docs/models/shared/assessmentresultsresult.md @@ -0,0 +1,9 @@ +# AssessmentResultsResult + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `data` | [::StackOne::Shared::AssessmentResult](../../models/shared/assessmentresult.md) | :heavy_check_mark: | N/A | +| `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/assessmentsresultsvalue.md b/docs/models/shared/assessmentresultvalue.md similarity index 89% rename from docs/models/shared/assessmentsresultsvalue.md rename to docs/models/shared/assessmentresultvalue.md index 67f05396..7ca7326c 100644 --- a/docs/models/shared/assessmentsresultsvalue.md +++ b/docs/models/shared/assessmentresultvalue.md @@ -1,4 +1,4 @@ -# AssessmentsResultsValue +# AssessmentResultValue The result of the test. diff --git a/docs/models/shared/assessmentsorder.md b/docs/models/shared/assessmentsorder.md deleted file mode 100644 index 054aeb10..00000000 --- a/docs/models/shared/assessmentsorder.md +++ /dev/null @@ -1,15 +0,0 @@ -# AssessmentsOrder - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `application` | [T.nilable(::StackOne::Shared::AssessmentsOrderApplication)](../../models/shared/assessmentsorderapplication.md) | :heavy_minus_sign: | N/A | | -| `candidate` | [T.nilable(::StackOne::Shared::AssessmentsOrderCandidate)](../../models/shared/assessmentsordercandidate.md) | :heavy_minus_sign: | N/A | | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `job` | [T.nilable(::StackOne::Shared::AssessmentsOrderJob)](../../models/shared/assessmentsorderjob.md) | :heavy_minus_sign: | N/A | | -| `package` | [T.nilable(::StackOne::Shared::Package)](../../models/shared/package.md) | :heavy_minus_sign: | N/A | | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `requester` | [T.nilable(::StackOne::Shared::Requester)](../../models/shared/requester.md) | :heavy_minus_sign: | N/A | | -| `results_update_url` | *T.nilable(::String)* | :heavy_minus_sign: | Results update url | https://exmaple.com/integrations/results/update | \ No newline at end of file diff --git a/docs/models/shared/assessmentsorderapplication.md b/docs/models/shared/assessmentsorderapplication.md deleted file mode 100644 index ff966602..00000000 --- a/docs/models/shared/assessmentsorderapplication.md +++ /dev/null @@ -1,11 +0,0 @@ -# AssessmentsOrderApplication - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `application_status` | [T.nilable(::StackOne::Shared::AssessmentsOrderApplicationStatus)](../../models/shared/assessmentsorderapplicationstatus.md) | :heavy_minus_sign: | N/A | | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | \ No newline at end of file diff --git a/docs/models/shared/assessmentsorderjob.md b/docs/models/shared/assessmentsorderjob.md deleted file mode 100644 index a72db777..00000000 --- a/docs/models/shared/assessmentsorderjob.md +++ /dev/null @@ -1,12 +0,0 @@ -# AssessmentsOrderJob - - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `hiring_team` | T::Array<[::StackOne::Shared::AssessmentsRequestsJobHiringTeamApiModel](../../models/shared/assessmentsrequestsjobhiringteamapimodel.md)> | :heavy_minus_sign: | Hiring team for the job. | | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `title` | *T.nilable(::String)* | :heavy_minus_sign: | Title of the job | Software Engineer | \ No newline at end of file diff --git a/docs/models/shared/assessmentspackagesresult.md b/docs/models/shared/assessmentspackagesresult.md deleted file mode 100644 index ac12982d..00000000 --- a/docs/models/shared/assessmentspackagesresult.md +++ /dev/null @@ -1,9 +0,0 @@ -# AssessmentsPackagesResult - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `data` | [::StackOne::Shared::AssessmentsPackages](../../models/shared/assessmentspackages.md) | :heavy_check_mark: | N/A | -| `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/assessmentsrequestsjobhiringteamapimodel.md b/docs/models/shared/assessmentsrequestsjobhiringteamapimodel.md deleted file mode 100644 index 29862101..00000000 --- a/docs/models/shared/assessmentsrequestsjobhiringteamapimodel.md +++ /dev/null @@ -1,13 +0,0 @@ -# AssessmentsRequestsJobHiringTeamApiModel - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `email` | *T.nilable(::String)* | :heavy_minus_sign: | Email of the hiring team member. | john.doe@gmail.com | -| `first_name` | *T.nilable(::String)* | :heavy_minus_sign: | First name of the hiring team member. | John | -| `last_name` | *T.nilable(::String)* | :heavy_minus_sign: | Last name of the hiring team member. | Doe | -| `remote_user_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier of the user | e3cb75bf-aa84-466e-a6c1-b8322b257a48 | -| `role` | *T.nilable(::String)* | :heavy_minus_sign: | Role of the hiring team member. | Software Engineer | -| `user_id` | *T.nilable(::String)* | :heavy_minus_sign: | User ID of the hiring team member. | 123456 | \ No newline at end of file diff --git a/docs/models/shared/assessmentsresults.md b/docs/models/shared/assessmentsresults.md deleted file mode 100644 index 286dda6f..00000000 --- a/docs/models/shared/assessmentsresults.md +++ /dev/null @@ -1,17 +0,0 @@ -# AssessmentsResults - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `attachments` | T::Array<[::StackOne::Shared::AssessmentsAttachment](../../models/shared/assessmentsattachment.md)> | :heavy_minus_sign: | N/A | | -| `candidate` | [T.nilable(::StackOne::Shared::AssessmentsResultsCandidate)](../../models/shared/assessmentsresultscandidate.md) | :heavy_minus_sign: | N/A | | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `result` | [T.nilable(::StackOne::Shared::Result)](../../models/shared/result.md) | :heavy_minus_sign: | N/A | | -| `result_url` | *T.nilable(::String)* | :heavy_minus_sign: | The test`s result url | https://exmaple.com/result?id=xyz | -| `score` | [T.nilable(::StackOne::Shared::Score)](../../models/shared/score.md) | :heavy_minus_sign: | N/A | | -| `start_date` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | The start date of the candidate test | 2021-01-01T01:01:01.000Z | -| `submission_date` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | The submission date of the candidate test | 2021-01-01T01:01:01.000Z | -| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | The summary about the result of the test | Test is passed | \ No newline at end of file diff --git a/docs/models/shared/assessmentsresultsresult.md b/docs/models/shared/assessmentsresultsresult.md deleted file mode 100644 index eac6cfcf..00000000 --- a/docs/models/shared/assessmentsresultsresult.md +++ /dev/null @@ -1,9 +0,0 @@ -# AssessmentsResultsResult - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `data` | [::StackOne::Shared::AssessmentsResults](../../models/shared/assessmentsresults.md) | :heavy_check_mark: | N/A | -| `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/assignment.md b/docs/models/shared/assignment.md index 2641043b..9b7bc0b3 100644 --- a/docs/models/shared/assignment.md +++ b/docs/models/shared/assignment.md @@ -8,6 +8,7 @@ | ~~`course_id`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The course ID associated with this assignment | 16873-ENG-1 | | `created_at` | *T.nilable(::String)* | :heavy_minus_sign: | The date the assignment was created | 2021-07-21T14:00:00.000Z | | `due_date` | *T.nilable(::String)* | :heavy_minus_sign: | The date the assignment is due to be completed | 2021-07-21T14:00:00.000Z | +| `external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external reference associated with this assignment | e3gd34-23tr21-er234-345er56 | | `id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID associated with this assignment | 123456 | | `learning_object_external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external reference of the learning object associated with this assignment | learning-content-123 | | `learning_object_id` | *T.nilable(::String)* | :heavy_minus_sign: | The learning_object_id associated with this assignment | e3gd34-23tr21-er234-345er56 | diff --git a/docs/models/shared/atscreatebackgroundcheckpackagesrequestdto.md b/docs/models/shared/atscreatebackgroundcheckpackagesrequestdto.md index 817d52fa..c97333c0 100644 --- a/docs/models/shared/atscreatebackgroundcheckpackagesrequestdto.md +++ b/docs/models/shared/atscreatebackgroundcheckpackagesrequestdto.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `description` | *T.nilable(::String)* | :heavy_minus_sign: | Package description | Standard background package for hires | -| `name` | *T.nilable(::String)* | :heavy_minus_sign: | Package name | Standard Background Check | -| `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | -| `tests` | T::Array<[::StackOne::Shared::CreateAssessmentsPackages](../../models/shared/createassessmentspackages.md)> | :heavy_minus_sign: | Package tests | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `description` | *T.nilable(::String)* | :heavy_minus_sign: | Package description | Skills test to gauge a candidate's proficiency in job-specific skills | +| `name` | *T.nilable(::String)* | :heavy_minus_sign: | Package name | Test 1 | +| `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | +| `tests` | T::Array<[::StackOne::Shared::CreatePackage](../../models/shared/createpackage.md)> | :heavy_minus_sign: | Package tests | | \ No newline at end of file diff --git a/docs/models/shared/assessmentsorderapplicationstatus.md b/docs/models/shared/attachment.md similarity index 65% rename from docs/models/shared/assessmentsorderapplicationstatus.md rename to docs/models/shared/attachment.md index 55a9ce95..22deacdd 100644 --- a/docs/models/shared/assessmentsorderapplicationstatus.md +++ b/docs/models/shared/attachment.md @@ -1,9 +1,9 @@ -# AssessmentsOrderApplicationStatus +# Attachment ## Fields | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the application status. | Hired | -| `value` | [T.nilable(::StackOne::Shared::AssessmentsOrderValue)](../../models/shared/assessmentsordervalue.md) | :heavy_minus_sign: | The status of the application. | hired | \ No newline at end of file +| `content_type` | [T.nilable(::StackOne::Shared::AttachmentContentType)](../../models/shared/attachmentcontenttype.md) | :heavy_minus_sign: | N/A | | +| `url` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the attachment. | http://example.com/resume.pdf | \ No newline at end of file diff --git a/docs/models/shared/attachmentcontenttype.md b/docs/models/shared/attachmentcontenttype.md new file mode 100644 index 00000000..26b24ba6 --- /dev/null +++ b/docs/models/shared/attachmentcontenttype.md @@ -0,0 +1,9 @@ +# AttachmentContentType + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the content type. | Text | +| `value` | [T.nilable(::StackOne::Shared::AttachmentValue)](../../models/shared/attachmentvalue.md) | :heavy_minus_sign: | The content type of the attachment. | text | \ No newline at end of file diff --git a/docs/models/shared/assessmentsattachmentvalue.md b/docs/models/shared/attachmentvalue.md similarity index 87% rename from docs/models/shared/assessmentsattachmentvalue.md rename to docs/models/shared/attachmentvalue.md index aa1bc4f5..fdb73185 100644 --- a/docs/models/shared/assessmentsattachmentvalue.md +++ b/docs/models/shared/attachmentvalue.md @@ -1,4 +1,4 @@ -# AssessmentsAttachmentValue +# AttachmentValue The content type of the attachment. diff --git a/docs/models/shared/backgroundcheckorderjob.md b/docs/models/shared/backgroundcheckorderjob.md index 1e64358d..9e85edaa 100644 --- a/docs/models/shared/backgroundcheckorderjob.md +++ b/docs/models/shared/backgroundcheckorderjob.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `hiring_team` | T::Array<[::StackOne::Shared::AssessmentsRequestsJobHiringTeamApiModel](../../models/shared/assessmentsrequestsjobhiringteamapimodel.md)> | :heavy_minus_sign: | Hiring team for the job. | | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `title` | *T.nilable(::String)* | :heavy_minus_sign: | Title of the job | Software Engineer | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `hiring_team` | T::Array<[::StackOne::Shared::JobHiringTeam](../../models/shared/jobhiringteam.md)> | :heavy_minus_sign: | Hiring team for the job. | | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `title` | *T.nilable(::String)* | :heavy_minus_sign: | Title of the job | Software Engineer | \ No newline at end of file diff --git a/docs/models/shared/backgroundcheckorderpackage.md b/docs/models/shared/backgroundcheckorderpackage.md index 92c7bffa..2612bc52 100644 --- a/docs/models/shared/backgroundcheckorderpackage.md +++ b/docs/models/shared/backgroundcheckorderpackage.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `description` | *T.nilable(::String)* | :heavy_minus_sign: | Package description | Standard background package for hires | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `name` | *T.nilable(::String)* | :heavy_minus_sign: | Package name | Standard Background Check | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `tests` | T::Array<[::StackOne::Shared::AssessmentsPackagesTestApiModel](../../models/shared/assessmentspackagestestapimodel.md)> | :heavy_minus_sign: | Package tests | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `description` | *T.nilable(::String)* | :heavy_minus_sign: | Package description | Skills test to gauge a candidate's proficiency in job-specific skills | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `name` | *T.nilable(::String)* | :heavy_minus_sign: | Package name | Test 1 | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `tests` | T::Array<[::StackOne::Shared::Package](../../models/shared/package.md)> | :heavy_minus_sign: | Package tests | | \ No newline at end of file diff --git a/docs/models/shared/backgroundcheckpackage.md b/docs/models/shared/backgroundcheckpackage.md index 3288cd81..c0308778 100644 --- a/docs/models/shared/backgroundcheckpackage.md +++ b/docs/models/shared/backgroundcheckpackage.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `description` | *T.nilable(::String)* | :heavy_minus_sign: | Package description | Standard background package for hires | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `name` | *T.nilable(::String)* | :heavy_minus_sign: | Package name | Standard Background Check | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `tests` | T::Array<[::StackOne::Shared::AssessmentsPackages](../../models/shared/assessmentspackages.md)> | :heavy_minus_sign: | Package tests | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `description` | *T.nilable(::String)* | :heavy_minus_sign: | Package description | Skills test to gauge a candidate's proficiency in job-specific skills | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `name` | *T.nilable(::String)* | :heavy_minus_sign: | Package name | Test 1 | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `tests` | T::Array<[::StackOne::Shared::Package](../../models/shared/package.md)> | :heavy_minus_sign: | Package tests | | \ No newline at end of file diff --git a/docs/models/shared/backgroundcheckresult.md b/docs/models/shared/backgroundcheckresult.md new file mode 100644 index 00000000..e1cc33ad --- /dev/null +++ b/docs/models/shared/backgroundcheckresult.md @@ -0,0 +1,17 @@ +# BackgroundCheckResult + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `attachments` | T::Array<[::StackOne::Shared::Attachment](../../models/shared/attachment.md)> | :heavy_minus_sign: | N/A | | +| `candidate` | [T.nilable(::StackOne::Shared::BackgroundCheckResultCandidate)](../../models/shared/backgroundcheckresultcandidate.md) | :heavy_minus_sign: | N/A | | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `result` | [T.nilable(::StackOne::Shared::BackgroundCheckResultResult)](../../models/shared/backgroundcheckresultresult.md) | :heavy_minus_sign: | N/A | | +| `result_url` | *T.nilable(::String)* | :heavy_minus_sign: | The test`s result url | https://exmaple.com/result?id=xyz | +| `score` | [T.nilable(::StackOne::Shared::BackgroundCheckResultScore)](../../models/shared/backgroundcheckresultscore.md) | :heavy_minus_sign: | N/A | | +| `start_date` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | The start date of the candidate test | 2021-01-01T01:01:01.000Z | +| `submission_date` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | The submission date of the candidate test | 2021-01-01T01:01:01.000Z | +| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | The summary about the result of the test | Test is passed | \ No newline at end of file diff --git a/docs/models/shared/backgroundcheckresultsresultcandidate.md b/docs/models/shared/backgroundcheckresultcandidate.md similarity index 96% rename from docs/models/shared/backgroundcheckresultsresultcandidate.md rename to docs/models/shared/backgroundcheckresultcandidate.md index 56d2c69f..be49f58e 100644 --- a/docs/models/shared/backgroundcheckresultsresultcandidate.md +++ b/docs/models/shared/backgroundcheckresultcandidate.md @@ -1,4 +1,4 @@ -# BackgroundCheckResultsResultCandidate +# BackgroundCheckResultCandidate ## Fields diff --git a/docs/models/shared/assessmentsattachmentcontenttype.md b/docs/models/shared/backgroundcheckresultresult.md similarity index 81% rename from docs/models/shared/assessmentsattachmentcontenttype.md rename to docs/models/shared/backgroundcheckresultresult.md index b057f27d..2aa694cb 100644 --- a/docs/models/shared/assessmentsattachmentcontenttype.md +++ b/docs/models/shared/backgroundcheckresultresult.md @@ -1,9 +1,9 @@ -# AssessmentsAttachmentContentType +# BackgroundCheckResultResult ## Fields | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the content type. | Text | -| `value` | [T.nilable(::StackOne::Shared::AssessmentsAttachmentValue)](../../models/shared/assessmentsattachmentvalue.md) | :heavy_minus_sign: | The content type of the attachment. | text | \ No newline at end of file +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the test result. | Passed | +| `value` | [T.nilable(::StackOne::Shared::BackgroundCheckResultValue)](../../models/shared/backgroundcheckresultvalue.md) | :heavy_minus_sign: | The result of the test. | passed | \ No newline at end of file diff --git a/docs/models/shared/backgroundcheckresultsresultscore.md b/docs/models/shared/backgroundcheckresultscore.md similarity index 96% rename from docs/models/shared/backgroundcheckresultsresultscore.md rename to docs/models/shared/backgroundcheckresultscore.md index f8ceec11..37b83237 100644 --- a/docs/models/shared/backgroundcheckresultsresultscore.md +++ b/docs/models/shared/backgroundcheckresultscore.md @@ -1,4 +1,4 @@ -# BackgroundCheckResultsResultScore +# BackgroundCheckResultScore ## Fields diff --git a/docs/models/shared/backgroundcheckresultsresult.md b/docs/models/shared/backgroundcheckresultsresult.md index 3bfbd443..61c2095f 100644 --- a/docs/models/shared/backgroundcheckresultsresult.md +++ b/docs/models/shared/backgroundcheckresultsresult.md @@ -3,15 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `attachments` | T::Array<[::StackOne::Shared::AssessmentsAttachment](../../models/shared/assessmentsattachment.md)> | :heavy_minus_sign: | N/A | | -| `candidate` | [T.nilable(::StackOne::Shared::BackgroundCheckResultsResultCandidate)](../../models/shared/backgroundcheckresultsresultcandidate.md) | :heavy_minus_sign: | N/A | | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `result` | [T.nilable(::StackOne::Shared::BackgroundCheckResultsResultResult)](../../models/shared/backgroundcheckresultsresultresult.md) | :heavy_minus_sign: | N/A | | -| `result_url` | *T.nilable(::String)* | :heavy_minus_sign: | The test`s result url | https://exmaple.com/result?id=xyz | -| `score` | [T.nilable(::StackOne::Shared::BackgroundCheckResultsResultScore)](../../models/shared/backgroundcheckresultsresultscore.md) | :heavy_minus_sign: | N/A | | -| `start_date` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | The start date of the candidate test | 2021-01-01T01:01:01.000Z | -| `submission_date` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | The submission date of the candidate test | 2021-01-01T01:01:01.000Z | -| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | The summary about the result of the test | Test is passed | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `data` | [::StackOne::Shared::BackgroundCheckResult](../../models/shared/backgroundcheckresult.md) | :heavy_check_mark: | N/A | +| `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/backgroundcheckresultsresultresult.md b/docs/models/shared/backgroundcheckresultsresultresult.md deleted file mode 100644 index 64d40c59..00000000 --- a/docs/models/shared/backgroundcheckresultsresultresult.md +++ /dev/null @@ -1,9 +0,0 @@ -# BackgroundCheckResultsResultResult - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the test result. | Passed | -| `value` | [T.nilable(::StackOne::Shared::BackgroundCheckResultsResultValue)](../../models/shared/backgroundcheckresultsresultvalue.md) | :heavy_minus_sign: | The result of the test. | passed | \ No newline at end of file diff --git a/docs/models/shared/backgroundcheckresultsresultvalue.md b/docs/models/shared/backgroundcheckresultvalue.md similarity index 85% rename from docs/models/shared/backgroundcheckresultsresultvalue.md rename to docs/models/shared/backgroundcheckresultvalue.md index 9dd11566..8e39402d 100644 --- a/docs/models/shared/backgroundcheckresultsresultvalue.md +++ b/docs/models/shared/backgroundcheckresultvalue.md @@ -1,4 +1,4 @@ -# BackgroundCheckResultsResultValue +# BackgroundCheckResultValue The result of the test. diff --git a/docs/models/shared/categoryvalue.md b/docs/models/shared/categoryvalue.md index 1c376211..a1d227cb 100644 --- a/docs/models/shared/categoryvalue.md +++ b/docs/models/shared/categoryvalue.md @@ -6,4 +6,5 @@ | Name | Value | | ----------- | ----------- | | `PRIMARY` | primary | -| `SECONDARY` | secondary | \ No newline at end of file +| `SECONDARY` | secondary | +| `TERTIARY` | tertiary | \ No newline at end of file diff --git a/docs/models/shared/completion.md b/docs/models/shared/completion.md index 648c2d78..446fa76e 100644 --- a/docs/models/shared/completion.md +++ b/docs/models/shared/completion.md @@ -11,6 +11,7 @@ | ~~`course_id`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The course ID associated with this completion | 16873-ENG-COURSE-1 | | `created_at` | *T.nilable(::String)* | :heavy_minus_sign: | The created date of the completion | 2021-07-21T14:00:00.000Z | | ~~`external_id`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The external ID associated with this completion | SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION | +| `external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external reference associated with this completion | e3gd34-23tr21-er234-345er56 | | `id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID associated with this completion | 123456 | | `learning_object_external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external reference of the learning object associated with this completion | learning-content-123 | | `learning_object_id` | *T.nilable(::String)* | :heavy_minus_sign: | The id of the learning object associated with this completion | e3gd34-23tr21-er234-345er56 | diff --git a/docs/models/shared/createcategoriesapimodel.md b/docs/models/shared/createcategoriesapimodel.md index a0359639..6cfb4140 100644 --- a/docs/models/shared/createcategoriesapimodel.md +++ b/docs/models/shared/createcategoriesapimodel.md @@ -3,7 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `name` | *T.nilable(::String)* | :heavy_minus_sign: | The name associated with this category | Information-Technology | -| `unified_custom_fields` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Custom Unified Fields configured in your StackOne project | {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
} | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID associated with this category | 16873-IT345 | +| `level` | [T.nilable(::StackOne::Shared::CreateCategoriesApiModelLevel)](../../models/shared/createcategoriesapimodellevel.md) | :heavy_minus_sign: | The hierarchal level of the category | | +| `name` | *T.nilable(::String)* | :heavy_minus_sign: | The name associated with this category | Information-Technology | +| `unified_custom_fields` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Custom Unified Fields configured in your StackOne project | {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
} | \ No newline at end of file diff --git a/docs/models/shared/createcategoriesapimodellevel.md b/docs/models/shared/createcategoriesapimodellevel.md new file mode 100644 index 00000000..ece61221 --- /dev/null +++ b/docs/models/shared/createcategoriesapimodellevel.md @@ -0,0 +1,11 @@ +# CreateCategoriesApiModelLevel + +The hierarchal level of the category + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | +| `value` | [T.nilable(::StackOne::Shared::CreateCategoriesApiModelValue)](../../models/shared/createcategoriesapimodelvalue.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/createcategoriesapimodelvalue.md b/docs/models/shared/createcategoriesapimodelvalue.md new file mode 100644 index 00000000..921e800d --- /dev/null +++ b/docs/models/shared/createcategoriesapimodelvalue.md @@ -0,0 +1,10 @@ +# CreateCategoriesApiModelValue + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `PRIMARY` | primary | +| `SECONDARY` | secondary | +| `TERTIARY` | tertiary | \ No newline at end of file diff --git a/docs/models/shared/createassessmentspackages.md b/docs/models/shared/createpackage.md similarity index 98% rename from docs/models/shared/createassessmentspackages.md rename to docs/models/shared/createpackage.md index 04820f54..fb1db69c 100644 --- a/docs/models/shared/createassessmentspackages.md +++ b/docs/models/shared/createpackage.md @@ -1,4 +1,4 @@ -# CreateAssessmentsPackages +# CreatePackage ## Fields diff --git a/docs/models/shared/createskillsapimodel.md b/docs/models/shared/createskillsapimodel.md index 35fee1b3..455359ee 100644 --- a/docs/models/shared/createskillsapimodel.md +++ b/docs/models/shared/createskillsapimodel.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID associated with this skill | 16873-IT345 | -| `name` | *T.nilable(::String)* | :heavy_minus_sign: | The name associated with this skill | Information-Technology | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID associated with this skill | 16873-IT345 | +| `level` | [T.nilable(::StackOne::Shared::CreateSkillsApiModelLevel)](../../models/shared/createskillsapimodellevel.md) | :heavy_minus_sign: | The hierarchal level of the skill | | +| `name` | *T.nilable(::String)* | :heavy_minus_sign: | The name associated with this skill | Information-Technology | \ No newline at end of file diff --git a/docs/models/shared/createskillsapimodellevel.md b/docs/models/shared/createskillsapimodellevel.md new file mode 100644 index 00000000..c9264abd --- /dev/null +++ b/docs/models/shared/createskillsapimodellevel.md @@ -0,0 +1,11 @@ +# CreateSkillsApiModelLevel + +The hierarchal level of the skill + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | +| `value` | [T.nilable(::StackOne::Shared::CreateSkillsApiModelValue)](../../models/shared/createskillsapimodelvalue.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/createskillsapimodelvalue.md b/docs/models/shared/createskillsapimodelvalue.md new file mode 100644 index 00000000..3b8a24a3 --- /dev/null +++ b/docs/models/shared/createskillsapimodelvalue.md @@ -0,0 +1,10 @@ +# CreateSkillsApiModelValue + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `PRIMARY` | primary | +| `SECONDARY` | secondary | +| `TERTIARY` | tertiary | \ No newline at end of file diff --git a/docs/models/shared/lmscreateassignmentrequestdto.md b/docs/models/shared/lmscreateassignmentrequestdto.md index c42ca8db..a08becfa 100644 --- a/docs/models/shared/lmscreateassignmentrequestdto.md +++ b/docs/models/shared/lmscreateassignmentrequestdto.md @@ -7,6 +7,7 @@ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `created_at` | *T.nilable(::String)* | :heavy_minus_sign: | The date the assignment was created | 2021-07-21T14:00:00.000Z | | `due_date` | *T.nilable(::String)* | :heavy_minus_sign: | The date the assignment is due to be completed | 2021-07-21T14:00:00.000Z | +| `external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external reference associated with this assignment | e3gd34-23tr21-er234-345er56 | | `learning_object_external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external reference of the learning object associated with this assignment | learning-content-123 | | `learning_object_id` | *T.nilable(::String)* | :heavy_minus_sign: | The learning_object_id associated with this assignment | e3gd34-23tr21-er234-345er56 | | `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | diff --git a/docs/models/shared/lmscreatecollectionrequestdto.md b/docs/models/shared/lmscreatecollectionrequestdto.md index 4bde504b..3e761bd2 100644 --- a/docs/models/shared/lmscreatecollectionrequestdto.md +++ b/docs/models/shared/lmscreatecollectionrequestdto.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `categories` | T::Array<[::StackOne::Shared::CreateCategoriesApiModel](../../models/shared/createcategoriesapimodel.md)> | :heavy_minus_sign: | The categories associated with this content | [
{
"name": "Technology"
}
] | +| `categories` | T::Array<[::StackOne::Shared::CreateCategoriesApiModel](../../models/shared/createcategoriesapimodel.md)> | :heavy_minus_sign: | The categories associated with this content | | | `cover_url` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the thumbnail image associated with the collection. | https://www.googledrive.com/?v=16873 | | `description` | *T.nilable(::String)* | :heavy_minus_sign: | The description of the collection | This collection acts as learning pathway for software engineers. | | `external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external ID associated with this collection | SOFTWARE-ENG-LV1-TRAINING-collection-1 | | `languages` | T::Array<*::String*> | :heavy_minus_sign: | The languages associated with this collection | | | `learning_object_ids` | T::Array<*::String*> | :heavy_minus_sign: | The child ID/IDs associated with this collection | [
"16873-SOFTWARE-ENG-COURSE",
"16874-SOFTWARE-ENG-COURSE"
] | | `remote_learning_object_ids` | T::Array<*::String*> | :heavy_minus_sign: | Provider's unique identifiers of the child ID/IDs associated with this collection | [
"e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"e3cb75bf-aa84-466e-a6c1-b8322b257a49"
] | -| `skills` | T::Array<[::StackOne::Shared::CreateSkillsApiModel](../../models/shared/createskillsapimodel.md)> | :heavy_minus_sign: | The skills associated with this content | [
{
"name": "Technology"
}
] | +| `skills` | T::Array<[::StackOne::Shared::CreateSkillsApiModel](../../models/shared/createskillsapimodel.md)> | :heavy_minus_sign: | The skills associated with this content | | | `title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the collection | Software Engineer Lv 1 Collection | | `unified_custom_fields` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Custom Unified Fields configured in your StackOne project | {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
} | \ No newline at end of file diff --git a/docs/models/shared/lmscreatecompletionrequestdto.md b/docs/models/shared/lmscreatecompletionrequestdto.md index fd7fac9d..5ef50aeb 100644 --- a/docs/models/shared/lmscreatecompletionrequestdto.md +++ b/docs/models/shared/lmscreatecompletionrequestdto.md @@ -9,6 +9,7 @@ | ~~`content_external_reference`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The external reference associated with this content | SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT | | ~~`content_id`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The content ID associated with this completion | 16873-ENG-VIDEO-1 | | ~~`external_id`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The external ID associated with this completion | SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION | +| `external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external reference associated with this completion | e3gd34-23tr21-er234-345er56 | | `learning_object_external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external reference of the learning object associated with this completion | learning-content-123 | | `learning_object_id` | *T.nilable(::String)* | :heavy_minus_sign: | The id of the learning object associated with this completion | e3gd34-23tr21-er234-345er56 | | `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | diff --git a/docs/models/shared/lmsupsertcontentrequestdto.md b/docs/models/shared/lmsupsertcontentrequestdto.md index 131f1020..22468562 100644 --- a/docs/models/shared/lmsupsertcontentrequestdto.md +++ b/docs/models/shared/lmsupsertcontentrequestdto.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Whether the content is active and available for users. | true | -| `categories` | T::Array<[::StackOne::Shared::CreateCategoriesApiModel](../../models/shared/createcategoriesapimodel.md)> | :heavy_minus_sign: | The categories associated with this content | [
{
"name": "Technology"
}
] | +| `categories` | T::Array<[::StackOne::Shared::CreateCategoriesApiModel](../../models/shared/createcategoriesapimodel.md)> | :heavy_minus_sign: | The categories associated with this content | | | `content_type` | [T.nilable(::StackOne::Shared::LmsUpsertContentRequestDtoContentType)](../../models/shared/lmsupsertcontentrequestdtocontenttype.md) | :heavy_minus_sign: | The type of content | | | `content_url` | *T.nilable(::String)* | :heavy_minus_sign: | The external URL of the content | https://www.youtube.com/watch?v=16873 | | `course_ids` | T::Array<*::String*> | :heavy_minus_sign: | The parent IDs associated with this content | [
"16873-SOFTWARE-ENG-COURSE"
] | @@ -17,6 +17,6 @@ | `languages` | T::Array<[::StackOne::Shared::LanguageEnum](../../models/shared/languageenum.md)> | :heavy_minus_sign: | The languages associated with this content | | | `order` | *T.nilable(::Float)* | :heavy_minus_sign: | The order of the individual content within a content grouping. This is not applicable for pushing individual content. | 1 | | `short_description` | *T.nilable(::String)* | :heavy_minus_sign: | A short description or summary for the content | This course is a valuable resource and acts as learning content for... | -| `skills` | T::Array<[::StackOne::Shared::CreateSkillsApiModel](../../models/shared/createskillsapimodel.md)> | :heavy_minus_sign: | The skills associated with this content | [
{
"name": "Software Engineering",
"id": "cx2367ndc8dgsbjhka9ry4",
"remote_id": "SE-001"
}
] | +| `skills` | T::Array<[::StackOne::Shared::CreateSkillsApiModel](../../models/shared/createskillsapimodel.md)> | :heavy_minus_sign: | The skills associated with this content | [
{
"id": "12345",
"name": "Sales Techniques"
}
] | | `title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the content | Software Engineer Lv 1 | | `unified_custom_fields` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Custom Unified Fields configured in your StackOne project | {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
} | \ No newline at end of file diff --git a/docs/models/shared/lmsupsertcourserequestdto.md b/docs/models/shared/lmsupsertcourserequestdto.md index a9ff9660..93614177 100644 --- a/docs/models/shared/lmsupsertcourserequestdto.md +++ b/docs/models/shared/lmsupsertcourserequestdto.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Whether the course is active and available for users. | true | -| `categories` | T::Array<[::StackOne::Shared::CreateCategoriesApiModel](../../models/shared/createcategoriesapimodel.md)> | :heavy_minus_sign: | The categories associated with this course | [
{
"name": "Technology"
}
] | +| `categories` | T::Array<[::StackOne::Shared::CreateCategoriesApiModel](../../models/shared/createcategoriesapimodel.md)> | :heavy_minus_sign: | The categories associated with this content | | | `content` | T::Array<[::StackOne::Shared::CreateContentApiModel](../../models/shared/createcontentapimodel.md)> | :heavy_minus_sign: | The content associated with this course | | | `content_ids` | T::Array<*::String*> | :heavy_minus_sign: | The child IDs associated with this course | [
"16873-SOFTWARE-ENG-Content"
] | | `cover_url` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the thumbnail image associated with the course. | https://www.googledrive.com/?v=16873 | @@ -14,7 +14,7 @@ | `duration` | *T.nilable(::String)* | :heavy_minus_sign: | The duration of the course following the ISO8601 standard. If duration_unit is applicable we will derive this from the smallest unit given in the duration string | P3Y6M4DT12H30M5S | | `external_reference` | *T.nilable(::String)* | :heavy_minus_sign: | The external ID associated with this course | SOFTWARE-ENG-LV1-TRAINING-VIDEO-1 | | `languages` | T::Array<[::StackOne::Shared::LanguageEnum](../../models/shared/languageenum.md)> | :heavy_minus_sign: | The languages associated with this course | | -| `skills` | T::Array<[::StackOne::Shared::CreateSkillsApiModel](../../models/shared/createskillsapimodel.md)> | :heavy_minus_sign: | The skills associated with this course | [
{
"name": "Software Engineering",
"id": "cx2367ndc8dgsbjhka9ry4",
"remote_id": "SE-001"
}
] | +| `skills` | T::Array<[::StackOne::Shared::CreateSkillsApiModel](../../models/shared/createskillsapimodel.md)> | :heavy_minus_sign: | The skills associated with this content | | | `title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the course | Software Engineer Lv 1 | | `unified_custom_fields` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Custom Unified Fields configured in your StackOne project | {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
} | | `url` | *T.nilable(::String)* | :heavy_minus_sign: | The redirect URL of the course. | https://www.linkedinlearning.com/?v=16873 | \ No newline at end of file diff --git a/docs/models/shared/result.md b/docs/models/shared/result.md index 15e2ebc1..2b1b3c62 100644 --- a/docs/models/shared/result.md +++ b/docs/models/shared/result.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the test result. | Passed | -| `value` | [T.nilable(::StackOne::Shared::AssessmentsResultsValue)](../../models/shared/assessmentsresultsvalue.md) | :heavy_minus_sign: | The result of the test. | passed | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the test result. | Passed | +| `value` | [T.nilable(::StackOne::Shared::AssessmentResultValue)](../../models/shared/assessmentresultvalue.md) | :heavy_minus_sign: | The result of the test. | passed | \ No newline at end of file diff --git a/docs/models/shared/skillsvalue.md b/docs/models/shared/skillsvalue.md index 5671f644..35e31e42 100644 --- a/docs/models/shared/skillsvalue.md +++ b/docs/models/shared/skillsvalue.md @@ -6,4 +6,5 @@ | Name | Value | | ----------- | ----------- | | `PRIMARY` | primary | -| `SECONDARY` | secondary | \ No newline at end of file +| `SECONDARY` | secondary | +| `TERTIARY` | tertiary | \ No newline at end of file diff --git a/docs/sdks/ats/README.md b/docs/sdks/ats/README.md index 43d34537..cc0131de 100644 --- a/docs/sdks/ats/README.md +++ b/docs/sdks/ats/README.md @@ -192,13 +192,13 @@ s.config_security( res = s.ats.create_background_check_package(ats_create_background_check_packages_request_dto=::StackOne::Shared::AtsCreateBackgroundCheckPackagesRequestDto.new( - description: "Standard background package for hires", - name: "Standard Background Check", + description: "Skills test to gauge a candidate's proficiency in job-specific skills", + name: "Test 1", passthrough: { "other_known_names": "John Doe", }, tests: [ - ::StackOne::Shared::CreateAssessmentsPackages.new( + ::StackOne::Shared::CreatePackage.new( description: "Skills test to gauge a candidate's proficiency in job-specific skills", name: "Test 1", ), @@ -848,7 +848,7 @@ req = ::StackOne::Operations::AtsGetAssessmentsPackageRequest.new( res = s.ats.get_assessments_package(req) -if ! res.assessments_packages_result.nil? +if ! res.assessment_package_result.nil? # handle response end @@ -893,7 +893,7 @@ req = ::StackOne::Operations::AtsGetAssessmentsRequestRequest.new( res = s.ats.get_assessments_request(req) -if ! res.assessments_order_result.nil? +if ! res.assessment_order_result.nil? # handle response end @@ -938,7 +938,7 @@ req = ::StackOne::Operations::AtsGetAssessmentsResultRequest.new( res = s.ats.get_assessments_result(req) -if ! res.assessments_results_result.nil? +if ! res.assessment_results_result.nil? # handle response end @@ -2048,7 +2048,7 @@ req = ::StackOne::Operations::AtsListAssessmentsPackagesRequest.new( res = s.ats.list_assessments_packages(req) -if ! res.assessments_packages_paginated.nil? +if ! res.assessment_package_paginated.nil? # handle response end diff --git a/docs/sdks/lms/README.md b/docs/sdks/lms/README.md index 6b50f917..9be8c4c9 100644 --- a/docs/sdks/lms/README.md +++ b/docs/sdks/lms/README.md @@ -57,7 +57,12 @@ res = s.lms.batch_upsert_content(lms_batch_upsert_content_request_dto=::StackOne active: true, categories: [ ::StackOne::Shared::CreateCategoriesApiModel.new( - name: "Technology", + id: "16873-IT345", + name: "Information-Technology", + unified_custom_fields: { + "my_project_custom_field_1": "REF-1236", + "my_project_custom_field_2": "some other value", + }, ), ], content_url: "https://www.youtube.com/watch?v=16873", @@ -77,9 +82,8 @@ res = s.lms.batch_upsert_content(lms_batch_upsert_content_request_dto=::StackOne short_description: "This course is a valuable resource and acts as learning content for...", skills: [ ::StackOne::Shared::CreateSkillsApiModel.new( - id: "cx2367ndc8dgsbjhka9ry4", - name: "Software Engineering", - remote_id: "SE-001", + id: "12345", + name: "Sales Techniques", ), ], title: "Software Engineer Lv 1", @@ -135,7 +139,12 @@ res = s.lms.batch_upsert_course(lms_batch_upsert_course_request_dto=::StackOne:: active: true, categories: [ ::StackOne::Shared::CreateCategoriesApiModel.new( - name: "Technology", + id: "16873-IT345", + name: "Information-Technology", + unified_custom_fields: { + "my_project_custom_field_1": "REF-1236", + "my_project_custom_field_2": "some other value", + }, ), ], content: [ @@ -160,9 +169,8 @@ res = s.lms.batch_upsert_course(lms_batch_upsert_course_request_dto=::StackOne:: ], skills: [ ::StackOne::Shared::CreateSkillsApiModel.new( - id: "cx2367ndc8dgsbjhka9ry4", - name: "Software Engineering", - remote_id: "SE-001", + id: "16873-IT345", + name: "Information-Technology", ), ], title: "Software Engineer Lv 1", @@ -216,7 +224,12 @@ s.config_security( res = s.lms.create_collection(lms_create_collection_request_dto=::StackOne::Shared::LmsCreateCollectionRequestDto.new( categories: [ ::StackOne::Shared::CreateCategoriesApiModel.new( - name: "Technology", + id: "16873-IT345", + name: "Information-Technology", + unified_custom_fields: { + "my_project_custom_field_1": "REF-1236", + "my_project_custom_field_2": "some other value", + }, ), ], cover_url: "https://www.googledrive.com/?v=16873", @@ -232,7 +245,8 @@ res = s.lms.create_collection(lms_create_collection_request_dto=::StackOne::Shar ], skills: [ ::StackOne::Shared::CreateSkillsApiModel.new( - name: "Technology", + id: "16873-IT345", + name: "Information-Technology", ), ], title: "Software Engineer Lv 1 Collection", @@ -283,6 +297,7 @@ s.config_security( res = s.lms.create_user_assignment(lms_create_assignment_request_dto=::StackOne::Shared::LmsCreateAssignmentRequestDto.new( created_at: "2021-07-21T14:00:00.000Z", due_date: "2021-07-21T14:00:00.000Z", + external_reference: "e3gd34-23tr21-er234-345er56", learning_object_external_reference: "learning-content-123", learning_object_id: "e3gd34-23tr21-er234-345er56", passthrough: { @@ -335,6 +350,7 @@ s.config_security( res = s.lms.create_user_completion(lms_create_completion_request_dto=::StackOne::Shared::LmsCreateCompletionRequestDto.new( completed_at: "2021-07-21T14:00:00.000Z", + external_reference: "e3gd34-23tr21-er234-345er56", learning_object_external_reference: "learning-content-123", learning_object_id: "e3gd34-23tr21-er234-345er56", passthrough: { @@ -785,7 +801,7 @@ s.config_security( req = ::StackOne::Operations::LmsListAssignmentsRequest.new( - fields_: "id,remote_id,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", + fields_: "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", filter: ::StackOne::Operations::LmsListAssignmentsQueryParamFilter.new( updated_after: "2020-01-01T00:00:00.000Z", ), @@ -881,7 +897,7 @@ s.config_security( req = ::StackOne::Operations::LmsListCompletionsRequest.new( - fields_: "id,remote_id,external_id,remote_external_id,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", + fields_: "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", filter: ::StackOne::Operations::LmsListCompletionsQueryParamFilter.new( updated_after: "2020-01-01T00:00:00.000Z", ), @@ -1069,7 +1085,7 @@ s.config_security( req = ::StackOne::Operations::LmsListUserAssignmentsRequest.new( - fields_: "id,remote_id,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", + fields_: "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", filter: ::StackOne::Operations::LmsListUserAssignmentsQueryParamFilter.new( updated_after: "2020-01-01T00:00:00.000Z", ), @@ -1119,7 +1135,7 @@ s.config_security( req = ::StackOne::Operations::LmsListUserCompletionsRequest.new( - fields_: "id,remote_id,external_id,remote_external_id,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", + fields_: "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", filter: ::StackOne::Operations::LmsListUserCompletionsQueryParamFilter.new( updated_after: "2020-01-01T00:00:00.000Z", ), @@ -1216,7 +1232,12 @@ s.config_security( res = s.lms.update_collection(lms_create_collection_request_dto=::StackOne::Shared::LmsCreateCollectionRequestDto.new( categories: [ ::StackOne::Shared::CreateCategoriesApiModel.new( - name: "Technology", + id: "16873-IT345", + name: "Information-Technology", + unified_custom_fields: { + "my_project_custom_field_1": "REF-1236", + "my_project_custom_field_2": "some other value", + }, ), ], cover_url: "https://www.googledrive.com/?v=16873", @@ -1232,7 +1253,8 @@ res = s.lms.update_collection(lms_create_collection_request_dto=::StackOne::Shar ], skills: [ ::StackOne::Shared::CreateSkillsApiModel.new( - name: "Technology", + id: "16873-IT345", + name: "Information-Technology", ), ], title: "Software Engineer Lv 1 Collection", @@ -1285,7 +1307,12 @@ res = s.lms.upsert_content(lms_upsert_content_request_dto=::StackOne::Shared::Lm active: true, categories: [ ::StackOne::Shared::CreateCategoriesApiModel.new( - name: "Technology", + id: "16873-IT345", + name: "Information-Technology", + unified_custom_fields: { + "my_project_custom_field_1": "REF-1236", + "my_project_custom_field_2": "some other value", + }, ), ], content_url: "https://www.youtube.com/watch?v=16873", @@ -1305,9 +1332,8 @@ res = s.lms.upsert_content(lms_upsert_content_request_dto=::StackOne::Shared::Lm short_description: "This course is a valuable resource and acts as learning content for...", skills: [ ::StackOne::Shared::CreateSkillsApiModel.new( - id: "cx2367ndc8dgsbjhka9ry4", - name: "Software Engineering", - remote_id: "SE-001", + id: "12345", + name: "Sales Techniques", ), ], title: "Software Engineer Lv 1", @@ -1359,7 +1385,12 @@ res = s.lms.upsert_course(lms_upsert_course_request_dto=::StackOne::Shared::LmsU active: true, categories: [ ::StackOne::Shared::CreateCategoriesApiModel.new( - name: "Technology", + id: "16873-IT345", + name: "Information-Technology", + unified_custom_fields: { + "my_project_custom_field_1": "REF-1236", + "my_project_custom_field_2": "some other value", + }, ), ], content: [ @@ -1384,9 +1415,8 @@ res = s.lms.upsert_course(lms_upsert_course_request_dto=::StackOne::Shared::LmsU ], skills: [ ::StackOne::Shared::CreateSkillsApiModel.new( - id: "cx2367ndc8dgsbjhka9ry4", - name: "Software Engineering", - remote_id: "SE-001", + id: "16873-IT345", + name: "Information-Technology", ), ], title: "Software Engineer Lv 1", diff --git a/gen.yaml b/gen.yaml index ac0a12e2..9e7aa319 100644 --- a/gen.yaml +++ b/gen.yaml @@ -12,7 +12,7 @@ generation: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false ruby: - version: 0.4.4 + version: 0.5.0 author: StackOne description: Ruby Client SDK Generated by Speakeasy imports: diff --git a/lib/stack_one/ats.rb b/lib/stack_one/ats.rb index 89ce7ddd..bff3287f 100644 --- a/lib/stack_one/ats.rb +++ b/lib/stack_one/ats.rb @@ -639,8 +639,8 @@ def get_assessments_package(request) ) if r.status == 200 if Utils.match_content_type(content_type, 'application/json') - out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::AssessmentsPackagesResult) - res.assessments_packages_result = out + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::AssessmentPackageResult) + res.assessment_package_result = out end elsif [400, 403, 412, 429, 500, 501].include?(r.status) elsif r.status == 408 @@ -680,8 +680,8 @@ def get_assessments_request(request) ) if r.status == 200 if Utils.match_content_type(content_type, 'application/json') - out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::AssessmentsOrderResult) - res.assessments_order_result = out + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::AssessmentOrderResult) + res.assessment_order_result = out end elsif [400, 403, 412, 429, 500, 501].include?(r.status) elsif r.status == 408 @@ -721,8 +721,8 @@ def get_assessments_result(request) ) if r.status == 200 if Utils.match_content_type(content_type, 'application/json') - out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::AssessmentsResultsResult) - res.assessments_results_result = out + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::AssessmentResultsResult) + res.assessment_results_result = out end elsif [400, 403, 412, 429, 500, 501].include?(r.status) elsif r.status == 408 @@ -1690,8 +1690,8 @@ def list_assessments_packages(request) ) if r.status == 200 if Utils.match_content_type(content_type, 'application/json') - out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::AssessmentsPackagesPaginated) - res.assessments_packages_paginated = out + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::AssessmentPackagePaginated) + res.assessment_package_paginated = out end elsif [400, 403, 412, 429, 500, 501].include?(r.status) elsif r.status == 408 diff --git a/lib/stack_one/models/operations/ats_get_assessments_package_response.rb b/lib/stack_one/models/operations/ats_get_assessments_package_response.rb index 03cc8e19..52ca3afe 100644 --- a/lib/stack_one/models/operations/ats_get_assessments_package_response.rb +++ b/lib/stack_one/models/operations/ats_get_assessments_package_response.rb @@ -20,16 +20,16 @@ class AtsGetAssessmentsPackageResponse < ::StackOne::Utils::FieldAugmented # HTTP response status code for this operation field :status_code, ::Integer # The assessments package with the given identifier was retrieved. - field :assessments_packages_result, T.nilable(::StackOne::Shared::AssessmentsPackagesResult) + field :assessment_package_result, T.nilable(::StackOne::Shared::AssessmentPackageResult) - sig { params(content_type: ::String, headers: T::Hash[Symbol, T::Array[::String]], raw_response: ::Faraday::Response, status_code: ::Integer, assessments_packages_result: T.nilable(::StackOne::Shared::AssessmentsPackagesResult)).void } - def initialize(content_type: nil, headers: nil, raw_response: nil, status_code: nil, assessments_packages_result: nil) + sig { params(content_type: ::String, headers: T::Hash[Symbol, T::Array[::String]], raw_response: ::Faraday::Response, status_code: ::Integer, assessment_package_result: T.nilable(::StackOne::Shared::AssessmentPackageResult)).void } + def initialize(content_type: nil, headers: nil, raw_response: nil, status_code: nil, assessment_package_result: nil) @content_type = content_type @headers = headers @raw_response = raw_response @status_code = status_code - @assessments_packages_result = assessments_packages_result + @assessment_package_result = assessment_package_result end end end diff --git a/lib/stack_one/models/operations/ats_get_assessments_request_response.rb b/lib/stack_one/models/operations/ats_get_assessments_request_response.rb index c48d90a7..96d90e04 100644 --- a/lib/stack_one/models/operations/ats_get_assessments_request_response.rb +++ b/lib/stack_one/models/operations/ats_get_assessments_request_response.rb @@ -20,16 +20,16 @@ class AtsGetAssessmentsRequestResponse < ::StackOne::Utils::FieldAugmented # HTTP response status code for this operation field :status_code, ::Integer # The assessments order with the given identifier was retrieved. - field :assessments_order_result, T.nilable(::StackOne::Shared::AssessmentsOrderResult) + field :assessment_order_result, T.nilable(::StackOne::Shared::AssessmentOrderResult) - sig { params(content_type: ::String, headers: T::Hash[Symbol, T::Array[::String]], raw_response: ::Faraday::Response, status_code: ::Integer, assessments_order_result: T.nilable(::StackOne::Shared::AssessmentsOrderResult)).void } - def initialize(content_type: nil, headers: nil, raw_response: nil, status_code: nil, assessments_order_result: nil) + sig { params(content_type: ::String, headers: T::Hash[Symbol, T::Array[::String]], raw_response: ::Faraday::Response, status_code: ::Integer, assessment_order_result: T.nilable(::StackOne::Shared::AssessmentOrderResult)).void } + def initialize(content_type: nil, headers: nil, raw_response: nil, status_code: nil, assessment_order_result: nil) @content_type = content_type @headers = headers @raw_response = raw_response @status_code = status_code - @assessments_order_result = assessments_order_result + @assessment_order_result = assessment_order_result end end end diff --git a/lib/stack_one/models/operations/ats_get_assessments_result_response.rb b/lib/stack_one/models/operations/ats_get_assessments_result_response.rb index e2019ba6..b92cf3ce 100644 --- a/lib/stack_one/models/operations/ats_get_assessments_result_response.rb +++ b/lib/stack_one/models/operations/ats_get_assessments_result_response.rb @@ -20,16 +20,16 @@ class AtsGetAssessmentsResultResponse < ::StackOne::Utils::FieldAugmented # HTTP response status code for this operation field :status_code, ::Integer # The assessments result with the given identifier was retrieved. - field :assessments_results_result, T.nilable(::StackOne::Shared::AssessmentsResultsResult) + field :assessment_results_result, T.nilable(::StackOne::Shared::AssessmentResultsResult) - sig { params(content_type: ::String, headers: T::Hash[Symbol, T::Array[::String]], raw_response: ::Faraday::Response, status_code: ::Integer, assessments_results_result: T.nilable(::StackOne::Shared::AssessmentsResultsResult)).void } - def initialize(content_type: nil, headers: nil, raw_response: nil, status_code: nil, assessments_results_result: nil) + sig { params(content_type: ::String, headers: T::Hash[Symbol, T::Array[::String]], raw_response: ::Faraday::Response, status_code: ::Integer, assessment_results_result: T.nilable(::StackOne::Shared::AssessmentResultsResult)).void } + def initialize(content_type: nil, headers: nil, raw_response: nil, status_code: nil, assessment_results_result: nil) @content_type = content_type @headers = headers @raw_response = raw_response @status_code = status_code - @assessments_results_result = assessments_results_result + @assessment_results_result = assessment_results_result end end end diff --git a/lib/stack_one/models/operations/ats_list_assessments_packages_response.rb b/lib/stack_one/models/operations/ats_list_assessments_packages_response.rb index a5deee3b..bc83a348 100644 --- a/lib/stack_one/models/operations/ats_list_assessments_packages_response.rb +++ b/lib/stack_one/models/operations/ats_list_assessments_packages_response.rb @@ -20,16 +20,16 @@ class AtsListAssessmentsPackagesResponse < ::StackOne::Utils::FieldAugmented # HTTP response status code for this operation field :status_code, ::Integer # The list of assessments packages was retrieved. - field :assessments_packages_paginated, T.nilable(::StackOne::Shared::AssessmentsPackagesPaginated) + field :assessment_package_paginated, T.nilable(::StackOne::Shared::AssessmentPackagePaginated) - sig { params(content_type: ::String, headers: T::Hash[Symbol, T::Array[::String]], raw_response: ::Faraday::Response, status_code: ::Integer, assessments_packages_paginated: T.nilable(::StackOne::Shared::AssessmentsPackagesPaginated)).void } - def initialize(content_type: nil, headers: nil, raw_response: nil, status_code: nil, assessments_packages_paginated: nil) + sig { params(content_type: ::String, headers: T::Hash[Symbol, T::Array[::String]], raw_response: ::Faraday::Response, status_code: ::Integer, assessment_package_paginated: T.nilable(::StackOne::Shared::AssessmentPackagePaginated)).void } + def initialize(content_type: nil, headers: nil, raw_response: nil, status_code: nil, assessment_package_paginated: nil) @content_type = content_type @headers = headers @raw_response = raw_response @status_code = status_code - @assessments_packages_paginated = assessments_packages_paginated + @assessment_package_paginated = assessment_package_paginated end end end diff --git a/lib/stack_one/models/shared.rb b/lib/stack_one/models/shared.rb index 01faf6a1..ff99d8b1 100644 --- a/lib/stack_one/models/shared.rb +++ b/lib/stack_one/models/shared.rb @@ -43,7 +43,7 @@ module Shared autoload :SocialLink, 'stack_one/models/shared/sociallink.rb' autoload :CustomFields, 'stack_one/models/shared/customfields.rb' autoload :AtsCreateBackgroundCheckPackagesRequestDto, 'stack_one/models/shared/atscreatebackgroundcheckpackagesrequestdto.rb' - autoload :CreateAssessmentsPackages, 'stack_one/models/shared/createassessmentspackages.rb' + autoload :CreatePackage, 'stack_one/models/shared/createpackage.rb' autoload :AtsCreateCandidateRequestDto, 'stack_one/models/shared/atscreatecandidaterequestdto.rb' autoload :AtsCreateNotesRequestDtoValue, 'stack_one/models/shared/atscreatenotesrequestdto_value.rb' autoload :Visibility, 'stack_one/models/shared/visibility.rb' @@ -114,29 +114,29 @@ module Shared autoload :ScorecardSection, 'stack_one/models/shared/scorecardsection.rb' autoload :FieldType, 'stack_one/models/shared/field_type.rb' autoload :Field, 'stack_one/models/shared/field.rb' - autoload :AssessmentsPackagesResult, 'stack_one/models/shared/assessmentspackagesresult.rb' - autoload :AssessmentsPackages, 'stack_one/models/shared/assessmentspackages.rb' - autoload :AssessmentsOrderResult, 'stack_one/models/shared/assessmentsorderresult.rb' - autoload :AssessmentsOrderValue, 'stack_one/models/shared/assessmentsorder_value.rb' - autoload :AssessmentsOrderApplicationStatus, 'stack_one/models/shared/assessmentsorder_application_status.rb' - autoload :AssessmentsOrderApplication, 'stack_one/models/shared/assessmentsorder_application.rb' - autoload :AssessmentsOrderCandidate, 'stack_one/models/shared/assessmentsorder_candidate.rb' - autoload :AssessmentsOrderJob, 'stack_one/models/shared/assessmentsorder_job.rb' - autoload :Package, 'stack_one/models/shared/package.rb' + autoload :AssessmentPackageResult, 'stack_one/models/shared/assessmentpackageresult.rb' + autoload :AssessmentPackage, 'stack_one/models/shared/assessmentpackage.rb' + autoload :AssessmentOrderResult, 'stack_one/models/shared/assessmentorderresult.rb' + autoload :AssessmentOrderValue, 'stack_one/models/shared/assessmentorder_value.rb' + autoload :AssessmentOrderApplicationStatus, 'stack_one/models/shared/assessmentorder_application_status.rb' + autoload :AssessmentOrderApplication, 'stack_one/models/shared/assessmentorder_application.rb' + autoload :AssessmentOrderCandidate, 'stack_one/models/shared/assessmentorder_candidate.rb' + autoload :AssessmentOrderJob, 'stack_one/models/shared/assessmentorder_job.rb' + autoload :AssessmentOrderPackage, 'stack_one/models/shared/assessmentorder_package.rb' autoload :Requester, 'stack_one/models/shared/requester.rb' - autoload :AssessmentsOrder, 'stack_one/models/shared/assessmentsorder.rb' - autoload :AssessmentsRequestsJobHiringTeamApiModel, 'stack_one/models/shared/assessmentsrequestsjobhiringteamapimodel.rb' - autoload :AssessmentsResultsResult, 'stack_one/models/shared/assessmentsresultsresult.rb' - autoload :AssessmentsResultsCandidate, 'stack_one/models/shared/assessmentsresults_candidate.rb' - autoload :AssessmentsResultsValue, 'stack_one/models/shared/assessmentsresults_value.rb' + autoload :AssessmentOrder, 'stack_one/models/shared/assessmentorder.rb' + autoload :AssessmentResultsResult, 'stack_one/models/shared/assessmentresultsresult.rb' + autoload :AssessmentResultCandidate, 'stack_one/models/shared/assessmentresult_candidate.rb' + autoload :AssessmentResultValue, 'stack_one/models/shared/assessmentresult_value.rb' autoload :Result, 'stack_one/models/shared/result.rb' autoload :Score, 'stack_one/models/shared/score.rb' - autoload :AssessmentsResults, 'stack_one/models/shared/assessmentsresults.rb' - autoload :AssessmentsAttachmentValue, 'stack_one/models/shared/assessmentsattachment_value.rb' - autoload :AssessmentsAttachmentContentType, 'stack_one/models/shared/assessmentsattachment_content_type.rb' - autoload :AssessmentsAttachment, 'stack_one/models/shared/assessmentsattachment.rb' + autoload :AssessmentResult, 'stack_one/models/shared/assessmentresult.rb' + autoload :AttachmentValue, 'stack_one/models/shared/attachment_value.rb' + autoload :AttachmentContentType, 'stack_one/models/shared/attachment_content_type.rb' + autoload :Attachment, 'stack_one/models/shared/attachment.rb' autoload :BackgroundCheckPackageResult, 'stack_one/models/shared/backgroundcheckpackageresult.rb' autoload :BackgroundCheckPackage, 'stack_one/models/shared/backgroundcheckpackage.rb' + autoload :Package, 'stack_one/models/shared/package.rb' autoload :BackgroundCheckOrderResult, 'stack_one/models/shared/backgroundcheckorderresult.rb' autoload :BackgroundCheckOrderValue, 'stack_one/models/shared/backgroundcheckorder_value.rb' autoload :BackgroundCheckOrderApplicationStatus, 'stack_one/models/shared/backgroundcheckorder_application_status.rb' @@ -146,12 +146,12 @@ module Shared autoload :BackgroundCheckOrderPackage, 'stack_one/models/shared/backgroundcheckorder_package.rb' autoload :BackgroundCheckOrderRequester, 'stack_one/models/shared/backgroundcheckorder_requester.rb' autoload :BackgroundCheckOrder, 'stack_one/models/shared/backgroundcheckorder.rb' - autoload :AssessmentsPackagesTestApiModel, 'stack_one/models/shared/assessmentspackagestestapimodel.rb' - autoload :BackgroundCheckResultsResultCandidate, 'stack_one/models/shared/backgroundcheckresultsresult_candidate.rb' - autoload :BackgroundCheckResultsResultValue, 'stack_one/models/shared/backgroundcheckresultsresult_value.rb' - autoload :BackgroundCheckResultsResultResult, 'stack_one/models/shared/backgroundcheckresultsresult_result.rb' - autoload :BackgroundCheckResultsResultScore, 'stack_one/models/shared/backgroundcheckresultsresult_score.rb' autoload :BackgroundCheckResultsResult, 'stack_one/models/shared/backgroundcheckresultsresult.rb' + autoload :BackgroundCheckResultCandidate, 'stack_one/models/shared/backgroundcheckresult_candidate.rb' + autoload :BackgroundCheckResultValue, 'stack_one/models/shared/backgroundcheckresult_value.rb' + autoload :BackgroundCheckResultResult, 'stack_one/models/shared/backgroundcheckresult_result.rb' + autoload :BackgroundCheckResultScore, 'stack_one/models/shared/backgroundcheckresult_score.rb' + autoload :BackgroundCheckResult, 'stack_one/models/shared/backgroundcheckresult.rb' autoload :CandidateResult, 'stack_one/models/shared/candidateresult.rb' autoload :Candidate, 'stack_one/models/shared/candidate.rb' autoload :NoteResult, 'stack_one/models/shared/noteresult.rb' @@ -216,7 +216,7 @@ module Shared autoload :ApplicationsPaginated, 'stack_one/models/shared/applicationspaginated.rb' autoload :OffersPaginated, 'stack_one/models/shared/offerspaginated.rb' autoload :ScheduledInterviewsPaginated, 'stack_one/models/shared/scheduledinterviewspaginated.rb' - autoload :AssessmentsPackagesPaginated, 'stack_one/models/shared/assessmentspackagespaginated.rb' + autoload :AssessmentPackagePaginated, 'stack_one/models/shared/assessmentpackagepaginated.rb' autoload :BackgroundCheckPackagePaginated, 'stack_one/models/shared/backgroundcheckpackagepaginated.rb' autoload :BackgroundCheckOrderPaginated, 'stack_one/models/shared/backgroundcheckorderpaginated.rb' autoload :NotesPaginated, 'stack_one/models/shared/notespaginated.rb' @@ -547,9 +547,13 @@ module Shared autoload :LmsUpsertContentRequestDtoValue, 'stack_one/models/shared/lmsupsertcontentrequestdto_value.rb' autoload :LmsUpsertContentRequestDtoContentType, 'stack_one/models/shared/lmsupsertcontentrequestdto_content_type.rb' autoload :LmsUpsertContentRequestDto, 'stack_one/models/shared/lmsupsertcontentrequestdto.rb' + autoload :CreateSkillsApiModelValue, 'stack_one/models/shared/createskillsapimodel_value.rb' + autoload :CreateSkillsApiModelLevel, 'stack_one/models/shared/createskillsapimodel_level.rb' autoload :CreateSkillsApiModel, 'stack_one/models/shared/createskillsapimodel.rb' autoload :LanguageEnumValue, 'stack_one/models/shared/languageenum_value.rb' autoload :LanguageEnum, 'stack_one/models/shared/languageenum.rb' + autoload :CreateCategoriesApiModelValue, 'stack_one/models/shared/createcategoriesapimodel_value.rb' + autoload :CreateCategoriesApiModelLevel, 'stack_one/models/shared/createcategoriesapimodel_level.rb' autoload :CreateCategoriesApiModel, 'stack_one/models/shared/createcategoriesapimodel.rb' autoload :LmsBatchUpsertCourseRequestDto, 'stack_one/models/shared/lmsbatchupsertcourserequestdto.rb' autoload :LmsUpsertCourseRequestDto, 'stack_one/models/shared/lmsupsertcourserequestdto.rb' diff --git a/lib/stack_one/models/shared/assessmentsorder.rb b/lib/stack_one/models/shared/assessmentorder.rb similarity index 59% rename from lib/stack_one/models/shared/assessmentsorder.rb rename to lib/stack_one/models/shared/assessmentorder.rb index e75580fe..f9086abe 100644 --- a/lib/stack_one/models/shared/assessmentsorder.rb +++ b/lib/stack_one/models/shared/assessmentorder.rb @@ -8,19 +8,19 @@ module StackOne module Shared - class AssessmentsOrder < ::StackOne::Utils::FieldAugmented + class AssessmentOrder < ::StackOne::Utils::FieldAugmented extend T::Sig - field :application, T.nilable(::StackOne::Shared::AssessmentsOrderApplication), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('application') } } + field :application, T.nilable(::StackOne::Shared::AssessmentOrderApplication), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('application') } } - field :candidate, T.nilable(::StackOne::Shared::AssessmentsOrderCandidate), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('candidate') } } + field :candidate, T.nilable(::StackOne::Shared::AssessmentOrderCandidate), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('candidate') } } # Unique identifier field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } - field :job, T.nilable(::StackOne::Shared::AssessmentsOrderJob), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('job') } } + field :job, T.nilable(::StackOne::Shared::AssessmentOrderJob), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('job') } } - field :package, T.nilable(::StackOne::Shared::Package), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('package') } } + field :package, T.nilable(::StackOne::Shared::AssessmentOrderPackage), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('package') } } # Provider's unique identifier field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } @@ -29,7 +29,7 @@ class AssessmentsOrder < ::StackOne::Utils::FieldAugmented field :results_update_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('results_update_url') } } - sig { params(application: T.nilable(::StackOne::Shared::AssessmentsOrderApplication), candidate: T.nilable(::StackOne::Shared::AssessmentsOrderCandidate), id: T.nilable(::String), job: T.nilable(::StackOne::Shared::AssessmentsOrderJob), package: T.nilable(::StackOne::Shared::Package), remote_id: T.nilable(::String), requester: T.nilable(::StackOne::Shared::Requester), results_update_url: T.nilable(::String)).void } + sig { params(application: T.nilable(::StackOne::Shared::AssessmentOrderApplication), candidate: T.nilable(::StackOne::Shared::AssessmentOrderCandidate), id: T.nilable(::String), job: T.nilable(::StackOne::Shared::AssessmentOrderJob), package: T.nilable(::StackOne::Shared::AssessmentOrderPackage), remote_id: T.nilable(::String), requester: T.nilable(::StackOne::Shared::Requester), results_update_url: T.nilable(::String)).void } def initialize(application: nil, candidate: nil, id: nil, job: nil, package: nil, remote_id: nil, requester: nil, results_update_url: nil) @application = application @candidate = candidate diff --git a/lib/stack_one/models/shared/assessmentsorder_application.rb b/lib/stack_one/models/shared/assessmentorder_application.rb similarity index 74% rename from lib/stack_one/models/shared/assessmentsorder_application.rb rename to lib/stack_one/models/shared/assessmentorder_application.rb index 6f455bae..6d6fef42 100644 --- a/lib/stack_one/models/shared/assessmentsorder_application.rb +++ b/lib/stack_one/models/shared/assessmentorder_application.rb @@ -8,11 +8,11 @@ module StackOne module Shared - class AssessmentsOrderApplication < ::StackOne::Utils::FieldAugmented + class AssessmentOrderApplication < ::StackOne::Utils::FieldAugmented extend T::Sig - field :application_status, T.nilable(::StackOne::Shared::AssessmentsOrderApplicationStatus), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('application_status') } } + field :application_status, T.nilable(::StackOne::Shared::AssessmentOrderApplicationStatus), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('application_status') } } # Unique identifier field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } # Value to pass through to the provider @@ -21,7 +21,7 @@ class AssessmentsOrderApplication < ::StackOne::Utils::FieldAugmented field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } - sig { params(application_status: T.nilable(::StackOne::Shared::AssessmentsOrderApplicationStatus), id: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), remote_id: T.nilable(::String)).void } + sig { params(application_status: T.nilable(::StackOne::Shared::AssessmentOrderApplicationStatus), id: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), remote_id: T.nilable(::String)).void } def initialize(application_status: nil, id: nil, passthrough: nil, remote_id: nil) @application_status = application_status @id = id diff --git a/lib/stack_one/models/shared/assessmentsorder_application_status.rb b/lib/stack_one/models/shared/assessmentorder_application_status.rb similarity index 61% rename from lib/stack_one/models/shared/assessmentsorder_application_status.rb rename to lib/stack_one/models/shared/assessmentorder_application_status.rb index f2fa8619..ab14172c 100644 --- a/lib/stack_one/models/shared/assessmentsorder_application_status.rb +++ b/lib/stack_one/models/shared/assessmentorder_application_status.rb @@ -8,16 +8,16 @@ module StackOne module Shared - class AssessmentsOrderApplicationStatus < ::StackOne::Utils::FieldAugmented + class AssessmentOrderApplicationStatus < ::StackOne::Utils::FieldAugmented extend T::Sig # The source value of the application status. field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } } # The status of the application. - field :value, T.nilable(::StackOne::Shared::AssessmentsOrderValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::AssessmentsOrderValue, true) } } + field :value, T.nilable(::StackOne::Shared::AssessmentOrderValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::AssessmentOrderValue, true) } } - sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::AssessmentsOrderValue)).void } + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::AssessmentOrderValue)).void } def initialize(source_value: nil, value: nil) @source_value = source_value @value = value diff --git a/lib/stack_one/models/shared/assessmentsorder_candidate.rb b/lib/stack_one/models/shared/assessmentorder_candidate.rb similarity index 96% rename from lib/stack_one/models/shared/assessmentsorder_candidate.rb rename to lib/stack_one/models/shared/assessmentorder_candidate.rb index e1005abb..c8677776 100644 --- a/lib/stack_one/models/shared/assessmentsorder_candidate.rb +++ b/lib/stack_one/models/shared/assessmentorder_candidate.rb @@ -8,7 +8,7 @@ module StackOne module Shared - class AssessmentsOrderCandidate < ::StackOne::Utils::FieldAugmented + class AssessmentOrderCandidate < ::StackOne::Utils::FieldAugmented extend T::Sig # List of candidate emails diff --git a/lib/stack_one/models/shared/assessmentsorder_job.rb b/lib/stack_one/models/shared/assessmentorder_job.rb similarity index 76% rename from lib/stack_one/models/shared/assessmentsorder_job.rb rename to lib/stack_one/models/shared/assessmentorder_job.rb index cd5c098c..8432666e 100644 --- a/lib/stack_one/models/shared/assessmentsorder_job.rb +++ b/lib/stack_one/models/shared/assessmentorder_job.rb @@ -8,11 +8,11 @@ module StackOne module Shared - class AssessmentsOrderJob < ::StackOne::Utils::FieldAugmented + class AssessmentOrderJob < ::StackOne::Utils::FieldAugmented extend T::Sig # Hiring team for the job. - field :hiring_team, T.nilable(T::Array[::StackOne::Shared::AssessmentsRequestsJobHiringTeamApiModel]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('hiring_team') } } + field :hiring_team, T.nilable(T::Array[::StackOne::Shared::JobHiringTeam]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('hiring_team') } } # Unique identifier field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } # Value to pass through to the provider @@ -23,7 +23,7 @@ class AssessmentsOrderJob < ::StackOne::Utils::FieldAugmented field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('title') } } - sig { params(hiring_team: T.nilable(T::Array[::StackOne::Shared::AssessmentsRequestsJobHiringTeamApiModel]), id: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), remote_id: T.nilable(::String), title: T.nilable(::String)).void } + sig { params(hiring_team: T.nilable(T::Array[::StackOne::Shared::JobHiringTeam]), id: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), remote_id: T.nilable(::String), title: T.nilable(::String)).void } def initialize(hiring_team: nil, id: nil, passthrough: nil, remote_id: nil, title: nil) @hiring_team = hiring_team @id = id diff --git a/lib/stack_one/models/shared/assessmentspackagestestapimodel.rb b/lib/stack_one/models/shared/assessmentorder_package.rb similarity index 93% rename from lib/stack_one/models/shared/assessmentspackagestestapimodel.rb rename to lib/stack_one/models/shared/assessmentorder_package.rb index f9beb545..e61b9fef 100644 --- a/lib/stack_one/models/shared/assessmentspackagestestapimodel.rb +++ b/lib/stack_one/models/shared/assessmentorder_package.rb @@ -8,7 +8,7 @@ module StackOne module Shared - class AssessmentsPackagesTestApiModel < ::StackOne::Utils::FieldAugmented + class AssessmentOrderPackage < ::StackOne::Utils::FieldAugmented extend T::Sig # Package description diff --git a/lib/stack_one/models/shared/assessmentsorder_value.rb b/lib/stack_one/models/shared/assessmentorder_value.rb similarity index 90% rename from lib/stack_one/models/shared/assessmentsorder_value.rb rename to lib/stack_one/models/shared/assessmentorder_value.rb index d865d95b..81d6985e 100644 --- a/lib/stack_one/models/shared/assessmentsorder_value.rb +++ b/lib/stack_one/models/shared/assessmentorder_value.rb @@ -7,8 +7,8 @@ module StackOne module Shared - # AssessmentsOrderValue - The status of the application. - class AssessmentsOrderValue < T::Enum + # AssessmentOrderValue - The status of the application. + class AssessmentOrderValue < T::Enum enums do ACTIVE = new('active') ASSESSMENT = new('assessment') diff --git a/lib/stack_one/models/shared/assessmentsresultsresult.rb b/lib/stack_one/models/shared/assessmentorderresult.rb similarity index 56% rename from lib/stack_one/models/shared/assessmentsresultsresult.rb rename to lib/stack_one/models/shared/assessmentorderresult.rb index 83b00063..4cd329ec 100644 --- a/lib/stack_one/models/shared/assessmentsresultsresult.rb +++ b/lib/stack_one/models/shared/assessmentorderresult.rb @@ -8,16 +8,16 @@ module StackOne module Shared - class AssessmentsResultsResult < ::StackOne::Utils::FieldAugmented + class AssessmentOrderResult < ::StackOne::Utils::FieldAugmented extend T::Sig - field :data, ::StackOne::Shared::AssessmentsResults, { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } } + field :data, ::StackOne::Shared::AssessmentOrder, { '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::AssessmentsResults, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } + sig { params(data: ::StackOne::Shared::AssessmentOrder, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } def initialize(data: nil, raw: nil) @data = data @raw = raw diff --git a/lib/stack_one/models/shared/assessmentspackages.rb b/lib/stack_one/models/shared/assessmentpackage.rb similarity index 94% rename from lib/stack_one/models/shared/assessmentspackages.rb rename to lib/stack_one/models/shared/assessmentpackage.rb index 5316148f..d95351f0 100644 --- a/lib/stack_one/models/shared/assessmentspackages.rb +++ b/lib/stack_one/models/shared/assessmentpackage.rb @@ -8,7 +8,7 @@ module StackOne module Shared - class AssessmentsPackages < ::StackOne::Utils::FieldAugmented + class AssessmentPackage < ::StackOne::Utils::FieldAugmented extend T::Sig # Package description diff --git a/lib/stack_one/models/shared/assessmentspackagespaginated.rb b/lib/stack_one/models/shared/assessmentpackagepaginated.rb similarity index 72% rename from lib/stack_one/models/shared/assessmentspackagespaginated.rb rename to lib/stack_one/models/shared/assessmentpackagepaginated.rb index 8d26714b..ef25cefb 100644 --- a/lib/stack_one/models/shared/assessmentspackagespaginated.rb +++ b/lib/stack_one/models/shared/assessmentpackagepaginated.rb @@ -8,11 +8,11 @@ module StackOne module Shared - class AssessmentsPackagesPaginated < ::StackOne::Utils::FieldAugmented + class AssessmentPackagePaginated < ::StackOne::Utils::FieldAugmented extend T::Sig - field :data, T::Array[::StackOne::Shared::AssessmentsPackages], { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } } + field :data, T::Array[::StackOne::Shared::AssessmentPackage], { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } } field :next_, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('next') } } # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible. @@ -21,7 +21,7 @@ class AssessmentsPackagesPaginated < ::StackOne::Utils::FieldAugmented field :raw, T.nilable(T::Array[::StackOne::Shared::RawResponse]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('raw') } } - sig { params(data: T::Array[::StackOne::Shared::AssessmentsPackages], next_: T.nilable(::String), next_page: T.nilable(::String), raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } + sig { params(data: T::Array[::StackOne::Shared::AssessmentPackage], next_: T.nilable(::String), next_page: T.nilable(::String), raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } def initialize(data: nil, next_: nil, next_page: nil, raw: nil) @data = data @next_ = next_ diff --git a/lib/stack_one/models/shared/assessmentspackagesresult.rb b/lib/stack_one/models/shared/assessmentpackageresult.rb similarity index 56% rename from lib/stack_one/models/shared/assessmentspackagesresult.rb rename to lib/stack_one/models/shared/assessmentpackageresult.rb index a4c8e965..add75348 100644 --- a/lib/stack_one/models/shared/assessmentspackagesresult.rb +++ b/lib/stack_one/models/shared/assessmentpackageresult.rb @@ -8,16 +8,16 @@ module StackOne module Shared - class AssessmentsPackagesResult < ::StackOne::Utils::FieldAugmented + class AssessmentPackageResult < ::StackOne::Utils::FieldAugmented extend T::Sig - field :data, ::StackOne::Shared::AssessmentsPackages, { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } } + field :data, ::StackOne::Shared::AssessmentPackage, { '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::AssessmentsPackages, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } + sig { params(data: ::StackOne::Shared::AssessmentPackage, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } def initialize(data: nil, raw: nil) @data = data @raw = raw diff --git a/lib/stack_one/models/shared/assessmentsresults.rb b/lib/stack_one/models/shared/assessmentresult.rb similarity index 76% rename from lib/stack_one/models/shared/assessmentsresults.rb rename to lib/stack_one/models/shared/assessmentresult.rb index a6edc373..bc60639e 100644 --- a/lib/stack_one/models/shared/assessmentsresults.rb +++ b/lib/stack_one/models/shared/assessmentresult.rb @@ -8,13 +8,13 @@ module StackOne module Shared - class AssessmentsResults < ::StackOne::Utils::FieldAugmented + class AssessmentResult < ::StackOne::Utils::FieldAugmented extend T::Sig - field :attachments, T.nilable(T::Array[::StackOne::Shared::AssessmentsAttachment]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('attachments') } } + field :attachments, T.nilable(T::Array[::StackOne::Shared::Attachment]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('attachments') } } - field :candidate, T.nilable(::StackOne::Shared::AssessmentsResultsCandidate), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('candidate') } } + field :candidate, T.nilable(::StackOne::Shared::AssessmentResultCandidate), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('candidate') } } # Unique identifier field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } # Provider's unique identifier @@ -33,7 +33,7 @@ class AssessmentsResults < ::StackOne::Utils::FieldAugmented field :summary, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('summary') } } - sig { params(attachments: T.nilable(T::Array[::StackOne::Shared::AssessmentsAttachment]), candidate: T.nilable(::StackOne::Shared::AssessmentsResultsCandidate), id: T.nilable(::String), remote_id: T.nilable(::String), result: T.nilable(::StackOne::Shared::Result), result_url: T.nilable(::String), score: T.nilable(::StackOne::Shared::Score), start_date: T.nilable(::DateTime), submission_date: T.nilable(::DateTime), summary: T.nilable(::String)).void } + sig { params(attachments: T.nilable(T::Array[::StackOne::Shared::Attachment]), candidate: T.nilable(::StackOne::Shared::AssessmentResultCandidate), id: T.nilable(::String), remote_id: T.nilable(::String), result: T.nilable(::StackOne::Shared::Result), result_url: T.nilable(::String), score: T.nilable(::StackOne::Shared::Score), start_date: T.nilable(::DateTime), submission_date: T.nilable(::DateTime), summary: T.nilable(::String)).void } def initialize(attachments: nil, candidate: nil, id: nil, remote_id: nil, result: nil, result_url: nil, score: nil, start_date: nil, submission_date: nil, summary: nil) @attachments = attachments @candidate = candidate diff --git a/lib/stack_one/models/shared/assessmentsresults_candidate.rb b/lib/stack_one/models/shared/assessmentresult_candidate.rb similarity index 92% rename from lib/stack_one/models/shared/assessmentsresults_candidate.rb rename to lib/stack_one/models/shared/assessmentresult_candidate.rb index a3929514..6ad3388b 100644 --- a/lib/stack_one/models/shared/assessmentsresults_candidate.rb +++ b/lib/stack_one/models/shared/assessmentresult_candidate.rb @@ -8,7 +8,7 @@ module StackOne module Shared - class AssessmentsResultsCandidate < ::StackOne::Utils::FieldAugmented + class AssessmentResultCandidate < ::StackOne::Utils::FieldAugmented extend T::Sig # Unique identifier diff --git a/lib/stack_one/models/shared/assessmentsresults_value.rb b/lib/stack_one/models/shared/assessmentresult_value.rb similarity index 76% rename from lib/stack_one/models/shared/assessmentsresults_value.rb rename to lib/stack_one/models/shared/assessmentresult_value.rb index 32e4b4c0..c7e2f674 100644 --- a/lib/stack_one/models/shared/assessmentsresults_value.rb +++ b/lib/stack_one/models/shared/assessmentresult_value.rb @@ -7,8 +7,8 @@ module StackOne module Shared - # AssessmentsResultsValue - The result of the test. - class AssessmentsResultsValue < T::Enum + # AssessmentResultValue - The result of the test. + class AssessmentResultValue < T::Enum enums do CANCELLED = new('cancelled') EXPIRED = new('expired') diff --git a/lib/stack_one/models/shared/assessmentsorderresult.rb b/lib/stack_one/models/shared/assessmentresultsresult.rb similarity index 74% rename from lib/stack_one/models/shared/assessmentsorderresult.rb rename to lib/stack_one/models/shared/assessmentresultsresult.rb index 3555cab8..08eb2f59 100644 --- a/lib/stack_one/models/shared/assessmentsorderresult.rb +++ b/lib/stack_one/models/shared/assessmentresultsresult.rb @@ -8,16 +8,16 @@ module StackOne module Shared - class AssessmentsOrderResult < ::StackOne::Utils::FieldAugmented + class AssessmentResultsResult < ::StackOne::Utils::FieldAugmented extend T::Sig - field :data, ::StackOne::Shared::AssessmentsOrder, { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } } + field :data, ::StackOne::Shared::AssessmentResult, { '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::AssessmentsOrder, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } + sig { params(data: ::StackOne::Shared::AssessmentResult, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } def initialize(data: nil, raw: nil) @data = data @raw = raw diff --git a/lib/stack_one/models/shared/assessmentsrequestsjobhiringteamapimodel.rb b/lib/stack_one/models/shared/assessmentsrequestsjobhiringteamapimodel.rb deleted file mode 100644 index 4da066d2..00000000 --- a/lib/stack_one/models/shared/assessmentsrequestsjobhiringteamapimodel.rb +++ /dev/null @@ -1,39 +0,0 @@ -# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - -# typed: true -# frozen_string_literal: true - - -module StackOne - module Shared - - - class AssessmentsRequestsJobHiringTeamApiModel < ::StackOne::Utils::FieldAugmented - extend T::Sig - - # Email of the hiring team member. - field :email, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('email') } } - # First name of the hiring team member. - field :first_name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('first_name') } } - # Last name of the hiring team member. - field :last_name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('last_name') } } - # Provider's unique identifier of the user - field :remote_user_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_user_id') } } - # Role of the hiring team member. - field :role, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('role') } } - # User ID of the hiring team member. - field :user_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('user_id') } } - - - sig { params(email: T.nilable(::String), first_name: T.nilable(::String), last_name: T.nilable(::String), remote_user_id: T.nilable(::String), role: T.nilable(::String), user_id: T.nilable(::String)).void } - def initialize(email: nil, first_name: nil, last_name: nil, remote_user_id: nil, role: nil, user_id: nil) - @email = email - @first_name = first_name - @last_name = last_name - @remote_user_id = remote_user_id - @role = role - @user_id = user_id - end - end - end -end diff --git a/lib/stack_one/models/shared/assignment.rb b/lib/stack_one/models/shared/assignment.rb index 11d7c169..0e2f7c47 100644 --- a/lib/stack_one/models/shared/assignment.rb +++ b/lib/stack_one/models/shared/assignment.rb @@ -19,6 +19,8 @@ class Assignment < ::StackOne::Utils::FieldAugmented field :created_at, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('created_at') } } # 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 + field :external_reference, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('external_reference') } } # The ID associated with this assignment field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } # The external reference of the learning object associated with this assignment @@ -49,11 +51,12 @@ class Assignment < ::StackOne::Utils::FieldAugmented field :user_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('user_id') } } - sig { params(course_id: T.nilable(::String), created_at: T.nilable(::String), due_date: T.nilable(::String), id: T.nilable(::String), learning_object_external_reference: T.nilable(::String), learning_object_id: T.nilable(::String), learning_object_type: T.nilable(::StackOne::Shared::LearningObjectType), progress: T.nilable(::Float), remote_course_id: T.nilable(::String), remote_id: T.nilable(::String), remote_learning_object_id: T.nilable(::String), remote_user_id: T.nilable(::String), status: T.nilable(::StackOne::Shared::Status), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object]), updated_at: T.nilable(::String), user_id: T.nilable(::String)).void } - def initialize(course_id: nil, created_at: nil, due_date: nil, id: nil, learning_object_external_reference: nil, learning_object_id: nil, learning_object_type: nil, progress: nil, remote_course_id: nil, remote_id: nil, remote_learning_object_id: nil, remote_user_id: nil, status: nil, unified_custom_fields: nil, updated_at: nil, user_id: nil) + sig { params(course_id: T.nilable(::String), created_at: T.nilable(::String), due_date: T.nilable(::String), external_reference: T.nilable(::String), id: T.nilable(::String), learning_object_external_reference: T.nilable(::String), learning_object_id: T.nilable(::String), learning_object_type: T.nilable(::StackOne::Shared::LearningObjectType), progress: T.nilable(::Float), remote_course_id: T.nilable(::String), remote_id: T.nilable(::String), remote_learning_object_id: T.nilable(::String), remote_user_id: T.nilable(::String), status: T.nilable(::StackOne::Shared::Status), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object]), updated_at: T.nilable(::String), user_id: T.nilable(::String)).void } + def initialize(course_id: nil, created_at: nil, due_date: nil, external_reference: nil, id: nil, learning_object_external_reference: nil, learning_object_id: nil, learning_object_type: nil, progress: nil, remote_course_id: nil, remote_id: nil, remote_learning_object_id: nil, remote_user_id: nil, status: nil, unified_custom_fields: nil, updated_at: nil, user_id: nil) @course_id = course_id @created_at = created_at @due_date = due_date + @external_reference = external_reference @id = id @learning_object_external_reference = learning_object_external_reference @learning_object_id = learning_object_id diff --git a/lib/stack_one/models/shared/atscreatebackgroundcheckpackagesrequestdto.rb b/lib/stack_one/models/shared/atscreatebackgroundcheckpackagesrequestdto.rb index b00e539f..0710d5f4 100644 --- a/lib/stack_one/models/shared/atscreatebackgroundcheckpackagesrequestdto.rb +++ b/lib/stack_one/models/shared/atscreatebackgroundcheckpackagesrequestdto.rb @@ -18,10 +18,10 @@ class AtsCreateBackgroundCheckPackagesRequestDto < ::StackOne::Utils::FieldAugme # Value to pass through to the provider field :passthrough, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } } # Package tests - field :tests, T.nilable(T::Array[::StackOne::Shared::CreateAssessmentsPackages]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('tests') } } + field :tests, T.nilable(T::Array[::StackOne::Shared::CreatePackage]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('tests') } } - sig { params(description: T.nilable(::String), name: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), tests: T.nilable(T::Array[::StackOne::Shared::CreateAssessmentsPackages])).void } + sig { params(description: T.nilable(::String), name: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), tests: T.nilable(T::Array[::StackOne::Shared::CreatePackage])).void } def initialize(description: nil, name: nil, passthrough: nil, tests: nil) @description = description @name = name diff --git a/lib/stack_one/models/shared/assessmentsattachment.rb b/lib/stack_one/models/shared/attachment.rb similarity index 62% rename from lib/stack_one/models/shared/assessmentsattachment.rb rename to lib/stack_one/models/shared/attachment.rb index d2507932..0b8556b4 100644 --- a/lib/stack_one/models/shared/assessmentsattachment.rb +++ b/lib/stack_one/models/shared/attachment.rb @@ -8,16 +8,16 @@ module StackOne module Shared - class AssessmentsAttachment < ::StackOne::Utils::FieldAugmented + class Attachment < ::StackOne::Utils::FieldAugmented extend T::Sig - field :content_type, T.nilable(::StackOne::Shared::AssessmentsAttachmentContentType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_type') } } + field :content_type, T.nilable(::StackOne::Shared::AttachmentContentType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content_type') } } # The URL of the attachment. field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('url') } } - sig { params(content_type: T.nilable(::StackOne::Shared::AssessmentsAttachmentContentType), url: T.nilable(::String)).void } + sig { params(content_type: T.nilable(::StackOne::Shared::AttachmentContentType), url: T.nilable(::String)).void } def initialize(content_type: nil, url: nil) @content_type = content_type @url = url diff --git a/lib/stack_one/models/shared/assessmentsattachment_content_type.rb b/lib/stack_one/models/shared/attachment_content_type.rb similarity index 60% rename from lib/stack_one/models/shared/assessmentsattachment_content_type.rb rename to lib/stack_one/models/shared/attachment_content_type.rb index 0fdbed98..08e41761 100644 --- a/lib/stack_one/models/shared/assessmentsattachment_content_type.rb +++ b/lib/stack_one/models/shared/attachment_content_type.rb @@ -8,16 +8,16 @@ module StackOne module Shared - class AssessmentsAttachmentContentType < ::StackOne::Utils::FieldAugmented + class AttachmentContentType < ::StackOne::Utils::FieldAugmented extend T::Sig # The source value of the content type. field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } } # The content type of the attachment. - field :value, T.nilable(::StackOne::Shared::AssessmentsAttachmentValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::AssessmentsAttachmentValue, true) } } + field :value, T.nilable(::StackOne::Shared::AttachmentValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::AttachmentValue, true) } } - sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::AssessmentsAttachmentValue)).void } + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::AttachmentValue)).void } def initialize(source_value: nil, value: nil) @source_value = source_value @value = value diff --git a/lib/stack_one/models/shared/assessmentsattachment_value.rb b/lib/stack_one/models/shared/attachment_value.rb similarity index 69% rename from lib/stack_one/models/shared/assessmentsattachment_value.rb rename to lib/stack_one/models/shared/attachment_value.rb index 2412f702..3c7083ad 100644 --- a/lib/stack_one/models/shared/assessmentsattachment_value.rb +++ b/lib/stack_one/models/shared/attachment_value.rb @@ -7,8 +7,8 @@ module StackOne module Shared - # AssessmentsAttachmentValue - The content type of the attachment. - class AssessmentsAttachmentValue < T::Enum + # AttachmentValue - The content type of the attachment. + class AttachmentValue < T::Enum enums do TEXT = new('text') UNMAPPED_VALUE = new('unmapped_value') diff --git a/lib/stack_one/models/shared/backgroundcheckorder_job.rb b/lib/stack_one/models/shared/backgroundcheckorder_job.rb index e36121bf..7c64e9a6 100644 --- a/lib/stack_one/models/shared/backgroundcheckorder_job.rb +++ b/lib/stack_one/models/shared/backgroundcheckorder_job.rb @@ -12,7 +12,7 @@ class BackgroundCheckOrderJob < ::StackOne::Utils::FieldAugmented extend T::Sig # Hiring team for the job. - field :hiring_team, T.nilable(T::Array[::StackOne::Shared::AssessmentsRequestsJobHiringTeamApiModel]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('hiring_team') } } + field :hiring_team, T.nilable(T::Array[::StackOne::Shared::JobHiringTeam]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('hiring_team') } } # Unique identifier field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } # Value to pass through to the provider @@ -23,7 +23,7 @@ class BackgroundCheckOrderJob < ::StackOne::Utils::FieldAugmented field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('title') } } - sig { params(hiring_team: T.nilable(T::Array[::StackOne::Shared::AssessmentsRequestsJobHiringTeamApiModel]), id: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), remote_id: T.nilable(::String), title: T.nilable(::String)).void } + sig { params(hiring_team: T.nilable(T::Array[::StackOne::Shared::JobHiringTeam]), id: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), remote_id: T.nilable(::String), title: T.nilable(::String)).void } def initialize(hiring_team: nil, id: nil, passthrough: nil, remote_id: nil, title: nil) @hiring_team = hiring_team @id = id diff --git a/lib/stack_one/models/shared/backgroundcheckorder_package.rb b/lib/stack_one/models/shared/backgroundcheckorder_package.rb index 04fddfb4..639d64d0 100644 --- a/lib/stack_one/models/shared/backgroundcheckorder_package.rb +++ b/lib/stack_one/models/shared/backgroundcheckorder_package.rb @@ -20,10 +20,10 @@ class BackgroundCheckOrderPackage < ::StackOne::Utils::FieldAugmented # Provider's unique identifier field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } # Package tests - field :tests, T.nilable(T::Array[::StackOne::Shared::AssessmentsPackagesTestApiModel]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('tests') } } + field :tests, T.nilable(T::Array[::StackOne::Shared::Package]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('tests') } } - sig { params(description: T.nilable(::String), id: T.nilable(::String), name: T.nilable(::String), remote_id: T.nilable(::String), tests: T.nilable(T::Array[::StackOne::Shared::AssessmentsPackagesTestApiModel])).void } + sig { params(description: T.nilable(::String), id: T.nilable(::String), name: T.nilable(::String), remote_id: T.nilable(::String), tests: T.nilable(T::Array[::StackOne::Shared::Package])).void } def initialize(description: nil, id: nil, name: nil, remote_id: nil, tests: nil) @description = description @id = id diff --git a/lib/stack_one/models/shared/backgroundcheckpackage.rb b/lib/stack_one/models/shared/backgroundcheckpackage.rb index a9850b35..9610fe30 100644 --- a/lib/stack_one/models/shared/backgroundcheckpackage.rb +++ b/lib/stack_one/models/shared/backgroundcheckpackage.rb @@ -20,10 +20,10 @@ class BackgroundCheckPackage < ::StackOne::Utils::FieldAugmented # Provider's unique identifier field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } # Package tests - field :tests, T.nilable(T::Array[::StackOne::Shared::AssessmentsPackages]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('tests') } } + field :tests, T.nilable(T::Array[::StackOne::Shared::Package]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('tests') } } - sig { params(description: T.nilable(::String), id: T.nilable(::String), name: T.nilable(::String), remote_id: T.nilable(::String), tests: T.nilable(T::Array[::StackOne::Shared::AssessmentsPackages])).void } + sig { params(description: T.nilable(::String), id: T.nilable(::String), name: T.nilable(::String), remote_id: T.nilable(::String), tests: T.nilable(T::Array[::StackOne::Shared::Package])).void } def initialize(description: nil, id: nil, name: nil, remote_id: nil, tests: nil) @description = description @id = id diff --git a/lib/stack_one/models/shared/backgroundcheckresult.rb b/lib/stack_one/models/shared/backgroundcheckresult.rb new file mode 100644 index 00000000..8c523cce --- /dev/null +++ b/lib/stack_one/models/shared/backgroundcheckresult.rb @@ -0,0 +1,51 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class BackgroundCheckResult < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :attachments, T.nilable(T::Array[::StackOne::Shared::Attachment]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('attachments') } } + + field :candidate, T.nilable(::StackOne::Shared::BackgroundCheckResultCandidate), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('candidate') } } + # Unique identifier + field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } + # Provider's unique identifier + field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } + + field :result, T.nilable(::StackOne::Shared::BackgroundCheckResultResult), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('result') } } + # The test`s result url + field :result_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('result_url') } } + + field :score, T.nilable(::StackOne::Shared::BackgroundCheckResultScore), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('score') } } + # The start date of the candidate test + field :start_date, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('start_date'), 'decoder': Utils.datetime_from_iso_format(true) } } + # The submission date of the candidate test + field :submission_date, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('submission_date'), 'decoder': Utils.datetime_from_iso_format(true) } } + # The summary about the result of the test + field :summary, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('summary') } } + + + sig { params(attachments: T.nilable(T::Array[::StackOne::Shared::Attachment]), candidate: T.nilable(::StackOne::Shared::BackgroundCheckResultCandidate), id: T.nilable(::String), remote_id: T.nilable(::String), result: T.nilable(::StackOne::Shared::BackgroundCheckResultResult), result_url: T.nilable(::String), score: T.nilable(::StackOne::Shared::BackgroundCheckResultScore), start_date: T.nilable(::DateTime), submission_date: T.nilable(::DateTime), summary: T.nilable(::String)).void } + def initialize(attachments: nil, candidate: nil, id: nil, remote_id: nil, result: nil, result_url: nil, score: nil, start_date: nil, submission_date: nil, summary: nil) + @attachments = attachments + @candidate = candidate + @id = id + @remote_id = remote_id + @result = result + @result_url = result_url + @score = score + @start_date = start_date + @submission_date = submission_date + @summary = summary + end + end + end +end diff --git a/lib/stack_one/models/shared/backgroundcheckresultsresult_candidate.rb b/lib/stack_one/models/shared/backgroundcheckresult_candidate.rb similarity index 91% rename from lib/stack_one/models/shared/backgroundcheckresultsresult_candidate.rb rename to lib/stack_one/models/shared/backgroundcheckresult_candidate.rb index 15001380..a12f82c4 100644 --- a/lib/stack_one/models/shared/backgroundcheckresultsresult_candidate.rb +++ b/lib/stack_one/models/shared/backgroundcheckresult_candidate.rb @@ -8,7 +8,7 @@ module StackOne module Shared - class BackgroundCheckResultsResultCandidate < ::StackOne::Utils::FieldAugmented + class BackgroundCheckResultCandidate < ::StackOne::Utils::FieldAugmented extend T::Sig # Unique identifier diff --git a/lib/stack_one/models/shared/backgroundcheckresultsresult_result.rb b/lib/stack_one/models/shared/backgroundcheckresult_result.rb similarity index 65% rename from lib/stack_one/models/shared/backgroundcheckresultsresult_result.rb rename to lib/stack_one/models/shared/backgroundcheckresult_result.rb index 823c507b..19478c3c 100644 --- a/lib/stack_one/models/shared/backgroundcheckresultsresult_result.rb +++ b/lib/stack_one/models/shared/backgroundcheckresult_result.rb @@ -8,16 +8,16 @@ module StackOne module Shared - class BackgroundCheckResultsResultResult < ::StackOne::Utils::FieldAugmented + class BackgroundCheckResultResult < ::StackOne::Utils::FieldAugmented extend T::Sig # The source value of the test result. field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } } # The result of the test. - field :value, T.nilable(::StackOne::Shared::BackgroundCheckResultsResultValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::BackgroundCheckResultsResultValue, true) } } + field :value, T.nilable(::StackOne::Shared::BackgroundCheckResultValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::BackgroundCheckResultValue, true) } } - sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::BackgroundCheckResultsResultValue)).void } + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::BackgroundCheckResultValue)).void } def initialize(source_value: nil, value: nil) @source_value = source_value @value = value diff --git a/lib/stack_one/models/shared/backgroundcheckresultsresult_score.rb b/lib/stack_one/models/shared/backgroundcheckresult_score.rb similarity index 93% rename from lib/stack_one/models/shared/backgroundcheckresultsresult_score.rb rename to lib/stack_one/models/shared/backgroundcheckresult_score.rb index 2bd4cafb..d73347cb 100644 --- a/lib/stack_one/models/shared/backgroundcheckresultsresult_score.rb +++ b/lib/stack_one/models/shared/backgroundcheckresult_score.rb @@ -8,7 +8,7 @@ module StackOne module Shared - class BackgroundCheckResultsResultScore < ::StackOne::Utils::FieldAugmented + class BackgroundCheckResultScore < ::StackOne::Utils::FieldAugmented extend T::Sig # The label of the score diff --git a/lib/stack_one/models/shared/backgroundcheckresultsresult_value.rb b/lib/stack_one/models/shared/backgroundcheckresult_value.rb similarity index 73% rename from lib/stack_one/models/shared/backgroundcheckresultsresult_value.rb rename to lib/stack_one/models/shared/backgroundcheckresult_value.rb index 1c011c69..5925f9c0 100644 --- a/lib/stack_one/models/shared/backgroundcheckresultsresult_value.rb +++ b/lib/stack_one/models/shared/backgroundcheckresult_value.rb @@ -7,8 +7,8 @@ module StackOne module Shared - # BackgroundCheckResultsResultValue - The result of the test. - class BackgroundCheckResultsResultValue < T::Enum + # BackgroundCheckResultValue - The result of the test. + class BackgroundCheckResultValue < T::Enum enums do CANCELLED = new('cancelled') EXPIRED = new('expired') diff --git a/lib/stack_one/models/shared/backgroundcheckresultsresult.rb b/lib/stack_one/models/shared/backgroundcheckresultsresult.rb index 8b79acee..38814171 100644 --- a/lib/stack_one/models/shared/backgroundcheckresultsresult.rb +++ b/lib/stack_one/models/shared/backgroundcheckresultsresult.rb @@ -12,39 +12,15 @@ class BackgroundCheckResultsResult < ::StackOne::Utils::FieldAugmented extend T::Sig - field :attachments, T.nilable(T::Array[::StackOne::Shared::AssessmentsAttachment]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('attachments') } } - - field :candidate, T.nilable(::StackOne::Shared::BackgroundCheckResultsResultCandidate), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('candidate') } } - # Unique identifier - field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } - # Provider's unique identifier - field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } - - field :result, T.nilable(::StackOne::Shared::BackgroundCheckResultsResultResult), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('result') } } - # The test`s result url - field :result_url, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('result_url') } } - - field :score, T.nilable(::StackOne::Shared::BackgroundCheckResultsResultScore), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('score') } } - # The start date of the candidate test - field :start_date, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('start_date'), 'decoder': Utils.datetime_from_iso_format(true) } } - # The submission date of the candidate test - field :submission_date, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('submission_date'), 'decoder': Utils.datetime_from_iso_format(true) } } - # The summary about the result of the test - field :summary, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('summary') } } - - - sig { params(attachments: T.nilable(T::Array[::StackOne::Shared::AssessmentsAttachment]), candidate: T.nilable(::StackOne::Shared::BackgroundCheckResultsResultCandidate), id: T.nilable(::String), remote_id: T.nilable(::String), result: T.nilable(::StackOne::Shared::BackgroundCheckResultsResultResult), result_url: T.nilable(::String), score: T.nilable(::StackOne::Shared::BackgroundCheckResultsResultScore), start_date: T.nilable(::DateTime), submission_date: T.nilable(::DateTime), summary: T.nilable(::String)).void } - def initialize(attachments: nil, candidate: nil, id: nil, remote_id: nil, result: nil, result_url: nil, score: nil, start_date: nil, submission_date: nil, summary: nil) - @attachments = attachments - @candidate = candidate - @id = id - @remote_id = remote_id - @result = result - @result_url = result_url - @score = score - @start_date = start_date - @submission_date = submission_date - @summary = summary + field :data, ::StackOne::Shared::BackgroundCheckResult, { '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::BackgroundCheckResult, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } + def initialize(data: nil, raw: nil) + @data = data + @raw = raw end end end diff --git a/lib/stack_one/models/shared/category_value.rb b/lib/stack_one/models/shared/category_value.rb index e23952ba..03d5a8ae 100644 --- a/lib/stack_one/models/shared/category_value.rb +++ b/lib/stack_one/models/shared/category_value.rb @@ -12,6 +12,7 @@ class CategoryValue < T::Enum enums do PRIMARY = new('primary') SECONDARY = new('secondary') + TERTIARY = new('tertiary') end end end diff --git a/lib/stack_one/models/shared/completion.rb b/lib/stack_one/models/shared/completion.rb index ced3ac74..c1932d8d 100644 --- a/lib/stack_one/models/shared/completion.rb +++ b/lib/stack_one/models/shared/completion.rb @@ -31,6 +31,8 @@ class Completion < ::StackOne::Utils::FieldAugmented # # @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 ID associated with this completion field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } # The external reference of the learning object associated with this completion @@ -67,14 +69,15 @@ class Completion < ::StackOne::Utils::FieldAugmented field :user_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('user_id') } } - sig { params(completed_at: T.nilable(::String), content_external_reference: T.nilable(::String), content_id: T.nilable(::String), course_id: T.nilable(::String), created_at: T.nilable(::String), external_id: T.nilable(::String), id: T.nilable(::String), learning_object_external_reference: T.nilable(::String), learning_object_id: T.nilable(::String), learning_object_type: T.nilable(::StackOne::Shared::CompletionLearningObjectType), remote_content_id: T.nilable(::String), remote_course_id: T.nilable(::String), remote_external_id: T.nilable(::String), remote_id: T.nilable(::String), remote_learning_object_id: T.nilable(::String), remote_user_id: T.nilable(::String), result: T.nilable(::StackOne::Shared::CompletionSchemasResult), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object]), updated_at: T.nilable(::String), user_id: T.nilable(::String)).void } - def initialize(completed_at: nil, content_external_reference: nil, content_id: nil, course_id: nil, created_at: nil, external_id: nil, id: nil, learning_object_external_reference: nil, learning_object_id: nil, learning_object_type: nil, remote_content_id: nil, remote_course_id: nil, remote_external_id: nil, remote_id: nil, remote_learning_object_id: nil, remote_user_id: nil, result: nil, unified_custom_fields: nil, updated_at: nil, user_id: nil) + sig { params(completed_at: T.nilable(::String), content_external_reference: T.nilable(::String), content_id: T.nilable(::String), course_id: T.nilable(::String), created_at: T.nilable(::String), external_id: T.nilable(::String), external_reference: T.nilable(::String), id: T.nilable(::String), learning_object_external_reference: T.nilable(::String), learning_object_id: T.nilable(::String), learning_object_type: T.nilable(::StackOne::Shared::CompletionLearningObjectType), remote_content_id: T.nilable(::String), remote_course_id: T.nilable(::String), remote_external_id: T.nilable(::String), remote_id: T.nilable(::String), remote_learning_object_id: T.nilable(::String), remote_user_id: T.nilable(::String), result: T.nilable(::StackOne::Shared::CompletionSchemasResult), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object]), updated_at: T.nilable(::String), user_id: T.nilable(::String)).void } + def initialize(completed_at: nil, content_external_reference: nil, content_id: nil, course_id: nil, created_at: nil, external_id: nil, external_reference: nil, id: nil, learning_object_external_reference: nil, learning_object_id: nil, learning_object_type: nil, remote_content_id: nil, remote_course_id: nil, remote_external_id: nil, remote_id: nil, remote_learning_object_id: nil, remote_user_id: nil, result: nil, unified_custom_fields: nil, updated_at: nil, user_id: nil) @completed_at = completed_at @content_external_reference = content_external_reference @content_id = content_id @course_id = course_id @created_at = created_at @external_id = external_id + @external_reference = external_reference @id = id @learning_object_external_reference = learning_object_external_reference @learning_object_id = learning_object_id diff --git a/lib/stack_one/models/shared/createcategoriesapimodel.rb b/lib/stack_one/models/shared/createcategoriesapimodel.rb index d72cf68b..163185a6 100644 --- a/lib/stack_one/models/shared/createcategoriesapimodel.rb +++ b/lib/stack_one/models/shared/createcategoriesapimodel.rb @@ -11,14 +11,20 @@ module Shared class CreateCategoriesApiModel < ::StackOne::Utils::FieldAugmented extend T::Sig + # The ID associated with this category + field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } + # The hierarchal level of the category + field :level, T.nilable(::StackOne::Shared::CreateCategoriesApiModelLevel), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('level') } } # The name associated with this category field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('name') } } # Custom Unified Fields configured in your StackOne project field :unified_custom_fields, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('unified_custom_fields') } } - sig { params(name: T.nilable(::String), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object])).void } - def initialize(name: nil, unified_custom_fields: nil) + sig { params(id: T.nilable(::String), level: T.nilable(::StackOne::Shared::CreateCategoriesApiModelLevel), name: T.nilable(::String), unified_custom_fields: T.nilable(T::Hash[Symbol, ::Object])).void } + def initialize(id: nil, level: nil, name: nil, unified_custom_fields: nil) + @id = id + @level = level @name = name @unified_custom_fields = unified_custom_fields end diff --git a/lib/stack_one/models/shared/createcategoriesapimodel_level.rb b/lib/stack_one/models/shared/createcategoriesapimodel_level.rb new file mode 100644 index 00000000..131d309d --- /dev/null +++ b/lib/stack_one/models/shared/createcategoriesapimodel_level.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 category + class CreateCategoriesApiModelLevel < ::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::CreateCategoriesApiModelValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::CreateCategoriesApiModelValue, true) } } + + + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CreateCategoriesApiModelValue)).void } + def initialize(source_value: nil, value: nil) + @source_value = source_value + @value = value + end + end + end +end diff --git a/lib/stack_one/models/shared/createcategoriesapimodel_value.rb b/lib/stack_one/models/shared/createcategoriesapimodel_value.rb new file mode 100644 index 00000000..ad0d7b96 --- /dev/null +++ b/lib/stack_one/models/shared/createcategoriesapimodel_value.rb @@ -0,0 +1,19 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class CreateCategoriesApiModelValue < T::Enum + enums do + PRIMARY = new('primary') + SECONDARY = new('secondary') + TERTIARY = new('tertiary') + end + end + end +end diff --git a/lib/stack_one/models/shared/createassessmentspackages.rb b/lib/stack_one/models/shared/createpackage.rb similarity index 90% rename from lib/stack_one/models/shared/createassessmentspackages.rb rename to lib/stack_one/models/shared/createpackage.rb index a6581489..52bf7cc9 100644 --- a/lib/stack_one/models/shared/createassessmentspackages.rb +++ b/lib/stack_one/models/shared/createpackage.rb @@ -8,7 +8,7 @@ module StackOne module Shared - class CreateAssessmentsPackages < ::StackOne::Utils::FieldAugmented + class CreatePackage < ::StackOne::Utils::FieldAugmented extend T::Sig # Package description diff --git a/lib/stack_one/models/shared/createskillsapimodel.rb b/lib/stack_one/models/shared/createskillsapimodel.rb index 5476ce9a..440a9e7c 100644 --- a/lib/stack_one/models/shared/createskillsapimodel.rb +++ b/lib/stack_one/models/shared/createskillsapimodel.rb @@ -13,17 +13,17 @@ class CreateSkillsApiModel < ::StackOne::Utils::FieldAugmented # The ID associated with this skill field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } + # The hierarchal level of the skill + field :level, T.nilable(::StackOne::Shared::CreateSkillsApiModelLevel), { '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') } } - # Provider's unique identifier - field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } - sig { params(id: T.nilable(::String), name: T.nilable(::String), remote_id: T.nilable(::String)).void } - def initialize(id: nil, name: nil, remote_id: nil) + sig { params(id: T.nilable(::String), level: T.nilable(::StackOne::Shared::CreateSkillsApiModelLevel), name: T.nilable(::String)).void } + def initialize(id: nil, level: nil, name: nil) @id = id + @level = level @name = name - @remote_id = remote_id end end end diff --git a/lib/stack_one/models/shared/createskillsapimodel_level.rb b/lib/stack_one/models/shared/createskillsapimodel_level.rb new file mode 100644 index 00000000..faa12863 --- /dev/null +++ b/lib/stack_one/models/shared/createskillsapimodel_level.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 CreateSkillsApiModelLevel < ::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::CreateSkillsApiModelValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::CreateSkillsApiModelValue, true) } } + + + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CreateSkillsApiModelValue)).void } + def initialize(source_value: nil, value: nil) + @source_value = source_value + @value = value + end + end + end +end diff --git a/lib/stack_one/models/shared/createskillsapimodel_value.rb b/lib/stack_one/models/shared/createskillsapimodel_value.rb new file mode 100644 index 00000000..b3a52717 --- /dev/null +++ b/lib/stack_one/models/shared/createskillsapimodel_value.rb @@ -0,0 +1,19 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class CreateSkillsApiModelValue < T::Enum + enums do + PRIMARY = new('primary') + SECONDARY = new('secondary') + TERTIARY = new('tertiary') + end + end + end +end diff --git a/lib/stack_one/models/shared/lmscreateassignmentrequestdto.rb b/lib/stack_one/models/shared/lmscreateassignmentrequestdto.rb index adf22274..d2eebe3d 100644 --- a/lib/stack_one/models/shared/lmscreateassignmentrequestdto.rb +++ b/lib/stack_one/models/shared/lmscreateassignmentrequestdto.rb @@ -15,6 +15,8 @@ class LmsCreateAssignmentRequestDto < ::StackOne::Utils::FieldAugmented field :created_at, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('created_at') } } # 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 + 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 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 @@ -27,10 +29,11 @@ class LmsCreateAssignmentRequestDto < ::StackOne::Utils::FieldAugmented field :status, T.nilable(::StackOne::Shared::LmsCreateAssignmentRequestDtoStatus), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('status') } } - sig { params(created_at: T.nilable(::String), due_date: T.nilable(::String), learning_object_external_reference: T.nilable(::String), learning_object_id: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), progress: T.nilable(::Float), status: T.nilable(::StackOne::Shared::LmsCreateAssignmentRequestDtoStatus)).void } - def initialize(created_at: nil, due_date: nil, learning_object_external_reference: nil, learning_object_id: nil, passthrough: nil, progress: nil, status: nil) + sig { params(created_at: T.nilable(::String), due_date: 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]), progress: T.nilable(::Float), status: T.nilable(::StackOne::Shared::LmsCreateAssignmentRequestDtoStatus)).void } + def initialize(created_at: nil, due_date: nil, external_reference: nil, learning_object_external_reference: nil, learning_object_id: nil, passthrough: nil, progress: nil, status: nil) @created_at = created_at @due_date = due_date + @external_reference = external_reference @learning_object_external_reference = learning_object_external_reference @learning_object_id = learning_object_id @passthrough = passthrough diff --git a/lib/stack_one/models/shared/lmscreatecompletionrequestdto.rb b/lib/stack_one/models/shared/lmscreatecompletionrequestdto.rb index 4f331b78..c0b60434 100644 --- a/lib/stack_one/models/shared/lmscreatecompletionrequestdto.rb +++ b/lib/stack_one/models/shared/lmscreatecompletionrequestdto.rb @@ -25,6 +25,8 @@ class LmsCreateCompletionRequestDto < ::StackOne::Utils::FieldAugmented # # @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 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 @@ -35,12 +37,13 @@ class LmsCreateCompletionRequestDto < ::StackOne::Utils::FieldAugmented 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), 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, 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), 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) @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 diff --git a/lib/stack_one/models/shared/lmsupsertcourserequestdto.rb b/lib/stack_one/models/shared/lmsupsertcourserequestdto.rb index ec0da05b..fdd2f488 100644 --- a/lib/stack_one/models/shared/lmsupsertcourserequestdto.rb +++ b/lib/stack_one/models/shared/lmsupsertcourserequestdto.rb @@ -13,7 +13,7 @@ class LmsUpsertCourseRequestDto < ::StackOne::Utils::FieldAugmented # Whether the course is active and available for users. field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('active') } } - # The categories associated with this course + # The categories associated with this content 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') } } @@ -29,7 +29,7 @@ class LmsUpsertCourseRequestDto < ::StackOne::Utils::FieldAugmented 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 skills associated with this course + # 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 field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('title') } } diff --git a/lib/stack_one/models/shared/result.rb b/lib/stack_one/models/shared/result.rb index dea1eee5..2d0550a7 100644 --- a/lib/stack_one/models/shared/result.rb +++ b/lib/stack_one/models/shared/result.rb @@ -14,10 +14,10 @@ class Result < ::StackOne::Utils::FieldAugmented # The source value of the test result. field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } } # The result of the test. - field :value, T.nilable(::StackOne::Shared::AssessmentsResultsValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::AssessmentsResultsValue, true) } } + field :value, T.nilable(::StackOne::Shared::AssessmentResultValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::AssessmentResultValue, true) } } - sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::AssessmentsResultsValue)).void } + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::AssessmentResultValue)).void } def initialize(source_value: nil, value: nil) @source_value = source_value @value = value diff --git a/lib/stack_one/models/shared/skills_value.rb b/lib/stack_one/models/shared/skills_value.rb index 5422455a..6ab1e39f 100644 --- a/lib/stack_one/models/shared/skills_value.rb +++ b/lib/stack_one/models/shared/skills_value.rb @@ -12,6 +12,7 @@ class SkillsValue < T::Enum enums do PRIMARY = new('primary') SECONDARY = new('secondary') + TERTIARY = new('tertiary') end end end diff --git a/lib/stack_one/sdkconfiguration.rb b/lib/stack_one/sdkconfiguration.rb index 339770e8..3cc49004 100644 --- a/lib/stack_one/sdkconfiguration.rb +++ b/lib/stack_one/sdkconfiguration.rb @@ -38,9 +38,9 @@ def initialize(client, security, server_url, server_idx) @security = security @language = 'ruby' @openapi_doc_version = '1.0.0' - @sdk_version = '0.4.4' - @gen_version = '2.484.0' - @user_agent = 'speakeasy-sdk/ruby 0.4.4 2.484.0 1.0.0 stackone_client' + @sdk_version = '0.5.0' + @gen_version = '2.486.1' + @user_agent = 'speakeasy-sdk/ruby 0.5.0 2.486.1 1.0.0 stackone_client' end sig { returns([String, T::Hash[Symbol, String]]) } diff --git a/stackone_client.gemspec b/stackone_client.gemspec index 46946436..b609c2ff 100644 --- a/stackone_client.gemspec +++ b/stackone_client.gemspec @@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__) Gem::Specification.new do |s| s.name = 'stackone_client' - s.version = '0.4.4' + s.version = '0.5.0' s.platform = Gem::Platform::RUBY s.licenses = ['Apache-2.0'] s.summary = ''