diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 87e99ba..67ed246 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 79567c4a-05f9-4d65-864d-dfe107aa4e9d management: - docChecksum: 49de8ed28eca4d8ac2ec7aed2f262494 + docChecksum: 4b99d051623e198b87a8dc30bf7ae83b docVersion: 1.0.0 - speakeasyVersion: 1.660.0 - generationVersion: 2.760.2 - releaseVersion: 0.2.4 - configChecksum: 28c5bbc65f271823ed2ffd96b46eb048 + speakeasyVersion: 1.666.0 + generationVersion: 2.768.0 + releaseVersion: 0.3.0 + configChecksum: dfcc71172191032548e6683a07565071 repoURL: https://github.com/kombohq/typescript-sdk.git installationURL: https://github.com/kombohq/typescript-sdk published: true @@ -14,7 +14,7 @@ features: typescript: additionalDependencies: 0.1.0 constsAndDefaults: 0.1.12 - core: 3.26.9 + core: 3.26.13 defaultEnabledRetries: 0.1.0 deprecations: 2.81.1 enumUnions: 0.1.0 @@ -35,9 +35,9 @@ features: pagination: 2.83.0 responseFormat: 0.2.3 retries: 2.83.0 - sdkHooks: 0.3.0 + sdkHooks: 0.4.0 serverIDs: 2.81.2 - unions: 2.86.0 + unions: 2.86.3 webhooks: 1.5.1 generatedFiles: - .gitattributes @@ -326,23 +326,31 @@ generatedFiles: - docs/models/getintegrationsintegrationidintegrationfieldspositiveresponsetype.md - docs/models/getintegrationsintegrationidpositiveresponse.md - docs/models/getintegrationsintegrationidpositiveresponsecategory.md - - docs/models/getintegrationsintegrationidpositiveresponsecoveragestatus.md - docs/models/getintegrationsintegrationidpositiveresponsedata.md - docs/models/getintegrationsintegrationidpositiveresponseenduser.md - - docs/models/getintegrationsintegrationidpositiveresponsefield.md - - docs/models/getintegrationsintegrationidpositiveresponsefieldcoveragestatus.md - docs/models/getintegrationsintegrationidpositiveresponsereadmodel.md + - docs/models/getintegrationsintegrationidpositiveresponsereadmodelcoveragestatus.md + - docs/models/getintegrationsintegrationidpositiveresponsereadmodelfield.md + - docs/models/getintegrationsintegrationidpositiveresponsereadmodelfieldcoveragestatus.md - docs/models/getintegrationsintegrationidpositiveresponsesetupstatus.md - docs/models/getintegrationsintegrationidpositiveresponsestatus.md - docs/models/getintegrationsintegrationidpositiveresponsetool.md + - docs/models/getintegrationsintegrationidpositiveresponsewriteaction.md + - docs/models/getintegrationsintegrationidpositiveresponsewriteactioncoveragestatus.md + - docs/models/getintegrationsintegrationidpositiveresponsewriteactionfield.md + - docs/models/getintegrationsintegrationidpositiveresponsewriteactionfieldcoveragestatus.md - docs/models/gettoolscategoryparametercategory.md - docs/models/gettoolscategorypositiveresponse.md - docs/models/gettoolscategorypositiveresponsedata.md - - docs/models/gettoolscategorypositiveresponsefield.md - - docs/models/gettoolscategorypositiveresponsefieldcoveragestatus.md - docs/models/gettoolscategorypositiveresponsereadmodel.md - docs/models/gettoolscategorypositiveresponsereadmodelcoveragestatus.md + - docs/models/gettoolscategorypositiveresponsereadmodelfield.md + - docs/models/gettoolscategorypositiveresponsereadmodelfieldcoveragestatus.md - docs/models/gettoolscategorypositiveresponsetool.md + - docs/models/gettoolscategorypositiveresponsewriteaction.md + - docs/models/gettoolscategorypositiveresponsewriteactioncoveragestatus.md + - docs/models/gettoolscategorypositiveresponsewriteactionfield.md + - docs/models/gettoolscategorypositiveresponsewriteactionfieldcoveragestatus.md - docs/models/group.md - docs/models/grouptype.md - docs/models/headers.md @@ -657,6 +665,7 @@ generatedFiles: - docs/models/postatscandidatesrequestbodypersonio.md - docs/models/postatscandidatesrequestbodypiloga.md - docs/models/postatscandidatesrequestbodypilogacandidate.md + - docs/models/postatscandidatesrequestbodypinpoint.md - docs/models/postatscandidatesrequestbodypostheaders.md - docs/models/postatscandidatesrequestbodyrecruitee.md - docs/models/postatscandidatesrequestbodyrecruiteecandidate.md @@ -793,6 +802,7 @@ generatedFiles: - docs/models/postatsjobsjobidapplicationsrequestbodypersonio.md - docs/models/postatsjobsjobidapplicationsrequestbodypiloga.md - docs/models/postatsjobsjobidapplicationsrequestbodypilogacandidate.md + - docs/models/postatsjobsjobidapplicationsrequestbodypinpoint.md - docs/models/postatsjobsjobidapplicationsrequestbodypostheaders.md - docs/models/postatsjobsjobidapplicationsrequestbodyrecruitee.md - docs/models/postatsjobsjobidapplicationsrequestbodyrecruiteecandidate.md @@ -857,6 +867,7 @@ generatedFiles: - docs/models/postpassthroughtoolapipositiveresponsewarning.md - docs/models/postpassthroughtoolapirequestbody.md - docs/models/preconditionoptions.md + - docs/models/prehire.md - docs/models/properties.md - docs/models/propertiesarray.md - docs/models/propertiescheckbox.md @@ -895,6 +906,7 @@ generatedFiles: - docs/models/putintegrationsintegrationidcustomfieldscustomfieldidpositiveresponsetype.md - docs/models/putintegrationsintegrationidcustomfieldscustomfieldidrequestbody.md - docs/models/qastatus.md + - docs/models/readmodelscopeconfigsetting.md - docs/models/remoteworkstatus.md - docs/models/reviewcycle.md - docs/models/reviewee.md @@ -966,7 +978,6 @@ generatedFiles: - docs/models/schema2union2.md - docs/models/schema4.md - docs/models/scopeconfig.md - - docs/models/scopeconfigsetting.md - docs/models/score.md - docs/models/screeningquestion.md - docs/models/security.md @@ -995,8 +1006,7 @@ generatedFiles: - docs/models/webhooks/webhooksyncfinishedwebhookpayloadrequest.md - docs/models/worklocation.md - docs/models/worklocationaddress.md - - docs/models/writeaction.md - - docs/models/writeactioncoveragestatus.md + - docs/models/writeactionscopeconfigsetting.md - docs/sdks/assessment/README.md - docs/sdks/ats/README.md - docs/sdks/connect/README.md @@ -5271,7 +5281,7 @@ examples: integration_id: "" responses: "200": - application/json: {"status": "success", "data": {"id": "factorial:8d1hpPsbjxUkoCoa1veLZGe5", "tool": {"id": "factorial", "label": "Factorial", "internal_label": null, "logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg", "icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg"}, "category": "HRIS", "status": "ACTIVE", "setup_status": "COMPLETED", "end_user": {"organization_name": "Acme", "creator_email": "example-integration-creator@acme.com", "origin_id": "2DQJAUtSzzzKP9buDTvUvPk3"}, "scope_config": {"id": "B1hu5NGyhdjSq5X3hxEz4bAN", "name": "Anonymous Scopes"}, "created_at": "2022-08-07T14:01:29.196Z", "beta": false, "read_models": [{"id": "hris_employees", "label": "Employees", "is_available": true, "coverage_status": "SUPPORTED", "scope_config_setting": "ENABLED", "opted_out_by_customer": false, "fields": [{"id": "date_of_birth", "is_available": false, "coverage_status": "SUPPORTED", "scope_config_setting": "OPTIONAL", "opted_out_by_customer": true}]}]}} + application/json: {"status": "success", "data": {"id": "factorial:8d1hpPsbjxUkoCoa1veLZGe5", "tool": {"id": "factorial", "label": "Factorial", "internal_label": null, "logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg", "icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg"}, "category": "HRIS", "status": "ACTIVE", "setup_status": "COMPLETED", "end_user": {"organization_name": "Acme", "creator_email": "example-integration-creator@acme.com", "origin_id": "2DQJAUtSzzzKP9buDTvUvPk3"}, "scope_config": {"id": "B1hu5NGyhdjSq5X3hxEz4bAN", "name": "Anonymous Scopes"}, "created_at": "2022-08-07T14:01:29.196Z", "beta": false, "read_models": [{"id": "hris_employees", "label": "Employees", "is_available": true, "coverage_status": "SUPPORTED", "scope_config_setting": "ENABLED", "opted_out_by_customer": false, "fields": [{"id": "date_of_birth", "is_available": false, "coverage_status": "SUPPORTED", "scope_config_setting": "OPTIONAL", "opted_out_by_customer": true}]}], "write_actions": [{"id": "hris_create_employee", "label": "Create employee", "is_available": true, "coverage_status": "SUPPORTED", "scope_config_setting": "ENABLED", "opted_out_by_customer": false, "fields": [{"id": "first_name", "is_available": true, "coverage_status": "SUPPORTED"}]}]}} Error Response: parameters: path: @@ -5441,7 +5451,7 @@ examples: category: "ats" responses: "200": - application/json: {"status": "success", "data": {"tools": [{"id": "factorial", "label": "Factorial", "internal_label": null, "assets": {"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg", "icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg", "icon_black_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon-black.svg"}, "paid_api_details_markdown": null, "fast_track_details_markdown": null, "partner_only_details_markdown": null, "connection_guide_url": "https://help.kombo.dev/hc/en-us/articles/18743884123409-Factorial-HR-How-do-I-link-my-account", "coverage": {"read_models": [{"id": "hris_employees", "label": "Employees", "coverage_status": "SUPPORTED", "fields": [{"id": "date_of_birth", "coverage_status": "SUPPORTED"}]}, {"id": "hris_teams", "label": "Groups", "coverage_status": "UNSUPPORTED", "fields": [{"id": "parent_id", "coverage_status": "UNSUPPORTED"}]}], "write_actions": [{"id": "hris_create_employee", "label": "Create employee", "coverage_status": "SUPPORTED"}], "features": [{"id": "automatic_source_writing", "label": "Automatic Source Writing", "coverage_status": "SUPPORTED"}]}}]}} + application/json: {"status": "success", "data": {"tools": [{"id": "factorial", "label": "Factorial", "internal_label": null, "assets": {"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg", "icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg", "icon_black_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon-black.svg"}, "paid_api_details_markdown": null, "fast_track_details_markdown": null, "partner_only_details_markdown": null, "connection_guide_url": "https://help.kombo.dev/hc/en-us/articles/18743884123409-Factorial-HR-How-do-I-link-my-account", "coverage": {"read_models": [{"id": "hris_employees", "label": "Employees", "coverage_status": "SUPPORTED", "fields": [{"id": "date_of_birth", "coverage_status": "SUPPORTED"}]}, {"id": "hris_teams", "label": "Groups", "coverage_status": "UNSUPPORTED", "fields": [{"id": "parent_id", "coverage_status": "UNSUPPORTED"}]}], "write_actions": [{"id": "hris_create_employee", "label": "Create employee", "coverage_status": "SUPPORTED", "fields": [{"id": "first_name", "coverage_status": "SUPPORTED"}]}], "features": [{"id": "automatic_source_writing", "label": "Automatic Source Writing", "coverage_status": "SUPPORTED"}]}}]}} Error Response: parameters: path: @@ -5539,7 +5549,7 @@ examples: application/json: {"properties": {"firstName": "John", "startDate": "2025-01-01T00:00:00Z", "workLocation": {"site": "8e422bf8cav", "keyNumbers": {"0": 142, "1": 525, "2": 63}}}} responses: "200": - application/json: {"status": "success", "data": {"id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "12345", "prehire_id": null}, "warnings": [{"message": "This is an example warning!"}]} + application/json: {"status": "success", "data": {"id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "12345", "prehire": {"remote_id": null}}, "warnings": [{"message": "This is an example warning!"}]} speakeasy-default-post-hris-employees-form: parameters: header: @@ -5548,7 +5558,7 @@ examples: application/json: {"properties": {"key": 3571.27}} responses: "200": - application/json: {"status": "success", "data": {"id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "12345", "prehire_id": null}, "warnings": [{"message": ""}]} + application/json: {"status": "success", "data": {"id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "12345", "prehire": {"remote_id": null}}, "warnings": [{"message": ""}]} default: application/json: {"status": "error", "error": {"code": "INTEGRATION.AUTHENTICATION_INVALID", "title": "", "message": "", "log_url": "https://authorized-dandelion.com"}} Error Response: @@ -7279,7 +7289,7 @@ examples: X-Integration-Id: "workday:HWUTwvyx2wLoSUHphiWVrp28" responses: "200": - application/json: {"status": "success", "data": {"next": "", "results": [{"id": "B5KQKhAgTv6ZwzrfAbqbhipd", "package_id": "typescript_test", "candidate": {"email": "john.doe@gmail.com", "first_name": "John", "last_name": "Doe", "phone": "+1 123 456 7890", "remote_id": "12345"}, "application": {"remote_id": "54321"}, "job": {"remote_id": "67890", "name": "Engineering Manager", "location": {"city": "Berlin", "country": "DE", "raw": "Berlin, Germany", "state": "Berlin", "street_1": "Lohmühlenstraße 65", "street_2": null, "zip_code": "12435"}, "hiring_team": [{"remote_id": "78901", "email": "jane.doe@gmail.com", "first_name": "Jane", "last_name": "Doe", "hiring_team_roles": ["RECRUITER"]}]}}]}} + application/json: {"status": "success", "data": {"next": "", "results": [{"id": "B5KQKhAgTv6ZwzrfAbqbhipd", "package_id": "typescript_test", "candidate": {"remote_id": "12345", "email": "john.doe@gmail.com", "first_name": "John", "last_name": "Doe", "phone": "+1 123 456 7890"}, "application": {"remote_id": "54321"}, "job": {"remote_id": "67890", "name": "Engineering Manager", "location": {"city": "Berlin", "country": "DE", "raw": "Berlin, Germany", "state": "Berlin", "street_1": "Lohmühlenstraße 65", "street_2": null, "zip_code": "12435"}, "hiring_team": [{"remote_id": "78901", "email": "jane.doe@gmail.com", "first_name": "Jane", "last_name": "Doe", "hiring_team_roles": ["RECRUITER"]}]}}]}} default: application/json: {"status": "error", "error": {"code": "ATS.JOB_CLOSED", "title": null, "message": "", "log_url": "https://specific-league.net/"}} Error Response: @@ -7596,3 +7606,4 @@ generatedTests: unlinkSharedEnvVariable: "2025-10-24T00:07:28Z" updateStaticIps: "2025-10-24T00:07:28Z" getProjectClientCerts: "2025-10-27T19:04:15Z" +releaseNotes: "## Typescript SDK Changes:\n* `kombo.hris.createEmployeeWithForm()`: `response.data` **Changed** **Breaking** :warning:\n* `kombo.general.getIntegrationDetails()`: `response.data.writeActions` **Added**\n* `kombo.general.getTools()`: `response.data.tools.[].coverage.writeActions.[].fields` **Added**\n* `kombo.ats.createCandidate()`: \n * `request.remoteFields.pinpoint` **Added**\n* `kombo.ats.createApplication()`: \n * `request.body.remoteFields.pinpoint` **Added**\n" diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 40d678b..3f29be5 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -27,7 +27,7 @@ generation: generateNewTests: true skipResponseBodyAssertions: false typescript: - version: 0.2.4 + version: 0.3.0 acceptHeaderEnum: true additionalDependencies: dependencies: {} @@ -61,7 +61,9 @@ typescript: exportZodModelNamespace: false flattenGlobalSecurity: true flatteningOrder: parameters-first + formStringArrayEncodeMode: encoded-string forwardCompatibleEnumsByDefault: false + forwardCompatibleUnionsByDefault: "false" generateExamples: true imports: option: openapi @@ -71,6 +73,7 @@ typescript: operations: models/operations shared: models webhooks: models/webhooks + inferUnionDiscriminators: true inputModelSuffix: input jsonpath: rfc9535 laxMode: strict @@ -78,8 +81,10 @@ typescript: methodArguments: infer-optional-args modelPropertyCasing: snake moduleFormat: esm + multipartArrayFormat: legacy outputModelSuffix: output packageName: '@kombo-api/sdk' + preApplyUnionDiscriminators: true responseFormat: flat sseFlatResponse: false templateVersion: v2 diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index cd9938f..2492ffe 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.660.0 +speakeasyVersion: 1.666.0 sources: kombo-prepared-spec: sourceNamespace: kombo-api - sourceRevisionDigest: sha256:e6893ee988ef930d09257aafa12d2fc912c919be517e8672a1748d80f3205d26 - sourceBlobDigest: sha256:5a23fe49cb300657dfb2707e34add47b21f08cba10934968014378c0c59e444a + sourceRevisionDigest: sha256:50a5c721045e410083bff30b593bc8cdededfbab193d6210a3a7d0880b7ed329 + sourceBlobDigest: sha256:af8ab6d699593e546175af62f6c187a0470e725a022d116ce27e73a1b7f88e43 tags: - latest - - speakeasy-sdk-regen-1763650715 + - speakeasy-sdk-regen-1764029099 - 1.0.0 targets: kombo-typescript: source: kombo-prepared-spec sourceNamespace: kombo-api - sourceRevisionDigest: sha256:e6893ee988ef930d09257aafa12d2fc912c919be517e8672a1748d80f3205d26 - sourceBlobDigest: sha256:5a23fe49cb300657dfb2707e34add47b21f08cba10934968014378c0c59e444a + sourceRevisionDigest: sha256:50a5c721045e410083bff30b593bc8cdededfbab193d6210a3a7d0880b7ed329 + sourceBlobDigest: sha256:af8ab6d699593e546175af62f6c187a0470e725a022d116ce27e73a1b7f88e43 codeSamplesNamespace: kombo-api-typescript-code-samples - codeSamplesRevisionDigest: sha256:cbfa3a011600e188aaa919c77b53398632aed5261fce5228264bb56ae61d73b7 + codeSamplesRevisionDigest: sha256:904454813482346f629f73866c2d625d9171d6bfc45b7da322bad0649d975c64 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index bc13635..45f9f12 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -58,4 +58,14 @@ Based on: ### Generated - [typescript v0.2.4] . ### Releases -- [NPM v0.2.4] https://www.npmjs.com/package/@kombo-api/sdk/v/0.2.4 - . \ No newline at end of file +- [NPM v0.2.4] https://www.npmjs.com/package/@kombo-api/sdk/v/0.2.4 - . + +## 2025-12-02 00:01:41 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.666.0 (2.768.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.3.0] . +### Releases +- [NPM v0.3.0] https://www.npmjs.com/package/@kombo-api/sdk/v/0.3.0 - . \ No newline at end of file diff --git a/docs/models/assessmentorderreceivedwebhookpayloadcandidate.md b/docs/models/assessmentorderreceivedwebhookpayloadcandidate.md index 993e92c..6f11d21 100644 --- a/docs/models/assessmentorderreceivedwebhookpayloadcandidate.md +++ b/docs/models/assessmentorderreceivedwebhookpayloadcandidate.md @@ -16,8 +16,8 @@ let value: AssessmentOrderReceivedWebhookPayloadCandidate = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `remote_id` | *string* | :heavy_minus_sign: | The candidate's identifier in the integrated system. | | `email` | *string* | :heavy_check_mark: | The candidate's email address. | | `first_name` | *string* | :heavy_minus_sign: | The candidate's first name. | | `last_name` | *string* | :heavy_minus_sign: | The candidate's last name. | -| `phone` | *string* | :heavy_minus_sign: | The candidate's phone number. | -| `remote_id` | *string* | :heavy_minus_sign: | The candidate's identifier in the integrated system. | \ No newline at end of file +| `phone` | *string* | :heavy_minus_sign: | The candidate's phone number. | \ No newline at end of file diff --git a/docs/models/attributesubresult.md b/docs/models/attributesubresult.md index bcc25bf..06789b2 100644 --- a/docs/models/attributesubresult.md +++ b/docs/models/attributesubresult.md @@ -21,7 +21,7 @@ let value: AttributeSubResult = { | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"SUB_RESULT"* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `label` | *string* | :heavy_check_mark: | N/A | | `score` | [models.Score](../models/score.md) | :heavy_check_mark: | N/A | diff --git a/docs/models/attributetext.md b/docs/models/attributetext.md index 4b8074e..4a4c85d 100644 --- a/docs/models/attributetext.md +++ b/docs/models/attributetext.md @@ -16,6 +16,6 @@ let value: AttributeText = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"TEXT"* | :heavy_check_mark: | N/A | | `label` | *string* | :heavy_check_mark: | N/A | | `value` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/coverage.md b/docs/models/coverage.md index baad44f..9e3102d 100644 --- a/docs/models/coverage.md +++ b/docs/models/coverage.md @@ -34,8 +34,8 @@ let value: Coverage = { ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `read_models` | [models.GetToolsCategoryPositiveResponseReadModel](../models/gettoolscategorypositiveresponsereadmodel.md)[] | :heavy_check_mark: | N/A | -| `write_actions` | [models.WriteAction](../models/writeaction.md)[] | :heavy_check_mark: | N/A | -| `features` | [models.Feature](../models/feature.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `read_models` | [models.GetToolsCategoryPositiveResponseReadModel](../models/gettoolscategorypositiveresponsereadmodel.md)[] | :heavy_check_mark: | N/A | +| `write_actions` | [models.GetToolsCategoryPositiveResponseWriteAction](../models/gettoolscategorypositiveresponsewriteaction.md)[] | :heavy_check_mark: | N/A | +| `features` | [models.Feature](../models/feature.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/deleteatscandidatescandidateidtagspositiveresponse.md b/docs/models/deleteatscandidatescandidateidtagspositiveresponse.md index 3299c86..4d78e72 100644 --- a/docs/models/deleteatscandidatescandidateidtagspositiveresponse.md +++ b/docs/models/deleteatscandidatescandidateidtagspositiveresponse.md @@ -20,6 +20,6 @@ let value: DeleteAtsCandidatesCandidateIdTagsPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.DeleteAtsCandidatesCandidateIdTagsPositiveResponseData](../models/deleteatscandidatescandidateidtagspositiveresponsedata.md) | :heavy_check_mark: | N/A | {} | | `warnings` | [models.DeleteAtsCandidatesCandidateIdTagsPositiveResponseWarning](../models/deleteatscandidatescandidateidtagspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/deletehrisabsencesabsenceidpositiveresponse.md b/docs/models/deletehrisabsencesabsenceidpositiveresponse.md index ec5e55c..9e039f3 100644 --- a/docs/models/deletehrisabsencesabsenceidpositiveresponse.md +++ b/docs/models/deletehrisabsencesabsenceidpositiveresponse.md @@ -33,6 +33,6 @@ let value: DeleteHrisAbsencesAbsenceIdPositiveResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.DeleteHrisAbsencesAbsenceIdPositiveResponseData](../models/deletehrisabsencesabsenceidpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "22st2Ji8XpncEYEak8mvQgQF",
"remote_id": "1348",
"employee_id": "JDdUy9kiH5APaGizFrgNmQjM",
"approver_id": "AgXEispYPP1BbToHpqnqcpxy",
"start_date": "2022-08-04T00:00:00Z",
"end_date": "2022-08-05T00:00:00Z",
"start_half_day": true,
"end_half_day": false,
"start_time": "13:15:00",
"end_time": "17:00:00",
"amount": 2,
"unit": "DAYS",
"status": "APPROVED",
"employee_note": "Visiting my family.",
"type_id": "xzZoKssDaMZAd62kxayzzQvD",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": "2022-08-07T14:01:29.196Z",
"remote_data": null
} | | `warnings` | [models.DeleteHrisAbsencesAbsenceIdPositiveResponseWarning](../models/deletehrisabsencesabsenceidpositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/deleteintegrationsintegrationidpositiveresponse.md b/docs/models/deleteintegrationsintegrationidpositiveresponse.md index 0bf8721..cefacee 100644 --- a/docs/models/deleteintegrationsintegrationidpositiveresponse.md +++ b/docs/models/deleteintegrationsintegrationidpositiveresponse.md @@ -15,5 +15,5 @@ let value: DeleteIntegrationsIntegrationIdPositiveResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `status` | *string* | :heavy_check_mark: | N/A | +| `status` | *"success"* | :heavy_check_mark: | N/A | | `data` | [models.DeleteIntegrationsIntegrationIdPositiveResponseData](../models/deleteintegrationsintegrationidpositiveresponsedata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formatboolean.md b/docs/models/formatboolean.md index e31cb28..92681c3 100644 --- a/docs/models/formatboolean.md +++ b/docs/models/formatboolean.md @@ -14,4 +14,4 @@ let value: FormatBoolean = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"BOOLEAN"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formatdate.md b/docs/models/formatdate.md index 9eb82ee..05f4ff4 100644 --- a/docs/models/formatdate.md +++ b/docs/models/formatdate.md @@ -14,4 +14,4 @@ let value: FormatDate = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"DATE"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formatfile.md b/docs/models/formatfile.md index ab70186..1984a2e 100644 --- a/docs/models/formatfile.md +++ b/docs/models/formatfile.md @@ -16,4 +16,4 @@ let value: FormatFile = { | --------------------- | --------------------- | --------------------- | --------------------- | | `accepted_mime_types` | *string*[] | :heavy_minus_sign: | N/A | | `max_file_size_bytes` | *number* | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"FILE"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formatinformation.md b/docs/models/formatinformation.md index 2a0d5a3..bf3cd95 100644 --- a/docs/models/formatinformation.md +++ b/docs/models/formatinformation.md @@ -14,4 +14,4 @@ let value: FormatInformation = { | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `type` | *string* | :heavy_check_mark: | This is just a text block. | \ No newline at end of file +| `type` | *"INFORMATION"* | :heavy_check_mark: | This is just a text block. | \ No newline at end of file diff --git a/docs/models/formatmultiselect.md b/docs/models/formatmultiselect.md index 36d7aae..b285f81 100644 --- a/docs/models/formatmultiselect.md +++ b/docs/models/formatmultiselect.md @@ -16,4 +16,4 @@ let value: FormatMultiSelect = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | | `options` | [models.Option2](../models/option2.md)[] | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"MULTI_SELECT"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formatnumber.md b/docs/models/formatnumber.md index ecfb824..f3740d3 100644 --- a/docs/models/formatnumber.md +++ b/docs/models/formatnumber.md @@ -17,4 +17,4 @@ let value: FormatNumber = { | `display_type` | [models.DisplayType2](../models/displaytype2.md) | :heavy_minus_sign: | N/A | | `max` | *number* | :heavy_minus_sign: | N/A | | `min` | *number* | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"NUMBER"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formatsingleselect.md b/docs/models/formatsingleselect.md index a91dc89..b655dc7 100644 --- a/docs/models/formatsingleselect.md +++ b/docs/models/formatsingleselect.md @@ -17,4 +17,4 @@ let value: FormatSingleSelect = { | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | | `display_type` | [models.DisplayType3](../models/displaytype3.md) | :heavy_minus_sign: | N/A | | `options` | [models.Option1](../models/option1.md)[] | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"SINGLE_SELECT"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formattext.md b/docs/models/formattext.md index 3ceed5b..b54ba36 100644 --- a/docs/models/formattext.md +++ b/docs/models/formattext.md @@ -16,4 +16,4 @@ let value: FormatText = { | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | `display_type` | [models.DisplayType1](../models/displaytype1.md) | :heavy_minus_sign: | If unavailable, we recommend displaying a single-line input. | | `max_length` | *number* | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"TEXT"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formatunknown.md b/docs/models/formatunknown.md index 92c6927..1c6b57d 100644 --- a/docs/models/formatunknown.md +++ b/docs/models/formatunknown.md @@ -15,4 +15,4 @@ let value: FormatUnknown = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw_question` | *any* | :heavy_minus_sign: | We pass the original question data along so you can handle it. | -| `type` | *string* | :heavy_check_mark: | When we're not able to map a specific question type yet, we will return this type. Every `UNKNOWN` question will also be parsed and unified by us at some point. | \ No newline at end of file +| `type` | *"UNKNOWN"* | :heavy_check_mark: | When we're not able to map a specific question type yet, we will return this type. Every `UNKNOWN` question will also be parsed and unified by us at some point. | \ No newline at end of file diff --git a/docs/models/getassessmentordersopenpositiveresponse.md b/docs/models/getassessmentordersopenpositiveresponse.md index 8f9b984..34ab1e7 100644 --- a/docs/models/getassessmentordersopenpositiveresponse.md +++ b/docs/models/getassessmentordersopenpositiveresponse.md @@ -14,11 +14,11 @@ let value: GetAssessmentOrdersOpenPositiveResponse = { id: "B5KQKhAgTv6ZwzrfAbqbhipd", package_id: "typescript_test", candidate: { + remote_id: "12345", email: "john.doe@gmail.com", first_name: "John", last_name: "Doe", phone: "+1 123 456 7890", - remote_id: "12345", }, application: { remote_id: "54321", @@ -57,5 +57,5 @@ let value: GetAssessmentOrdersOpenPositiveResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | +| `status` | *"success"* | :heavy_check_mark: | N/A | | `data` | [models.GetAssessmentOrdersOpenPositiveResponseData](../models/getassessmentordersopenpositiveresponsedata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/getassessmentordersopenpositiveresponsecandidate.md b/docs/models/getassessmentordersopenpositiveresponsecandidate.md index 622d52b..c3df8fa 100644 --- a/docs/models/getassessmentordersopenpositiveresponsecandidate.md +++ b/docs/models/getassessmentordersopenpositiveresponsecandidate.md @@ -8,11 +8,11 @@ Information about the candidate taking the assessment. import { GetAssessmentOrdersOpenPositiveResponseCandidate } from "@kombo-api/sdk/models"; let value: GetAssessmentOrdersOpenPositiveResponseCandidate = { + remote_id: "12345", email: "john.doe@gmail.com", first_name: "John", last_name: "Doe", phone: "+1 123 456 7890", - remote_id: "12345", }; ``` @@ -20,8 +20,8 @@ let value: GetAssessmentOrdersOpenPositiveResponseCandidate = { | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `remote_id` | *string* | :heavy_minus_sign: | The candidate's identifier in the integrated system. | 12345 | | `email` | *string* | :heavy_check_mark: | The candidate's email address. | john.doe@gmail.com | | `first_name` | *string* | :heavy_minus_sign: | The candidate's first name. | John | | `last_name` | *string* | :heavy_minus_sign: | The candidate's last name. | Doe | -| `phone` | *string* | :heavy_minus_sign: | The candidate's phone number. | +1 123 456 7890 | -| `remote_id` | *string* | :heavy_minus_sign: | The candidate's identifier in the integrated system. | 12345 | \ No newline at end of file +| `phone` | *string* | :heavy_minus_sign: | The candidate's phone number. | +1 123 456 7890 | \ No newline at end of file diff --git a/docs/models/getassessmentordersopenpositiveresponsedata.md b/docs/models/getassessmentordersopenpositiveresponsedata.md index a7601da..555eb56 100644 --- a/docs/models/getassessmentordersopenpositiveresponsedata.md +++ b/docs/models/getassessmentordersopenpositiveresponsedata.md @@ -12,11 +12,11 @@ let value: GetAssessmentOrdersOpenPositiveResponseData = { id: "B5KQKhAgTv6ZwzrfAbqbhipd", package_id: "typescript_test", candidate: { + remote_id: "12345", email: "john.doe@gmail.com", first_name: "John", last_name: "Doe", phone: "+1 123 456 7890", - remote_id: "12345", }, application: { remote_id: "54321", diff --git a/docs/models/getassessmentordersopenpositiveresponseresult.md b/docs/models/getassessmentordersopenpositiveresponseresult.md index b4efa63..7f49a21 100644 --- a/docs/models/getassessmentordersopenpositiveresponseresult.md +++ b/docs/models/getassessmentordersopenpositiveresponseresult.md @@ -9,11 +9,11 @@ let value: GetAssessmentOrdersOpenPositiveResponseResult = { id: "B5KQKhAgTv6ZwzrfAbqbhipd", package_id: "typescript_test", candidate: { + remote_id: "12345", email: "john.doe@gmail.com", first_name: "John", last_name: "Doe", phone: "+1 123 456 7890", - remote_id: "12345", }, application: { remote_id: "54321", diff --git a/docs/models/getassessmentpackagespositiveresponse.md b/docs/models/getassessmentpackagespositiveresponse.md index f164731..5207ab7 100644 --- a/docs/models/getassessmentpackagespositiveresponse.md +++ b/docs/models/getassessmentpackagespositiveresponse.md @@ -25,5 +25,5 @@ let value: GetAssessmentPackagesPositiveResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAssessmentPackagesPositiveResponseData](../models/getassessmentpackagespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"packages": [
{
"id": "1001",
"name": "TypeScript",
"description": "TypeScript coding skills assessments",
"updated_at": "2023-06-29T18:47:40.89Z",
"type": "SKILLS_TEST"
}
]
} | \ No newline at end of file diff --git a/docs/models/getatsapplicationsapplicationidattachmentspositiveresponse.md b/docs/models/getatsapplicationsapplicationidattachmentspositiveresponse.md index c73c92b..11514e4 100644 --- a/docs/models/getatsapplicationsapplicationidattachmentspositiveresponse.md +++ b/docs/models/getatsapplicationsapplicationidattachmentspositiveresponse.md @@ -33,6 +33,6 @@ let value: GetAtsApplicationsApplicationIdAttachmentsPositiveResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsApplicationsApplicationIdAttachmentsPositiveResponseData](../models/getatsapplicationsapplicationidattachmentspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"results": [
{
"type": "CV",
"id": "EYJjhMQT3LtVKXnTbnRT8s6U",
"remote_id": "GUzE666zfyjeoCJX6A8n7wh6",
"data_url": "https://resources.kombo.dev/7yZfKGzWigXxxRTygqAfHvyE",
"file_name": "Frank Doe CV.pdf",
"content_type": "application/x-pdf",
"remote_created_at": null,
"remote_updated_at": null
}
]
} | | `warnings` | [models.GetAtsApplicationsApplicationIdAttachmentsPositiveResponseWarning](../models/getatsapplicationsapplicationidattachmentspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/getatsapplicationspositiveresponse.md b/docs/models/getatsapplicationspositiveresponse.md index 15691da..eecc82a 100644 --- a/docs/models/getatsapplicationspositiveresponse.md +++ b/docs/models/getatsapplicationspositiveresponse.md @@ -119,5 +119,5 @@ let value: GetAtsApplicationsPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsApplicationsPositiveResponseData](../models/getatsapplicationspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "H77fDF8uvEzGNPRubiz5DvQ7",
"remote_id": "32",
"outcome": "HIRED",
"rejection_reason_name": null,
"rejected_at": null,
"current_stage_id": "5J7L4b48wBfffYwek9Az9pkM",
"job_id": "H5daSm8e85Dmvmne3wLeCPhX",
"candidate_id": "26vafvWSRmbhNcxJYqjCzuJg",
"screening_question_answers": [
{
"answer": {
"choice": "TypeScript"
},
"question": {
"remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
"title": "Which is your primary programming language",
"type": "SINGLE_SELECT"
}
}
],
"custom_fields": {},
"integration_fields": [],
"remote_url": "https://app.greenhouse.io/applications/32",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"remote_data": null,
"candidate": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
],
"phone_numbers": [
{
"phone_number": "+1-541-754-3010",
"type": "HOME"
}
],
"social_media": [
{
"link": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"type": "YOUTUBE",
"username": null
}
],
"source": "Employee Referral",
"remote_url": "https://app.greenhouse.io/people/32",
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "High Potential"
}
]
},
"current_stage": {
"id": "5J7L4b48wBfffYwek9Az9pkM",
"remote_id": "32",
"name": "Initial Screening",
"index": 2
},
"job": {
"id": "H5daSm8e85Dmvmne3wLeCPhX",
"remote_id": "32",
"name": "Backend Engineer"
},
"interviews": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"title": "Interview with John Doe",
"starting_at": "2023-06-26T14:30:00Z",
"ending_at": "2023-06-26T15:30:00Z",
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
},
"canceled": false
}
],
"offers": [
{
"id": "76bab8LKuFtqpZ89mofCPMHX",
"remote_id": "6",
"status": "ACCEPTED"
}
]
}
]
} | \ No newline at end of file diff --git a/docs/models/getatsapplicationspositiveresponsequestionboolean.md b/docs/models/getatsapplicationspositiveresponsequestionboolean.md index 2303456..b10c5b5 100644 --- a/docs/models/getatsapplicationspositiveresponsequestionboolean.md +++ b/docs/models/getatsapplicationspositiveresponsequestionboolean.md @@ -18,4 +18,4 @@ let value: GetAtsApplicationsPositiveResponseQuestionBoolean = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"BOOLEAN"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/getatsapplicationspositiveresponsequestiondate.md b/docs/models/getatsapplicationspositiveresponsequestiondate.md index d18a242..a360273 100644 --- a/docs/models/getatsapplicationspositiveresponsequestiondate.md +++ b/docs/models/getatsapplicationspositiveresponsequestiondate.md @@ -18,4 +18,4 @@ let value: GetAtsApplicationsPositiveResponseQuestionDate = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"DATE"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/getatsapplicationspositiveresponsequestionmultiselect.md b/docs/models/getatsapplicationspositiveresponsequestionmultiselect.md index b6447dd..ef73b44 100644 --- a/docs/models/getatsapplicationspositiveresponsequestionmultiselect.md +++ b/docs/models/getatsapplicationspositiveresponsequestionmultiselect.md @@ -18,4 +18,4 @@ let value: GetAtsApplicationsPositiveResponseQuestionMultiSelect = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"MULTI_SELECT"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/getatsapplicationspositiveresponsequestionnumber.md b/docs/models/getatsapplicationspositiveresponsequestionnumber.md index 852e685..03e916d 100644 --- a/docs/models/getatsapplicationspositiveresponsequestionnumber.md +++ b/docs/models/getatsapplicationspositiveresponsequestionnumber.md @@ -18,4 +18,4 @@ let value: GetAtsApplicationsPositiveResponseQuestionNumber = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"NUMBER"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/getatsapplicationspositiveresponsequestionsingleselect.md b/docs/models/getatsapplicationspositiveresponsequestionsingleselect.md index 4f922e7..8ae1052 100644 --- a/docs/models/getatsapplicationspositiveresponsequestionsingleselect.md +++ b/docs/models/getatsapplicationspositiveresponsequestionsingleselect.md @@ -18,4 +18,4 @@ let value: GetAtsApplicationsPositiveResponseQuestionSingleSelect = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"SINGLE_SELECT"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/getatsapplicationspositiveresponsequestiontext.md b/docs/models/getatsapplicationspositiveresponsequestiontext.md index 2ddbdec..d27b704 100644 --- a/docs/models/getatsapplicationspositiveresponsequestiontext.md +++ b/docs/models/getatsapplicationspositiveresponsequestiontext.md @@ -18,4 +18,4 @@ let value: GetAtsApplicationsPositiveResponseQuestionText = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"TEXT"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/getatsapplicationspositiveresponsequestionunknown.md b/docs/models/getatsapplicationspositiveresponsequestionunknown.md index b5e991e..b5abbf4 100644 --- a/docs/models/getatsapplicationspositiveresponsequestionunknown.md +++ b/docs/models/getatsapplicationspositiveresponsequestionunknown.md @@ -18,4 +18,4 @@ let value: GetAtsApplicationsPositiveResponseQuestionUnknown = { | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | When we're not able to map a specific question type yet, we will return this type. Every `UNKNOWN` question will also be parsed and unified by us at some point. | \ No newline at end of file +| `type` | *"UNKNOWN"* | :heavy_check_mark: | When we're not able to map a specific question type yet, we will return this type. Every `UNKNOWN` question will also be parsed and unified by us at some point. | \ No newline at end of file diff --git a/docs/models/getatsapplicationstagespositiveresponse.md b/docs/models/getatsapplicationstagespositiveresponse.md index 7ce0a46..c3f7a02 100644 --- a/docs/models/getatsapplicationstagespositiveresponse.md +++ b/docs/models/getatsapplicationstagespositiveresponse.md @@ -27,5 +27,5 @@ let value: GetAtsApplicationStagesPositiveResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsApplicationStagesPositiveResponseData](../models/getatsapplicationstagespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "5J7L4b48wBfffYwek9Az9pkM",
"remote_id": "32",
"name": "Initial Screening",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null
}
]
} | \ No newline at end of file diff --git a/docs/models/getatscandidatescandidateidattachmentspositiveresponse.md b/docs/models/getatscandidatescandidateidattachmentspositiveresponse.md index 40966c4..b9451dd 100644 --- a/docs/models/getatscandidatescandidateidattachmentspositiveresponse.md +++ b/docs/models/getatscandidatescandidateidattachmentspositiveresponse.md @@ -31,6 +31,6 @@ let value: GetAtsCandidatesCandidateIdAttachmentsPositiveResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsCandidatesCandidateIdAttachmentsPositiveResponseData](../models/getatscandidatescandidateidattachmentspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"results": [
{
"id": "EYJjhMQT3LtVKXnTbnRT8s6U",
"application_id": null,
"candidate_id": "BTbkvY2w5ou3z3hdwuKcKzDh",
"type": "CV",
"remote_id": "GUzE666zfyjeoCJX6A8n7wh6",
"data_url": "https://resources.kombo.dev/EYJjhMQT3LtVKXnTbnRT8s6U",
"file_name": "Frank Doe CV.pdf",
"content_type": "application/pdf",
"remote_created_at": null,
"remote_updated_at": null
}
]
} | | `warnings` | [models.GetAtsCandidatesCandidateIdAttachmentsPositiveResponseWarning](../models/getatscandidatescandidateidattachmentspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/getatscandidatespositiveresponse.md b/docs/models/getatscandidatespositiveresponse.md index 6b0d8ae..d7b90a4 100644 --- a/docs/models/getatscandidatespositiveresponse.md +++ b/docs/models/getatscandidatespositiveresponse.md @@ -95,5 +95,5 @@ let value: GetAtsCandidatesPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsCandidatesPositiveResponseData](../models/getatscandidatespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"company": "Acme, Inc.",
"title": "Head of Marketing",
"confidential": false,
"source": "Employee Referral",
"phone_numbers": [
{
"phone_number": "+1-541-754-3010",
"type": "HOME"
}
],
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
],
"social_media": [
{
"link": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"type": "YOUTUBE",
"username": null
}
],
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
},
"custom_fields": {},
"integration_fields": [],
"remote_url": "https://app.greenhouse.io/people/32",
"remote_created_at": "2022-04-02T00:00:00Z",
"remote_updated_at": "2022-04-04T00:00:00Z",
"remote_data": null,
"changed_at": "2022-04-04T00:00:00Z",
"remote_deleted_at": null,
"applications": [
{
"id": "H77fDF8uvEzGNPRubiz5DvQ7",
"remote_id": "32",
"outcome": "HIRED",
"rejection_reason_name": null,
"rejected_at": null,
"remote_url": "https://app.greenhouse.io/applications/32",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"current_stage": {
"id": "5J7L4b48wBfffYwek9Az9pkM",
"name": "Initial Screening",
"remote_id": "32",
"index": 2
},
"job": {
"id": "H5daSm8e85Dmvmne3wLeCPhX",
"name": "Backend Engineer",
"remote_id": "32"
}
}
],
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "High Potential",
"remote_id": "32"
}
]
}
]
} | \ No newline at end of file diff --git a/docs/models/getatsinterviewspositiveresponse.md b/docs/models/getatsinterviewspositiveresponse.md index 5ccb14c..633605c 100644 --- a/docs/models/getatsinterviewspositiveresponse.md +++ b/docs/models/getatsinterviewspositiveresponse.md @@ -75,5 +75,5 @@ let value: GetAtsInterviewsPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsInterviewsPositiveResponseData](../models/getatsinterviewspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"title": "Interview with John Doe",
"starting_at": "2023-06-26T14:30:00Z",
"ending_at": "2023-06-26T15:30:00Z",
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
},
"application_id": "H77fDF8uvEzGNPRubiz5DvQ7",
"stage_id": "H5daSm8e85Dmvmne3wLeCPhX",
"canceled": false,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"users": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@kombo.dev"
}
],
"application": {
"id": "H77fDF8uvEzGNPRubiz5DvQ7",
"remote_id": "32",
"outcome": "HIRED",
"rejection_reason_name": null,
"candidate": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
]
},
"job": {
"id": "H5daSm8e85Dmvmne3wLeCPhX",
"remote_id": "32",
"name": "Backend Engineer"
}
}
}
]
} | \ No newline at end of file diff --git a/docs/models/getatsjobspositiveresponse.md b/docs/models/getatsjobspositiveresponse.md index 9b2d430..c1b999f 100644 --- a/docs/models/getatsjobspositiveresponse.md +++ b/docs/models/getatsjobspositiveresponse.md @@ -113,5 +113,5 @@ let value: GetAtsJobsPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsJobsPositiveResponseData](../models/getatsjobspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "H5daSm8e85Dmvmne3wLeCPhX",
"remote_id": "32",
"name": "Backend Engineer",
"job_code": "BE-2021-01",
"description": "\u003cp\u003eKombo is hiring engineers! If you are reading this and you are located in Berlin, Germany, feel free to contact us about this position.\u003c/p\u003e",
"confidential": false,
"weekly_hours": 37,
"employment_type": "FULL_TIME",
"status": "OPEN",
"visibility": "PUBLIC",
"category": "Technical Job",
"department": "Engineering",
"post_url": "https://jobs.example.com/post/159829112",
"experience_level": "Mid-Senior",
"remote_work_status": "HYBRID",
"salary_amount": 4200,
"salary_amount_from": null,
"salary_amount_to": null,
"salary_currency": "EUR",
"salary_period": "MONTH",
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
},
"custom_fields": {},
"integration_fields": [],
"remote_url": "https://app.greenhouse.io/jobs/32",
"opened_at": "2022-08-07T14:01:29.196Z",
"closed_at": null,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"contact_id": "6gT2yLMBEipd3zpezATv3Rhu",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"stages": [
{
"id": "5J7L4b48wBfffYwek9Az9pkM",
"remote_id": "32",
"name": "Initial Screening",
"remote_data": null,
"index": 0
}
],
"screening_questions": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
"title": "Which is your primary programming language?",
"description": "Please enter the language you are most comfortable with.",
"format": {
"display_type": "SINGLE_LINE",
"max_length": null,
"type": "TEXT"
},
"category": null,
"index": 0,
"required": true,
"precondition_question_id": "4ZVteCSSgDw3BdwGzcQqGEPk",
"precondition_options": [
"7qd5qjPwDHarsMLFMGzXYG1K"
]
}
],
"job_postings": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
"title": "Frontend Engineer",
"description_html": "\u003cp\u003eWe are looking for a Frontend Engineer.\u003c/p\u003e",
"status": "ACTIVE",
"visibility": "PUBLIC",
"url": "https://jobs.example.com/post/159829112",
"remote_data": null
}
],
"hiring_team": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@kombo.dev",
"hiring_team_roles": [
"RECRUITER"
]
}
]
}
]
} | \ No newline at end of file diff --git a/docs/models/getatsofferspositiveresponse.md b/docs/models/getatsofferspositiveresponse.md index df2d12e..bb0d7bf 100644 --- a/docs/models/getatsofferspositiveresponse.md +++ b/docs/models/getatsofferspositiveresponse.md @@ -51,5 +51,5 @@ let value: GetAtsOffersPositiveResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsOffersPositiveResponseData](../models/getatsofferspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "76bab8LKuFtqpZ89mofCPMHX",
"remote_id": "6",
"status": "ACCEPTED",
"employment_start_date": "2022-08-07T14:01:29.196Z",
"application_id": "BAkbueBMBusj9Bg7L1Wps3AR",
"custom_fields": {},
"integration_fields": [],
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"remote_data": null,
"application": {
"candidate": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
]
},
"job": {
"id": "H5daSm8e85Dmvmne3wLeCPhX",
"remote_id": "32",
"name": "Backend Engineer"
}
}
}
]
} | \ No newline at end of file diff --git a/docs/models/getatsrejectionreasonspositiveresponse.md b/docs/models/getatsrejectionreasonspositiveresponse.md index 15e17db..72bae44 100644 --- a/docs/models/getatsrejectionreasonspositiveresponse.md +++ b/docs/models/getatsrejectionreasonspositiveresponse.md @@ -27,5 +27,5 @@ let value: GetAtsRejectionReasonsPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsRejectionReasonsPositiveResponseData](../models/getatsrejectionreasonspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "76bab8LKuFtqpZ89mofCPMHX",
"remote_id": "6",
"name": "Not a fit",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": null
}
]
} | \ No newline at end of file diff --git a/docs/models/getatstagspositiveresponse.md b/docs/models/getatstagspositiveresponse.md index 648c7d4..63ac880 100644 --- a/docs/models/getatstagspositiveresponse.md +++ b/docs/models/getatstagspositiveresponse.md @@ -27,5 +27,5 @@ let value: GetAtsTagsPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsTagsPositiveResponseData](../models/getatstagspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "High Potential",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null
}
]
} | \ No newline at end of file diff --git a/docs/models/getatsuserspositiveresponse.md b/docs/models/getatsuserspositiveresponse.md index 05b4949..56f5b51 100644 --- a/docs/models/getatsuserspositiveresponse.md +++ b/docs/models/getatsuserspositiveresponse.md @@ -30,5 +30,5 @@ let value: GetAtsUsersPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetAtsUsersPositiveResponseData](../models/getatsuserspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@kombo.dev",
"status": "ACTIVE",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null
}
]
} | \ No newline at end of file diff --git a/docs/models/getcheckapikeypositiveresponse.md b/docs/models/getcheckapikeypositiveresponse.md index 2558a11..18e1b22 100644 --- a/docs/models/getcheckapikeypositiveresponse.md +++ b/docs/models/getcheckapikeypositiveresponse.md @@ -17,5 +17,5 @@ let value: GetCheckApiKeyPositiveResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetCheckApiKeyPositiveResponseData](../models/getcheckapikeypositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"environment_id": "2Uev1YUTqLFdvMPD3Jtrg2FX",
"customer_id": "2Uev1YUTqLFdvMPD3Jtrg2FX"
} | \ No newline at end of file diff --git a/docs/models/getconnectintegrationbytokentokenpositiveresponse.md b/docs/models/getconnectintegrationbytokentokenpositiveresponse.md index a20bd3d..609f4d1 100644 --- a/docs/models/getconnectintegrationbytokentokenpositiveresponse.md +++ b/docs/models/getconnectintegrationbytokentokenpositiveresponse.md @@ -22,5 +22,5 @@ let value: GetConnectIntegrationByTokenTokenPositiveResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetConnectIntegrationByTokenTokenPositiveResponseData](../models/getconnectintegrationbytokentokenpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"tool": "personio",
"id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
"end_user_origin_id": "36123",
"end_user_organization_name": "Acme, Inc.",
"end_user_email": "user@example.com",
"setup_status": "COMPLETED"
} | \ No newline at end of file diff --git a/docs/models/gethrisabsencespositiveresponse.md b/docs/models/gethrisabsencespositiveresponse.md index 1572558..6115a1a 100644 --- a/docs/models/gethrisabsencespositiveresponse.md +++ b/docs/models/gethrisabsencespositiveresponse.md @@ -48,5 +48,5 @@ let value: GetHrisAbsencesPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisAbsencesPositiveResponseData](../models/gethrisabsencespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "22st2Ji8XpncEYEak8mvQgQF",
"remote_id": "1348",
"employee_id": "JDdUy9kiH5APaGizFrgNmQjM",
"approver_id": "AgXEispYPP1BbToHpqnqcpxy",
"start_date": "2022-08-04T00:00:00Z",
"end_date": "2022-08-05T00:00:00Z",
"start_half_day": true,
"end_half_day": false,
"start_time": "13:15:00",
"end_time": "17:00:00",
"amount": 2,
"unit": "DAYS",
"status": "APPROVED",
"employee_note": "Visiting my family.",
"type_id": "xzZoKssDaMZAd62kxayzzQvD",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": "2022-08-07T14:01:29.196Z",
"remote_data": null,
"type": {
"id": "xzZoKssDaMZAd62kxayzzQvD",
"remote_id": "91",
"name": "Vacation",
"unit": "DAYS",
"half_days_supported": true,
"exact_times_supported": false,
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null
}
}
]
} | \ No newline at end of file diff --git a/docs/models/gethrisabsencetypespositiveresponse.md b/docs/models/gethrisabsencetypespositiveresponse.md index d5d0682..9a3c19b 100644 --- a/docs/models/gethrisabsencetypespositiveresponse.md +++ b/docs/models/gethrisabsencetypespositiveresponse.md @@ -30,5 +30,5 @@ let value: GetHrisAbsenceTypesPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisAbsenceTypesPositiveResponseData](../models/gethrisabsencetypespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "xzZoKssDaMZAd62kxayzzQvD",
"remote_id": "91",
"name": "Vacation",
"unit": "DAYS",
"half_days_supported": true,
"exact_times_supported": false,
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null
}
]
} | \ No newline at end of file diff --git a/docs/models/gethrisemployeedocumentcategoriespositiveresponse.md b/docs/models/gethrisemployeedocumentcategoriespositiveresponse.md index 1303c7e..6439220 100644 --- a/docs/models/gethrisemployeedocumentcategoriespositiveresponse.md +++ b/docs/models/gethrisemployeedocumentcategoriespositiveresponse.md @@ -27,5 +27,5 @@ let value: GetHrisEmployeeDocumentCategoriesPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisEmployeeDocumentCategoriesPositiveResponseData](../models/gethrisemployeedocumentcategoriespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Employment contract",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null
}
]
} | \ No newline at end of file diff --git a/docs/models/gethrisemployeesformpositiveresponse.md b/docs/models/gethrisemployeesformpositiveresponse.md index 74cced1..effb46c 100644 --- a/docs/models/gethrisemployeesformpositiveresponse.md +++ b/docs/models/gethrisemployeesformpositiveresponse.md @@ -92,6 +92,6 @@ let value: GetHrisEmployeesFormPositiveResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisEmployeesFormPositiveResponseData](../models/gethrisemployeesformpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"properties": {
"firstName": {
"label": "First Name",
"required": true,
"description": "Employee's first name",
"unified_key": "first_name",
"type": "text",
"min_length": 1,
"max_length": 100,
"reg_exp": null
},
"startDate": {
"label": "Start Date",
"required": true,
"description": "Employee's start date",
"unified_key": "start_date",
"type": "date"
},
"workLocation": {
"label": "Work Location",
"required": false,
"description": "Employee's work location",
"unified_key": null,
"type": "object",
"properties": {
"site": {
"label": "Site",
"required": true,
"description": "Employee's site",
"unified_key": null,
"type": "single_select",
"options": {
"type": "inline",
"entries": [
{
"id": "FXrER44xubBqA9DLgZ3PFNNx",
"label": "Site 1",
"unified_value": "1",
"remote_id": "site_1"
},
{
"id": "2rv75UKT2XBoQXsUb9agiTUm",
"label": "Site 2",
"unified_value": "2",
"remote_id": "site_2"
}
]
}
},
"keyNumbers": {
"label": "Key Numbers",
"required": false,
"description": "Employee's key numbers",
"unified_key": null,
"type": "array",
"item_type": {
"label": "Key Number",
"required": false,
"description": "The number of the keys which belong to the employee",
"unified_key": null,
"type": "number",
"min": 0,
"max": 99
},
"min_items": 2,
"max_items": 5
}
}
}
}
} | | `warnings` | [models.GetHrisEmployeesFormPositiveResponseWarning](../models/gethrisemployeesformpositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/gethrisemployeesformpositiveresponseoptionsinline1.md b/docs/models/gethrisemployeesformpositiveresponseoptionsinline1.md index d843299..09e0093 100644 --- a/docs/models/gethrisemployeesformpositiveresponseoptionsinline1.md +++ b/docs/models/gethrisemployeesformpositiveresponseoptionsinline1.md @@ -21,5 +21,5 @@ let value: GetHrisEmployeesFormPositiveResponseOptionsInline1 = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"inline"* | :heavy_check_mark: | N/A | | `entries` | [models.GetHrisEmployeesFormPositiveResponseEntry1](../models/gethrisemployeesformpositiveresponseentry1.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/gethrisemployeesformpositiveresponseoptionsinline2.md b/docs/models/gethrisemployeesformpositiveresponseoptionsinline2.md index 217d73e..9d6e4bc 100644 --- a/docs/models/gethrisemployeesformpositiveresponseoptionsinline2.md +++ b/docs/models/gethrisemployeesformpositiveresponseoptionsinline2.md @@ -21,5 +21,5 @@ let value: GetHrisEmployeesFormPositiveResponseOptionsInline2 = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"inline"* | :heavy_check_mark: | N/A | | `entries` | [models.GetHrisEmployeesFormPositiveResponseEntry2](../models/gethrisemployeesformpositiveresponseentry2.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/gethrisemployeesformpositiveresponseoptionsreferenced1.md b/docs/models/gethrisemployeesformpositiveresponseoptionsreferenced1.md index dac6d88..4832f77 100644 --- a/docs/models/gethrisemployeesformpositiveresponseoptionsreferenced1.md +++ b/docs/models/gethrisemployeesformpositiveresponseoptionsreferenced1.md @@ -15,5 +15,5 @@ let value: GetHrisEmployeesFormPositiveResponseOptionsReferenced1 = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"referenced"* | :heavy_check_mark: | N/A | | `link` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/gethrisemployeesformpositiveresponseoptionsreferenced2.md b/docs/models/gethrisemployeesformpositiveresponseoptionsreferenced2.md index 0d7eb28..dcb7a21 100644 --- a/docs/models/gethrisemployeesformpositiveresponseoptionsreferenced2.md +++ b/docs/models/gethrisemployeesformpositiveresponseoptionsreferenced2.md @@ -15,5 +15,5 @@ let value: GetHrisEmployeesFormPositiveResponseOptionsReferenced2 = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"referenced"* | :heavy_check_mark: | N/A | | `link` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/gethrisemployeespositiveresponse.md b/docs/models/gethrisemployeespositiveresponse.md index 373c2a6..e8aaeca 100644 --- a/docs/models/gethrisemployeespositiveresponse.md +++ b/docs/models/gethrisemployeespositiveresponse.md @@ -162,5 +162,5 @@ let value: GetHrisEmployeesPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisEmployeesPositiveResponseData](../models/gethrisemployeespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"employee_number": "3243422",
"first_name": "John",
"last_name": "Doe",
"nationality": "French",
"display_full_name": "John Doe",
"job_title": "Integrations Team Lead",
"work_email": "john.doe@acme.com",
"personal_email": "john@doe.me",
"mobile_phone_number": "801-555-4687",
"ssn": "555-32-6395",
"tax_id": "12 345 678 901",
"gender": "MALE",
"ethnicity": "BLACK_AFRICAN_AMERICAN",
"marital_status": "MARRIED",
"employment_status": "INACTIVE",
"employment_type": "FULL_TIME",
"weekly_hours": 40,
"avatar": "https://resources.bamboohr.com/images/photo_person_150x150.png",
"work_location_id": "7E2gyuv6TmvtByzBxW9Sxt53",
"legal_entity_id": "xB32bied320csBSsl3XWdlw33",
"manager_id": "9pf2pxBB8VX8EQMC9aipW2Bo",
"home_address": {
"city": "Berlin",
"country": "DE",
"raw": "Sonnenallee 63\n12045 Berlin\nGermany",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"street_2": null,
"zip_code": "12045"
},
"bank_accounts": [
{
"account_number": "1234567890",
"bank_name": "Commerzbank",
"bic": "COBADEFFXXX",
"domestic_bank_routing": {
"number": "34567890",
"type": "DE_BANKLEITZAHL"
},
"holder_name": "John Doe",
"iban": "DE12345678901234567890"
}
],
"date_of_birth": "1986-01-01T00:00:00Z",
"start_date": "2020-04-07T00:00:00Z",
"termination_date": "2022-05-20T00:00:00Z",
"remote_created_at": "2020-04-07T12:32:01Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"custom_fields": {},
"integration_fields": [],
"remote_data": null,
"employments": [
{
"id": "12vpXR7BeqYNWDShXRgsonnm",
"remote_id": "859",
"employee_id": "26vafvWSRmbhNcxJYqjCzuJg",
"job_title": "Social Media Marketer",
"pay_rate": 85000,
"pay_period": "YEAR",
"pay_frequency": "SEMIMONTHLY",
"employment_type": "FULL_TIME",
"pay_currency": "EUR",
"effective_date": "2021-01-30T00:00:00Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": null,
"custom_fields": {},
"integration_fields": []
}
],
"time_off_balances": [
{
"id": "FuyRuk5NqP3qTcThED3ymTuE",
"remote_id": "124123",
"employee_id": "2Up4ZCvq1bFVzmzXG6EWzV3j",
"type_id": "BQJaBxRCiqN46G27VTegvkEr",
"balance": 14,
"balance_unit": "DAYS",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"used": 3,
"used_unit": "DAYS",
"remote_data": null
}
],
"manager": {
"first_name": "John",
"last_name": "Doe",
"display_full_name": "John Doe",
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"employee_number": "3243422",
"work_email": "john.doe@acme.com",
"remote_id": "32",
"employment_status": "INACTIVE",
"termination_date": "2022-05-20T00:00:00Z"
},
"groups": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "49",
"name": "Customer Success",
"type": "TEAM"
}
],
"legal_entity": {
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "49",
"name": "ACME Inc.",
"address": {
"city": "Berlin",
"country": "DE",
"raw": "Sonnenallee 63\n12045 Berlin, Berlin\nGermany",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"street_2": null,
"zip_code": "12045"
}
},
"teams": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "49",
"name": "Customer Success",
"type": "TEAM"
}
],
"work_location": {
"id": "22st2Ji8XpncEYEak8mvQgQF",
"remote_id": "1348",
"name": "Kombo HQ",
"address": {
"city": "Berlin",
"country": "DE",
"raw": "Sonnenallee 63\n12045 Berlin, Berlin\nGermany",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"street_2": null,
"zip_code": "12045"
},
"type": "OFFICE",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": "2022-08-07T14:01:29.196Z",
"remote_data": null
}
}
]
} | \ No newline at end of file diff --git a/docs/models/gethrisemploymentspositiveresponse.md b/docs/models/gethrisemploymentspositiveresponse.md index 1516752..563fb59 100644 --- a/docs/models/gethrisemploymentspositiveresponse.md +++ b/docs/models/gethrisemploymentspositiveresponse.md @@ -35,5 +35,5 @@ let value: GetHrisEmploymentsPositiveResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisEmploymentsPositiveResponseData](../models/gethrisemploymentspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "12vpXR7BeqYNWDShXRgsonnm",
"remote_id": "859",
"employee_id": "26vafvWSRmbhNcxJYqjCzuJg",
"job_title": "Social Media Marketer",
"pay_rate": 85000,
"pay_period": "YEAR",
"pay_frequency": "SEMIMONTHLY",
"employment_type": "FULL_TIME",
"pay_currency": "EUR",
"effective_date": "2021-01-30T00:00:00Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": null,
"custom_fields": {},
"integration_fields": []
}
]
} | \ No newline at end of file diff --git a/docs/models/gethrisgroupspositiveresponse.md b/docs/models/gethrisgroupspositiveresponse.md index b8756bc..110ea47 100644 --- a/docs/models/gethrisgroupspositiveresponse.md +++ b/docs/models/gethrisgroupspositiveresponse.md @@ -29,5 +29,5 @@ let value: GetHrisGroupsPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisGroupsPositiveResponseData](../models/gethrisgroupspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "49",
"name": "Customer Success",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"type": "TEAM",
"parent_id": "KGaJ5XaVPob8mYVfD49W4DGB",
"remote_data": null
}
]
} | \ No newline at end of file diff --git a/docs/models/gethrislegalentitiespositiveresponse.md b/docs/models/gethrislegalentitiespositiveresponse.md index 9ee39d0..19c4a74 100644 --- a/docs/models/gethrislegalentitiespositiveresponse.md +++ b/docs/models/gethrislegalentitiespositiveresponse.md @@ -38,5 +38,5 @@ let value: GetHrisLegalEntitiesPositiveResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisLegalEntitiesPositiveResponseData](../models/gethrislegalentitiespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "49",
"name": "ACME Inc.",
"address": {
"city": "Berlin",
"country": "DE",
"raw": "Sonnenallee 63\n12045 Berlin, Berlin\nGermany",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"street_2": null,
"zip_code": "12045"
},
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": null
}
]
} | \ No newline at end of file diff --git a/docs/models/gethrislocationspositiveresponse.md b/docs/models/gethrislocationspositiveresponse.md index f1fc350..6d91d6a 100644 --- a/docs/models/gethrislocationspositiveresponse.md +++ b/docs/models/gethrislocationspositiveresponse.md @@ -39,5 +39,5 @@ let value: GetHrisLocationsPositiveResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisLocationsPositiveResponseData](../models/gethrislocationspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "22st2Ji8XpncEYEak8mvQgQF",
"remote_id": "1348",
"name": "Kombo HQ",
"address": {
"city": "Berlin",
"country": "DE",
"raw": "Sonnenallee 63\n12045 Berlin, Berlin\nGermany",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"street_2": null,
"zip_code": "12045"
},
"type": "OFFICE",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": "2022-08-07T14:01:29.196Z",
"remote_data": null
}
]
} | \ No newline at end of file diff --git a/docs/models/gethrisperformancereviewcyclespositiveresponse.md b/docs/models/gethrisperformancereviewcyclespositiveresponse.md index 330979c..1730da0 100644 --- a/docs/models/gethrisperformancereviewcyclespositiveresponse.md +++ b/docs/models/gethrisperformancereviewcyclespositiveresponse.md @@ -28,5 +28,5 @@ let value: GetHrisPerformanceReviewCyclesPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisPerformanceReviewCyclesPositiveResponseData](../models/gethrisperformancereviewcyclespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "1",
"name": "2025 Annual Performance Review Cycle",
"review_period_start_date": "2025-01-01T00:00:00Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": null
}
]
} | \ No newline at end of file diff --git a/docs/models/gethrisperformancereviewspositiveresponse.md b/docs/models/gethrisperformancereviewspositiveresponse.md index 663ef0e..9966316 100644 --- a/docs/models/gethrisperformancereviewspositiveresponse.md +++ b/docs/models/gethrisperformancereviewspositiveresponse.md @@ -65,5 +65,5 @@ let value: GetHrisPerformanceReviewsPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisPerformanceReviewsPositiveResponseData](../models/gethrisperformancereviewspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "1",
"type": "MANAGER",
"summary_comment": "Good job this year! Let's keep it up for 2024!",
"summary_rating": {
"ordered_options": [
"Needs improvement",
"Below expectations",
"Meets expectations",
"Exceeds expectations",
"Exceptional"
],
"type": "SINGLE_SELECT",
"value": "Exceeds expectations"
},
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": null,
"reviewee": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"display_full_name": "John Doe",
"work_email": "john.doe@acme.com",
"remote_deleted_at": null
},
"reviewer": {
"id": "4EeSSSd9Fr8iiW9mPKmjEVWK",
"remote_id": "1024",
"first_name": "Peter",
"last_name": "Doe",
"display_full_name": "Peter Doe",
"work_email": "peter.doe@acme.com",
"remote_deleted_at": null
},
"review_cycle": {
"id": "4B9bKBpX5tnwjiG93TAqF7ci",
"remote_id": "1",
"name": "2025 Annual Performance Review Cycle",
"review_period_start_date": "2025-01-01T00:00:00Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": null
}
}
]
} | \ No newline at end of file diff --git a/docs/models/gethristimeoffbalancespositiveresponse.md b/docs/models/gethristimeoffbalancespositiveresponse.md index 13760e1..7a827ad 100644 --- a/docs/models/gethristimeoffbalancespositiveresponse.md +++ b/docs/models/gethristimeoffbalancespositiveresponse.md @@ -42,5 +42,5 @@ let value: GetHrisTimeOffBalancesPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisTimeOffBalancesPositiveResponseData](../models/gethristimeoffbalancespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "FuyRuk5NqP3qTcThED3ymTuE",
"remote_id": "124123",
"employee_id": "2Up4ZCvq1bFVzmzXG6EWzV3j",
"type_id": "BQJaBxRCiqN46G27VTegvkEr",
"balance": 14,
"balance_unit": "DAYS",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"used": 3,
"used_unit": "DAYS",
"remote_data": null,
"type": {
"id": "xzZoKssDaMZAd62kxayzzQvD",
"remote_id": "91",
"name": "Vacation",
"unit": "DAYS",
"half_days_supported": true,
"exact_times_supported": false,
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null
}
}
]
} | \ No newline at end of file diff --git a/docs/models/gethristimesheetspositiveresponse.md b/docs/models/gethristimesheetspositiveresponse.md index cfb08de..b0c5a7e 100644 --- a/docs/models/gethristimesheetspositiveresponse.md +++ b/docs/models/gethristimesheetspositiveresponse.md @@ -43,5 +43,5 @@ let value: GetHrisTimesheetsPositiveResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetHrisTimesheetsPositiveResponseData](../models/gethristimesheetspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "C1BB1C36-FE1D-4185-AAB8-0716D8FBA017",
"remote_id": "446655440000",
"employee_id": "289AD550-8659-4305-92B2-6EAA006AAB17",
"started_at": "2025-04-16T09:02:00Z",
"ended_at": "2025-04-16T16:59:00Z",
"timezone": "-04:00",
"payable_hours": 8,
"unpaid_break_minutes": 30,
"breaks": [
{
"ended_at": "2025-04-16T12:30:00Z",
"paid": false,
"started_at": "2025-04-16T12:00:00Z"
}
],
"approval_status": "APPROVED",
"approved_at": "2025-04-16T17:05:31Z",
"comment": "Sprint planning \u0026 code review",
"custom_fields": {},
"integration_fields": [],
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": {}
}
]
} | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidcustomfieldspositiveresponse.md b/docs/models/getintegrationsintegrationidcustomfieldspositiveresponse.md index dc897de..185e45c 100644 --- a/docs/models/getintegrationsintegrationidcustomfieldspositiveresponse.md +++ b/docs/models/getintegrationsintegrationidcustomfieldspositiveresponse.md @@ -32,5 +32,5 @@ let value: GetIntegrationsIntegrationIdCustomFieldsPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetIntegrationsIntegrationIdCustomFieldsPositiveResponseData](../models/getintegrationsintegrationidcustomfieldspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"results": [
{
"id": "D9CoSqqun6ix7uKEwb2kHBU1",
"key": "unified_tax_id",
"integration_field": {
"id": "FFpTK47GhXnU6QAopPq2bdos",
"key": "tax_id",
"type": "DEFAULT",
"label": "The employee's tax ID"
},
"model": "hris_employees",
"label": null,
"description": null
}
],
"next_cursor": null,
"next": null
} | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidintegrationfieldspositiveresponse.md b/docs/models/getintegrationsintegrationidintegrationfieldspositiveresponse.md index f12c211..e03f68b 100644 --- a/docs/models/getintegrationsintegrationidintegrationfieldspositiveresponse.md +++ b/docs/models/getintegrationsintegrationidintegrationfieldspositiveresponse.md @@ -28,5 +28,5 @@ let value: GetIntegrationsIntegrationIdIntegrationFieldsPositiveResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.GetIntegrationsIntegrationIdIntegrationFieldsPositiveResponseData](../models/getintegrationsintegrationidintegrationfieldspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"results": [
{
"id": "FFpTK47GhXnU6QAopPq2bdos",
"key": "tax_id",
"model": "hris_employees",
"type": "DEFAULT",
"label": "Tax ID",
"is_passthrough_enabled": true,
"is_writable": false
}
],
"next_cursor": null,
"next": null
} | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidintegrationfieldspositiveresponseresult.md b/docs/models/getintegrationsintegrationidintegrationfieldspositiveresponseresult.md index c275fa2..de2b740 100644 --- a/docs/models/getintegrationsintegrationidintegrationfieldspositiveresponseresult.md +++ b/docs/models/getintegrationsintegrationidintegrationfieldspositiveresponseresult.md @@ -27,4 +27,4 @@ let value: GetIntegrationsIntegrationIdIntegrationFieldsPositiveResponseResult = | `type` | [models.GetIntegrationsIntegrationIdIntegrationFieldsPositiveResponseType](../models/getintegrationsintegrationidintegrationfieldspositiveresponsetype.md) | :heavy_check_mark: | The type of the integration field. There is a type to avoid collisions between DEFAULT fields and CUSTOM fields with the same key. | | `label` | *string* | :heavy_check_mark: | The label of the field in the remote system. | | `is_passthrough_enabled` | *boolean* | :heavy_check_mark: | Whether the field is included in the integrations_fields array of the corresponding model. | -| `is_writable` | *boolean* | :heavy_check_mark: | This field is related to a deprecated feature and means nothing, but is kept for backwards compatibility. | \ No newline at end of file +| `is_writable` | *false* | :heavy_check_mark: | This field is related to a deprecated feature and means nothing, but is kept for backwards compatibility. | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidpositiveresponse.md b/docs/models/getintegrationsintegrationidpositiveresponse.md index 6c917b6..5ac40d0 100644 --- a/docs/models/getintegrationsintegrationidpositiveresponse.md +++ b/docs/models/getintegrationsintegrationidpositiveresponse.md @@ -51,13 +51,30 @@ let value: GetIntegrationsIntegrationIdPositiveResponse = { ], }, ], + write_actions: [ + { + id: "hris_create_employee", + label: "Create employee", + is_available: true, + coverage_status: "SUPPORTED", + scope_config_setting: "ENABLED", + opted_out_by_customer: false, + fields: [ + { + id: "first_name", + is_available: true, + coverage_status: "SUPPORTED", + }, + ], + }, + ], }, }; ``` ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | -| `data` | [models.GetIntegrationsIntegrationIdPositiveResponseData](../models/getintegrationsintegrationidpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "factorial:8d1hpPsbjxUkoCoa1veLZGe5",
"tool": {
"id": "factorial",
"label": "Factorial",
"internal_label": null,
"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
"icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg"
},
"category": "HRIS",
"status": "ACTIVE",
"setup_status": "COMPLETED",
"end_user": {
"organization_name": "Acme",
"creator_email": "example-integration-creator@acme.com",
"origin_id": "2DQJAUtSzzzKP9buDTvUvPk3"
},
"scope_config": {
"id": "B1hu5NGyhdjSq5X3hxEz4bAN",
"name": "Anonymous Scopes"
},
"created_at": "2022-08-07T14:01:29.196Z",
"beta": false,
"read_models": [
{
"id": "hris_employees",
"label": "Employees",
"is_available": true,
"coverage_status": "SUPPORTED",
"scope_config_setting": "ENABLED",
"opted_out_by_customer": false,
"fields": [
{
"id": "date_of_birth",
"is_available": false,
"coverage_status": "SUPPORTED",
"scope_config_setting": "OPTIONAL",
"opted_out_by_customer": true
}
]
}
]
} | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `status` | *"success"* | :heavy_check_mark: | N/A | | +| `data` | [models.GetIntegrationsIntegrationIdPositiveResponseData](../models/getintegrationsintegrationidpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "factorial:8d1hpPsbjxUkoCoa1veLZGe5",
"tool": {
"id": "factorial",
"label": "Factorial",
"internal_label": null,
"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
"icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg"
},
"category": "HRIS",
"status": "ACTIVE",
"setup_status": "COMPLETED",
"end_user": {
"organization_name": "Acme",
"creator_email": "example-integration-creator@acme.com",
"origin_id": "2DQJAUtSzzzKP9buDTvUvPk3"
},
"scope_config": {
"id": "B1hu5NGyhdjSq5X3hxEz4bAN",
"name": "Anonymous Scopes"
},
"created_at": "2022-08-07T14:01:29.196Z",
"beta": false,
"read_models": [
{
"id": "hris_employees",
"label": "Employees",
"is_available": true,
"coverage_status": "SUPPORTED",
"scope_config_setting": "ENABLED",
"opted_out_by_customer": false,
"fields": [
{
"id": "date_of_birth",
"is_available": false,
"coverage_status": "SUPPORTED",
"scope_config_setting": "OPTIONAL",
"opted_out_by_customer": true
}
]
}
],
"write_actions": [
{
"id": "hris_create_employee",
"label": "Create employee",
"is_available": true,
"coverage_status": "SUPPORTED",
"scope_config_setting": "ENABLED",
"opted_out_by_customer": false,
"fields": [
{
"id": "first_name",
"is_available": true,
"coverage_status": "SUPPORTED"
}
]
}
]
} | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidpositiveresponsedata.md b/docs/models/getintegrationsintegrationidpositiveresponsedata.md index 3fb2360..3fd56b1 100644 --- a/docs/models/getintegrationsintegrationidpositiveresponsedata.md +++ b/docs/models/getintegrationsintegrationidpositiveresponsedata.md @@ -49,6 +49,23 @@ let value: GetIntegrationsIntegrationIdPositiveResponseData = { ], }, ], + write_actions: [ + { + id: "hris_create_employee", + label: "Create employee", + is_available: true, + coverage_status: "SUPPORTED", + scope_config_setting: "ENABLED", + opted_out_by_customer: false, + fields: [ + { + id: "first_name", + is_available: true, + coverage_status: "SUPPORTED", + }, + ], + }, + ], }; ``` @@ -65,4 +82,5 @@ let value: GetIntegrationsIntegrationIdPositiveResponseData = { | `scope_config` | [models.ScopeConfig](../models/scopeconfig.md) | :heavy_check_mark: | N/A | | `created_at` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | YYYY-MM-DDTHH:mm:ss.sssZ

[](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) | | `beta` | *boolean* | :heavy_check_mark: | N/A | -| `read_models` | [models.GetIntegrationsIntegrationIdPositiveResponseReadModel](../models/getintegrationsintegrationidpositiveresponsereadmodel.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `read_models` | [models.GetIntegrationsIntegrationIdPositiveResponseReadModel](../models/getintegrationsintegrationidpositiveresponsereadmodel.md)[] | :heavy_check_mark: | N/A | +| `write_actions` | [models.GetIntegrationsIntegrationIdPositiveResponseWriteAction](../models/getintegrationsintegrationidpositiveresponsewriteaction.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidpositiveresponsereadmodel.md b/docs/models/getintegrationsintegrationidpositiveresponsereadmodel.md index 156609d..85aa090 100644 --- a/docs/models/getintegrationsintegrationidpositiveresponsereadmodel.md +++ b/docs/models/getintegrationsintegrationidpositiveresponsereadmodel.md @@ -31,7 +31,7 @@ let value: GetIntegrationsIntegrationIdPositiveResponseReadModel = { | `id` | *string* | :heavy_check_mark: | ID of the model (e.g. hris_employees). | | `label` | *string* | :heavy_check_mark: | Label of the model (e.g. Employees). | | `is_available` | *boolean* | :heavy_check_mark: | Whether the datapoint is available and enabled and not opted out of. | -| `coverage_status` | [models.GetIntegrationsIntegrationIdPositiveResponseCoverageStatus](../models/getintegrationsintegrationidpositiveresponsecoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | -| `scope_config_setting` | [models.ScopeConfigSetting](../models/scopeconfigsetting.md) | :heavy_check_mark: | The setting of the datapoint in the scope config that you configured in the Kombo dashboard. | +| `coverage_status` | [models.GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus](../models/getintegrationsintegrationidpositiveresponsereadmodelcoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | +| `scope_config_setting` | [models.ReadModelScopeConfigSetting](../models/readmodelscopeconfigsetting.md) | :heavy_check_mark: | The setting of the datapoint in the scope config that you configured in the Kombo dashboard. | | `opted_out_by_customer` | *boolean* | :heavy_check_mark: | Whether the datapoint is opted out by your customer in the connection flow. | -| `fields` | [models.GetIntegrationsIntegrationIdPositiveResponseField](../models/getintegrationsintegrationidpositiveresponsefield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | [models.GetIntegrationsIntegrationIdPositiveResponseReadModelField](../models/getintegrationsintegrationidpositiveresponsereadmodelfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/writeactioncoveragestatus.md b/docs/models/getintegrationsintegrationidpositiveresponsereadmodelcoveragestatus.md similarity index 66% rename from docs/models/writeactioncoveragestatus.md rename to docs/models/getintegrationsintegrationidpositiveresponsereadmodelcoveragestatus.md index 9f529b7..263ac4b 100644 --- a/docs/models/writeactioncoveragestatus.md +++ b/docs/models/getintegrationsintegrationidpositiveresponsereadmodelcoveragestatus.md @@ -1,4 +1,4 @@ -# WriteActionCoverageStatus +# GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus The status of a datapoint of an integrated tool: @@ -10,9 +10,10 @@ The status of a datapoint of an integrated tool: ## Example Usage ```typescript -import { WriteActionCoverageStatus } from "@kombo-api/sdk/models"; +import { GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus } from "@kombo-api/sdk/models"; -let value: WriteActionCoverageStatus = "UNKNOWN"; +let value: GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus = + "SUPPORTED"; ``` ## Values diff --git a/docs/models/getintegrationsintegrationidpositiveresponsefield.md b/docs/models/getintegrationsintegrationidpositiveresponsereadmodelfield.md similarity index 96% rename from docs/models/getintegrationsintegrationidpositiveresponsefield.md rename to docs/models/getintegrationsintegrationidpositiveresponsereadmodelfield.md index a8977a5..5134d63 100644 --- a/docs/models/getintegrationsintegrationidpositiveresponsefield.md +++ b/docs/models/getintegrationsintegrationidpositiveresponsereadmodelfield.md @@ -1,16 +1,16 @@ -# GetIntegrationsIntegrationIdPositiveResponseField +# GetIntegrationsIntegrationIdPositiveResponseReadModelField ## Example Usage ```typescript -import { GetIntegrationsIntegrationIdPositiveResponseField } from "@kombo-api/sdk/models"; +import { GetIntegrationsIntegrationIdPositiveResponseReadModelField } from "@kombo-api/sdk/models"; -let value: GetIntegrationsIntegrationIdPositiveResponseField = { +let value: GetIntegrationsIntegrationIdPositiveResponseReadModelField = { id: "", - is_available: true, + is_available: false, coverage_status: "UNKNOWN", scope_config_setting: "DISABLED", - opted_out_by_customer: true, + opted_out_by_customer: false, }; ``` @@ -20,6 +20,6 @@ let value: GetIntegrationsIntegrationIdPositiveResponseField = { | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | Key of the field in the API (e.g. first_name). | | `is_available` | *boolean* | :heavy_check_mark: | Whether the datapoint is available and enabled and not opted out of. | -| `coverage_status` | [models.GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus](../models/getintegrationsintegrationidpositiveresponsefieldcoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | +| `coverage_status` | [models.GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus](../models/getintegrationsintegrationidpositiveresponsereadmodelfieldcoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | | `scope_config_setting` | [models.FieldScopeConfigSetting](../models/fieldscopeconfigsetting.md) | :heavy_check_mark: | The setting of the datapoint in the scope config that you configured in the Kombo dashboard. | | `opted_out_by_customer` | *boolean* | :heavy_check_mark: | Whether the datapoint is opted out by your customer in the connection flow. | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidpositiveresponsereadmodelfieldcoveragestatus.md b/docs/models/getintegrationsintegrationidpositiveresponsereadmodelfieldcoveragestatus.md new file mode 100644 index 0000000..12466e3 --- /dev/null +++ b/docs/models/getintegrationsintegrationidpositiveresponsereadmodelfieldcoveragestatus.md @@ -0,0 +1,24 @@ +# GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus + +The status of a datapoint of an integrated tool: + +- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. +- `UNSUPPORTED`: the tool does not support the datapoint. +- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). +- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + +## Example Usage + +```typescript +import { GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus } from "@kombo-api/sdk/models"; + +let value: + GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus = + "UNSUPPORTED"; +``` + +## Values + +```typescript +"SUPPORTED" | "UNSUPPORTED" | "NOT_IMPLEMENTED" | "UNKNOWN" +``` \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidpositiveresponsewriteaction.md b/docs/models/getintegrationsintegrationidpositiveresponsewriteaction.md new file mode 100644 index 0000000..e3193e0 --- /dev/null +++ b/docs/models/getintegrationsintegrationidpositiveresponsewriteaction.md @@ -0,0 +1,29 @@ +# GetIntegrationsIntegrationIdPositiveResponseWriteAction + +## Example Usage + +```typescript +import { GetIntegrationsIntegrationIdPositiveResponseWriteAction } from "@kombo-api/sdk/models"; + +let value: GetIntegrationsIntegrationIdPositiveResponseWriteAction = { + id: "", + label: "", + is_available: false, + coverage_status: "UNKNOWN", + scope_config_setting: "OPTIONAL", + opted_out_by_customer: false, + fields: [], +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | ID of the action (e.g. ats_create_candidate). | +| `label` | *string* | :heavy_check_mark: | Label of the action (e.g. Create candidate). | +| `is_available` | *boolean* | :heavy_check_mark: | Whether the datapoint is available and enabled and not opted out of. | +| `coverage_status` | [models.GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus](../models/getintegrationsintegrationidpositiveresponsewriteactioncoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | +| `scope_config_setting` | [models.WriteActionScopeConfigSetting](../models/writeactionscopeconfigsetting.md) | :heavy_check_mark: | The setting of the datapoint in the scope config that you configured in the Kombo dashboard. | +| `opted_out_by_customer` | *boolean* | :heavy_check_mark: | Whether the datapoint is opted out by your customer in the connection flow. | +| `fields` | [models.GetIntegrationsIntegrationIdPositiveResponseWriteActionField](../models/getintegrationsintegrationidpositiveresponsewriteactionfield.md)[] | :heavy_check_mark: | Field support status for the action. Please note that action fields can't be configured in the scope config or opted out by your customer. | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidpositiveresponsewriteactioncoveragestatus.md b/docs/models/getintegrationsintegrationidpositiveresponsewriteactioncoveragestatus.md new file mode 100644 index 0000000..9798259 --- /dev/null +++ b/docs/models/getintegrationsintegrationidpositiveresponsewriteactioncoveragestatus.md @@ -0,0 +1,24 @@ +# GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus + +The status of a datapoint of an integrated tool: + +- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. +- `UNSUPPORTED`: the tool does not support the datapoint. +- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). +- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + +## Example Usage + +```typescript +import { GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus } from "@kombo-api/sdk/models"; + +let value: + GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus = + "UNKNOWN"; +``` + +## Values + +```typescript +"SUPPORTED" | "UNSUPPORTED" | "NOT_IMPLEMENTED" | "UNKNOWN" +``` \ No newline at end of file diff --git a/docs/models/writeaction.md b/docs/models/getintegrationsintegrationidpositiveresponsewriteactionfield.md similarity index 90% rename from docs/models/writeaction.md rename to docs/models/getintegrationsintegrationidpositiveresponsewriteactionfield.md index dddcdc6..bab3e53 100644 --- a/docs/models/writeaction.md +++ b/docs/models/getintegrationsintegrationidpositiveresponsewriteactionfield.md @@ -1,16 +1,14 @@ -# WriteAction - -List of supported write actions for this tool. +# GetIntegrationsIntegrationIdPositiveResponseWriteActionField ## Example Usage ```typescript -import { WriteAction } from "@kombo-api/sdk/models"; +import { GetIntegrationsIntegrationIdPositiveResponseWriteActionField } from "@kombo-api/sdk/models"; -let value: WriteAction = { +let value: GetIntegrationsIntegrationIdPositiveResponseWriteActionField = { id: "", - label: "", - coverage_status: "UNKNOWN", + is_available: false, + coverage_status: "UNSUPPORTED", }; ``` @@ -18,6 +16,6 @@ let value: WriteAction = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `label` | *string* | :heavy_check_mark: | N/A | -| `coverage_status` | [models.WriteActionCoverageStatus](../models/writeactioncoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | \ No newline at end of file +| `id` | *string* | :heavy_check_mark: | Key of the input field (e.g. candidate.first_name). | +| `is_available` | *boolean* | :heavy_check_mark: | Whether the datapoint is available and enabled and not opted out of. | +| `coverage_status` | [models.GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus](../models/getintegrationsintegrationidpositiveresponsewriteactionfieldcoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidpositiveresponsewriteactionfieldcoveragestatus.md b/docs/models/getintegrationsintegrationidpositiveresponsewriteactionfieldcoveragestatus.md new file mode 100644 index 0000000..b7b6df8 --- /dev/null +++ b/docs/models/getintegrationsintegrationidpositiveresponsewriteactionfieldcoveragestatus.md @@ -0,0 +1,24 @@ +# GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus + +The status of a datapoint of an integrated tool: + +- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. +- `UNSUPPORTED`: the tool does not support the datapoint. +- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). +- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + +## Example Usage + +```typescript +import { GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus } from "@kombo-api/sdk/models"; + +let value: + GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus = + "UNSUPPORTED"; +``` + +## Values + +```typescript +"SUPPORTED" | "UNSUPPORTED" | "NOT_IMPLEMENTED" | "UNKNOWN" +``` \ No newline at end of file diff --git a/docs/models/gettoolscategorypositiveresponse.md b/docs/models/gettoolscategorypositiveresponse.md index 3fbe14c..c3103b5 100644 --- a/docs/models/gettoolscategorypositiveresponse.md +++ b/docs/models/gettoolscategorypositiveresponse.md @@ -56,6 +56,12 @@ let value: GetToolsCategoryPositiveResponse = { id: "hris_create_employee", label: "Create employee", coverage_status: "SUPPORTED", + fields: [ + { + id: "first_name", + coverage_status: "SUPPORTED", + }, + ], }, ], features: [ @@ -74,7 +80,7 @@ let value: GetToolsCategoryPositiveResponse = { ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | -| `data` | [models.GetToolsCategoryPositiveResponseData](../models/gettoolscategorypositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"tools": [
{
"id": "factorial",
"label": "Factorial",
"internal_label": null,
"assets": {
"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
"icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg",
"icon_black_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon-black.svg"
},
"paid_api_details_markdown": null,
"fast_track_details_markdown": null,
"partner_only_details_markdown": null,
"connection_guide_url": "https://help.kombo.dev/hc/en-us/articles/18743884123409-Factorial-HR-How-do-I-link-my-account",
"coverage": {
"read_models": [
{
"id": "hris_employees",
"label": "Employees",
"coverage_status": "SUPPORTED",
"fields": [
{
"id": "date_of_birth",
"coverage_status": "SUPPORTED"
}
]
},
{
"id": "hris_teams",
"label": "Groups",
"coverage_status": "UNSUPPORTED",
"fields": [
{
"id": "parent_id",
"coverage_status": "UNSUPPORTED"
}
]
}
],
"write_actions": [
{
"id": "hris_create_employee",
"label": "Create employee",
"coverage_status": "SUPPORTED"
}
],
"features": [
{
"id": "automatic_source_writing",
"label": "Automatic Source Writing",
"coverage_status": "SUPPORTED"
}
]
}
}
]
} | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `status` | *"success"* | :heavy_check_mark: | N/A | | +| `data` | [models.GetToolsCategoryPositiveResponseData](../models/gettoolscategorypositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"tools": [
{
"id": "factorial",
"label": "Factorial",
"internal_label": null,
"assets": {
"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
"icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg",
"icon_black_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon-black.svg"
},
"paid_api_details_markdown": null,
"fast_track_details_markdown": null,
"partner_only_details_markdown": null,
"connection_guide_url": "https://help.kombo.dev/hc/en-us/articles/18743884123409-Factorial-HR-How-do-I-link-my-account",
"coverage": {
"read_models": [
{
"id": "hris_employees",
"label": "Employees",
"coverage_status": "SUPPORTED",
"fields": [
{
"id": "date_of_birth",
"coverage_status": "SUPPORTED"
}
]
},
{
"id": "hris_teams",
"label": "Groups",
"coverage_status": "UNSUPPORTED",
"fields": [
{
"id": "parent_id",
"coverage_status": "UNSUPPORTED"
}
]
}
],
"write_actions": [
{
"id": "hris_create_employee",
"label": "Create employee",
"coverage_status": "SUPPORTED",
"fields": [
{
"id": "first_name",
"coverage_status": "SUPPORTED"
}
]
}
],
"features": [
{
"id": "automatic_source_writing",
"label": "Automatic Source Writing",
"coverage_status": "SUPPORTED"
}
]
}
}
]
} | \ No newline at end of file diff --git a/docs/models/gettoolscategorypositiveresponsedata.md b/docs/models/gettoolscategorypositiveresponsedata.md index 4a1f6e4..cb4de51 100644 --- a/docs/models/gettoolscategorypositiveresponsedata.md +++ b/docs/models/gettoolscategorypositiveresponsedata.md @@ -54,6 +54,12 @@ let value: GetToolsCategoryPositiveResponseData = { id: "hris_create_employee", label: "Create employee", coverage_status: "SUPPORTED", + fields: [ + { + id: "first_name", + coverage_status: "SUPPORTED", + }, + ], }, ], features: [ diff --git a/docs/models/gettoolscategorypositiveresponsereadmodel.md b/docs/models/gettoolscategorypositiveresponsereadmodel.md index f77676d..57a0b95 100644 --- a/docs/models/gettoolscategorypositiveresponsereadmodel.md +++ b/docs/models/gettoolscategorypositiveresponsereadmodel.md @@ -27,4 +27,4 @@ let value: GetToolsCategoryPositiveResponseReadModel = { | `id` | *string* | :heavy_check_mark: | ID of the model (e.g. hris_employees). | | `label` | *string* | :heavy_check_mark: | Label of the model (e.g. Employees). | | `coverage_status` | [models.GetToolsCategoryPositiveResponseReadModelCoverageStatus](../models/gettoolscategorypositiveresponsereadmodelcoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | -| `fields` | [models.GetToolsCategoryPositiveResponseField](../models/gettoolscategorypositiveresponsefield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | [models.GetToolsCategoryPositiveResponseReadModelField](../models/gettoolscategorypositiveresponsereadmodelfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/gettoolscategorypositiveresponsefield.md b/docs/models/gettoolscategorypositiveresponsereadmodelfield.md similarity index 95% rename from docs/models/gettoolscategorypositiveresponsefield.md rename to docs/models/gettoolscategorypositiveresponsereadmodelfield.md index 64f8efd..ffeee74 100644 --- a/docs/models/gettoolscategorypositiveresponsefield.md +++ b/docs/models/gettoolscategorypositiveresponsereadmodelfield.md @@ -1,13 +1,13 @@ -# GetToolsCategoryPositiveResponseField +# GetToolsCategoryPositiveResponseReadModelField ## Example Usage ```typescript -import { GetToolsCategoryPositiveResponseField } from "@kombo-api/sdk/models"; +import { GetToolsCategoryPositiveResponseReadModelField } from "@kombo-api/sdk/models"; -let value: GetToolsCategoryPositiveResponseField = { +let value: GetToolsCategoryPositiveResponseReadModelField = { id: "", - coverage_status: "NOT_IMPLEMENTED", + coverage_status: "UNKNOWN", }; ``` @@ -16,4 +16,4 @@ let value: GetToolsCategoryPositiveResponseField = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | Key of the field in the model (e.g. first_name). | -| `coverage_status` | [models.GetToolsCategoryPositiveResponseFieldCoverageStatus](../models/gettoolscategorypositiveresponsefieldcoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | \ No newline at end of file +| `coverage_status` | [models.GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus](../models/gettoolscategorypositiveresponsereadmodelfieldcoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidpositiveresponsefieldcoveragestatus.md b/docs/models/gettoolscategorypositiveresponsereadmodelfieldcoveragestatus.md similarity index 69% rename from docs/models/getintegrationsintegrationidpositiveresponsefieldcoveragestatus.md rename to docs/models/gettoolscategorypositiveresponsereadmodelfieldcoveragestatus.md index 6e0c3df..cb6ab0e 100644 --- a/docs/models/getintegrationsintegrationidpositiveresponsefieldcoveragestatus.md +++ b/docs/models/gettoolscategorypositiveresponsereadmodelfieldcoveragestatus.md @@ -1,4 +1,4 @@ -# GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus +# GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus The status of a datapoint of an integrated tool: @@ -10,9 +10,9 @@ The status of a datapoint of an integrated tool: ## Example Usage ```typescript -import { GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus } from "@kombo-api/sdk/models"; +import { GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus } from "@kombo-api/sdk/models"; -let value: GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus = +let value: GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus = "UNKNOWN"; ``` diff --git a/docs/models/gettoolscategorypositiveresponsewriteaction.md b/docs/models/gettoolscategorypositiveresponsewriteaction.md new file mode 100644 index 0000000..a48b437 --- /dev/null +++ b/docs/models/gettoolscategorypositiveresponsewriteaction.md @@ -0,0 +1,25 @@ +# GetToolsCategoryPositiveResponseWriteAction + +List of supported write actions for this tool. + +## Example Usage + +```typescript +import { GetToolsCategoryPositiveResponseWriteAction } from "@kombo-api/sdk/models"; + +let value: GetToolsCategoryPositiveResponseWriteAction = { + id: "", + label: "", + coverage_status: "UNSUPPORTED", + fields: [], +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | N/A | +| `label` | *string* | :heavy_check_mark: | N/A | +| `coverage_status` | [models.GetToolsCategoryPositiveResponseWriteActionCoverageStatus](../models/gettoolscategorypositiveresponsewriteactioncoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | +| `fields` | [models.GetToolsCategoryPositiveResponseWriteActionField](../models/gettoolscategorypositiveresponsewriteactionfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/gettoolscategorypositiveresponsefieldcoveragestatus.md b/docs/models/gettoolscategorypositiveresponsewriteactioncoveragestatus.md similarity index 71% rename from docs/models/gettoolscategorypositiveresponsefieldcoveragestatus.md rename to docs/models/gettoolscategorypositiveresponsewriteactioncoveragestatus.md index 67a9ca3..738d3e8 100644 --- a/docs/models/gettoolscategorypositiveresponsefieldcoveragestatus.md +++ b/docs/models/gettoolscategorypositiveresponsewriteactioncoveragestatus.md @@ -1,4 +1,4 @@ -# GetToolsCategoryPositiveResponseFieldCoverageStatus +# GetToolsCategoryPositiveResponseWriteActionCoverageStatus The status of a datapoint of an integrated tool: @@ -10,9 +10,9 @@ The status of a datapoint of an integrated tool: ## Example Usage ```typescript -import { GetToolsCategoryPositiveResponseFieldCoverageStatus } from "@kombo-api/sdk/models"; +import { GetToolsCategoryPositiveResponseWriteActionCoverageStatus } from "@kombo-api/sdk/models"; -let value: GetToolsCategoryPositiveResponseFieldCoverageStatus = +let value: GetToolsCategoryPositiveResponseWriteActionCoverageStatus = "NOT_IMPLEMENTED"; ``` diff --git a/docs/models/gettoolscategorypositiveresponsewriteactionfield.md b/docs/models/gettoolscategorypositiveresponsewriteactionfield.md new file mode 100644 index 0000000..7867e81 --- /dev/null +++ b/docs/models/gettoolscategorypositiveresponsewriteactionfield.md @@ -0,0 +1,19 @@ +# GetToolsCategoryPositiveResponseWriteActionField + +## Example Usage + +```typescript +import { GetToolsCategoryPositiveResponseWriteActionField } from "@kombo-api/sdk/models"; + +let value: GetToolsCategoryPositiveResponseWriteActionField = { + id: "", + coverage_status: "NOT_IMPLEMENTED", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | Key of the input field (e.g. `candidate.first_name`). | +| `coverage_status` | [models.GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus](../models/gettoolscategorypositiveresponsewriteactionfieldcoveragestatus.md) | :heavy_check_mark: | The status of a datapoint of an integrated tool:

- `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo.
- `UNSUPPORTED`: the tool does not support the datapoint.
- `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).
- `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. | \ No newline at end of file diff --git a/docs/models/getintegrationsintegrationidpositiveresponsecoveragestatus.md b/docs/models/gettoolscategorypositiveresponsewriteactionfieldcoveragestatus.md similarity index 69% rename from docs/models/getintegrationsintegrationidpositiveresponsecoveragestatus.md rename to docs/models/gettoolscategorypositiveresponsewriteactionfieldcoveragestatus.md index fff1184..22d4d6d 100644 --- a/docs/models/getintegrationsintegrationidpositiveresponsecoveragestatus.md +++ b/docs/models/gettoolscategorypositiveresponsewriteactionfieldcoveragestatus.md @@ -1,4 +1,4 @@ -# GetIntegrationsIntegrationIdPositiveResponseCoverageStatus +# GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus The status of a datapoint of an integrated tool: @@ -10,9 +10,9 @@ The status of a datapoint of an integrated tool: ## Example Usage ```typescript -import { GetIntegrationsIntegrationIdPositiveResponseCoverageStatus } from "@kombo-api/sdk/models"; +import { GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus } from "@kombo-api/sdk/models"; -let value: GetIntegrationsIntegrationIdPositiveResponseCoverageStatus = +let value: GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus = "SUPPORTED"; ``` diff --git a/docs/models/inlineassessmentorderreceivedwebhookpayloadcandidate.md b/docs/models/inlineassessmentorderreceivedwebhookpayloadcandidate.md index 2cb0357..76e47c4 100644 --- a/docs/models/inlineassessmentorderreceivedwebhookpayloadcandidate.md +++ b/docs/models/inlineassessmentorderreceivedwebhookpayloadcandidate.md @@ -16,8 +16,8 @@ let value: InlineAssessmentOrderReceivedWebhookPayloadCandidate = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `remote_id` | *string* | :heavy_minus_sign: | The candidate's identifier in the integrated system. | | `email` | *string* | :heavy_check_mark: | The candidate's email address. | | `first_name` | *string* | :heavy_minus_sign: | The candidate's first name. | | `last_name` | *string* | :heavy_minus_sign: | The candidate's last name. | -| `phone` | *string* | :heavy_minus_sign: | The candidate's phone number. | -| `remote_id` | *string* | :heavy_minus_sign: | The candidate's identifier in the integrated system. | \ No newline at end of file +| `phone` | *string* | :heavy_minus_sign: | The candidate's phone number. | \ No newline at end of file diff --git a/docs/models/operations/getassessmentordersopenresponse.md b/docs/models/operations/getassessmentordersopenresponse.md index df319d0..819439c 100644 --- a/docs/models/operations/getassessmentordersopenresponse.md +++ b/docs/models/operations/getassessmentordersopenresponse.md @@ -15,11 +15,11 @@ let value: GetAssessmentOrdersOpenResponse = { id: "B5KQKhAgTv6ZwzrfAbqbhipd", package_id: "typescript_test", candidate: { + remote_id: "12345", email: "john.doe@gmail.com", first_name: "John", last_name: "Doe", phone: "+1 123 456 7890", - remote_id: "12345", }, application: { remote_id: "54321", diff --git a/docs/models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponse.md b/docs/models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponse.md index c6ad063..772ca76 100644 --- a/docs/models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponse.md +++ b/docs/models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponse.md @@ -27,5 +27,5 @@ let value: | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PatchIntegrationsIntegrationIdIntegrationFieldsIntegrationFieldIdPositiveResponseData](../models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "9suhxJU83Kon4kPTS47837uE",
"key": "tax_id",
"model": "hris_employees",
"type": "DEFAULT",
"label": "Tax ID",
"is_passthrough_enabled": true,
"is_writable": false
} | \ No newline at end of file diff --git a/docs/models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponsedata.md b/docs/models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponsedata.md index 157c24c..99f4d7a 100644 --- a/docs/models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponsedata.md +++ b/docs/models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponsedata.md @@ -30,4 +30,4 @@ let value: | `type` | [models.PatchIntegrationsIntegrationIdIntegrationFieldsIntegrationFieldIdPositiveResponseType](../models/patchintegrationsintegrationidintegrationfieldsintegrationfieldidpositiveresponsetype.md) | :heavy_check_mark: | The type of the integration field. There is a type to avoid collisions between DEFAULT fields and CUSTOM fields with the same key. | | `label` | *string* | :heavy_check_mark: | The label of the field in the remote system. | | `is_passthrough_enabled` | *boolean* | :heavy_check_mark: | Whether the field is included in the integrations_fields array of the corresponding model. | -| `is_writable` | *boolean* | :heavy_check_mark: | This field is related to a deprecated feature and means nothing, but is kept for backwards compatibility. | \ No newline at end of file +| `is_writable` | *false* | :heavy_check_mark: | This field is related to a deprecated feature and means nothing, but is kept for backwards compatibility. | \ No newline at end of file diff --git a/docs/models/postatsapplicationsapplicationidattachmentspositiveresponse.md b/docs/models/postatsapplicationsapplicationidattachmentspositiveresponse.md index a00424f..5682d76 100644 --- a/docs/models/postatsapplicationsapplicationidattachmentspositiveresponse.md +++ b/docs/models/postatsapplicationsapplicationidattachmentspositiveresponse.md @@ -20,6 +20,6 @@ let value: PostAtsApplicationsApplicationIdAttachmentsPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostAtsApplicationsApplicationIdAttachmentsPositiveResponseData](../models/postatsapplicationsapplicationidattachmentspositiveresponsedata.md) | :heavy_check_mark: | N/A | {} | | `warnings` | [models.PostAtsApplicationsApplicationIdAttachmentsPositiveResponseWarning](../models/postatsapplicationsapplicationidattachmentspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/postatsapplicationsapplicationidnotespositiveresponse.md b/docs/models/postatsapplicationsapplicationidnotespositiveresponse.md index 5fa1ca1..0d2bcee 100644 --- a/docs/models/postatsapplicationsapplicationidnotespositiveresponse.md +++ b/docs/models/postatsapplicationsapplicationidnotespositiveresponse.md @@ -20,6 +20,6 @@ let value: PostAtsApplicationsApplicationIdNotesPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostAtsApplicationsApplicationIdNotesPositiveResponseData](../models/postatsapplicationsapplicationidnotespositiveresponsedata.md) | :heavy_check_mark: | N/A | {} | | `warnings` | [models.PostAtsApplicationsApplicationIdNotesPositiveResponseWarning](../models/postatsapplicationsapplicationidnotespositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/postatsapplicationsapplicationidrejectpositiveresponse.md b/docs/models/postatsapplicationsapplicationidrejectpositiveresponse.md index 218221e..66caac1 100644 --- a/docs/models/postatsapplicationsapplicationidrejectpositiveresponse.md +++ b/docs/models/postatsapplicationsapplicationidrejectpositiveresponse.md @@ -20,6 +20,6 @@ let value: PostAtsApplicationsApplicationIdRejectPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostAtsApplicationsApplicationIdRejectPositiveResponseData](../models/postatsapplicationsapplicationidrejectpositiveresponsedata.md) | :heavy_check_mark: | N/A | {} | | `warnings` | [models.PostAtsApplicationsApplicationIdRejectPositiveResponseWarning](../models/postatsapplicationsapplicationidrejectpositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/postatsapplicationsapplicationidresultlinkspositiveresponse.md b/docs/models/postatsapplicationsapplicationidresultlinkspositiveresponse.md index 7feef94..559bb10 100644 --- a/docs/models/postatsapplicationsapplicationidresultlinkspositiveresponse.md +++ b/docs/models/postatsapplicationsapplicationidresultlinkspositiveresponse.md @@ -20,6 +20,6 @@ let value: PostAtsApplicationsApplicationIdResultLinksPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostAtsApplicationsApplicationIdResultLinksPositiveResponseData](../models/postatsapplicationsapplicationidresultlinkspositiveresponsedata.md) | :heavy_check_mark: | N/A | {} | | `warnings` | [models.PostAtsApplicationsApplicationIdResultLinksPositiveResponseWarning](../models/postatsapplicationsapplicationidresultlinkspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/postatscandidatescandidateidattachmentspositiveresponse.md b/docs/models/postatscandidatescandidateidattachmentspositiveresponse.md index 1ed60f1..110bdbb 100644 --- a/docs/models/postatscandidatescandidateidattachmentspositiveresponse.md +++ b/docs/models/postatscandidatescandidateidattachmentspositiveresponse.md @@ -20,6 +20,6 @@ let value: PostAtsCandidatesCandidateIdAttachmentsPositiveResponse = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | +| `status` | *"success"* | :heavy_check_mark: | N/A | | `data` | [models.PostAtsCandidatesCandidateIdAttachmentsPositiveResponseData](../models/postatscandidatescandidateidattachmentspositiveresponsedata.md) | :heavy_check_mark: | N/A | | `warnings` | [models.PostAtsCandidatesCandidateIdAttachmentsPositiveResponseWarning](../models/postatscandidatescandidateidattachmentspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | \ No newline at end of file diff --git a/docs/models/postatscandidatescandidateidresultlinkspositiveresponse.md b/docs/models/postatscandidatescandidateidresultlinkspositiveresponse.md index 31848ff..03d5fbb 100644 --- a/docs/models/postatscandidatescandidateidresultlinkspositiveresponse.md +++ b/docs/models/postatscandidatescandidateidresultlinkspositiveresponse.md @@ -16,6 +16,6 @@ let value: PostAtsCandidatesCandidateIdResultLinksPositiveResponse = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | +| `status` | *"success"* | :heavy_check_mark: | N/A | | `data` | [models.PostAtsCandidatesCandidateIdResultLinksPositiveResponseData](../models/postatscandidatescandidateidresultlinkspositiveresponsedata.md) | :heavy_check_mark: | N/A | | `warnings` | [models.PostAtsCandidatesCandidateIdResultLinksPositiveResponseWarning](../models/postatscandidatescandidateidresultlinkspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | \ No newline at end of file diff --git a/docs/models/postatscandidatescandidateidtagspositiveresponse.md b/docs/models/postatscandidatescandidateidtagspositiveresponse.md index ea7ccdc..8c26ff9 100644 --- a/docs/models/postatscandidatescandidateidtagspositiveresponse.md +++ b/docs/models/postatscandidatescandidateidtagspositiveresponse.md @@ -16,6 +16,6 @@ let value: PostAtsCandidatesCandidateIdTagsPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostAtsCandidatesCandidateIdTagsPositiveResponseData](../models/postatscandidatescandidateidtagspositiveresponsedata.md) | :heavy_check_mark: | N/A | {} | | `warnings` | [models.PostAtsCandidatesCandidateIdTagsPositiveResponseWarning](../models/postatscandidatescandidateidtagspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/postatscandidatespositiveresponse.md b/docs/models/postatscandidatespositiveresponse.md index a202067..b3772d4 100644 --- a/docs/models/postatscandidatespositiveresponse.md +++ b/docs/models/postatscandidatespositiveresponse.md @@ -94,6 +94,6 @@ let value: PostAtsCandidatesPositiveResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostAtsCandidatesPositiveResponseData](../models/postatscandidatespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"company": "Acme, Inc.",
"title": "Head of Marketing",
"confidential": false,
"source": "Employee Referral",
"phone_numbers": [
{
"phone_number": "+1-541-754-3010",
"type": "HOME"
}
],
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
],
"social_media": [
{
"link": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"type": "YOUTUBE",
"username": null
}
],
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
},
"custom_fields": {},
"integration_fields": [],
"remote_url": "https://app.greenhouse.io/people/32",
"remote_created_at": "2022-04-02T00:00:00Z",
"remote_updated_at": "2022-04-04T00:00:00Z",
"remote_data": null,
"changed_at": "2022-04-04T00:00:00Z",
"remote_deleted_at": null,
"applications": [
{
"id": "H77fDF8uvEzGNPRubiz5DvQ7",
"remote_id": "32",
"outcome": "HIRED",
"rejection_reason_name": null,
"rejected_at": null,
"remote_url": "https://app.greenhouse.io/applications/32",
"changed_at": "2022-04-04T00:00:00Z",
"remote_created_at": "2022-04-02T00:00:00Z",
"remote_updated_at": "2022-04-04T00:00:00Z",
"current_stage": {
"id": "5J7L4b48wBfffYwek9Az9pkM",
"name": "Initial Screening",
"remote_id": "32",
"index": 2
},
"job": {
"id": "H5daSm8e85Dmvmne3wLeCPhX",
"name": "Backend Engineer",
"remote_id": "32"
}
}
],
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "High Potential",
"remote_id": "32"
}
]
} | | `warnings` | [models.PostAtsCandidatesPositiveResponseWarning](../models/postatscandidatespositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/postatscandidatesrequestbodypinpoint.md b/docs/models/postatscandidatesrequestbodypinpoint.md new file mode 100644 index 0000000..c626990 --- /dev/null +++ b/docs/models/postatscandidatesrequestbodypinpoint.md @@ -0,0 +1,17 @@ +# PostAtsCandidatesRequestBodyPinpoint + +Fields specific to Pinpoint. + +## Example Usage + +```typescript +import { PostAtsCandidatesRequestBodyPinpoint } from "@kombo-api/sdk/models"; + +let value: PostAtsCandidatesRequestBodyPinpoint = {}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `candidate` | Record | :heavy_minus_sign: | Fields that we will pass through to Pinpoint's `Candidate` object. | \ No newline at end of file diff --git a/docs/models/postatscandidatesrequestbodyremotefields.md b/docs/models/postatscandidatesrequestbodyremotefields.md index ca7e01d..1d4d52c 100644 --- a/docs/models/postatscandidatesrequestbodyremotefields.md +++ b/docs/models/postatscandidatesrequestbodyremotefields.md @@ -33,4 +33,5 @@ let value: PostAtsCandidatesRequestBodyRemoteFields = {}; | `avature` | [models.PostAtsCandidatesRequestBodyAvature](../models/postatscandidatesrequestbodyavature.md) | :heavy_minus_sign: | Fields specific to Avature. | | `recruitee` | [models.PostAtsCandidatesRequestBodyRecruitee](../models/postatscandidatesrequestbodyrecruitee.md) | :heavy_minus_sign: | Fields specific to Recruitee. | | `umantis` | [models.PostAtsCandidatesRequestBodyUmantis](../models/postatscandidatesrequestbodyumantis.md) | :heavy_minus_sign: | Fields specific to Abacus Umantis. | -| `piloga` | [models.PostAtsCandidatesRequestBodyPiloga](../models/postatscandidatesrequestbodypiloga.md) | :heavy_minus_sign: | Fields specific to P&I Loga. | \ No newline at end of file +| `piloga` | [models.PostAtsCandidatesRequestBodyPiloga](../models/postatscandidatesrequestbodypiloga.md) | :heavy_minus_sign: | Fields specific to P&I Loga. | +| `pinpoint` | [models.PostAtsCandidatesRequestBodyPinpoint](../models/postatscandidatesrequestbodypinpoint.md) | :heavy_minus_sign: | Fields specific to Pinpoint. | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationpositiveresponse.md b/docs/models/postatsimporttrackedapplicationpositiveresponse.md index c5f1989..9ca338a 100644 --- a/docs/models/postatsimporttrackedapplicationpositiveresponse.md +++ b/docs/models/postatsimporttrackedapplicationpositiveresponse.md @@ -29,6 +29,6 @@ let value: PostAtsImportTrackedApplicationPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostAtsImportTrackedApplicationPositiveResponseData](../models/postatsimporttrackedapplicationpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "5wdtQtJei2oVhJKya2V1KZLM",
"tracked_at": "2025-02-11T15:37:37Z",
"imported_id": {
"successfactors": {
"id_type": "application_remote_id",
"application_remote_id": "1224042"
}
}
} | | `warnings` | [models.PostAtsImportTrackedApplicationPositiveResponseWarning](../models/postatsimporttrackedapplicationpositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationpositiveresponseerecruiterapplicationandcandidateremoteids.md b/docs/models/postatsimporttrackedapplicationpositiveresponseerecruiterapplicationandcandidateremoteids.md index 7fc5966..683436c 100644 --- a/docs/models/postatsimporttrackedapplicationpositiveresponseerecruiterapplicationandcandidateremoteids.md +++ b/docs/models/postatsimporttrackedapplicationpositiveresponseerecruiterapplicationandcandidateremoteids.md @@ -20,6 +20,6 @@ let value: | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `id_type` | *string* | :heavy_check_mark: | Uses the `Api/Applications/{applicantId}` endpoint to retrieve the relevant application based on the candidate ID. | +| `id_type` | *"application_and_candidate_remote_ids"* | :heavy_check_mark: | Uses the `Api/Applications/{applicantId}` endpoint to retrieve the relevant application based on the candidate ID. | | `candidate_remote_id` | *string* | :heavy_check_mark: | N/A | | `application_remote_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationpositiveresponseerecruiterapplicationandjobremoteids.md b/docs/models/postatsimporttrackedapplicationpositiveresponseerecruiterapplicationandjobremoteids.md index 903a5cd..341518b 100644 --- a/docs/models/postatsimporttrackedapplicationpositiveresponseerecruiterapplicationandjobremoteids.md +++ b/docs/models/postatsimporttrackedapplicationpositiveresponseerecruiterapplicationandjobremoteids.md @@ -20,6 +20,6 @@ let value: | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `id_type` | *string* | :heavy_check_mark: | Uses the `Api/Applications/ByJob/{jobId}` endpoint to retrieve the relevant application based on the job ID. | +| `id_type` | *"application_and_job_remote_ids"* | :heavy_check_mark: | Uses the `Api/Applications/ByJob/{jobId}` endpoint to retrieve the relevant application based on the job ID. | | `application_remote_id` | *string* | :heavy_check_mark: | N/A | | `job_remote_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationpositiveresponsegreenhouseapplicationid.md b/docs/models/postatsimporttrackedapplicationpositiveresponsegreenhouseapplicationid.md index aab8791..8cded39 100644 --- a/docs/models/postatsimporttrackedapplicationpositiveresponsegreenhouseapplicationid.md +++ b/docs/models/postatsimporttrackedapplicationpositiveresponsegreenhouseapplicationid.md @@ -16,5 +16,5 @@ let value: | Field | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/applications/{id}` endpoint to retrieve the application. | +| `id_type` | *"application_id"* | :heavy_check_mark: | Uses the `/applications/{id}` endpoint to retrieve the application. | | `application_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationpositiveresponseonlyfyapplicationid.md b/docs/models/postatsimporttrackedapplicationpositiveresponseonlyfyapplicationid.md index d6cee15..28687f4 100644 --- a/docs/models/postatsimporttrackedapplicationpositiveresponseonlyfyapplicationid.md +++ b/docs/models/postatsimporttrackedapplicationpositiveresponseonlyfyapplicationid.md @@ -16,5 +16,5 @@ let value: PostAtsImportTrackedApplicationPositiveResponseOnlyfyApplicationID = | Field | Type | Required | Description | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/v1/application/{id}` endpoint to retrieve the application. | +| `id_type` | *"application_id"* | :heavy_check_mark: | Uses the `/v1/application/{id}` endpoint to retrieve the application. | | `application_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationpositiveresponserecruiteeplacementid.md b/docs/models/postatsimporttrackedapplicationpositiveresponserecruiteeplacementid.md index d8a77af..f858e25 100644 --- a/docs/models/postatsimporttrackedapplicationpositiveresponserecruiteeplacementid.md +++ b/docs/models/postatsimporttrackedapplicationpositiveresponserecruiteeplacementid.md @@ -16,5 +16,5 @@ let value: PostAtsImportTrackedApplicationPositiveResponseRecruiteePlacementID = | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/candidates` endpoint to retrieve all candidates, to find the relevant application based on the placement ID. | +| `id_type` | *"placement_id"* | :heavy_check_mark: | Uses the `/candidates` endpoint to retrieve all candidates, to find the relevant application based on the placement ID. | | `placement_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationpositiveresponsesmartrecruiterscandidateandjobremoteids.md b/docs/models/postatsimporttrackedapplicationpositiveresponsesmartrecruiterscandidateandjobremoteids.md index e667f3b..a771353 100644 --- a/docs/models/postatsimporttrackedapplicationpositiveresponsesmartrecruiterscandidateandjobremoteids.md +++ b/docs/models/postatsimporttrackedapplicationpositiveresponsesmartrecruiterscandidateandjobremoteids.md @@ -20,6 +20,6 @@ let value: | Field | Type | Required | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/candidates/{candidateId}/jobs/{jobId}` endpoint to retrieve the application. | +| `id_type` | *"candidate_and_job_remote_ids"* | :heavy_check_mark: | Uses the `/candidates/{candidateId}/jobs/{jobId}` endpoint to retrieve the application. | | `candidate_remote_id` | *string* | :heavy_check_mark: | N/A | | `job_remote_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationpositiveresponsesuccessfactorsapplicationremoteid.md b/docs/models/postatsimporttrackedapplicationpositiveresponsesuccessfactorsapplicationremoteid.md index 87d5fee..b963f2c 100644 --- a/docs/models/postatsimporttrackedapplicationpositiveresponsesuccessfactorsapplicationremoteid.md +++ b/docs/models/postatsimporttrackedapplicationpositiveresponsesuccessfactorsapplicationremoteid.md @@ -17,5 +17,5 @@ let value: | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/JobApplication` ODATA endpoint to retrieve the relevant application based on the application ID. | +| `id_type` | *"application_remote_id"* | :heavy_check_mark: | Uses the `/JobApplication` ODATA endpoint to retrieve the relevant application based on the application ID. | | `application_remote_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationrequestbodyerecruiterapplicationandcandidateremoteids.md b/docs/models/postatsimporttrackedapplicationrequestbodyerecruiterapplicationandcandidateremoteids.md index 7c5bba9..26b7661 100644 --- a/docs/models/postatsimporttrackedapplicationrequestbodyerecruiterapplicationandcandidateremoteids.md +++ b/docs/models/postatsimporttrackedapplicationrequestbodyerecruiterapplicationandcandidateremoteids.md @@ -20,6 +20,6 @@ let value: | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `id_type` | *string* | :heavy_check_mark: | Uses the `Api/Applications/{applicantId}` endpoint to retrieve the relevant application based on the candidate ID. | +| `id_type` | *"application_and_candidate_remote_ids"* | :heavy_check_mark: | Uses the `Api/Applications/{applicantId}` endpoint to retrieve the relevant application based on the candidate ID. | | `candidate_remote_id` | *string* | :heavy_check_mark: | N/A | | `application_remote_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationrequestbodyerecruiterapplicationandjobremoteids.md b/docs/models/postatsimporttrackedapplicationrequestbodyerecruiterapplicationandjobremoteids.md index 168c2f6..0105100 100644 --- a/docs/models/postatsimporttrackedapplicationrequestbodyerecruiterapplicationandjobremoteids.md +++ b/docs/models/postatsimporttrackedapplicationrequestbodyerecruiterapplicationandjobremoteids.md @@ -18,6 +18,6 @@ let value: | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `id_type` | *string* | :heavy_check_mark: | Uses the `Api/Applications/ByJob/{jobId}` endpoint to retrieve the relevant application based on the job ID. | +| `id_type` | *"application_and_job_remote_ids"* | :heavy_check_mark: | Uses the `Api/Applications/ByJob/{jobId}` endpoint to retrieve the relevant application based on the job ID. | | `application_remote_id` | *string* | :heavy_check_mark: | N/A | | `job_remote_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationrequestbodygreenhouseapplicationid.md b/docs/models/postatsimporttrackedapplicationrequestbodygreenhouseapplicationid.md index eefb2de..6aff06a 100644 --- a/docs/models/postatsimporttrackedapplicationrequestbodygreenhouseapplicationid.md +++ b/docs/models/postatsimporttrackedapplicationrequestbodygreenhouseapplicationid.md @@ -15,5 +15,5 @@ let value: PostAtsImportTrackedApplicationRequestBodyGreenhouseApplicationID = { | Field | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/applications/{id}` endpoint to retrieve the application. | +| `id_type` | *"application_id"* | :heavy_check_mark: | Uses the `/applications/{id}` endpoint to retrieve the application. | | `application_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationrequestbodyonlyfyapplicationid.md b/docs/models/postatsimporttrackedapplicationrequestbodyonlyfyapplicationid.md index ee50626..c1690a2 100644 --- a/docs/models/postatsimporttrackedapplicationrequestbodyonlyfyapplicationid.md +++ b/docs/models/postatsimporttrackedapplicationrequestbodyonlyfyapplicationid.md @@ -15,5 +15,5 @@ let value: PostAtsImportTrackedApplicationRequestBodyOnlyfyApplicationID = { | Field | Type | Required | Description | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/v1/application/{id}` endpoint to retrieve the application. | +| `id_type` | *"application_id"* | :heavy_check_mark: | Uses the `/v1/application/{id}` endpoint to retrieve the application. | | `application_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationrequestbodyrecruiteeplacementid.md b/docs/models/postatsimporttrackedapplicationrequestbodyrecruiteeplacementid.md index 1ad6a2b..6cf9fd9 100644 --- a/docs/models/postatsimporttrackedapplicationrequestbodyrecruiteeplacementid.md +++ b/docs/models/postatsimporttrackedapplicationrequestbodyrecruiteeplacementid.md @@ -15,5 +15,5 @@ let value: PostAtsImportTrackedApplicationRequestBodyRecruiteePlacementID = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/candidates` endpoint to retrieve all candidates, to find the relevant application based on the placement ID. | +| `id_type` | *"placement_id"* | :heavy_check_mark: | Uses the `/candidates` endpoint to retrieve all candidates, to find the relevant application based on the placement ID. | | `placement_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationrequestbodysmartrecruiterscandidateandjobremoteids.md b/docs/models/postatsimporttrackedapplicationrequestbodysmartrecruiterscandidateandjobremoteids.md index 43d8747..adce56c 100644 --- a/docs/models/postatsimporttrackedapplicationrequestbodysmartrecruiterscandidateandjobremoteids.md +++ b/docs/models/postatsimporttrackedapplicationrequestbodysmartrecruiterscandidateandjobremoteids.md @@ -20,6 +20,6 @@ let value: | Field | Type | Required | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/candidates/{candidateId}/jobs/{jobId}` endpoint to retrieve the application. | +| `id_type` | *"candidate_and_job_remote_ids"* | :heavy_check_mark: | Uses the `/candidates/{candidateId}/jobs/{jobId}` endpoint to retrieve the application. | | `candidate_remote_id` | *string* | :heavy_check_mark: | N/A | | `job_remote_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsimporttrackedapplicationrequestbodysuccessfactorsapplicationremoteid.md b/docs/models/postatsimporttrackedapplicationrequestbodysuccessfactorsapplicationremoteid.md index acc73a9..50e3e03 100644 --- a/docs/models/postatsimporttrackedapplicationrequestbodysuccessfactorsapplicationremoteid.md +++ b/docs/models/postatsimporttrackedapplicationrequestbodysuccessfactorsapplicationremoteid.md @@ -17,5 +17,5 @@ let value: | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `id_type` | *string* | :heavy_check_mark: | Uses the `/JobApplication` ODATA endpoint to retrieve the relevant application based on the application ID. | +| `id_type` | *"application_remote_id"* | :heavy_check_mark: | Uses the `/JobApplication` ODATA endpoint to retrieve the relevant application based on the application ID. | | `application_remote_id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationspositiveresponse.md b/docs/models/postatsjobsjobidapplicationspositiveresponse.md index e41ab3d..a09ae23 100644 --- a/docs/models/postatsjobsjobidapplicationspositiveresponse.md +++ b/docs/models/postatsjobsjobidapplicationspositiveresponse.md @@ -94,6 +94,6 @@ let value: PostAtsJobsJobIdApplicationsPositiveResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostAtsJobsJobIdApplicationsPositiveResponseData](../models/postatsjobsjobidapplicationspositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "H77fDF8uvEzGNPRubiz5DvQ7",
"remote_id": "32",
"outcome": "PENDING",
"rejection_reason_name": null,
"rejected_at": null,
"current_stage_id": "5J7L4b48wBfffYwek9Az9pkM",
"job_id": "H5daSm8e85Dmvmne3wLeCPhX",
"candidate_id": "26vafvWSRmbhNcxJYqjCzuJg",
"screening_question_answers": [],
"custom_fields": {},
"integration_fields": [],
"remote_url": "https://example.com/applications/32",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_created_at": "2022-04-02T00:00:00Z",
"remote_updated_at": "2022-04-04T00:00:00Z",
"remote_data": null,
"current_stage": {
"id": "5J7L4b48wBfffYwek9Az9pkM",
"name": "Interview",
"remote_id": "5",
"index": 2
},
"job": {
"id": "H5daSm8e85Dmvmne3wLeCPhX",
"name": "Head of Integrations",
"remote_id": "1"
},
"candidate": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"company": "Acme, Inc.",
"title": "Head of Marketing",
"confidential": false,
"source": "Employee Referral",
"phone_numbers": [
{
"phone_number": "+1-541-754-3010",
"type": "HOME"
}
],
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
],
"social_media": [
{
"link": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"type": "YOUTUBE",
"username": null
}
],
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
},
"custom_fields": {},
"integration_fields": [],
"remote_url": "https://example.com/candidates/32",
"remote_created_at": "2022-04-02T00:00:00Z",
"remote_updated_at": "2022-04-04T00:00:00Z",
"remote_data": null,
"changed_at": "2022-04-04T00:00:00Z",
"remote_deleted_at": null,
"tags": [
{
"id": "7DHDky9zk4qnWkycuuQjFXNh",
"name": "Fast Learner",
"remote_id": "1"
}
]
}
} | | `warnings` | [models.PostAtsJobsJobIdApplicationsPositiveResponseWarning](../models/postatsjobsjobidapplicationspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionboolean.md b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionboolean.md index 03b64e9..a827c72 100644 --- a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionboolean.md +++ b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionboolean.md @@ -18,4 +18,4 @@ let value: PostAtsJobsJobIdApplicationsPositiveResponseQuestionBoolean = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"BOOLEAN"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationspositiveresponsequestiondate.md b/docs/models/postatsjobsjobidapplicationspositiveresponsequestiondate.md index cc85d99..56c0f21 100644 --- a/docs/models/postatsjobsjobidapplicationspositiveresponsequestiondate.md +++ b/docs/models/postatsjobsjobidapplicationspositiveresponsequestiondate.md @@ -18,4 +18,4 @@ let value: PostAtsJobsJobIdApplicationsPositiveResponseQuestionDate = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"DATE"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionmultiselect.md b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionmultiselect.md index 4d12624..1559c58 100644 --- a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionmultiselect.md +++ b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionmultiselect.md @@ -18,4 +18,4 @@ let value: PostAtsJobsJobIdApplicationsPositiveResponseQuestionMultiSelect = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"MULTI_SELECT"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionnumber.md b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionnumber.md index a637977..bf1d5ae 100644 --- a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionnumber.md +++ b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionnumber.md @@ -18,4 +18,4 @@ let value: PostAtsJobsJobIdApplicationsPositiveResponseQuestionNumber = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"NUMBER"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionsingleselect.md b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionsingleselect.md index 630eebd..9886d48 100644 --- a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionsingleselect.md +++ b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionsingleselect.md @@ -18,4 +18,4 @@ let value: PostAtsJobsJobIdApplicationsPositiveResponseQuestionSingleSelect = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"SINGLE_SELECT"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationspositiveresponsequestiontext.md b/docs/models/postatsjobsjobidapplicationspositiveresponsequestiontext.md index 3092505..6594526 100644 --- a/docs/models/postatsjobsjobidapplicationspositiveresponsequestiontext.md +++ b/docs/models/postatsjobsjobidapplicationspositiveresponsequestiontext.md @@ -18,4 +18,4 @@ let value: PostAtsJobsJobIdApplicationsPositiveResponseQuestionText = { | ------------------ | ------------------ | ------------------ | ------------------ | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"TEXT"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionunknown.md b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionunknown.md index 655da0c..5e9a8af 100644 --- a/docs/models/postatsjobsjobidapplicationspositiveresponsequestionunknown.md +++ b/docs/models/postatsjobsjobidapplicationspositiveresponsequestionunknown.md @@ -18,4 +18,4 @@ let value: PostAtsJobsJobIdApplicationsPositiveResponseQuestionUnknown = { | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `remote_id` | *string* | :heavy_check_mark: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | When we're not able to map a specific question type yet, we will return this type. Every `UNKNOWN` question will also be parsed and unified by us at some point. | \ No newline at end of file +| `type` | *"UNKNOWN"* | :heavy_check_mark: | When we're not able to map a specific question type yet, we will return this type. Every `UNKNOWN` question will also be parsed and unified by us at some point. | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationsrequestbodypinpoint.md b/docs/models/postatsjobsjobidapplicationsrequestbodypinpoint.md new file mode 100644 index 0000000..18f0a35 --- /dev/null +++ b/docs/models/postatsjobsjobidapplicationsrequestbodypinpoint.md @@ -0,0 +1,17 @@ +# PostAtsJobsJobIdApplicationsRequestBodyPinpoint + +Fields specific to Pinpoint. + +## Example Usage + +```typescript +import { PostAtsJobsJobIdApplicationsRequestBodyPinpoint } from "@kombo-api/sdk/models"; + +let value: PostAtsJobsJobIdApplicationsRequestBodyPinpoint = {}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `candidate` | Record | :heavy_minus_sign: | Fields that we will pass through to Pinpoint's `Candidate` object. | \ No newline at end of file diff --git a/docs/models/postatsjobsjobidapplicationsrequestbodyremotefields.md b/docs/models/postatsjobsjobidapplicationsrequestbodyremotefields.md index 028e6be..e4dbe31 100644 --- a/docs/models/postatsjobsjobidapplicationsrequestbodyremotefields.md +++ b/docs/models/postatsjobsjobidapplicationsrequestbodyremotefields.md @@ -33,4 +33,5 @@ let value: PostAtsJobsJobIdApplicationsRequestBodyRemoteFields = {}; | `avature` | [models.PostAtsJobsJobIdApplicationsRequestBodyAvature](../models/postatsjobsjobidapplicationsrequestbodyavature.md) | :heavy_minus_sign: | Fields specific to Avature. | | `recruitee` | [models.PostAtsJobsJobIdApplicationsRequestBodyRecruitee](../models/postatsjobsjobidapplicationsrequestbodyrecruitee.md) | :heavy_minus_sign: | Fields specific to Recruitee. | | `umantis` | [models.PostAtsJobsJobIdApplicationsRequestBodyUmantis](../models/postatsjobsjobidapplicationsrequestbodyumantis.md) | :heavy_minus_sign: | Fields specific to Abacus Umantis. | -| `piloga` | [models.PostAtsJobsJobIdApplicationsRequestBodyPiloga](../models/postatsjobsjobidapplicationsrequestbodypiloga.md) | :heavy_minus_sign: | Fields specific to P&I Loga. | \ No newline at end of file +| `piloga` | [models.PostAtsJobsJobIdApplicationsRequestBodyPiloga](../models/postatsjobsjobidapplicationsrequestbodypiloga.md) | :heavy_minus_sign: | Fields specific to P&I Loga. | +| `pinpoint` | [models.PostAtsJobsJobIdApplicationsRequestBodyPinpoint](../models/postatsjobsjobidapplicationsrequestbodypinpoint.md) | :heavy_minus_sign: | Fields specific to Pinpoint. | \ No newline at end of file diff --git a/docs/models/postconnectcreatelinkpositiveresponse.md b/docs/models/postconnectcreatelinkpositiveresponse.md index 5e606cb..c2f9306 100644 --- a/docs/models/postconnectcreatelinkpositiveresponse.md +++ b/docs/models/postconnectcreatelinkpositiveresponse.md @@ -18,5 +18,5 @@ let value: PostConnectCreateLinkPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostConnectCreateLinkPositiveResponseData](../models/postconnectcreatelinkpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"link": "https://connect.kombo.dev/v1?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.SWYgeW91IGFyZSByZWFkaW5nIHRoaXMsIHdlIHdvdWxkIGxpa2UgdG8gbGV0IHlvdSBrbm93IHRoYXQgd2UgYXJlIGhpcmluZyBwZW9wbGUgbGlrZSB5b3UgOikuIFJlYWNoIG91dCB0byBhbGV4QGtvbWJvLmRldiB0byBnZXQgaW4gY29udGFjdCBhbmQgdGVsbCBoaW0geW91IGNvbWUgZnJvbSB0aGUgSldUIDsp._hhX5YTtHfLn9ZC806dZceRn2whzxHyrhft1ONzNgOE"
} | \ No newline at end of file diff --git a/docs/models/postforcesyncpositiveresponse.md b/docs/models/postforcesyncpositiveresponse.md index 18c1224..5bce126 100644 --- a/docs/models/postforcesyncpositiveresponse.md +++ b/docs/models/postforcesyncpositiveresponse.md @@ -19,5 +19,5 @@ let value: PostForceSyncPositiveResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostForceSyncPositiveResponseData](../models/postforcesyncpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"already_queued": false,
"sync_id": "119ihtp91nA3dqRFiV67nXS6",
"type": "DELTA"
} | \ No newline at end of file diff --git a/docs/models/posthrisabsencespositiveresponse.md b/docs/models/posthrisabsencespositiveresponse.md index 627f26f..d8f33ed 100644 --- a/docs/models/posthrisabsencespositiveresponse.md +++ b/docs/models/posthrisabsencespositiveresponse.md @@ -33,6 +33,6 @@ let value: PostHrisAbsencesPositiveResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostHrisAbsencesPositiveResponseData](../models/posthrisabsencespositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "22st2Ji8XpncEYEak8mvQgQF",
"remote_id": "1348",
"employee_id": "JDdUy9kiH5APaGizFrgNmQjM",
"approver_id": "AgXEispYPP1BbToHpqnqcpxy",
"start_date": "2022-08-04T00:00:00Z",
"end_date": "2022-08-05T00:00:00Z",
"start_half_day": true,
"end_half_day": false,
"start_time": "13:15:00",
"end_time": "17:00:00",
"amount": 2,
"unit": "DAYS",
"status": "APPROVED",
"employee_note": "Visiting my family.",
"type_id": "xzZoKssDaMZAd62kxayzzQvD",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": "2022-08-07T14:01:29.196Z",
"remote_data": null
} | | `warnings` | [models.PostHrisAbsencesPositiveResponseWarning](../models/posthrisabsencespositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/posthrisemployeesemployeeiddocumentspositiveresponse.md b/docs/models/posthrisemployeesemployeeiddocumentspositiveresponse.md index 5ab2bc9..a930eec 100644 --- a/docs/models/posthrisemployeesemployeeiddocumentspositiveresponse.md +++ b/docs/models/posthrisemployeesemployeeiddocumentspositiveresponse.md @@ -16,6 +16,6 @@ let value: PostHrisEmployeesEmployeeIdDocumentsPositiveResponse = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | +| `status` | *"success"* | :heavy_check_mark: | N/A | | `data` | [models.PostHrisEmployeesEmployeeIdDocumentsPositiveResponseData](../models/posthrisemployeesemployeeiddocumentspositiveresponsedata.md) | :heavy_check_mark: | N/A | | `warnings` | [models.PostHrisEmployeesEmployeeIdDocumentsPositiveResponseWarning](../models/posthrisemployeesemployeeiddocumentspositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | \ No newline at end of file diff --git a/docs/models/posthrisemployeesformpositiveresponse.md b/docs/models/posthrisemployeesformpositiveresponse.md index 19a168d..6131cb4 100644 --- a/docs/models/posthrisemployeesformpositiveresponse.md +++ b/docs/models/posthrisemployeesformpositiveresponse.md @@ -10,7 +10,9 @@ let value: PostHrisEmployeesFormPositiveResponse = { data: { id: "26vafvWSRmbhNcxJYqjCzuJg", remote_id: "12345", - prehire_id: null, + prehire: { + remote_id: null, + }, }, warnings: [ { @@ -24,6 +26,6 @@ let value: PostHrisEmployeesFormPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | -| `data` | [models.PostHrisEmployeesFormPositiveResponseData](../models/posthrisemployeesformpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "12345",
"prehire_id": null
} | +| `status` | *"success"* | :heavy_check_mark: | N/A | | +| `data` | [models.PostHrisEmployeesFormPositiveResponseData](../models/posthrisemployeesformpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "12345",
"prehire": {
"remote_id": null
}
} | | `warnings` | [models.PostHrisEmployeesFormPositiveResponseWarning](../models/posthrisemployeesformpositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/posthrisemployeesformpositiveresponsedata.md b/docs/models/posthrisemployeesformpositiveresponsedata.md index d74e1e6..9c8f00c 100644 --- a/docs/models/posthrisemployeesformpositiveresponsedata.md +++ b/docs/models/posthrisemployeesformpositiveresponsedata.md @@ -8,14 +8,16 @@ import { PostHrisEmployeesFormPositiveResponseData } from "@kombo-api/sdk/models let value: PostHrisEmployeesFormPositiveResponseData = { id: "26vafvWSRmbhNcxJYqjCzuJg", remote_id: "12345", - prehire_id: null, + prehire: { + remote_id: null, + }, }; ``` ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | The Kombo id of the created employee. If null, we only created a pre-hire which shows up in the next sync after a successful onboarding. | -| `remote_id` | *string* | :heavy_check_mark: | The raw ID of the created employee in the remote system. This is only populated when `id` is set (i.e., when a full employee was created). For pre-hires, use `prehire_id` instead. | -| `prehire_id` | *string* | :heavy_check_mark: | The temporary ID returned by the remote system when creating a pre-hire. This ID may change or become invalid when the pre-hire becomes a full employee. Only populated when `id` is null. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | The Kombo id of the created employee. If null, we only created a pre-hire which shows up in the next sync after a successful onboarding. | +| `remote_id` | *string* | :heavy_check_mark: | The raw ID of the created employee in the remote system. This is only populated when `id` is set (i.e., when a full employee was created). For pre-hires, use the `prehire` object instead. | +| `prehire` | [models.Prehire](../models/prehire.md) | :heavy_check_mark: | An object containing the temporary pre-hire information from the remote system. This ID may change or become invalid when the pre-hire becomes a full employee. Only populated when `id` is null. | \ No newline at end of file diff --git a/docs/models/postintegrationsintegrationidrelinkpositiveresponse.md b/docs/models/postintegrationsintegrationidrelinkpositiveresponse.md index 8cea1d7..a2f1dcf 100644 --- a/docs/models/postintegrationsintegrationidrelinkpositiveresponse.md +++ b/docs/models/postintegrationsintegrationidrelinkpositiveresponse.md @@ -17,5 +17,5 @@ let value: PostIntegrationsIntegrationIdRelinkPositiveResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | +| `status` | *"success"* | :heavy_check_mark: | N/A | | `data` | [models.PostIntegrationsIntegrationIdRelinkPositiveResponseData](../models/postintegrationsintegrationidrelinkpositiveresponsedata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postpassthroughtoolapipositiveresponse.md b/docs/models/postpassthroughtoolapipositiveresponse.md index 8ab83fe..74bb06e 100644 --- a/docs/models/postpassthroughtoolapipositiveresponse.md +++ b/docs/models/postpassthroughtoolapipositiveresponse.md @@ -36,6 +36,6 @@ let value: PostPassthroughToolApiPositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PostPassthroughToolApiPositiveResponseData](../models/postpassthroughtoolapipositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"url": "https://api.personio.de/v1/company/employees",
"status": 200,
"headers": {
"content-type": "application/json"
},
"data": {
"success": true,
"data": [
{
"id": 123,
"first_name": "John",
"last_name": "Doe"
}
]
}
} | | `warnings` | [models.PostPassthroughToolApiPositiveResponseWarning](../models/postpassthroughtoolapipositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/prehire.md b/docs/models/prehire.md new file mode 100644 index 0000000..f45374e --- /dev/null +++ b/docs/models/prehire.md @@ -0,0 +1,19 @@ +# Prehire + +An object containing the temporary pre-hire information from the remote system. This ID may change or become invalid when the pre-hire becomes a full employee. Only populated when `id` is null. + +## Example Usage + +```typescript +import { Prehire } from "@kombo-api/sdk/models"; + +let value: Prehire = { + remote_id: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `remote_id` | *string* | :heavy_check_mark: | The temporary ID returned by the remote system when creating a pre-hire. | \ No newline at end of file diff --git a/docs/models/propertiesarray.md b/docs/models/propertiesarray.md index 68b9444..67b9b0a 100644 --- a/docs/models/propertiesarray.md +++ b/docs/models/propertiesarray.md @@ -29,7 +29,7 @@ let value: PropertiesArray = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.GetHrisEmployeesFormPositiveResponseUnifiedKey7](../models/gethrisemployeesformpositiveresponseunifiedkey7.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"array"* | :heavy_check_mark: | N/A | | `item_type` | *models.Schema2Union2* | :heavy_check_mark: | N/A | | `min_items` | *number* | :heavy_minus_sign: | N/A | | `max_items` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/propertiescheckbox.md b/docs/models/propertiescheckbox.md index dfae761..9aa9a17 100644 --- a/docs/models/propertiescheckbox.md +++ b/docs/models/propertiescheckbox.md @@ -20,4 +20,4 @@ let value: PropertiesCheckbox = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.GetHrisEmployeesFormPositiveResponseUnifiedKey5](../models/gethrisemployeesformpositiveresponseunifiedkey5.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"checkbox"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/propertiesdate.md b/docs/models/propertiesdate.md index cf64699..de0486a 100644 --- a/docs/models/propertiesdate.md +++ b/docs/models/propertiesdate.md @@ -20,4 +20,4 @@ let value: PropertiesDate = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.GetHrisEmployeesFormPositiveResponseUnifiedKey3](../models/gethrisemployeesformpositiveresponseunifiedkey3.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"date"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/propertiesfile.md b/docs/models/propertiesfile.md index e185eca..15eff8d 100644 --- a/docs/models/propertiesfile.md +++ b/docs/models/propertiesfile.md @@ -25,5 +25,5 @@ let value: PropertiesFile = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.GetHrisEmployeesFormPositiveResponseUnifiedKey8](../models/gethrisemployeesformpositiveresponseunifiedkey8.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"file"* | :heavy_check_mark: | N/A | | `file_restrictions` | [models.GetHrisEmployeesFormPositiveResponseFileRestrictions](../models/gethrisemployeesformpositiveresponsefilerestrictions.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/propertiesmultiselect.md b/docs/models/propertiesmultiselect.md index 5393606..ca12e62 100644 --- a/docs/models/propertiesmultiselect.md +++ b/docs/models/propertiesmultiselect.md @@ -24,7 +24,7 @@ let value: PropertiesMultiSelect = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | *string* | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"multi_select"* | :heavy_check_mark: | N/A | | `min_items` | *number* | :heavy_minus_sign: | N/A | | `max_items` | *number* | :heavy_minus_sign: | N/A | | `options` | *models.GetHrisEmployeesFormPositiveResponseOptionsUnion2* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/propertiesnumber.md b/docs/models/propertiesnumber.md index d869839..1fb737d 100644 --- a/docs/models/propertiesnumber.md +++ b/docs/models/propertiesnumber.md @@ -20,6 +20,6 @@ let value: PropertiesNumber = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.GetHrisEmployeesFormPositiveResponseUnifiedKey2](../models/gethrisemployeesformpositiveresponseunifiedkey2.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"number"* | :heavy_check_mark: | N/A | | `min` | *number* | :heavy_minus_sign: | N/A | | `max` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/propertiesobject.md b/docs/models/propertiesobject.md index db4ceda..78325c8 100644 --- a/docs/models/propertiesobject.md +++ b/docs/models/propertiesobject.md @@ -21,5 +21,5 @@ let value: PropertiesObject = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.GetHrisEmployeesFormPositiveResponseUnifiedKey6](../models/gethrisemployeesformpositiveresponseunifiedkey6.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"object"* | :heavy_check_mark: | N/A | | `properties` | Record | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/propertiessingleselect.md b/docs/models/propertiessingleselect.md index 1876178..671184e 100644 --- a/docs/models/propertiessingleselect.md +++ b/docs/models/propertiessingleselect.md @@ -24,5 +24,5 @@ let value: PropertiesSingleSelect = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.GetHrisEmployeesFormPositiveResponseUnifiedKey4](../models/gethrisemployeesformpositiveresponseunifiedkey4.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"single_select"* | :heavy_check_mark: | N/A | | `options` | *models.GetHrisEmployeesFormPositiveResponseOptionsUnion1* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/propertiestext.md b/docs/models/propertiestext.md index 4d4c223..41cc80b 100644 --- a/docs/models/propertiestext.md +++ b/docs/models/propertiestext.md @@ -20,7 +20,7 @@ let value: PropertiesText = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.GetHrisEmployeesFormPositiveResponseUnifiedKey1](../models/gethrisemployeesformpositiveresponseunifiedkey1.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"text"* | :heavy_check_mark: | N/A | | `min_length` | *number* | :heavy_minus_sign: | N/A | | `max_length` | *number* | :heavy_minus_sign: | N/A | | `reg_exp` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/putassessmentordersassessmentorderidresultpositiveresponse.md b/docs/models/putassessmentordersassessmentorderidresultpositiveresponse.md index 0ce002f..b11ee80 100644 --- a/docs/models/putassessmentordersassessmentorderidresultpositiveresponse.md +++ b/docs/models/putassessmentordersassessmentorderidresultpositiveresponse.md @@ -20,6 +20,6 @@ let value: PutAssessmentOrdersAssessmentOrderIdResultPositiveResponse = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | +| `status` | *"success"* | :heavy_check_mark: | N/A | | `data` | [models.PutAssessmentOrdersAssessmentOrderIdResultPositiveResponseData](../models/putassessmentordersassessmentorderidresultpositiveresponsedata.md) | :heavy_check_mark: | N/A | | `warnings` | [models.PutAssessmentOrdersAssessmentOrderIdResultPositiveResponseWarning](../models/putassessmentordersassessmentorderidresultpositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | \ No newline at end of file diff --git a/docs/models/putassessmentpackagespositiveresponse.md b/docs/models/putassessmentpackagespositiveresponse.md index 80eb40a..546a9cf 100644 --- a/docs/models/putassessmentpackagespositiveresponse.md +++ b/docs/models/putassessmentpackagespositiveresponse.md @@ -16,6 +16,6 @@ let value: PutAssessmentPackagesPositiveResponse = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | +| `status` | *"success"* | :heavy_check_mark: | N/A | | `data` | [models.PutAssessmentPackagesPositiveResponseData](../models/putassessmentpackagespositiveresponsedata.md) | :heavy_check_mark: | N/A | | `warnings` | [models.PutAssessmentPackagesPositiveResponseWarning](../models/putassessmentpackagespositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | \ No newline at end of file diff --git a/docs/models/putatsapplicationsapplicationidstagepositiveresponse.md b/docs/models/putatsapplicationsapplicationidstagepositiveresponse.md index 35028a2..5663def 100644 --- a/docs/models/putatsapplicationsapplicationidstagepositiveresponse.md +++ b/docs/models/putatsapplicationsapplicationidstagepositiveresponse.md @@ -16,6 +16,6 @@ let value: PutAtsApplicationsApplicationIdStagePositiveResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PutAtsApplicationsApplicationIdStagePositiveResponseData](../models/putatsapplicationsapplicationidstagepositiveresponsedata.md) | :heavy_check_mark: | N/A | {} | | `warnings` | [models.PutAtsApplicationsApplicationIdStagePositiveResponseWarning](../models/putatsapplicationsapplicationidstagepositiveresponsewarning.md)[] | :heavy_check_mark: | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | | \ No newline at end of file diff --git a/docs/models/putintegrationsintegrationidcustomfieldscustomfieldidpositiveresponse.md b/docs/models/putintegrationsintegrationidcustomfieldscustomfieldidpositiveresponse.md index 25dffd2..da71ffc 100644 --- a/docs/models/putintegrationsintegrationidcustomfieldscustomfieldidpositiveresponse.md +++ b/docs/models/putintegrationsintegrationidcustomfieldscustomfieldidpositiveresponse.md @@ -28,5 +28,5 @@ let value: | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_check_mark: | N/A | | +| `status` | *"success"* | :heavy_check_mark: | N/A | | | `data` | [models.PutIntegrationsIntegrationIdCustomFieldsCustomFieldIdPositiveResponseData](../models/putintegrationsintegrationidcustomfieldscustomfieldidpositiveresponsedata.md) | :heavy_check_mark: | N/A | {
"id": "EU3Bwa4iDfGspEELW71WDvvu",
"key": "tshirt_size",
"integration_field": {
"id": "3n6geaAmKL5tFonXVAtsMDmr",
"key": "custom.tshirt_size",
"type": "CUSTOM",
"label": "T-Shirt Size"
},
"model": "hris_employees",
"label": "T-Shirt Size",
"description": "Map this to the employee's tshirt size"
} | \ No newline at end of file diff --git a/docs/models/scopeconfigsetting.md b/docs/models/readmodelscopeconfigsetting.md similarity index 56% rename from docs/models/scopeconfigsetting.md rename to docs/models/readmodelscopeconfigsetting.md index bdacd42..853dde8 100644 --- a/docs/models/scopeconfigsetting.md +++ b/docs/models/readmodelscopeconfigsetting.md @@ -1,13 +1,13 @@ -# ScopeConfigSetting +# ReadModelScopeConfigSetting The setting of the datapoint in the scope config that you configured in the Kombo dashboard. ## Example Usage ```typescript -import { ScopeConfigSetting } from "@kombo-api/sdk/models"; +import { ReadModelScopeConfigSetting } from "@kombo-api/sdk/models"; -let value: ScopeConfigSetting = "DISABLED"; +let value: ReadModelScopeConfigSetting = "ENABLED"; ``` ## Values diff --git a/docs/models/schema1array1.md b/docs/models/schema1array1.md index 6addac1..cb01331 100644 --- a/docs/models/schema1array1.md +++ b/docs/models/schema1array1.md @@ -29,7 +29,7 @@ let value: Schema1Array1 = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema1UnifiedKey7](../models/schema1unifiedkey7.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"array"* | :heavy_check_mark: | N/A | | `item_type` | *models.Schema2Union1* | :heavy_check_mark: | N/A | | `min_items` | *number* | :heavy_minus_sign: | N/A | | `max_items` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/schema1array2.md b/docs/models/schema1array2.md index c1a4d1e..2767b8d 100644 --- a/docs/models/schema1array2.md +++ b/docs/models/schema1array2.md @@ -11,7 +11,7 @@ let value: Schema1Array2 = { type: "array", item_type: { label: "", - required: false, + required: true, type: "checkbox", }, }; @@ -25,7 +25,7 @@ let value: Schema1Array2 = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema1UnifiedKey7](../models/schema1unifiedkey7.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"array"* | :heavy_check_mark: | N/A | | `item_type` | *models.Schema2Union2* | :heavy_check_mark: | N/A | | `min_items` | *number* | :heavy_minus_sign: | N/A | | `max_items` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/schema1checkbox.md b/docs/models/schema1checkbox.md index 9ed5fb1..0d1ccf3 100644 --- a/docs/models/schema1checkbox.md +++ b/docs/models/schema1checkbox.md @@ -20,4 +20,4 @@ let value: Schema1Checkbox = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema1UnifiedKey5](../models/schema1unifiedkey5.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"checkbox"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1date.md b/docs/models/schema1date.md index 6857496..6d0a9b1 100644 --- a/docs/models/schema1date.md +++ b/docs/models/schema1date.md @@ -20,4 +20,4 @@ let value: Schema1Date = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema1UnifiedKey3](../models/schema1unifiedkey3.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"date"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1file.md b/docs/models/schema1file.md index e5efd05..bec3452 100644 --- a/docs/models/schema1file.md +++ b/docs/models/schema1file.md @@ -26,5 +26,5 @@ let value: Schema1File = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema1UnifiedKey8](../models/schema1unifiedkey8.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"file"* | :heavy_check_mark: | N/A | | `file_restrictions` | [models.Schema1FileRestrictions](../models/schema1filerestrictions.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1multiselect.md b/docs/models/schema1multiselect.md index fe4dee3..5e01029 100644 --- a/docs/models/schema1multiselect.md +++ b/docs/models/schema1multiselect.md @@ -30,7 +30,7 @@ let value: Schema1MultiSelect = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | *string* | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"multi_select"* | :heavy_check_mark: | N/A | | `min_items` | *number* | :heavy_minus_sign: | N/A | | `max_items` | *number* | :heavy_minus_sign: | N/A | | `options` | *models.Schema1OptionsUnion2* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1number.md b/docs/models/schema1number.md index 7ee3d8c..fb396fb 100644 --- a/docs/models/schema1number.md +++ b/docs/models/schema1number.md @@ -20,6 +20,6 @@ let value: Schema1Number = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema1UnifiedKey2](../models/schema1unifiedkey2.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"number"* | :heavy_check_mark: | N/A | | `min` | *number* | :heavy_minus_sign: | N/A | | `max` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/schema1object.md b/docs/models/schema1object.md index 787cd3d..0a45798 100644 --- a/docs/models/schema1object.md +++ b/docs/models/schema1object.md @@ -21,5 +21,5 @@ let value: Schema1Object = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema1UnifiedKey6](../models/schema1unifiedkey6.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"object"* | :heavy_check_mark: | N/A | | `properties` | [models.Schema1](../models/schema1.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1optionsinline1.md b/docs/models/schema1optionsinline1.md index 9bbb20e..b5fdc39 100644 --- a/docs/models/schema1optionsinline1.md +++ b/docs/models/schema1optionsinline1.md @@ -21,5 +21,5 @@ let value: Schema1OptionsInline1 = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"inline"* | :heavy_check_mark: | N/A | | `entries` | [models.Schema1Entry1](../models/schema1entry1.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1optionsinline2.md b/docs/models/schema1optionsinline2.md index 0b9d929..eab7cbe 100644 --- a/docs/models/schema1optionsinline2.md +++ b/docs/models/schema1optionsinline2.md @@ -15,5 +15,5 @@ let value: Schema1OptionsInline2 = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"inline"* | :heavy_check_mark: | N/A | | `entries` | [models.Schema1Entry2](../models/schema1entry2.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1optionsreferenced1.md b/docs/models/schema1optionsreferenced1.md index 804e5ab..abd58d1 100644 --- a/docs/models/schema1optionsreferenced1.md +++ b/docs/models/schema1optionsreferenced1.md @@ -15,5 +15,5 @@ let value: Schema1OptionsReferenced1 = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"referenced"* | :heavy_check_mark: | N/A | | `link` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1optionsreferenced2.md b/docs/models/schema1optionsreferenced2.md index fd2ac8e..b35fb9f 100644 --- a/docs/models/schema1optionsreferenced2.md +++ b/docs/models/schema1optionsreferenced2.md @@ -15,5 +15,5 @@ let value: Schema1OptionsReferenced2 = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"referenced"* | :heavy_check_mark: | N/A | | `link` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1singleselect.md b/docs/models/schema1singleselect.md index 4c4c740..18f54c1 100644 --- a/docs/models/schema1singleselect.md +++ b/docs/models/schema1singleselect.md @@ -24,5 +24,5 @@ let value: Schema1SingleSelect = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema1UnifiedKey4](../models/schema1unifiedkey4.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"single_select"* | :heavy_check_mark: | N/A | | `options` | *models.Schema1OptionsUnion1* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema1text.md b/docs/models/schema1text.md index a4fde80..a587093 100644 --- a/docs/models/schema1text.md +++ b/docs/models/schema1text.md @@ -20,7 +20,7 @@ let value: Schema1Text = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema1UnifiedKey1](../models/schema1unifiedkey1.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"text"* | :heavy_check_mark: | N/A | | `min_length` | *number* | :heavy_minus_sign: | N/A | | `max_length` | *number* | :heavy_minus_sign: | N/A | | `reg_exp` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/schema1union2.md b/docs/models/schema1union2.md index 984cca0..fa19647 100644 --- a/docs/models/schema1union2.md +++ b/docs/models/schema1union2.md @@ -97,7 +97,7 @@ const value: models.Schema1Array2 = { type: "array", item_type: { label: "", - required: false, + required: true, type: "checkbox", }, }; diff --git a/docs/models/schema2array1.md b/docs/models/schema2array1.md index ed90d68..90c8f16 100644 --- a/docs/models/schema2array1.md +++ b/docs/models/schema2array1.md @@ -25,7 +25,7 @@ let value: Schema2Array1 = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey7](../models/schema2unifiedkey7.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"array"* | :heavy_check_mark: | N/A | | `item_type` | *models.Schema2Union1* | :heavy_check_mark: | N/A | | `min_items` | *number* | :heavy_minus_sign: | N/A | | `max_items` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/schema2array2.md b/docs/models/schema2array2.md index c0bc2af..12a1171 100644 --- a/docs/models/schema2array2.md +++ b/docs/models/schema2array2.md @@ -30,7 +30,7 @@ let value: Schema2Array2 = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey7](../models/schema2unifiedkey7.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"array"* | :heavy_check_mark: | N/A | | `item_type` | *models.Schema2Union2* | :heavy_check_mark: | N/A | | `min_items` | *number* | :heavy_minus_sign: | N/A | | `max_items` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/schema2checkbox.md b/docs/models/schema2checkbox.md index e79bb5f..daf17c4 100644 --- a/docs/models/schema2checkbox.md +++ b/docs/models/schema2checkbox.md @@ -20,4 +20,4 @@ let value: Schema2Checkbox = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey5](../models/schema2unifiedkey5.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"checkbox"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2date.md b/docs/models/schema2date.md index 44e7118..1325f2d 100644 --- a/docs/models/schema2date.md +++ b/docs/models/schema2date.md @@ -20,4 +20,4 @@ let value: Schema2Date = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey3](../models/schema2unifiedkey3.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"date"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2file.md b/docs/models/schema2file.md index a898d1a..307c488 100644 --- a/docs/models/schema2file.md +++ b/docs/models/schema2file.md @@ -27,5 +27,5 @@ let value: Schema2File = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey8](../models/schema2unifiedkey8.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"file"* | :heavy_check_mark: | N/A | | `file_restrictions` | [models.Schema2FileRestrictions](../models/schema2filerestrictions.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2multiselect.md b/docs/models/schema2multiselect.md index 0ca1f57..d43e037 100644 --- a/docs/models/schema2multiselect.md +++ b/docs/models/schema2multiselect.md @@ -24,7 +24,7 @@ let value: Schema2MultiSelect = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | *string* | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"multi_select"* | :heavy_check_mark: | N/A | | `min_items` | *number* | :heavy_minus_sign: | N/A | | `max_items` | *number* | :heavy_minus_sign: | N/A | | `options` | *models.Schema2OptionsUnion2* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2number.md b/docs/models/schema2number.md index d70e309..c5858b3 100644 --- a/docs/models/schema2number.md +++ b/docs/models/schema2number.md @@ -20,6 +20,6 @@ let value: Schema2Number = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey2](../models/schema2unifiedkey2.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"number"* | :heavy_check_mark: | N/A | | `min` | *number* | :heavy_minus_sign: | N/A | | `max` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/schema2object1.md b/docs/models/schema2object1.md index 2d68f5c..a9eb80f 100644 --- a/docs/models/schema2object1.md +++ b/docs/models/schema2object1.md @@ -21,5 +21,5 @@ let value: Schema2Object1 = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey6](../models/schema2unifiedkey6.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"object"* | :heavy_check_mark: | N/A | | `properties` | [models.Schema1](../models/schema1.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2object2.md b/docs/models/schema2object2.md index 99a6fec..d88ffa7 100644 --- a/docs/models/schema2object2.md +++ b/docs/models/schema2object2.md @@ -21,5 +21,5 @@ let value: Schema2Object2 = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey6](../models/schema2unifiedkey6.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"object"* | :heavy_check_mark: | N/A | | `properties` | Record | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2optionsinline1.md b/docs/models/schema2optionsinline1.md index 72c1122..f08fee3 100644 --- a/docs/models/schema2optionsinline1.md +++ b/docs/models/schema2optionsinline1.md @@ -15,5 +15,5 @@ let value: Schema2OptionsInline1 = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"inline"* | :heavy_check_mark: | N/A | | `entries` | [models.Schema2Entry1](../models/schema2entry1.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2optionsinline2.md b/docs/models/schema2optionsinline2.md index 7db67f6..fed894b 100644 --- a/docs/models/schema2optionsinline2.md +++ b/docs/models/schema2optionsinline2.md @@ -21,5 +21,5 @@ let value: Schema2OptionsInline2 = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"inline"* | :heavy_check_mark: | N/A | | `entries` | [models.Schema2Entry2](../models/schema2entry2.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2optionsreferenced1.md b/docs/models/schema2optionsreferenced1.md index a3999a9..23e9747 100644 --- a/docs/models/schema2optionsreferenced1.md +++ b/docs/models/schema2optionsreferenced1.md @@ -15,5 +15,5 @@ let value: Schema2OptionsReferenced1 = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"referenced"* | :heavy_check_mark: | N/A | | `link` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2optionsreferenced2.md b/docs/models/schema2optionsreferenced2.md index 5bf41c2..daf15ce 100644 --- a/docs/models/schema2optionsreferenced2.md +++ b/docs/models/schema2optionsreferenced2.md @@ -15,5 +15,5 @@ let value: Schema2OptionsReferenced2 = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"referenced"* | :heavy_check_mark: | N/A | | `link` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2singleselect.md b/docs/models/schema2singleselect.md index 650e52e..9e1661b 100644 --- a/docs/models/schema2singleselect.md +++ b/docs/models/schema2singleselect.md @@ -24,5 +24,5 @@ let value: Schema2SingleSelect = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey4](../models/schema2unifiedkey4.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"single_select"* | :heavy_check_mark: | N/A | | `options` | *models.Schema2OptionsUnion1* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/schema2text.md b/docs/models/schema2text.md index 7497268..c3697ef 100644 --- a/docs/models/schema2text.md +++ b/docs/models/schema2text.md @@ -20,7 +20,7 @@ let value: Schema2Text = { | `required` | *boolean* | :heavy_check_mark: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `unified_key` | [models.Schema2UnifiedKey1](../models/schema2unifiedkey1.md) | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"text"* | :heavy_check_mark: | N/A | | `min_length` | *number* | :heavy_minus_sign: | N/A | | `max_length` | *number* | :heavy_minus_sign: | N/A | | `reg_exp` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/summaryratingnumeric.md b/docs/models/summaryratingnumeric.md index 8d4a4d1..372a6d3 100644 --- a/docs/models/summaryratingnumeric.md +++ b/docs/models/summaryratingnumeric.md @@ -17,7 +17,7 @@ let value: SummaryRatingNumeric = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"NUMERIC"* | :heavy_check_mark: | N/A | | `min` | *number* | :heavy_check_mark: | The minimum value of the summary rating. | | `max` | *number* | :heavy_check_mark: | The maximum value of the summary rating. | | `value` | *number* | :heavy_check_mark: | The numeric value of the summary rating. | \ No newline at end of file diff --git a/docs/models/summaryratingsingleselect.md b/docs/models/summaryratingsingleselect.md index 9f1313e..cda8488 100644 --- a/docs/models/summaryratingsingleselect.md +++ b/docs/models/summaryratingsingleselect.md @@ -20,6 +20,6 @@ let value: SummaryRatingSingleSelect = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `type` | *string* | :heavy_check_mark: | N/A | +| `type` | *"SINGLE_SELECT"* | :heavy_check_mark: | N/A | | `ordered_options` | *string*[] | :heavy_check_mark: | The options of the summary rating. Ordered from bad to good. | | `value` | *string* | :heavy_check_mark: | The text value of the summary rating. | \ No newline at end of file diff --git a/docs/models/writeactionscopeconfigsetting.md b/docs/models/writeactionscopeconfigsetting.md new file mode 100644 index 0000000..907d2b9 --- /dev/null +++ b/docs/models/writeactionscopeconfigsetting.md @@ -0,0 +1,17 @@ +# WriteActionScopeConfigSetting + +The setting of the datapoint in the scope config that you configured in the Kombo dashboard. + +## Example Usage + +```typescript +import { WriteActionScopeConfigSetting } from "@kombo-api/sdk/models"; + +let value: WriteActionScopeConfigSetting = "DISABLED"; +``` + +## Values + +```typescript +"ENABLED" | "DISABLED" | "OPTIONAL" +``` \ No newline at end of file diff --git a/docs/sdks/general/README.md b/docs/sdks/general/README.md index 40031cf..f5a8012 100644 --- a/docs/sdks/general/README.md +++ b/docs/sdks/general/README.md @@ -279,6 +279,7 @@ To get started, please pick the relevant API (some tools provide multiple to due |BITE|`bite/v1`|[Bite's v1 API](https://api.b-ite.io/docs/#/). We automatically authenticate all requests and use 'https://api.b-ite.io/v1' as base URL.| |Zelt|`zelt/partner`|Zelt's [Partner API](https://go.zelt.app/apiv2/swagger). We automatically authenticate all requests using the connected OAuth credentials and use `https://go.zelt.app/apiv2/partner` as the base URL.| |Planday|`planday/api`|Planday's [HR API v1.0](https://openapi.planday.com/api/hr?version=v1.0). We automatically authenticate all requests and use `https://openapi.planday.com` as the base URL.| +|BoondManager|`boondmanager/api`|BoondManager [REST API](https://ui.boondmanager.com/administrator/developer/apisandbox). We automatically authenticate all requests and use `https://ui.boondmanager.com/api` as the base URL.| |Hailey HR|`haileyhr/api`|Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL.| |Silae|`silae/rest`|[Silae's REST API](https://silae-api.document360.io/docs). We automatically authenticate all requests and use 'https://payroll-api.silae.fr/payroll' as the base URL.| |Mysolution|`mysolution/default`|[Mysolution's API](https://swagger.mysolution.nl/). We automatically authenticate all requests and use the customer's domain as base URL.| diff --git a/examples/package-lock.json b/examples/package-lock.json index fb4e918..4b40cbf 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -18,7 +18,7 @@ }, "..": { "name": "@kombo-api/sdk", - "version": "0.2.4", + "version": "0.3.0", "license": "MIT", "dependencies": { "zod": "^3.25.0 || ^4.0.0" diff --git a/jsr.json b/jsr.json index ac8fac5..d56f413 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@kombo-api/sdk", - "version": "0.2.4", + "version": "0.3.0", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 0164590..c51170f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@kombo-api/sdk", - "version": "0.2.4", + "version": "0.3.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@kombo-api/sdk", - "version": "0.2.4", + "version": "0.3.0", "license": "MIT", "dependencies": { "zod": "^3.25.0 || ^4.0.0" diff --git a/package.json b/package.json index 8d84555..ca00bb0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@kombo-api/sdk", - "version": "0.2.4", + "version": "0.3.0", "author": "Kombo Technologies GmbH (https://www.kombo.dev)", "description": "The official TypeScript/JavaScript SDK for the Kombo Unified API", "homepage": "https://github.com/kombohq/typescript-sdk#readme", diff --git a/src/funcs/generalSendPassthroughRequest.ts b/src/funcs/generalSendPassthroughRequest.ts index dfd1719..93f938c 100644 --- a/src/funcs/generalSendPassthroughRequest.ts +++ b/src/funcs/generalSendPassthroughRequest.ts @@ -147,6 +147,7 @@ import { Result } from "../types/fp.js"; * |BITE|`bite/v1`|[Bite's v1 API](https://api.b-ite.io/docs/#/). We automatically authenticate all requests and use 'https://api.b-ite.io/v1' as base URL.| * |Zelt|`zelt/partner`|Zelt's [Partner API](https://go.zelt.app/apiv2/swagger). We automatically authenticate all requests using the connected OAuth credentials and use `https://go.zelt.app/apiv2/partner` as the base URL.| * |Planday|`planday/api`|Planday's [HR API v1.0](https://openapi.planday.com/api/hr?version=v1.0). We automatically authenticate all requests and use `https://openapi.planday.com` as the base URL.| + * |BoondManager|`boondmanager/api`|BoondManager [REST API](https://ui.boondmanager.com/administrator/developer/apisandbox). We automatically authenticate all requests and use `https://ui.boondmanager.com/api` as the base URL.| * |Hailey HR|`haileyhr/api`|Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL.| * |Silae|`silae/rest`|[Silae's REST API](https://silae-api.document360.io/docs). We automatically authenticate all requests and use 'https://payroll-api.silae.fr/payroll' as the base URL.| * |Mysolution|`mysolution/default`|[Mysolution's API](https://swagger.mysolution.nl/). We automatically authenticate all requests and use the customer's domain as base URL.| diff --git a/src/lib/config.ts b/src/lib/config.ts index 50217f7..4efee1d 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -69,7 +69,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "1.0.0", - sdkVersion: "0.2.4", - genVersion: "2.760.2", - userAgent: "speakeasy-sdk/typescript 0.2.4 2.760.2 1.0.0 @kombo-api/sdk", + sdkVersion: "0.3.0", + genVersion: "2.768.0", + userAgent: "speakeasy-sdk/typescript 0.3.0 2.768.0 1.0.0 @kombo-api/sdk", } as const; diff --git a/src/lib/encodings.ts b/src/lib/encodings.ts index 25c9dcb..31cd373 100644 --- a/src/lib/encodings.ts +++ b/src/lib/encodings.ts @@ -102,8 +102,9 @@ export function encodeLabel( }); encValue = mapped?.join("").slice(1); } else { - const k = - options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : ""; + const k = options?.explode && isPlainObject(value) + ? `${encodeString(pk)}=` + : ""; encValue = `${k}${encodeValue(pv)}`; } @@ -426,6 +427,7 @@ export function queryJoin(...args: (string | undefined)[]): string { type QueryEncoderOptions = { explode?: boolean; charEncoding?: "percent" | "none"; + allowEmptyValue?: string[]; }; type QueryEncoder = ( @@ -440,7 +442,7 @@ type BulkQueryEncoder = ( ) => string; export function queryEncoder(f: QueryEncoder): BulkQueryEncoder { - const bulkEncode = function ( + const bulkEncode = function( values: Record, options?: QueryEncoderOptions, ): string { @@ -450,7 +452,19 @@ export function queryEncoder(f: QueryEncoder): BulkQueryEncoder { charEncoding: options?.charEncoding ?? "percent", }; + const allowEmptySet = new Set(options?.allowEmptyValue ?? []); + const encoded = Object.entries(values).map(([key, value]) => { + if (allowEmptySet.has(key)) { + if ( + value === undefined + || value === null + || value === "" + || (Array.isArray(value) && value.length === 0) + ) { + return `${encodeURIComponent(key)}=`; + } + } return f(key, value, opts); }); return queryJoin(...encoded); diff --git a/src/models/assessmentorderreceivedwebhookpayload.ts b/src/models/assessmentorderreceivedwebhookpayload.ts index f748745..d45a11b 100644 --- a/src/models/assessmentorderreceivedwebhookpayload.ts +++ b/src/models/assessmentorderreceivedwebhookpayload.ts @@ -41,6 +41,10 @@ export type AssessmentOrderReceivedWebhookPayloadStatus = ClosedEnum< * Information about the candidate taking the assessment. */ export type AssessmentOrderReceivedWebhookPayloadCandidate = { + /** + * The candidate's identifier in the integrated system. + */ + remote_id?: string | null | undefined; /** * The candidate's email address. */ @@ -57,10 +61,6 @@ export type AssessmentOrderReceivedWebhookPayloadCandidate = { * The candidate's phone number. */ phone?: string | null | undefined; - /** - * The candidate's identifier in the integrated system. - */ - remote_id?: string | null | undefined; }; /** @@ -219,19 +219,19 @@ export const AssessmentOrderReceivedWebhookPayloadCandidate$inboundSchema: z.ZodTypeDef, unknown > = z.object({ + remote_id: z.nullable(z.string()).optional(), email: z.string(), first_name: z.nullable(z.string()).optional(), last_name: z.nullable(z.string()).optional(), phone: z.nullable(z.string()).optional(), - remote_id: z.nullable(z.string()).optional(), }); /** @internal */ export type AssessmentOrderReceivedWebhookPayloadCandidate$Outbound = { + remote_id?: string | null | undefined; email: string; first_name?: string | null | undefined; last_name?: string | null | undefined; phone?: string | null | undefined; - remote_id?: string | null | undefined; }; /** @internal */ @@ -241,11 +241,11 @@ export const AssessmentOrderReceivedWebhookPayloadCandidate$outboundSchema: z.ZodTypeDef, AssessmentOrderReceivedWebhookPayloadCandidate > = z.object({ + remote_id: z.nullable(z.string()).optional(), email: z.string(), first_name: z.nullable(z.string()).optional(), last_name: z.nullable(z.string()).optional(), phone: z.nullable(z.string()).optional(), - remote_id: z.nullable(z.string()).optional(), }); export function assessmentOrderReceivedWebhookPayloadCandidateToJSON( diff --git a/src/models/getassessmentordersopenpositiveresponse.ts b/src/models/getassessmentordersopenpositiveresponse.ts index 1435d8d..3b8d3c5 100644 --- a/src/models/getassessmentordersopenpositiveresponse.ts +++ b/src/models/getassessmentordersopenpositiveresponse.ts @@ -12,6 +12,10 @@ import { SDKValidationError } from "./errors/sdkvalidationerror.js"; * Information about the candidate taking the assessment. */ export type GetAssessmentOrdersOpenPositiveResponseCandidate = { + /** + * The candidate's identifier in the integrated system. + */ + remote_id?: string | null | undefined; /** * The candidate's email address. */ @@ -28,10 +32,6 @@ export type GetAssessmentOrdersOpenPositiveResponseCandidate = { * The candidate's phone number. */ phone?: string | null | undefined; - /** - * The candidate's identifier in the integrated system. - */ - remote_id?: string | null | undefined; }; /** @@ -164,11 +164,11 @@ export const GetAssessmentOrdersOpenPositiveResponseCandidate$inboundSchema: z.ZodTypeDef, unknown > = z.object({ + remote_id: z.nullable(z.string()).optional(), email: z.string(), first_name: z.nullable(z.string()).optional(), last_name: z.nullable(z.string()).optional(), phone: z.nullable(z.string()).optional(), - remote_id: z.nullable(z.string()).optional(), }); export function getAssessmentOrdersOpenPositiveResponseCandidateFromJSON( diff --git a/src/models/getatsjobspositiveresponse.ts b/src/models/getatsjobspositiveresponse.ts index 4cabe3f..ab3a37d 100644 --- a/src/models/getatsjobspositiveresponse.ts +++ b/src/models/getatsjobspositiveresponse.ts @@ -213,13 +213,13 @@ export type FormatText = { }; export type Format = - | FormatSingleSelect - | FormatMultiSelect | FormatText | FormatNumber | FormatFile + | FormatSingleSelect | FormatBoolean | FormatDate + | FormatMultiSelect | FormatInformation | FormatUnknown; @@ -257,13 +257,13 @@ export type ScreeningQuestion = { */ description: string | null; format?: - | FormatSingleSelect - | FormatMultiSelect | FormatText | FormatNumber | FormatFile + | FormatSingleSelect | FormatBoolean | FormatDate + | FormatMultiSelect | FormatInformation | FormatUnknown | null @@ -851,13 +851,13 @@ export function formatTextFromJSON( /** @internal */ export const Format$inboundSchema: z.ZodType = z .union([ - z.lazy(() => FormatSingleSelect$inboundSchema), - z.lazy(() => FormatMultiSelect$inboundSchema), z.lazy(() => FormatText$inboundSchema), z.lazy(() => FormatNumber$inboundSchema), z.lazy(() => FormatFile$inboundSchema), + z.lazy(() => FormatSingleSelect$inboundSchema), z.lazy(() => FormatBoolean$inboundSchema), z.lazy(() => FormatDate$inboundSchema), + z.lazy(() => FormatMultiSelect$inboundSchema), z.lazy(() => FormatInformation$inboundSchema), z.lazy(() => FormatUnknown$inboundSchema), ]); @@ -906,13 +906,13 @@ export const ScreeningQuestion$inboundSchema: z.ZodType< description: z.nullable(z.string()), format: z.nullable( z.union([ - z.lazy(() => FormatSingleSelect$inboundSchema), - z.lazy(() => FormatMultiSelect$inboundSchema), z.lazy(() => FormatText$inboundSchema), z.lazy(() => FormatNumber$inboundSchema), z.lazy(() => FormatFile$inboundSchema), + z.lazy(() => FormatSingleSelect$inboundSchema), z.lazy(() => FormatBoolean$inboundSchema), z.lazy(() => FormatDate$inboundSchema), + z.lazy(() => FormatMultiSelect$inboundSchema), z.lazy(() => FormatInformation$inboundSchema), z.lazy(() => FormatUnknown$inboundSchema), ]), diff --git a/src/models/gethrisemployeesformpositiveresponse.ts b/src/models/gethrisemployeesformpositiveresponse.ts index 0b668d6..e985431 100644 --- a/src/models/gethrisemployeesformpositiveresponse.ts +++ b/src/models/gethrisemployeesformpositiveresponse.ts @@ -384,28 +384,28 @@ export type PropertiesText = { }; export type Properties = + | PropertiesText + | PropertiesNumber + | PropertiesDate | PropertiesSingleSelect | PropertiesMultiSelect + | PropertiesCheckbox | PropertiesObject | PropertiesArray - | PropertiesFile - | PropertiesText - | PropertiesNumber - | PropertiesDate - | PropertiesCheckbox; + | PropertiesFile; export type GetHrisEmployeesFormPositiveResponseData = { properties: { [k: string]: + | PropertiesText + | PropertiesNumber + | PropertiesDate | PropertiesSingleSelect | PropertiesMultiSelect + | PropertiesCheckbox | PropertiesObject | PropertiesArray - | PropertiesFile - | PropertiesText - | PropertiesNumber - | PropertiesDate - | PropertiesCheckbox; + | PropertiesFile; }; }; @@ -1020,15 +1020,15 @@ export const Properties$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.union([ + z.lazy(() => PropertiesText$inboundSchema), + z.lazy(() => PropertiesNumber$inboundSchema), + z.lazy(() => PropertiesDate$inboundSchema), z.lazy(() => PropertiesSingleSelect$inboundSchema), z.lazy(() => PropertiesMultiSelect$inboundSchema), + z.lazy(() => PropertiesCheckbox$inboundSchema), z.lazy(() => PropertiesObject$inboundSchema), z.lazy(() => PropertiesArray$inboundSchema), z.lazy(() => PropertiesFile$inboundSchema), - z.lazy(() => PropertiesText$inboundSchema), - z.lazy(() => PropertiesNumber$inboundSchema), - z.lazy(() => PropertiesDate$inboundSchema), - z.lazy(() => PropertiesCheckbox$inboundSchema), ]); export function propertiesFromJSON( @@ -1049,15 +1049,15 @@ export const GetHrisEmployeesFormPositiveResponseData$inboundSchema: z.ZodType< > = z.object({ properties: z.record( z.union([ + z.lazy(() => PropertiesText$inboundSchema), + z.lazy(() => PropertiesNumber$inboundSchema), + z.lazy(() => PropertiesDate$inboundSchema), z.lazy(() => PropertiesSingleSelect$inboundSchema), z.lazy(() => PropertiesMultiSelect$inboundSchema), + z.lazy(() => PropertiesCheckbox$inboundSchema), z.lazy(() => PropertiesObject$inboundSchema), z.lazy(() => PropertiesArray$inboundSchema), z.lazy(() => PropertiesFile$inboundSchema), - z.lazy(() => PropertiesText$inboundSchema), - z.lazy(() => PropertiesNumber$inboundSchema), - z.lazy(() => PropertiesDate$inboundSchema), - z.lazy(() => PropertiesCheckbox$inboundSchema), ]), ), }); diff --git a/src/models/getintegrationsintegrationidpositiveresponse.ts b/src/models/getintegrationsintegrationidpositiveresponse.ts index 3c38465..4b12443 100644 --- a/src/models/getintegrationsintegrationidpositiveresponse.ts +++ b/src/models/getintegrationsintegrationidpositiveresponse.ts @@ -114,12 +114,13 @@ export type ScopeConfig = { * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ -export const GetIntegrationsIntegrationIdPositiveResponseCoverageStatus = { - Supported: "SUPPORTED", - Unsupported: "UNSUPPORTED", - NotImplemented: "NOT_IMPLEMENTED", - Unknown: "UNKNOWN", -} as const; +export const GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus = + { + Supported: "SUPPORTED", + Unsupported: "UNSUPPORTED", + NotImplemented: "NOT_IMPLEMENTED", + Unknown: "UNKNOWN", + } as const; /** * The status of a datapoint of an integrated tool: * @@ -130,13 +131,15 @@ export const GetIntegrationsIntegrationIdPositiveResponseCoverageStatus = { * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ -export type GetIntegrationsIntegrationIdPositiveResponseCoverageStatus = - ClosedEnum; +export type GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus = + ClosedEnum< + typeof GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus + >; /** * The setting of the datapoint in the scope config that you configured in the Kombo dashboard. */ -export const ScopeConfigSetting = { +export const ReadModelScopeConfigSetting = { Enabled: "ENABLED", Disabled: "DISABLED", Optional: "OPTIONAL", @@ -144,7 +147,9 @@ export const ScopeConfigSetting = { /** * The setting of the datapoint in the scope config that you configured in the Kombo dashboard. */ -export type ScopeConfigSetting = ClosedEnum; +export type ReadModelScopeConfigSetting = ClosedEnum< + typeof ReadModelScopeConfigSetting +>; /** * The status of a datapoint of an integrated tool: @@ -156,12 +161,13 @@ export type ScopeConfigSetting = ClosedEnum; * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ -export const GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus = { - Supported: "SUPPORTED", - Unsupported: "UNSUPPORTED", - NotImplemented: "NOT_IMPLEMENTED", - Unknown: "UNKNOWN", -} as const; +export const GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus = + { + Supported: "SUPPORTED", + Unsupported: "UNSUPPORTED", + NotImplemented: "NOT_IMPLEMENTED", + Unknown: "UNKNOWN", + } as const; /** * The status of a datapoint of an integrated tool: * @@ -172,9 +178,9 @@ export const GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus = { * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ -export type GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus = +export type GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus = ClosedEnum< - typeof GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus + typeof GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus >; /** @@ -192,7 +198,7 @@ export type FieldScopeConfigSetting = ClosedEnum< typeof FieldScopeConfigSetting >; -export type GetIntegrationsIntegrationIdPositiveResponseField = { +export type GetIntegrationsIntegrationIdPositiveResponseReadModelField = { /** * Key of the field in the API (e.g. first_name). */ @@ -212,7 +218,7 @@ export type GetIntegrationsIntegrationIdPositiveResponseField = { * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ coverage_status: - GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus; + GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus; /** * The setting of the datapoint in the scope config that you configured in the Kombo dashboard. */ @@ -246,16 +252,158 @@ export type GetIntegrationsIntegrationIdPositiveResponseReadModel = { * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ - coverage_status: GetIntegrationsIntegrationIdPositiveResponseCoverageStatus; + coverage_status: + GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus; /** * The setting of the datapoint in the scope config that you configured in the Kombo dashboard. */ - scope_config_setting: ScopeConfigSetting; + scope_config_setting: ReadModelScopeConfigSetting; /** * Whether the datapoint is opted out by your customer in the connection flow. */ opted_out_by_customer: boolean; - fields: Array; + fields: Array; +}; + +/** + * The status of a datapoint of an integrated tool: + * + * @remarks + * + * - `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. + * - `UNSUPPORTED`: the tool does not support the datapoint. + * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). + * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + */ +export const GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus = + { + Supported: "SUPPORTED", + Unsupported: "UNSUPPORTED", + NotImplemented: "NOT_IMPLEMENTED", + Unknown: "UNKNOWN", + } as const; +/** + * The status of a datapoint of an integrated tool: + * + * @remarks + * + * - `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. + * - `UNSUPPORTED`: the tool does not support the datapoint. + * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). + * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + */ +export type GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus = + ClosedEnum< + typeof GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus + >; + +/** + * The setting of the datapoint in the scope config that you configured in the Kombo dashboard. + */ +export const WriteActionScopeConfigSetting = { + Enabled: "ENABLED", + Disabled: "DISABLED", + Optional: "OPTIONAL", +} as const; +/** + * The setting of the datapoint in the scope config that you configured in the Kombo dashboard. + */ +export type WriteActionScopeConfigSetting = ClosedEnum< + typeof WriteActionScopeConfigSetting +>; + +/** + * The status of a datapoint of an integrated tool: + * + * @remarks + * + * - `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. + * - `UNSUPPORTED`: the tool does not support the datapoint. + * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). + * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + */ +export const GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus = + { + Supported: "SUPPORTED", + Unsupported: "UNSUPPORTED", + NotImplemented: "NOT_IMPLEMENTED", + Unknown: "UNKNOWN", + } as const; +/** + * The status of a datapoint of an integrated tool: + * + * @remarks + * + * - `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. + * - `UNSUPPORTED`: the tool does not support the datapoint. + * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). + * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + */ +export type GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus = + ClosedEnum< + typeof GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus + >; + +export type GetIntegrationsIntegrationIdPositiveResponseWriteActionField = { + /** + * Key of the input field (e.g. candidate.first_name). + */ + id: string; + /** + * Whether the datapoint is available and enabled and not opted out of. + */ + is_available: boolean; + /** + * The status of a datapoint of an integrated tool: + * + * @remarks + * + * - `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. + * - `UNSUPPORTED`: the tool does not support the datapoint. + * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). + * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + */ + coverage_status: + GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus; +}; + +export type GetIntegrationsIntegrationIdPositiveResponseWriteAction = { + /** + * ID of the action (e.g. ats_create_candidate). + */ + id: string; + /** + * Label of the action (e.g. Create candidate). + */ + label: string; + /** + * Whether the datapoint is available and enabled and not opted out of. + */ + is_available: boolean; + /** + * The status of a datapoint of an integrated tool: + * + * @remarks + * + * - `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. + * - `UNSUPPORTED`: the tool does not support the datapoint. + * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). + * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + */ + coverage_status: + GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus; + /** + * The setting of the datapoint in the scope config that you configured in the Kombo dashboard. + */ + scope_config_setting: WriteActionScopeConfigSetting; + /** + * Whether the datapoint is opted out by your customer in the connection flow. + */ + opted_out_by_customer: boolean; + /** + * Field support status for the action. Please note that action fields can't be configured in the scope config or opted out by your customer. + */ + fields: Array; }; export type GetIntegrationsIntegrationIdPositiveResponseData = { @@ -290,6 +438,7 @@ export type GetIntegrationsIntegrationIdPositiveResponseData = { created_at: Date; beta: boolean; read_models: Array; + write_actions: Array; }; export type GetIntegrationsIntegrationIdPositiveResponse = { @@ -392,22 +541,24 @@ export function scopeConfigFromJSON( } /** @internal */ -export const GetIntegrationsIntegrationIdPositiveResponseCoverageStatus$inboundSchema: +export const GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus$inboundSchema: z.ZodNativeEnum< - typeof GetIntegrationsIntegrationIdPositiveResponseCoverageStatus - > = z.nativeEnum(GetIntegrationsIntegrationIdPositiveResponseCoverageStatus); + typeof GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus + > = z.nativeEnum( + GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus, + ); /** @internal */ -export const ScopeConfigSetting$inboundSchema: z.ZodNativeEnum< - typeof ScopeConfigSetting -> = z.nativeEnum(ScopeConfigSetting); +export const ReadModelScopeConfigSetting$inboundSchema: z.ZodNativeEnum< + typeof ReadModelScopeConfigSetting +> = z.nativeEnum(ReadModelScopeConfigSetting); /** @internal */ -export const GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus$inboundSchema: +export const GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus$inboundSchema: z.ZodNativeEnum< - typeof GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus + typeof GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus > = z.nativeEnum( - GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus, + GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus, ); /** @internal */ @@ -416,33 +567,32 @@ export const FieldScopeConfigSetting$inboundSchema: z.ZodNativeEnum< > = z.nativeEnum(FieldScopeConfigSetting); /** @internal */ -export const GetIntegrationsIntegrationIdPositiveResponseField$inboundSchema: +export const GetIntegrationsIntegrationIdPositiveResponseReadModelField$inboundSchema: z.ZodType< - GetIntegrationsIntegrationIdPositiveResponseField, + GetIntegrationsIntegrationIdPositiveResponseReadModelField, z.ZodTypeDef, unknown > = z.object({ id: z.string(), is_available: z.boolean(), coverage_status: - GetIntegrationsIntegrationIdPositiveResponseFieldCoverageStatus$inboundSchema, + GetIntegrationsIntegrationIdPositiveResponseReadModelFieldCoverageStatus$inboundSchema, scope_config_setting: FieldScopeConfigSetting$inboundSchema, opted_out_by_customer: z.boolean(), }); -export function getIntegrationsIntegrationIdPositiveResponseFieldFromJSON( +export function getIntegrationsIntegrationIdPositiveResponseReadModelFieldFromJSON( jsonString: string, ): SafeParseResult< - GetIntegrationsIntegrationIdPositiveResponseField, + GetIntegrationsIntegrationIdPositiveResponseReadModelField, SDKValidationError > { return safeParse( jsonString, (x) => - GetIntegrationsIntegrationIdPositiveResponseField$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'GetIntegrationsIntegrationIdPositiveResponseField' from JSON`, + GetIntegrationsIntegrationIdPositiveResponseReadModelField$inboundSchema + .parse(JSON.parse(x)), + `Failed to parse 'GetIntegrationsIntegrationIdPositiveResponseReadModelField' from JSON`, ); } @@ -457,12 +607,12 @@ export const GetIntegrationsIntegrationIdPositiveResponseReadModel$inboundSchema label: z.string(), is_available: z.boolean(), coverage_status: - GetIntegrationsIntegrationIdPositiveResponseCoverageStatus$inboundSchema, - scope_config_setting: ScopeConfigSetting$inboundSchema, + GetIntegrationsIntegrationIdPositiveResponseReadModelCoverageStatus$inboundSchema, + scope_config_setting: ReadModelScopeConfigSetting$inboundSchema, opted_out_by_customer: z.boolean(), fields: z.array( z.lazy(() => - GetIntegrationsIntegrationIdPositiveResponseField$inboundSchema + GetIntegrationsIntegrationIdPositiveResponseReadModelField$inboundSchema ), ), }); @@ -483,6 +633,91 @@ export function getIntegrationsIntegrationIdPositiveResponseReadModelFromJSON( ); } +/** @internal */ +export const GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus$inboundSchema: + z.ZodNativeEnum< + typeof GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus + > = z.nativeEnum( + GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus, + ); + +/** @internal */ +export const WriteActionScopeConfigSetting$inboundSchema: z.ZodNativeEnum< + typeof WriteActionScopeConfigSetting +> = z.nativeEnum(WriteActionScopeConfigSetting); + +/** @internal */ +export const GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus$inboundSchema: + z.ZodNativeEnum< + typeof GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus + > = z.nativeEnum( + GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus, + ); + +/** @internal */ +export const GetIntegrationsIntegrationIdPositiveResponseWriteActionField$inboundSchema: + z.ZodType< + GetIntegrationsIntegrationIdPositiveResponseWriteActionField, + z.ZodTypeDef, + unknown + > = z.object({ + id: z.string(), + is_available: z.boolean(), + coverage_status: + GetIntegrationsIntegrationIdPositiveResponseWriteActionFieldCoverageStatus$inboundSchema, + }); + +export function getIntegrationsIntegrationIdPositiveResponseWriteActionFieldFromJSON( + jsonString: string, +): SafeParseResult< + GetIntegrationsIntegrationIdPositiveResponseWriteActionField, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + GetIntegrationsIntegrationIdPositiveResponseWriteActionField$inboundSchema + .parse(JSON.parse(x)), + `Failed to parse 'GetIntegrationsIntegrationIdPositiveResponseWriteActionField' from JSON`, + ); +} + +/** @internal */ +export const GetIntegrationsIntegrationIdPositiveResponseWriteAction$inboundSchema: + z.ZodType< + GetIntegrationsIntegrationIdPositiveResponseWriteAction, + z.ZodTypeDef, + unknown + > = z.object({ + id: z.string(), + label: z.string(), + is_available: z.boolean(), + coverage_status: + GetIntegrationsIntegrationIdPositiveResponseWriteActionCoverageStatus$inboundSchema, + scope_config_setting: WriteActionScopeConfigSetting$inboundSchema, + opted_out_by_customer: z.boolean(), + fields: z.array( + z.lazy(() => + GetIntegrationsIntegrationIdPositiveResponseWriteActionField$inboundSchema + ), + ), + }); + +export function getIntegrationsIntegrationIdPositiveResponseWriteActionFromJSON( + jsonString: string, +): SafeParseResult< + GetIntegrationsIntegrationIdPositiveResponseWriteAction, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + GetIntegrationsIntegrationIdPositiveResponseWriteAction$inboundSchema + .parse(JSON.parse(x)), + `Failed to parse 'GetIntegrationsIntegrationIdPositiveResponseWriteAction' from JSON`, + ); +} + /** @internal */ export const GetIntegrationsIntegrationIdPositiveResponseData$inboundSchema: z.ZodType< @@ -512,6 +747,11 @@ export const GetIntegrationsIntegrationIdPositiveResponseData$inboundSchema: GetIntegrationsIntegrationIdPositiveResponseReadModel$inboundSchema ), ), + write_actions: z.array( + z.lazy(() => + GetIntegrationsIntegrationIdPositiveResponseWriteAction$inboundSchema + ), + ), }); export function getIntegrationsIntegrationIdPositiveResponseDataFromJSON( diff --git a/src/models/gettoolscategorypositiveresponse.ts b/src/models/gettoolscategorypositiveresponse.ts index 643b21b..8e65b7e 100644 --- a/src/models/gettoolscategorypositiveresponse.ts +++ b/src/models/gettoolscategorypositiveresponse.ts @@ -53,7 +53,7 @@ export type GetToolsCategoryPositiveResponseReadModelCoverageStatus = * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ -export const GetToolsCategoryPositiveResponseFieldCoverageStatus = { +export const GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus = { Supported: "SUPPORTED", Unsupported: "UNSUPPORTED", NotImplemented: "NOT_IMPLEMENTED", @@ -69,11 +69,12 @@ export const GetToolsCategoryPositiveResponseFieldCoverageStatus = { * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ -export type GetToolsCategoryPositiveResponseFieldCoverageStatus = ClosedEnum< - typeof GetToolsCategoryPositiveResponseFieldCoverageStatus ->; +export type GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus = + ClosedEnum< + typeof GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus + >; -export type GetToolsCategoryPositiveResponseField = { +export type GetToolsCategoryPositiveResponseReadModelField = { /** * Key of the field in the model (e.g. first_name). */ @@ -88,7 +89,7 @@ export type GetToolsCategoryPositiveResponseField = { * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ - coverage_status: GetToolsCategoryPositiveResponseFieldCoverageStatus; + coverage_status: GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus; }; /** @@ -114,7 +115,7 @@ export type GetToolsCategoryPositiveResponseReadModel = { * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ coverage_status: GetToolsCategoryPositiveResponseReadModelCoverageStatus; - fields: Array; + fields: Array; }; /** @@ -127,7 +128,7 @@ export type GetToolsCategoryPositiveResponseReadModel = { * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ -export const WriteActionCoverageStatus = { +export const GetToolsCategoryPositiveResponseWriteActionCoverageStatus = { Supported: "SUPPORTED", Unsupported: "UNSUPPORTED", NotImplemented: "NOT_IMPLEMENTED", @@ -143,14 +144,63 @@ export const WriteActionCoverageStatus = { * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ -export type WriteActionCoverageStatus = ClosedEnum< - typeof WriteActionCoverageStatus ->; +export type GetToolsCategoryPositiveResponseWriteActionCoverageStatus = + ClosedEnum; + +/** + * The status of a datapoint of an integrated tool: + * + * @remarks + * + * - `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. + * - `UNSUPPORTED`: the tool does not support the datapoint. + * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). + * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + */ +export const GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus = { + Supported: "SUPPORTED", + Unsupported: "UNSUPPORTED", + NotImplemented: "NOT_IMPLEMENTED", + Unknown: "UNKNOWN", +} as const; +/** + * The status of a datapoint of an integrated tool: + * + * @remarks + * + * - `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. + * - `UNSUPPORTED`: the tool does not support the datapoint. + * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). + * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + */ +export type GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus = + ClosedEnum< + typeof GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus + >; + +export type GetToolsCategoryPositiveResponseWriteActionField = { + /** + * Key of the input field (e.g. `candidate.first_name`). + */ + id: string; + /** + * The status of a datapoint of an integrated tool: + * + * @remarks + * + * - `SUPPORTED`: the tool supports the datapoint and it can be used through Kombo. + * - `UNSUPPORTED`: the tool does not support the datapoint. + * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). + * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. + */ + coverage_status: + GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus; +}; /** * List of supported write actions for this tool. */ -export type WriteAction = { +export type GetToolsCategoryPositiveResponseWriteAction = { id: string; label: string; /** @@ -163,7 +213,8 @@ export type WriteAction = { * - `NOT_IMPLEMENTED`: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid). * - `UNKNOWN`: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool. */ - coverage_status: WriteActionCoverageStatus; + coverage_status: GetToolsCategoryPositiveResponseWriteActionCoverageStatus; + fields: Array; }; /** @@ -215,7 +266,7 @@ export type Feature = { */ export type Coverage = { read_models: Array; - write_actions: Array; + write_actions: Array; features: Array; }; @@ -283,29 +334,38 @@ export const GetToolsCategoryPositiveResponseReadModelCoverageStatus$inboundSche > = z.nativeEnum(GetToolsCategoryPositiveResponseReadModelCoverageStatus); /** @internal */ -export const GetToolsCategoryPositiveResponseFieldCoverageStatus$inboundSchema: - z.ZodNativeEnum = - z.nativeEnum(GetToolsCategoryPositiveResponseFieldCoverageStatus); +export const GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus$inboundSchema: + z.ZodNativeEnum< + typeof GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus + > = z.nativeEnum( + GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus, + ); /** @internal */ -export const GetToolsCategoryPositiveResponseField$inboundSchema: z.ZodType< - GetToolsCategoryPositiveResponseField, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - coverage_status: - GetToolsCategoryPositiveResponseFieldCoverageStatus$inboundSchema, -}); +export const GetToolsCategoryPositiveResponseReadModelField$inboundSchema: + z.ZodType< + GetToolsCategoryPositiveResponseReadModelField, + z.ZodTypeDef, + unknown + > = z.object({ + id: z.string(), + coverage_status: + GetToolsCategoryPositiveResponseReadModelFieldCoverageStatus$inboundSchema, + }); -export function getToolsCategoryPositiveResponseFieldFromJSON( +export function getToolsCategoryPositiveResponseReadModelFieldFromJSON( jsonString: string, -): SafeParseResult { +): SafeParseResult< + GetToolsCategoryPositiveResponseReadModelField, + SDKValidationError +> { return safeParse( jsonString, (x) => - GetToolsCategoryPositiveResponseField$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'GetToolsCategoryPositiveResponseField' from JSON`, + GetToolsCategoryPositiveResponseReadModelField$inboundSchema.parse( + JSON.parse(x), + ), + `Failed to parse 'GetToolsCategoryPositiveResponseReadModelField' from JSON`, ); } @@ -320,7 +380,7 @@ export const GetToolsCategoryPositiveResponseReadModel$inboundSchema: z.ZodType< coverage_status: GetToolsCategoryPositiveResponseReadModelCoverageStatus$inboundSchema, fields: z.array( - z.lazy(() => GetToolsCategoryPositiveResponseField$inboundSchema), + z.lazy(() => GetToolsCategoryPositiveResponseReadModelField$inboundSchema), ), }); @@ -341,28 +401,78 @@ export function getToolsCategoryPositiveResponseReadModelFromJSON( } /** @internal */ -export const WriteActionCoverageStatus$inboundSchema: z.ZodNativeEnum< - typeof WriteActionCoverageStatus -> = z.nativeEnum(WriteActionCoverageStatus); +export const GetToolsCategoryPositiveResponseWriteActionCoverageStatus$inboundSchema: + z.ZodNativeEnum< + typeof GetToolsCategoryPositiveResponseWriteActionCoverageStatus + > = z.nativeEnum(GetToolsCategoryPositiveResponseWriteActionCoverageStatus); /** @internal */ -export const WriteAction$inboundSchema: z.ZodType< - WriteAction, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - label: z.string(), - coverage_status: WriteActionCoverageStatus$inboundSchema, -}); +export const GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus$inboundSchema: + z.ZodNativeEnum< + typeof GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus + > = z.nativeEnum( + GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus, + ); -export function writeActionFromJSON( +/** @internal */ +export const GetToolsCategoryPositiveResponseWriteActionField$inboundSchema: + z.ZodType< + GetToolsCategoryPositiveResponseWriteActionField, + z.ZodTypeDef, + unknown + > = z.object({ + id: z.string(), + coverage_status: + GetToolsCategoryPositiveResponseWriteActionFieldCoverageStatus$inboundSchema, + }); + +export function getToolsCategoryPositiveResponseWriteActionFieldFromJSON( jsonString: string, -): SafeParseResult { +): SafeParseResult< + GetToolsCategoryPositiveResponseWriteActionField, + SDKValidationError +> { return safeParse( jsonString, - (x) => WriteAction$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'WriteAction' from JSON`, + (x) => + GetToolsCategoryPositiveResponseWriteActionField$inboundSchema.parse( + JSON.parse(x), + ), + `Failed to parse 'GetToolsCategoryPositiveResponseWriteActionField' from JSON`, + ); +} + +/** @internal */ +export const GetToolsCategoryPositiveResponseWriteAction$inboundSchema: + z.ZodType< + GetToolsCategoryPositiveResponseWriteAction, + z.ZodTypeDef, + unknown + > = z.object({ + id: z.string(), + label: z.string(), + coverage_status: + GetToolsCategoryPositiveResponseWriteActionCoverageStatus$inboundSchema, + fields: z.array( + z.lazy(() => + GetToolsCategoryPositiveResponseWriteActionField$inboundSchema + ), + ), + }); + +export function getToolsCategoryPositiveResponseWriteActionFromJSON( + jsonString: string, +): SafeParseResult< + GetToolsCategoryPositiveResponseWriteAction, + SDKValidationError +> { + return safeParse( + jsonString, + (x) => + GetToolsCategoryPositiveResponseWriteAction$inboundSchema.parse( + JSON.parse(x), + ), + `Failed to parse 'GetToolsCategoryPositiveResponseWriteAction' from JSON`, ); } @@ -398,7 +508,9 @@ export const Coverage$inboundSchema: z.ZodType< read_models: z.array( z.lazy(() => GetToolsCategoryPositiveResponseReadModel$inboundSchema), ), - write_actions: z.array(z.lazy(() => WriteAction$inboundSchema)), + write_actions: z.array( + z.lazy(() => GetToolsCategoryPositiveResponseWriteAction$inboundSchema), + ), features: z.array(z.lazy(() => Feature$inboundSchema)), }); diff --git a/src/models/inlineassessmentorderreceivedwebhookpayload.ts b/src/models/inlineassessmentorderreceivedwebhookpayload.ts index 8e5dddf..de1f100 100644 --- a/src/models/inlineassessmentorderreceivedwebhookpayload.ts +++ b/src/models/inlineassessmentorderreceivedwebhookpayload.ts @@ -41,6 +41,10 @@ export type InlineAssessmentOrderReceivedWebhookPayloadStatus = ClosedEnum< * Information about the candidate taking the assessment. */ export type InlineAssessmentOrderReceivedWebhookPayloadCandidate = { + /** + * The candidate's identifier in the integrated system. + */ + remote_id?: string | null | undefined; /** * The candidate's email address. */ @@ -57,10 +61,6 @@ export type InlineAssessmentOrderReceivedWebhookPayloadCandidate = { * The candidate's phone number. */ phone?: string | null | undefined; - /** - * The candidate's identifier in the integrated system. - */ - remote_id?: string | null | undefined; }; /** @@ -223,19 +223,19 @@ export const InlineAssessmentOrderReceivedWebhookPayloadCandidate$inboundSchema: z.ZodTypeDef, unknown > = z.object({ + remote_id: z.nullable(z.string()).optional(), email: z.string(), first_name: z.nullable(z.string()).optional(), last_name: z.nullable(z.string()).optional(), phone: z.nullable(z.string()).optional(), - remote_id: z.nullable(z.string()).optional(), }); /** @internal */ export type InlineAssessmentOrderReceivedWebhookPayloadCandidate$Outbound = { + remote_id?: string | null | undefined; email: string; first_name?: string | null | undefined; last_name?: string | null | undefined; phone?: string | null | undefined; - remote_id?: string | null | undefined; }; /** @internal */ @@ -245,11 +245,11 @@ export const InlineAssessmentOrderReceivedWebhookPayloadCandidate$outboundSchema z.ZodTypeDef, InlineAssessmentOrderReceivedWebhookPayloadCandidate > = z.object({ + remote_id: z.nullable(z.string()).optional(), email: z.string(), first_name: z.nullable(z.string()).optional(), last_name: z.nullable(z.string()).optional(), phone: z.nullable(z.string()).optional(), - remote_id: z.nullable(z.string()).optional(), }); export function inlineAssessmentOrderReceivedWebhookPayloadCandidateToJSON( diff --git a/src/models/postatscandidatesrequestbody.ts b/src/models/postatscandidatesrequestbody.ts index ad5281c..92090d2 100644 --- a/src/models/postatscandidatesrequestbody.ts +++ b/src/models/postatscandidatesrequestbody.ts @@ -826,6 +826,16 @@ export type PostAtsCandidatesRequestBodyPiloga = { candidate?: PostAtsCandidatesRequestBodyPilogaCandidate | undefined; }; +/** + * Fields specific to Pinpoint. + */ +export type PostAtsCandidatesRequestBodyPinpoint = { + /** + * Fields that we will pass through to Pinpoint's `Candidate` object. + */ + candidate?: { [k: string]: any } | undefined; +}; + /** * Additional fields that we will pass through to specific ATS systems. */ @@ -907,6 +917,10 @@ export type PostAtsCandidatesRequestBodyRemoteFields = { * Fields specific to P&I Loga. */ piloga?: PostAtsCandidatesRequestBodyPiloga | undefined; + /** + * Fields specific to Pinpoint. + */ + pinpoint?: PostAtsCandidatesRequestBodyPinpoint | undefined; }; export type PostAtsCandidatesRequestBody = { @@ -3076,6 +3090,30 @@ export function postAtsCandidatesRequestBodyPilogaToJSON( ); } +/** @internal */ +export type PostAtsCandidatesRequestBodyPinpoint$Outbound = { + candidate?: { [k: string]: any } | undefined; +}; + +/** @internal */ +export const PostAtsCandidatesRequestBodyPinpoint$outboundSchema: z.ZodType< + PostAtsCandidatesRequestBodyPinpoint$Outbound, + z.ZodTypeDef, + PostAtsCandidatesRequestBodyPinpoint +> = z.object({ + candidate: z.record(z.any()).optional(), +}); + +export function postAtsCandidatesRequestBodyPinpointToJSON( + postAtsCandidatesRequestBodyPinpoint: PostAtsCandidatesRequestBodyPinpoint, +): string { + return JSON.stringify( + PostAtsCandidatesRequestBodyPinpoint$outboundSchema.parse( + postAtsCandidatesRequestBodyPinpoint, + ), + ); +} + /** @internal */ export type PostAtsCandidatesRequestBodyRemoteFields$Outbound = { successfactors?: @@ -3102,6 +3140,7 @@ export type PostAtsCandidatesRequestBodyRemoteFields$Outbound = { recruitee?: PostAtsCandidatesRequestBodyRecruitee$Outbound | undefined; umantis?: PostAtsCandidatesRequestBodyUmantis$Outbound | undefined; piloga?: PostAtsCandidatesRequestBodyPiloga$Outbound | undefined; + pinpoint?: PostAtsCandidatesRequestBodyPinpoint$Outbound | undefined; }; /** @internal */ @@ -3157,6 +3196,8 @@ export const PostAtsCandidatesRequestBodyRemoteFields$outboundSchema: z.ZodType< .optional(), piloga: z.lazy(() => PostAtsCandidatesRequestBodyPiloga$outboundSchema) .optional(), + pinpoint: z.lazy(() => PostAtsCandidatesRequestBodyPinpoint$outboundSchema) + .optional(), }); export function postAtsCandidatesRequestBodyRemoteFieldsToJSON( diff --git a/src/models/postatsjobsjobidapplicationsrequestbody.ts b/src/models/postatsjobsjobidapplicationsrequestbody.ts index 4d2adc8..dcc6695 100644 --- a/src/models/postatsjobsjobidapplicationsrequestbody.ts +++ b/src/models/postatsjobsjobidapplicationsrequestbody.ts @@ -748,6 +748,16 @@ export type PostAtsJobsJobIdApplicationsRequestBodyPiloga = { | undefined; }; +/** + * Fields specific to Pinpoint. + */ +export type PostAtsJobsJobIdApplicationsRequestBodyPinpoint = { + /** + * Fields that we will pass through to Pinpoint's `Candidate` object. + */ + candidate?: { [k: string]: any } | undefined; +}; + /** * Additional fields that we will pass through to specific ATS systems. */ @@ -833,6 +843,10 @@ export type PostAtsJobsJobIdApplicationsRequestBodyRemoteFields = { * Fields specific to P&I Loga. */ piloga?: PostAtsJobsJobIdApplicationsRequestBodyPiloga | undefined; + /** + * Fields specific to Pinpoint. + */ + pinpoint?: PostAtsJobsJobIdApplicationsRequestBodyPinpoint | undefined; }; /** @@ -3078,6 +3092,32 @@ export function postAtsJobsJobIdApplicationsRequestBodyPilogaToJSON( ); } +/** @internal */ +export type PostAtsJobsJobIdApplicationsRequestBodyPinpoint$Outbound = { + candidate?: { [k: string]: any } | undefined; +}; + +/** @internal */ +export const PostAtsJobsJobIdApplicationsRequestBodyPinpoint$outboundSchema: + z.ZodType< + PostAtsJobsJobIdApplicationsRequestBodyPinpoint$Outbound, + z.ZodTypeDef, + PostAtsJobsJobIdApplicationsRequestBodyPinpoint + > = z.object({ + candidate: z.record(z.any()).optional(), + }); + +export function postAtsJobsJobIdApplicationsRequestBodyPinpointToJSON( + postAtsJobsJobIdApplicationsRequestBodyPinpoint: + PostAtsJobsJobIdApplicationsRequestBodyPinpoint, +): string { + return JSON.stringify( + PostAtsJobsJobIdApplicationsRequestBodyPinpoint$outboundSchema.parse( + postAtsJobsJobIdApplicationsRequestBodyPinpoint, + ), + ); +} + /** @internal */ export type PostAtsJobsJobIdApplicationsRequestBodyRemoteFields$Outbound = { successfactors?: @@ -3124,6 +3164,9 @@ export type PostAtsJobsJobIdApplicationsRequestBodyRemoteFields$Outbound = { | undefined; umantis?: PostAtsJobsJobIdApplicationsRequestBodyUmantis$Outbound | undefined; piloga?: PostAtsJobsJobIdApplicationsRequestBodyPiloga$Outbound | undefined; + pinpoint?: + | PostAtsJobsJobIdApplicationsRequestBodyPinpoint$Outbound + | undefined; }; /** @internal */ @@ -3193,6 +3236,9 @@ export const PostAtsJobsJobIdApplicationsRequestBodyRemoteFields$outboundSchema: piloga: z.lazy(() => PostAtsJobsJobIdApplicationsRequestBodyPiloga$outboundSchema ).optional(), + pinpoint: z.lazy(() => + PostAtsJobsJobIdApplicationsRequestBodyPinpoint$outboundSchema + ).optional(), }); export function postAtsJobsJobIdApplicationsRequestBodyRemoteFieldsToJSON( diff --git a/src/models/posthrisemployeesformpositiveresponse.ts b/src/models/posthrisemployeesformpositiveresponse.ts index a22def6..232b77e 100644 --- a/src/models/posthrisemployeesformpositiveresponse.ts +++ b/src/models/posthrisemployeesformpositiveresponse.ts @@ -7,19 +7,29 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * An object containing the temporary pre-hire information from the remote system. This ID may change or become invalid when the pre-hire becomes a full employee. Only populated when `id` is null. + */ +export type Prehire = { + /** + * The temporary ID returned by the remote system when creating a pre-hire. + */ + remote_id: string | null; +}; + export type PostHrisEmployeesFormPositiveResponseData = { /** * The Kombo id of the created employee. If null, we only created a pre-hire which shows up in the next sync after a successful onboarding. */ id: string | null; /** - * The raw ID of the created employee in the remote system. This is only populated when `id` is set (i.e., when a full employee was created). For pre-hires, use `prehire_id` instead. + * The raw ID of the created employee in the remote system. This is only populated when `id` is set (i.e., when a full employee was created). For pre-hires, use the `prehire` object instead. */ remote_id: string | null; /** - * The temporary ID returned by the remote system when creating a pre-hire. This ID may change or become invalid when the pre-hire becomes a full employee. Only populated when `id` is null. + * An object containing the temporary pre-hire information from the remote system. This ID may change or become invalid when the pre-hire becomes a full employee. Only populated when `id` is null. */ - prehire_id: string | null; + prehire: Prehire; }; export type PostHrisEmployeesFormPositiveResponseWarning = { @@ -35,6 +45,22 @@ export type PostHrisEmployeesFormPositiveResponse = { warnings: Array; }; +/** @internal */ +export const Prehire$inboundSchema: z.ZodType = + z.object({ + remote_id: z.nullable(z.string()), + }); + +export function prehireFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => Prehire$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'Prehire' from JSON`, + ); +} + /** @internal */ export const PostHrisEmployeesFormPositiveResponseData$inboundSchema: z.ZodType< PostHrisEmployeesFormPositiveResponseData, @@ -43,7 +69,7 @@ export const PostHrisEmployeesFormPositiveResponseData$inboundSchema: z.ZodType< > = z.object({ id: z.nullable(z.string()), remote_id: z.nullable(z.string()), - prehire_id: z.nullable(z.string()), + prehire: z.lazy(() => Prehire$inboundSchema), }); export function postHrisEmployeesFormPositiveResponseDataFromJSON( diff --git a/src/models/putassessmentordersassessmentorderidresultrequestbody.ts b/src/models/putassessmentordersassessmentorderidresultrequestbody.ts index a50a237..23b34b3 100644 --- a/src/models/putassessmentordersassessmentorderidresultrequestbody.ts +++ b/src/models/putassessmentordersassessmentorderidresultrequestbody.ts @@ -55,7 +55,7 @@ export type AttributeText = { value: string; }; -export type Attribute = AttributeSubResult | AttributeText; +export type Attribute = AttributeText | AttributeSubResult; export type PutAssessmentOrdersAssessmentOrderIdResultRequestBodyAttachment = { /** @@ -137,7 +137,7 @@ export type PutAssessmentOrdersAssessmentOrderIdResultRequestBody = { * * - If an ATS only supports writing text attributes, we will transform non `TEXT` attributes into formatted plain text values. */ - attributes?: Array | undefined; + attributes?: Array | undefined; /** * An array of attachments containing the assessment result. */ @@ -237,8 +237,8 @@ export function attributeTextToJSON(attributeText: AttributeText): string { /** @internal */ export type Attribute$Outbound = - | AttributeSubResult$Outbound - | AttributeText$Outbound; + | AttributeText$Outbound + | AttributeSubResult$Outbound; /** @internal */ export const Attribute$outboundSchema: z.ZodType< @@ -246,8 +246,8 @@ export const Attribute$outboundSchema: z.ZodType< z.ZodTypeDef, Attribute > = z.union([ - z.lazy(() => AttributeSubResult$outboundSchema), z.lazy(() => AttributeText$outboundSchema), + z.lazy(() => AttributeSubResult$outboundSchema), ]); export function attributeToJSON(attribute: Attribute): string { @@ -356,7 +356,7 @@ export type PutAssessmentOrdersAssessmentOrderIdResultRequestBody$Outbound = { score?: number | undefined; max_score?: number | undefined; attributes?: - | Array + | Array | undefined; attachments?: | Array< @@ -383,8 +383,8 @@ export const PutAssessmentOrdersAssessmentOrderIdResultRequestBody$outboundSchem max_score: z.number().optional(), attributes: z.array( z.union([ - z.lazy(() => AttributeSubResult$outboundSchema), z.lazy(() => AttributeText$outboundSchema), + z.lazy(() => AttributeSubResult$outboundSchema), ]), ).optional(), attachments: z.array( diff --git a/src/models/schema1union1.ts b/src/models/schema1union1.ts index 00c74d0..37049b0 100644 --- a/src/models/schema1union1.ts +++ b/src/models/schema1union1.ts @@ -340,15 +340,15 @@ export type Schema1Text = { }; export type Schema1Union1 = + | Schema1Text + | Schema1Number + | Schema1Date | Schema1SingleSelect | Schema1MultiSelect + | Schema1Checkbox | Schema1Object | Schema1Array1 - | Schema1File - | Schema1Text - | Schema1Number - | Schema1Date - | Schema1Checkbox; + | Schema1File; /** @internal */ export const Schema1UnifiedKey8$inboundSchema: z.ZodNativeEnum< @@ -841,15 +841,15 @@ export const Schema1Union1$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.union([ + z.lazy(() => Schema1Text$inboundSchema), + z.lazy(() => Schema1Number$inboundSchema), + z.lazy(() => Schema1Date$inboundSchema), z.lazy(() => Schema1SingleSelect$inboundSchema), z.lazy(() => Schema1MultiSelect$inboundSchema), + z.lazy(() => Schema1Checkbox$inboundSchema), z.lazy(() => Schema1Object$inboundSchema), z.lazy(() => Schema1Array1$inboundSchema), z.lazy(() => Schema1File$inboundSchema), - z.lazy(() => Schema1Text$inboundSchema), - z.lazy(() => Schema1Number$inboundSchema), - z.lazy(() => Schema1Date$inboundSchema), - z.lazy(() => Schema1Checkbox$inboundSchema), ]); export function schema1Union1FromJSON( diff --git a/src/models/schema1union2.ts b/src/models/schema1union2.ts index e969882..dbc7704 100644 --- a/src/models/schema1union2.ts +++ b/src/models/schema1union2.ts @@ -29,15 +29,15 @@ import { import { Schema2Union2, Schema2Union2$inboundSchema } from "./schema2union2.js"; export type Schema1Union2 = + | Schema1Text + | Schema1Number + | Schema1Date | Schema1SingleSelect | Schema1MultiSelect + | Schema1Checkbox | Schema1Object | Schema1Array2 - | Schema1File - | Schema1Text - | Schema1Number - | Schema1Date - | Schema1Checkbox; + | Schema1File; export type Schema1Array2 = { label: string; @@ -56,15 +56,15 @@ export const Schema1Union2$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.union([ + Schema1Text$inboundSchema, + Schema1Number$inboundSchema, + Schema1Date$inboundSchema, Schema1SingleSelect$inboundSchema, Schema1MultiSelect$inboundSchema, + Schema1Checkbox$inboundSchema, Schema1Object$inboundSchema, z.lazy(() => Schema1Array2$inboundSchema), Schema1File$inboundSchema, - Schema1Text$inboundSchema, - Schema1Number$inboundSchema, - Schema1Date$inboundSchema, - Schema1Checkbox$inboundSchema, ]); export function schema1Union2FromJSON( diff --git a/src/models/schema2union1.ts b/src/models/schema2union1.ts index b7cee78..f59c76e 100644 --- a/src/models/schema2union1.ts +++ b/src/models/schema2union1.ts @@ -328,15 +328,15 @@ export type Schema2Object1 = { }; export type Schema2Union1 = + | Schema2Text + | Schema2Number + | Schema2Date | Schema2SingleSelect | Schema2MultiSelect + | Schema2Checkbox | Schema2Object1 | Schema2Array1 - | Schema2File - | Schema2Text - | Schema2Number - | Schema2Date - | Schema2Checkbox; + | Schema2File; export type Schema2Array1 = { label: string; @@ -345,15 +345,15 @@ export type Schema2Array1 = { unified_key?: Schema2UnifiedKey7 | null | undefined; type: "array"; item_type: + | Schema2Text + | Schema2Number + | Schema2Date | Schema2SingleSelect | Schema2MultiSelect + | Schema2Checkbox | Schema2Object1 | Schema2Array1 - | Schema2File - | Schema2Text - | Schema2Number - | Schema2Date - | Schema2Checkbox; + | Schema2File; min_items?: number | null | undefined; max_items?: number | null | undefined; }; @@ -823,15 +823,15 @@ export const Schema2Union1$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.union([ + z.lazy(() => Schema2Text$inboundSchema), + z.lazy(() => Schema2Number$inboundSchema), + z.lazy(() => Schema2Date$inboundSchema), z.lazy(() => Schema2SingleSelect$inboundSchema), z.lazy(() => Schema2MultiSelect$inboundSchema), + z.lazy(() => Schema2Checkbox$inboundSchema), z.lazy(() => Schema2Object1$inboundSchema), z.lazy(() => Schema2Array1$inboundSchema), z.lazy(() => Schema2File$inboundSchema), - z.lazy(() => Schema2Text$inboundSchema), - z.lazy(() => Schema2Number$inboundSchema), - z.lazy(() => Schema2Date$inboundSchema), - z.lazy(() => Schema2Checkbox$inboundSchema), ]); export function schema2Union1FromJSON( @@ -856,15 +856,15 @@ export const Schema2Array1$inboundSchema: z.ZodType< unified_key: z.nullable(Schema2UnifiedKey7$inboundSchema).optional(), type: z.literal("array"), item_type: z.union([ + z.lazy(() => Schema2Text$inboundSchema), + z.lazy(() => Schema2Number$inboundSchema), + z.lazy(() => Schema2Date$inboundSchema), z.lazy(() => Schema2SingleSelect$inboundSchema), z.lazy(() => Schema2MultiSelect$inboundSchema), + z.lazy(() => Schema2Checkbox$inboundSchema), z.lazy(() => Schema2Object1$inboundSchema), z.lazy(() => Schema2Array1$inboundSchema), z.lazy(() => Schema2File$inboundSchema), - z.lazy(() => Schema2Text$inboundSchema), - z.lazy(() => Schema2Number$inboundSchema), - z.lazy(() => Schema2Date$inboundSchema), - z.lazy(() => Schema2Checkbox$inboundSchema), ]), min_items: z.nullable(z.number()).optional(), max_items: z.nullable(z.number()).optional(), diff --git a/src/models/schema2union2.ts b/src/models/schema2union2.ts index 6d348ef..bd87819 100644 --- a/src/models/schema2union2.ts +++ b/src/models/schema2union2.ts @@ -38,15 +38,15 @@ export type Schema2Object2 = { }; export type Schema2Union2 = + | Schema2Text + | Schema2Number + | Schema2Date | Schema2SingleSelect | Schema2MultiSelect + | Schema2Checkbox | Schema2Object2 | Schema2Array2 - | Schema2File - | Schema2Text - | Schema2Number - | Schema2Date - | Schema2Checkbox; + | Schema2File; export type Schema2Array2 = { label: string; @@ -55,15 +55,15 @@ export type Schema2Array2 = { unified_key?: Schema2UnifiedKey7 | null | undefined; type: "array"; item_type: + | Schema2Text + | Schema2Number + | Schema2Date | Schema2SingleSelect | Schema2MultiSelect + | Schema2Checkbox | Schema2Object2 | Schema2Array2 - | Schema2File - | Schema2Text - | Schema2Number - | Schema2Date - | Schema2Checkbox; + | Schema2File; min_items?: number | null | undefined; max_items?: number | null | undefined; }; @@ -98,15 +98,15 @@ export const Schema2Union2$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.union([ + Schema2Text$inboundSchema, + Schema2Number$inboundSchema, + Schema2Date$inboundSchema, Schema2SingleSelect$inboundSchema, Schema2MultiSelect$inboundSchema, + Schema2Checkbox$inboundSchema, z.lazy(() => Schema2Object2$inboundSchema), z.lazy(() => Schema2Array2$inboundSchema), Schema2File$inboundSchema, - Schema2Text$inboundSchema, - Schema2Number$inboundSchema, - Schema2Date$inboundSchema, - Schema2Checkbox$inboundSchema, ]); export function schema2Union2FromJSON( @@ -131,15 +131,15 @@ export const Schema2Array2$inboundSchema: z.ZodType< unified_key: z.nullable(Schema2UnifiedKey7$inboundSchema).optional(), type: z.literal("array"), item_type: z.union([ + Schema2Text$inboundSchema, + Schema2Number$inboundSchema, + Schema2Date$inboundSchema, Schema2SingleSelect$inboundSchema, Schema2MultiSelect$inboundSchema, + Schema2Checkbox$inboundSchema, z.lazy(() => Schema2Object2$inboundSchema), z.lazy(() => Schema2Array2$inboundSchema), Schema2File$inboundSchema, - Schema2Text$inboundSchema, - Schema2Number$inboundSchema, - Schema2Date$inboundSchema, - Schema2Checkbox$inboundSchema, ]), min_items: z.nullable(z.number()).optional(), max_items: z.nullable(z.number()).optional(), diff --git a/src/sdk/general.ts b/src/sdk/general.ts index cad8f33..bb4bbd8 100644 --- a/src/sdk/general.ts +++ b/src/sdk/general.ts @@ -175,6 +175,7 @@ export class General extends ClientSDK { * |BITE|`bite/v1`|[Bite's v1 API](https://api.b-ite.io/docs/#/). We automatically authenticate all requests and use 'https://api.b-ite.io/v1' as base URL.| * |Zelt|`zelt/partner`|Zelt's [Partner API](https://go.zelt.app/apiv2/swagger). We automatically authenticate all requests using the connected OAuth credentials and use `https://go.zelt.app/apiv2/partner` as the base URL.| * |Planday|`planday/api`|Planday's [HR API v1.0](https://openapi.planday.com/api/hr?version=v1.0). We automatically authenticate all requests and use `https://openapi.planday.com` as the base URL.| + * |BoondManager|`boondmanager/api`|BoondManager [REST API](https://ui.boondmanager.com/administrator/developer/apisandbox). We automatically authenticate all requests and use `https://ui.boondmanager.com/api` as the base URL.| * |Hailey HR|`haileyhr/api`|Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL.| * |Silae|`silae/rest`|[Silae's REST API](https://silae-api.document360.io/docs). We automatically authenticate all requests and use 'https://payroll-api.silae.fr/payroll' as the base URL.| * |Mysolution|`mysolution/default`|[Mysolution's API](https://swagger.mysolution.nl/). We automatically authenticate all requests and use the customer's domain as base URL.| diff --git a/src/types/unrecognized.ts b/src/types/unrecognized.ts index 08227f2..b7a2a13 100644 --- a/src/types/unrecognized.ts +++ b/src/types/unrecognized.ts @@ -16,8 +16,16 @@ export function startCountingUnrecognized() { refCount++; const start = globalCount; return { - end: () => { + /** + * Ends counting and returns the delta. + * @param delta - If provided, only this amount is added to the parent counter + * (used for nested unions where we only want to record the winning option's count). + * If not provided, records all counts since start(). + */ + end: (delta?: number) => { const count = globalCount - start; + // Reset globalCount back to start, then add only the specified delta + globalCount = start + (delta ?? count); if (--refCount === 0) globalCount = 0; return count; }, diff --git a/tsconfig.json b/tsconfig.json index 8a8858b..a9f80db 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,7 +1,6 @@ { "compilerOptions": { "incremental": true, - "tsBuildInfoFile": ".tsbuildinfo", "target": "ES2020", "lib": ["ES2022", "DOM", "DOM.Iterable"], "jsx": "react-jsx",