diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 74a91025..3dbadc19 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,20 +1,20 @@ lockVersion: 2.0.0 id: 7fa83af8-9e8e-4410-b7e2-cf1d0eaf688b management: - docChecksum: b7e066c5b3be81c2d8269a69257b8408 + docChecksum: 8b6de23c6d4626e6a540c61f90d4c04d docVersion: 1.0.0 - speakeasyVersion: 1.709.1 - generationVersion: 2.812.2 - releaseVersion: 4.34.0 - configChecksum: 8ef1f1c6848b6615ee4cc9fb7efbe307 + speakeasyVersion: 1.718.0 + generationVersion: 2.824.1 + releaseVersion: 4.34.1 + configChecksum: f658032e63a64c2c48390b93c8d3f2a0 repoURL: https://github.com/StackOneHQ/stackone-client-typescript.git repoSubDirectory: . installationURL: https://github.com/StackOneHQ/stackone-client-typescript published: true persistentEdits: - generation_id: 984af5da-b7bc-46a3-a1fb-99b1757401a9 - pristine_commit_hash: ac7fcda5999aa7eda678ff3c0c3528e5098c7a94 - pristine_tree_hash: 16be32ef0e73c8be3aaa7135ea762bf7af054845 + generation_id: 0b73bbf0-988b-4408-88e2-199761c42705 + pristine_commit_hash: 831d91fc6db32947ed50863da6cd424a5f21a7cc + pristine_tree_hash: 91016874c88ddbf2412c916ffc67c09b7c9aaeef features: typescript: acceptHeaders: 2.81.2 @@ -7739,8 +7739,8 @@ trackedFiles: pristine_git_object: 87b5a7495ef6119c368e2c6a9116afd410beb2ea docs/sdk/models/shared/linkedaccount.md: id: 75ce68768ccc - last_write_checksum: sha1:8971108f136137e632be89fdef3be23488d186cc - pristine_git_object: 556fb758000f6dd688249ad65b1e874d5e6352eb + last_write_checksum: sha1:118a9f9c8f173bfbcf4c9f0de7fbff0f474563ee + pristine_git_object: 4198c64266e2b48d874e316112c8b8eba97a8506 docs/sdk/models/shared/linkedaccountmeta.md: id: 80b01a0a27a3 last_write_checksum: sha1:bced5eba43128f6ae05c801832e20b75ff198783 @@ -8279,8 +8279,8 @@ trackedFiles: pristine_git_object: a7568cba2323751f4ae1760c4fe44336358d0580 docs/sdk/models/shared/patchaccountexternaldto.md: id: c82a303c1cfa - last_write_checksum: sha1:28812ef44fb8147d82a7b3bf1c35f3a8662250e8 - pristine_git_object: 0d4fdf86f7e79c4a57e89b362c370e3cad9fc3a3 + last_write_checksum: sha1:985f661976bc011d9d0d9e85a27675f43e0f742b + pristine_git_object: 53daa8ce31d724fa0449eff6b3228dc702f144fb docs/sdk/models/shared/patchaccountexternaldtocredentials.md: id: 386e12541cc7 last_write_checksum: sha1:ba4179e01db6fe7ad2c4948cfae0720ed75f671a @@ -9899,12 +9899,12 @@ trackedFiles: pristine_git_object: 59b07d716a5a829bb20315725a027a555c897fad jsr.json: id: 7f6ab7767282 - last_write_checksum: sha1:0002b801cc7bcf8205e6cc87cb256152e1c3da20 - pristine_git_object: 2200332d9d633ccb58a349b7f5e6702ee9f4ac9e + last_write_checksum: sha1:1022bf02ae01b6f7ac22d1d0d1503c50e24033f3 + pristine_git_object: 5cdef410f2eafbe07b41c575ceebed4c83d3ce80 package.json: id: 7030d0b2f71b - last_write_checksum: sha1:5c3e1753b86b725601fefad42f197a9da0d1deab - pristine_git_object: 13f36a38dc098864f85c4f18770ec26cd4a0d7a0 + last_write_checksum: sha1:10edc45d5d8ecc978e9f1436869fc57365d7693c + pristine_git_object: ec80113b0dc58925dd5c0fd586fe4826f46b472b src/core.ts: id: f431fdbcd144 last_write_checksum: sha1:548d01dbd4f51d5b691421fd49f593b899550bd5 @@ -11099,8 +11099,8 @@ trackedFiles: pristine_git_object: 0aebd8b0a4867e35cb3348fc52921c3c0b4725b7 src/lib/config.ts: id: 320761608fb3 - last_write_checksum: sha1:ebe1db48d76ffe04696284041f47040ebcf700a8 - pristine_git_object: 9c39d1b6fa6626aded41ec88aca80fdd7dae01be + last_write_checksum: sha1:a2f331c7683d0f83c58dd078e11d56a14bf804d7 + pristine_git_object: af37571f6537d08fc0d3f0046a1acb3d1a3f7c55 src/lib/dlv.ts: id: b1988214835a last_write_checksum: sha1:1dd3e3fbb4550c4bf31f5ef997faff355d6f3250 @@ -13471,8 +13471,8 @@ trackedFiles: pristine_git_object: 6346d54609ea1327e7a693242bc309ce9177d645 src/sdk/models/shared/linkedaccount.ts: id: 14871a94b1d1 - last_write_checksum: sha1:d5bce7a28848a40499d9f3b5cc74a3bb003a2fd2 - pristine_git_object: beabca362b603d49422207ec4a1ab5fb5e501b82 + last_write_checksum: sha1:6fb83434276d8c216170881d4b49e346edb351b0 + pristine_git_object: a1615272cd332b9706a90c02d5b38fdbbda5b3ab src/sdk/models/shared/linkedaccountmeta.ts: id: bf7414ca6d79 last_write_checksum: sha1:ece521411a46af410a1a4c4f54b32af3ce7e97f8 @@ -13643,8 +13643,8 @@ trackedFiles: pristine_git_object: 5ac959e6848b80f7f05cefe6102e8d8892f1904a src/sdk/models/shared/patchaccountexternaldto.ts: id: 4facd0f2ba62 - last_write_checksum: sha1:66614f67749c48841e37b2f2e0edda2d62e82c3f - pristine_git_object: 113d71de990091b6b4ff5af8d0cf6ed6cb4d4383 + last_write_checksum: sha1:0b1497d9000edc7888b79965190a2cfb9fd796cd + pristine_git_object: 8d4b84f5f1320a5c29f796cf776ac5971e0ce85e src/sdk/models/shared/phonenumber.ts: id: 8d3e3b17bfc0 last_write_checksum: sha1:48a4235f26646c390fb23f973d7739e43d636879 @@ -25665,7 +25665,7 @@ examples: application/json: {"message": "Bad Gateway", "statusCode": 502, "timestamp": "2023-05-30T00:00:00.000Z"} examplesVersion: 1.0.2 generatedTests: {} -releaseNotes: "## Typescript SDK Changes:\n* `stackone.actions.buildActionEmbeddings()`: `response` **Changed** (Breaking ⚠️)\n* `stackone.connectSessions.authenticateConnectSession()`: `response.organizationId` **Changed** (Breaking ⚠️)\n* `stackone.connectSessions.createConnectSession()`: `response.organizationId` **Changed** (Breaking ⚠️)\n* `stackone.actions.listActionsMeta()`: \n * `request.include` **Changed**\n * `response.data[].actions[].authentication[].support` **Added**\n" +releaseNotes: "## Typescript SDK Changes:\n* `stackone.accounts.deleteAccount()`: `response.shared` **Added**\n* `stackone.accounts.getAccount()`: `response.shared` **Added**\n* `stackone.accounts.listLinkedAccounts()`: `response.[].shared` **Added**\n* `stackone.accounts.updateAccount()`: \n * `request.patchAccountExternalDto.shared` **Added**\n * `response.shared` **Added**\n" generatedFiles: - .gitattributes - .npmignore diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index f473ce2a..9079769a 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.709.1 +speakeasyVersion: 1.718.0 sources: my-source: sourceNamespace: my-source - sourceRevisionDigest: sha256:5d51018e6191c7d8a81be97d7ce96e94001ee7a6f875d62c623ffb653528bec0 - sourceBlobDigest: sha256:7de4c3285442658014c21ce18cfc3295c11f98d999e7df9ce2c747f75c310e9d + sourceRevisionDigest: sha256:10795a3705f5d0ac43cb920fc6800c28483f6454314a5f98e3222828f92c3059 + sourceBlobDigest: sha256:a378d55f377d7ab6f9bc5fa00c896131fb5c8acdc2258552cbc96a7d4fc7b1c3 tags: - latest - - speakeasy-sdk-regen-1770024140 + - speakeasy-sdk-regen-1771233905 - 1.0.0 targets: StackOneTypeScriptClient: source: my-source sourceNamespace: my-source - sourceRevisionDigest: sha256:5d51018e6191c7d8a81be97d7ce96e94001ee7a6f875d62c623ffb653528bec0 - sourceBlobDigest: sha256:7de4c3285442658014c21ce18cfc3295c11f98d999e7df9ce2c747f75c310e9d + sourceRevisionDigest: sha256:10795a3705f5d0ac43cb920fc6800c28483f6454314a5f98e3222828f92c3059 + sourceBlobDigest: sha256:a378d55f377d7ab6f9bc5fa00c896131fb5c8acdc2258552cbc96a7d4fc7b1c3 codeSamplesNamespace: code-samples-typescript-stackonetypescriptclient - codeSamplesRevisionDigest: sha256:a0b27926e0456bcaa198f6b0fdf4a9868bb419696296a8efa19affa0e7139b93 + codeSamplesRevisionDigest: sha256:324820a77cef37b9bccb2777919da219b43da708095db8d874d27af3c4d3a234 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index fcc4eba0..a1099e13 100755 --- a/README.md +++ b/README.md @@ -7,7 +7,18 @@ ## Summary -Accounting: The documentation for the StackOne Unified API - ACCOUNTING +Accounting: The documentation for the StackOne API +The documentation for the StackOne Unified API - HRIS +The documentation for the StackOne Unified API - ATS +The documentation for the StackOne Unified API - CRM +The documentation for the StackOne Unified API - IAM +The documentation for the StackOne Unified API - MARKETING +The documentation for the StackOne Unified API - LMS +The documentation for the StackOne Unified API - TICKETING +The documentation for the StackOne Unified API - DOCUMENTS +The documentation for the StackOne Unified API - SCREENING +The documentation for the StackOne Unified API - MESSAGING +The documentation for the StackOne Unified API - ACCOUNTING @@ -614,19 +625,23 @@ The `HTTPClient` constructor takes an optional `fetcher` argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures. -The following example shows how to use the `"beforeRequest"` hook to to add a -custom header and a timeout to requests and how to use the `"requestError"` hook -to log errors: +The following example shows how to: +- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent +- use the `"beforeRequest"` hook to add a custom header and a timeout to requests +- use the `"requestError"` hook to log errors ```typescript import { StackOne } from "@stackone/stackone-client-ts"; +import { ProxyAgent } from "undici"; import { HTTPClient } from "@stackone/stackone-client-ts/lib/http"; +const dispatcher = new ProxyAgent("http://proxy.example.com:8080"); + const httpClient = new HTTPClient({ - // fetcher takes a function that has the same signature as native `fetch`. - fetcher: (request) => { - return fetch(request); - } + // 'fetcher' takes a function that has the same signature as native 'fetch'. + fetcher: (input, init) => + // 'dispatcher' is specific to undici and not part of the standard Fetch API. + fetch(input, { ...init, dispatcher } as RequestInit), }); httpClient.addHook("beforeRequest", (request) => { diff --git a/RELEASES.md b/RELEASES.md index 6507d898..3822af7e 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -2066,4 +2066,14 @@ Based on: ### Generated - [typescript v4.34.0] . ### Releases -- [NPM v4.34.0] https://www.npmjs.com/package/@stackone/stackone-client-ts/v/4.34.0 - . \ No newline at end of file +- [NPM v4.34.0] https://www.npmjs.com/package/@stackone/stackone-client-ts/v/4.34.0 - . + +## 2026-02-16 09:24:38 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.718.0 (2.824.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v4.34.1] . +### Releases +- [NPM v4.34.1] https://www.npmjs.com/package/@stackone/stackone-client-ts/v/4.34.1 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index ded30d5c..ab28b564 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -8,1702 +8,1702 @@ actions: "x-codeSamples": - "lang": "typescript" "label": "stackone_list_linked_accounts" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.listLinkedAccounts({});\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.listLinkedAccounts({});\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/accounts/{id}"]["delete"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_delete_account" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.deleteAccount({\n id: \"\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.deleteAccount({\n id: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/accounts/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_get_account" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.getAccount({\n id: \"\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.getAccount({\n id: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/accounts/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_update_account" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { PatchAccountExternalDtoType } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.updateAccount({\n id: \"\",\n patchAccountExternalDto: {\n type: PatchAccountExternalDtoType.Test,\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { PatchAccountExternalDtoType } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.updateAccount({\n patchAccountExternalDto: {\n type: PatchAccountExternalDtoType.Test,\n },\n id: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/accounts/{id}/meta"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_get_account_meta_info" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.getAccountMetaInfo({\n id: \"\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounts.getAccountMetaInfo({\n id: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/actions"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_list_actions_meta" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { ExcludeT, StackoneListActionsMetaQueryParamInclude } from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.actions.listActionsMeta({\n groupBy: \"[\\\"connector\\\"]\",\n filter: {\n connectors: \"connector1,connector2\",\n accountIds: \"account1,account2\",\n actionKey: \"action1\",\n },\n include: [\n StackoneListActionsMetaQueryParamInclude.ActionDetails,\n StackoneListActionsMetaQueryParamInclude.AuthenticationGuides,\n ],\n search: \"employee\",\n exclude: [\n ExcludeT.Actions,\n ],\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { ExcludeT, Include } from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.actions.listActionsMeta({\n exclude: [\n ExcludeT.Actions,\n ],\n filter: {\n accountIds: \"account1,account2\",\n actionKey: \"action1\",\n connectors: \"connector1,connector2\",\n },\n groupBy: \"[\\\"connector\\\"]\",\n include: [\n Include.ActionDetails,\n ],\n search: \"employee\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/actions/build"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_build_action_embeddings" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.actions.buildActionEmbeddings({\n connectorKey: \"slack\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.actions.buildActionEmbeddings({\n connectorKey: \"slack\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/actions/rpc"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_rpc_action" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.actions.rpcAction({\n action: \"create_employee\",\n path: {\n \"id\": \"123\",\n },\n query: {\n debug: false,\n },\n headers: {\n \"Content-Type\": \"application/json\",\n },\n body: {\n \"data\": \"example\",\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.actions.rpcAction({\n action: \"create_employee\",\n body: {\n \"data\": \"example\",\n },\n headers: {\n \"Content-Type\": \"application/json\",\n },\n path: {\n \"id\": \"123\",\n },\n query: {\n debug: false,\n },\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/actions/search"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_search_actions" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.actions.searchActions({\n query: \"send a message\",\n connector: \"slack\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.actions.searchActions({\n connector: \"slack\",\n query: \"send a message\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/connect_sessions"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_create_connect_session" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { Categories } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.connectSessions.createConnectSession({\n categories: [\n Categories.Ats,\n Categories.Hris,\n Categories.Ticketing,\n Categories.Crm,\n Categories.Iam,\n Categories.Marketing,\n Categories.Lms,\n Categories.Marketing,\n Categories.Documents,\n Categories.Ticketing,\n Categories.Screening,\n Categories.Messaging,\n Categories.Accounting,\n Categories.Scheduling,\n ],\n originOwnerId: \"\",\n originOwnerName: \"\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { ConnectSessionCreateCategories, ConnectSessionCreateType } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.connectSessions.createConnectSession({\n categories: [\n ConnectSessionCreateCategories.Ats,\n ConnectSessionCreateCategories.Hris,\n ConnectSessionCreateCategories.Documents,\n ConnectSessionCreateCategories.Crm,\n ConnectSessionCreateCategories.Iam,\n ConnectSessionCreateCategories.Marketing,\n ConnectSessionCreateCategories.Lms,\n ConnectSessionCreateCategories.Iam,\n ConnectSessionCreateCategories.Documents,\n ConnectSessionCreateCategories.Ticketing,\n ConnectSessionCreateCategories.Screening,\n ConnectSessionCreateCategories.Messaging,\n ConnectSessionCreateCategories.Accounting,\n ConnectSessionCreateCategories.Scheduling,\n ],\n originOwnerId: \"\",\n originOwnerName: \"\",\n type: ConnectSessionCreateType.Test,\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/connect_sessions/authenticate"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_authenticate_connect_session" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.connectSessions.authenticateConnectSession({\n token: \"\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.connectSessions.authenticateConnectSession({\n token: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/connectors/meta"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_list_connectors_meta" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.connectors.listConnectorsMeta({\n include: \"field_path,unmapped_fields,resources,inactive,webhooks,static_fields\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.connectors.listConnectorsMeta({\n include: \"field_path,unmapped_fields,resources,inactive,webhooks,static_fields\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/connectors/meta/{provider}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_get_connector_meta" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.connectors.getConnectorMeta({\n provider: \"\",\n include: \"field_path,unmapped_fields,resources,inactive,webhooks,static_fields\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.connectors.getConnectorMeta({\n include: \"field_path,unmapped_fields,resources,inactive,webhooks,static_fields\",\n provider: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/mcp"]["delete"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_mcp_delete" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne();\n\nasync function run() {\n const result = await stackOne.mcp.mcpDelete({\n basic: {\n username: \"\",\n password: \"\",\n },\n }, {\n mcpSessionId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne();\n\nasync function run() {\n const result = await stackOne.mcp.mcpDelete({\n apiKey: \"\",\n }, {\n mcpSessionId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/mcp"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_mcp_get" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne();\n\nasync function run() {\n const result = await stackOne.mcp.mcpGet({\n basic: {\n username: \"\",\n password: \"\",\n },\n }, {\n mcpSessionId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne();\n\nasync function run() {\n const result = await stackOne.mcp.mcpGet({\n apiKey: \"\",\n }, {\n mcpSessionId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/mcp"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_mcp_post" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne();\n\nasync function run() {\n const result = await stackOne.mcp.mcpPost({\n basic: {\n username: \"\",\n password: \"\",\n },\n }, {\n jsonRpcMessageDto: {\n jsonrpc: \"2.0\",\n method: \"initialize\",\n params: {},\n id: {},\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne();\n\nasync function run() {\n const result = await stackOne.mcp.mcpPost({\n apiKey: \"\",\n }, {\n jsonRpcMessageDto: {\n id: {},\n jsonrpc: \"2.0\",\n method: \"initialize\",\n params: {},\n },\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/requests/logs"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_list_logs" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n QueryParamInclude,\n QueryParamOrderBy,\n QueryParamOrderDirection,\n StackoneListLogsQueryParamOrderBy,\n StackoneListLogsQueryParamOrderDirection,\n} from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.requestLogs.listLogs({\n orderBy: QueryParamOrderBy.Duration,\n orderDirection: QueryParamOrderDirection.Asc,\n include: QueryParamInclude.StepLogs,\n filter: {\n accountIds: \"45355976281015164504,45355976281015164505\",\n startDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n endDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n requestIds: \"adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c\",\n sourceTypes: \"DASHBOARD,SYNTHETIC_WEBHOOK\",\n httpMethods: \"GET,POST\",\n providers: \"ashby,greenhouse\",\n services: \"hris,ats\",\n resources: \"employees,users\",\n childResources: \"documents,time-off\",\n subResources: \"documents,employees\",\n actions: \"download,upload\",\n statusCodes: \"200,400\",\n success: true,\n orderBy: StackoneListLogsQueryParamOrderBy.Duration,\n orderDirection: StackoneListLogsQueryParamOrderDirection.Asc,\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n OrderBy,\n OrderDirection,\n QueryParamOrderBy,\n QueryParamOrderDirection,\n StackoneListLogsQueryParamInclude,\n} from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.requestLogs.listLogs({\n filter: {\n accountIds: \"45355976281015164504,45355976281015164505\",\n actions: \"download,upload\",\n childResources: \"documents,time-off\",\n endDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n httpMethods: \"GET,POST\",\n orderBy: QueryParamOrderBy.Service,\n orderDirection: QueryParamOrderDirection.Asc,\n providers: \"ashby,greenhouse\",\n requestIds: \"adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c\",\n resources: \"employees,users\",\n services: \"hris,ats\",\n sourceTypes: \"DASHBOARD,SYNTHETIC_WEBHOOK\",\n startDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n statusCodes: \"200,400\",\n subResources: \"documents,employees\",\n success: true,\n },\n include: StackoneListLogsQueryParamInclude.StepLogs,\n orderBy: OrderBy.Duration,\n orderDirection: OrderDirection.Asc,\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/requests/logs/steps"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_list_step_logs" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { OrderBy, OrderDirection } from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.requestLogs.listStepLogs({\n orderBy: OrderBy.EventDatetime,\n orderDirection: OrderDirection.Asc,\n filter: {\n accountIds: \"45355976281015164504,45355976281015164505\",\n startDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n endDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n requestIds: \"adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c\",\n httpMethods: \"GET,POST\",\n providers: \"ashby,greenhouse\",\n services: \"hris,ats\",\n resources: \"employees,users\",\n childResources: \"documents,time-off\",\n subResources: \"documents,employees\",\n actions: \"download,upload\",\n statusCodes: \"200,400\",\n success: true,\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n StackoneListStepLogsQueryParamOrderBy,\n StackoneListStepLogsQueryParamOrderDirection,\n} from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.requestLogs.listStepLogs({\n filter: {\n accountIds: \"45355976281015164504,45355976281015164505\",\n actions: \"download,upload\",\n childResources: \"documents,time-off\",\n endDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n httpMethods: \"GET,POST\",\n providers: \"ashby,greenhouse\",\n requestIds: \"adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c\",\n resources: \"employees,users\",\n services: \"hris,ats\",\n startDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n statusCodes: \"200,400\",\n subResources: \"documents,employees\",\n success: true,\n },\n orderBy: StackoneListStepLogsQueryParamOrderBy.EventDatetime,\n orderDirection: StackoneListStepLogsQueryParamOrderDirection.Asc,\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/requests/logs/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_get_log" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { Include } from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.requestLogs.getLog({\n id: \"\",\n include: Include.StepLogs,\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { QueryParamInclude } from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.requestLogs.getLog({\n id: \"\",\n include: QueryParamInclude.StepLogs,\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/requests/platform-logs"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_list_platform_logs" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n StackoneListPlatformLogsQueryParamOrderBy,\n StackoneListPlatformLogsQueryParamOrderDirection,\n StackoneListPlatformLogsQueryParamRequestLogsOrderBy,\n StackoneListPlatformLogsQueryParamRequestLogsOrderDirection,\n} from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.requestLogs.listPlatformLogs({\n orderBy: StackoneListPlatformLogsQueryParamOrderBy.Duration,\n orderDirection: StackoneListPlatformLogsQueryParamOrderDirection.Asc,\n filter: {\n accountIds: \"45355976281015164504,45355976281015164505\",\n startDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n endDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n requestIds: \"adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c\",\n sourceTypes: \"DASHBOARD,SYNTHETIC_WEBHOOK\",\n httpMethods: \"GET,POST\",\n categories: \"hris,ats\",\n resources: \"employees,users\",\n actions: \"download,upload\",\n statusCodes: \"200,400\",\n success: true,\n orderBy: StackoneListPlatformLogsQueryParamRequestLogsOrderBy.EventDatetime,\n orderDirection: StackoneListPlatformLogsQueryParamRequestLogsOrderDirection.Asc,\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n StackoneListPlatformLogsQueryParamOrderBy,\n StackoneListPlatformLogsQueryParamOrderDirection,\n StackoneListPlatformLogsQueryParamRequestLogsOrderBy,\n StackoneListPlatformLogsQueryParamRequestLogsOrderDirection,\n} from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.requestLogs.listPlatformLogs({\n filter: {\n accountIds: \"45355976281015164504,45355976281015164505\",\n actions: \"download,upload\",\n categories: \"hris,ats\",\n endDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n httpMethods: \"GET,POST\",\n orderBy: StackoneListPlatformLogsQueryParamRequestLogsOrderBy.EventDatetime,\n orderDirection: StackoneListPlatformLogsQueryParamRequestLogsOrderDirection.Asc,\n requestIds: \"adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c\",\n resources: \"employees,users\",\n sourceTypes: \"DASHBOARD,SYNTHETIC_WEBHOOK\",\n startDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n statusCodes: \"200,400\",\n success: true,\n },\n orderBy: StackoneListPlatformLogsQueryParamOrderBy.Duration,\n orderDirection: StackoneListPlatformLogsQueryParamOrderDirection.Asc,\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_list_companies" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.listCompanies({\n fields: \"id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.listCompanies({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_get_company" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.getCompany({\n id: \"\",\n fields: \"id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.getCompany({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies/{id}/accounts"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_list_company_accounts" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.listCompanyAccounts({\n id: \"\",\n fields: \"id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields\",\n filter: null,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.listCompanyAccounts({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields\",\n filter: null,\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies/{id}/accounts/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_get_company_account" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.getCompanyAccount({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.getCompanyAccount({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies/{id}/journals"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_list_company_journals" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.listCompanyJournals({\n id: \"\",\n fields: \"id,remote_id,company_id,remote_company_id,reference,memo,transaction_date,status,lines,created_at,updated_at,posted_at,unified_custom_fields\",\n filter: null,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.listCompanyJournals({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,company_id,remote_company_id,reference,memo,transaction_date,status,lines,created_at,updated_at,posted_at,unified_custom_fields\",\n filter: null,\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies/{id}/journals"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_create_company_journal" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AccountingJournalCreateRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.createCompanyJournal({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n accountingJournalCreateRequestDto: {\n reference: \"JRN-2024-001\",\n memo: \"Monthly closing entries\",\n currencyCode: {\n value: AccountingJournalCreateRequestDtoValue.Usd,\n sourceValue: \"USD\",\n },\n exchangeRate: 1,\n transactionDate: new Date(\"2024-03-20T10:00:00Z\"),\n lines: [\n {\n accountId: \"acc_123456789\",\n description: \"Payment for office supplies\",\n amount: 10010,\n taxRateId: \"tax_123456789\",\n taxAmount: 10010,\n },\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AccountingJournalCreateRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.createCompanyJournal({\n accountingJournalCreateRequestDto: {\n currencyCode: {\n sourceValue: \"USD\",\n value: AccountingJournalCreateRequestDtoValue.Usd,\n },\n exchangeRate: 1,\n lines: [\n {\n accountId: \"acc_123456789\",\n amount: 10010,\n description: \"Payment for office supplies\",\n taxAmount: 10010,\n taxRateId: \"tax_123456789\",\n },\n ],\n memo: \"Monthly closing entries\",\n reference: \"JRN-2024-001\",\n transactionDate: new Date(\"2024-03-20T10:00:00Z\"),\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies/{id}/journals/batch"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_batch_create_company_journals" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.batchCreateCompanyJournals({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n accountingJournalBatchCreateRequestDto: {\n items: [],\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.batchCreateCompanyJournals({\n accountingJournalBatchCreateRequestDto: {\n items: [],\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies/{id}/journals/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_get_company_journal" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.getCompanyJournal({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,company_id,remote_company_id,reference,memo,transaction_date,status,lines,created_at,updated_at,posted_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.getCompanyJournal({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,company_id,remote_company_id,reference,memo,transaction_date,status,lines,created_at,updated_at,posted_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies/{id}/tax_rates"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_list_company_tax_rates" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.listCompanyTaxRates({\n id: \"\",\n fields: \"id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.listCompanyTaxRates({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/accounting/companies/{id}/tax_rates/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "accounting_get_company_tax_rate" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.getCompanyTaxRate({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.accounting.getCompanyTaxRate({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/application_stages"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_application_stages" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationStages({\n fields: \"id,remote_id,name,order,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationStages({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,order,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/application_stages/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_application_stage" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationStage({\n id: \"\",\n fields: \"id,remote_id,name,order,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationStage({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,order,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_applications" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplications({\n fields: \"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"documents\",\n include: \"attachments,custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplications({\n prefer: \"heartbeat\",\n expand: \"documents\",\n fields: \"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields\",\n filter: {\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n include: \"attachments,custom_fields\",\n jobId: \"cxQiyiuasdFKfdsYfer\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_create_application" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsDocumentsUploadRequestDtoValue, CreateAnswerValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createApplication({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateApplicationRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n jobId: \"4071538b-3cac-4fbf-ac76-f78ed250ffdd\",\n jobPostingId: \"1c702a20-8de8-4d03-ac18-cbf4ac42eb51\",\n locationId: \"dd8d41d1-5eb8-4408-9c87-9ba44604eae4\",\n applicationStatus: null,\n questionnaires: [\n {\n id: \"right_to_work\",\n answers: [\n {\n id: \"answer1\",\n type: {\n value: CreateAnswerValue.ShortText,\n sourceValue: \"Short Text\",\n },\n values: [\n \"Yes\",\n ],\n },\n ],\n },\n ],\n source: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"LinkedIn\",\n },\n candidateId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n candidate: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n phoneNumbers: [\n {\n phone: \"+447700112233\",\n },\n ],\n name: \"Romain Sestier\",\n firstName: \"Romain\",\n lastName: \"Sestier\",\n email: \"sestier.romain123@gmail.com\",\n socialLinks: [\n {\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n },\n ],\n company: \"Company Inc.\",\n title: \"Software Engineer\",\n hiredAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n country: \"United States\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n value: \"Completed\",\n valueId: \"value_456\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n },\n ],\n },\n documents: [\n {\n name: \"weather-forecast\",\n fileFormat: {\n value: AtsDocumentsUploadRequestDtoValue.Pdf,\n sourceValue: \"application/pdf\",\n },\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n categoryId: \"6530\",\n path: \"/path/to/file\",\n confidential: null,\n category: {},\n },\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateApplicationRequestDtoValue, CreateAnswerValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createApplication({\n atsCreateApplicationRequestDto: {\n applicationStatus: {\n sourceValue: \"Hired\",\n value: AtsCreateApplicationRequestDtoValue.Hired,\n },\n candidate: {\n company: \"Company Inc.\",\n country: \"United States\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n email: \"sestier.romain123@gmail.com\",\n firstName: \"Romain\",\n hiredAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n lastName: \"Sestier\",\n name: \"Romain Sestier\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n phoneNumbers: [\n {\n phone: \"+447700112233\",\n },\n {\n phone: \"+447700112233\",\n },\n ],\n socialLinks: [\n {\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n },\n {\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n },\n {\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n },\n ],\n title: \"Software Engineer\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n candidateId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n documents: null,\n jobId: \"4071538b-3cac-4fbf-ac76-f78ed250ffdd\",\n jobPostingId: \"1c702a20-8de8-4d03-ac18-cbf4ac42eb51\",\n locationId: \"dd8d41d1-5eb8-4408-9c87-9ba44604eae4\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n questionnaires: [\n {\n answers: [\n {\n id: \"answer1\",\n type: {\n sourceValue: \"Short Text\",\n value: CreateAnswerValue.ShortText,\n },\n values: [\n \"Yes\",\n ],\n },\n ],\n id: \"right_to_work\",\n },\n ],\n source: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"LinkedIn\",\n },\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_application" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplication({\n id: \"\",\n fields: \"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields\",\n expand: \"documents\",\n include: \"attachments,custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplication({\n prefer: \"heartbeat\",\n expand: \"documents\",\n fields: \"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields\",\n id: \"\",\n include: \"attachments,custom_fields\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_update_application" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateApplicationRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateApplication({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsUpdateApplicationRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n value: \"Completed\",\n valueId: \"value_456\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n },\n ],\n applicationStatus: {\n value: AtsUpdateApplicationRequestDtoValue.Hired,\n sourceValue: \"Hired\",\n },\n source: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"LinkedIn\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateApplicationRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateApplication({\n atsUpdateApplicationRequestDto: {\n applicationStatus: {\n sourceValue: \"Hired\",\n value: AtsUpdateApplicationRequestDtoValue.Hired,\n },\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n source: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"LinkedIn\",\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/changes"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_application_changes" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationChanges({\n id: \"\",\n fields: \"event_id,remote_event_id,created_at,effective_at,change_type,actor,new_values,unified_custom_fields\",\n filter: {\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationChanges({\n prefer: \"heartbeat\",\n fields: \"event_id,remote_event_id,created_at,effective_at,change_type,actor,new_values,unified_custom_fields\",\n filter: {\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/documents"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_application_documents" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationDocuments({\n id: \"\",\n fields: \"id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationDocuments({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/documents/upload"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_upload_application_document" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsDocumentsUploadRequestDtoSchemasValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.uploadApplicationDocument({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsDocumentsUploadRequestDto: {\n name: \"weather-forecast\",\n fileFormat: null,\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n categoryId: \"6530\",\n path: \"/path/to/file\",\n confidential: {\n value: AtsDocumentsUploadRequestDtoSchemasValue.True,\n sourceValue: \"public\",\n },\n category: {},\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n AtsDocumentsUploadRequestDtoSchemasFileFormatValue,\n AtsDocumentsUploadRequestDtoSchemasValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.uploadApplicationDocument({\n atsDocumentsUploadRequestDto: {\n category: {},\n categoryId: \"6530\",\n confidential: {\n sourceValue: \"public\",\n value: AtsDocumentsUploadRequestDtoSchemasValue.True,\n },\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n fileFormat: {\n sourceValue: \"application/pdf\",\n value: AtsDocumentsUploadRequestDtoSchemasFileFormatValue.Pdf,\n },\n name: \"weather-forecast\",\n path: \"/path/to/file\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/documents/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_application_document" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationDocument({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationDocument({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/documents/{subResourceId}/download"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_download_application_document" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.downloadApplicationDocument({\n id: \"\",\n subResourceId: \"\",\n format: \"base64\",\n exportFormat: \"text/plain\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.downloadApplicationDocument({\n prefer: \"heartbeat\",\n exportFormat: \"text/plain\",\n format: \"base64\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/move"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_move_application" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.moveApplication({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsMoveApplicationRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n interviewStageId: \"f223d7f6-908b-48f0-9237-b201c307f609\",\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.moveApplication({\n atsMoveApplicationRequestDto: {\n interviewStageId: \"f223d7f6-908b-48f0-9237-b201c307f609\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/notes"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_application_notes" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationNotes({\n id: \"\",\n fields: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationNotes({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/notes"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_create_application_note" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createApplicationNote({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateNotesRequestDto: {\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n authorId: \"1234567890\",\n visibility: {\n value: AtsCreateNotesRequestDtoValue.Public,\n sourceValue: \"Public\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createApplicationNote({\n atsCreateNotesRequestDto: {\n authorId: \"1234567890\",\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n visibility: {\n sourceValue: \"Public\",\n value: AtsCreateNotesRequestDtoValue.Public,\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/notes/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_application_note" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationNote({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationNote({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/notes/{subResourceId}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_update_application_note" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateApplicationNote({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsUpdateNotesRequestDto: {\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n authorId: \"1234567890\",\n visibility: {\n value: AtsUpdateNotesRequestDtoValue.Public,\n sourceValue: \"Public\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateApplicationNote({\n atsUpdateNotesRequestDto: {\n authorId: \"1234567890\",\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n visibility: {\n sourceValue: \"Public\",\n value: AtsUpdateNotesRequestDtoValue.Public,\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/offers"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_applications_offers" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationsOffers({\n id: \"\",\n fields: \"id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationsOffers({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/offers/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_application_offer" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationOffer({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationOffer({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/reject"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_reject_application" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.rejectApplication({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsRejectApplicationRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n rejectedReasonId: \"f223d7f6-908b-48f0-9237-b201c307f609\",\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.rejectApplication({\n atsRejectApplicationRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n rejectedReasonId: \"f223d7f6-908b-48f0-9237-b201c307f609\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/scheduled_interviews"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_applications_scheduled_interviews" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationsScheduledInterviews({\n id: \"\",\n fields: \"id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationsScheduledInterviews({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/scheduled_interviews/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_application_scheduled_interview" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationScheduledInterview({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationScheduledInterview({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/scorecards"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_application_scorecards" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationScorecards({\n id: \"\",\n fields: \"id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationScorecards({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/applications/{id}/scorecards/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_application_scorecard" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationScorecard({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationScorecard({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/assessments/orders"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_order_assessments_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateCandidatesAssessmentsRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.orderAssessmentsRequest({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateCandidatesAssessmentsRequestDto: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n package: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n },\n application: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n applicationStatus: {\n value: AtsCreateCandidatesAssessmentsRequestDtoValue.Hired,\n sourceValue: \"Hired\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n job: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n title: \"Software Engineer\",\n hiringTeam: [\n {\n userId: \"123456\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n firstName: \"John\",\n lastName: \"Doe\",\n email: \"john.doe@gmail.com\",\n role: \"Software Engineer\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n candidate: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n firstName: \"Romain\",\n lastName: \"Sestier\",\n emails: [\n {\n type: \"personal\",\n value: \"sestier.romain123@gmail.com\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n profileUrl: \"https://exmaple.com/candidate?id=xyz\",\n },\n requester: {\n userId: \"123456\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n firstName: \"John\",\n lastName: \"Doe\",\n email: \"john.doe@gmail.com\",\n role: \"Software Engineer\",\n },\n resultsUpdateUrl: \"https://exmaple.com/integrations/results/update\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateCandidatesAssessmentsRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.orderAssessmentsRequest({\n atsCreateCandidatesAssessmentsRequestDto: {\n application: {\n applicationStatus: {\n sourceValue: \"Hired\",\n value: AtsCreateCandidatesAssessmentsRequestDtoValue.Hired,\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n candidate: {\n emails: [\n {\n type: \"personal\",\n value: \"sestier.romain123@gmail.com\",\n },\n ],\n firstName: \"Romain\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n lastName: \"Sestier\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n profileUrl: \"https://exmaple.com/candidate?id=xyz\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n job: {\n hiringTeam: [\n {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n ],\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n title: \"Software Engineer\",\n },\n package: {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Test 1\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n requester: {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n resultsUpdateUrl: \"https://exmaple.com/integrations/results/update\",\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/assessments/orders/{id}/result"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_update_assessments_result" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateCandidatesAssessmentsResultsRequestDtoValue, AttachmentValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateAssessmentsResult({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsUpdateCandidatesAssessmentsResultsRequestDto: {\n score: null,\n startDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n submissionDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n summary: \"Test is passed\",\n result: {\n value: AtsUpdateCandidatesAssessmentsResultsRequestDtoValue.Passed,\n sourceValue: \"Passed\",\n },\n resultUrl: \"https://exmaple.com/result?id=xyz\",\n attachments: [\n {\n url: \"http://example.com/resume.pdf\",\n contentType: {\n value: AttachmentValue.Text,\n sourceValue: \"Text\",\n },\n },\n ],\n candidate: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n profileUrl: \"https://exmaple.com/candidate?id=xyz\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateCandidatesAssessmentsResultsRequestDtoValue, AttachmentValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateAssessmentsResult({\n atsUpdateCandidatesAssessmentsResultsRequestDto: {\n attachments: [\n {\n contentType: {\n sourceValue: \"Text\",\n value: AttachmentValue.Text,\n },\n url: \"http://example.com/resume.pdf\",\n },\n ],\n candidate: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n profileUrl: \"https://exmaple.com/candidate?id=xyz\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n result: {\n sourceValue: \"Passed\",\n value: AtsUpdateCandidatesAssessmentsResultsRequestDtoValue.Passed,\n },\n resultUrl: \"https://exmaple.com/result?id=xyz\",\n score: {\n label: \"Percentage\",\n max: \"100\",\n min: \"0\",\n value: \"80\",\n },\n startDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n submissionDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n summary: \"Test is passed\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/assessments/packages"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_assessments_packages" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listAssessmentsPackages({\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listAssessmentsPackages({\n prefer: \"heartbeat\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/assessments/packages/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_assessments_package" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getAssessmentsPackage({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getAssessmentsPackage({\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/background_checks/orders"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_order_background_check_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateBackgroundCheckOrderRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.orderBackgroundCheckRequest({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateBackgroundCheckOrderRequestDto: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n application: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n applicationStatus: {\n value: AtsCreateBackgroundCheckOrderRequestDtoValue.Hired,\n sourceValue: \"Hired\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n job: null,\n candidate: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n firstName: \"Romain\",\n lastName: \"Sestier\",\n emails: [\n {\n type: \"personal\",\n value: \"sestier.romain123@gmail.com\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n profileUrl: \"https://exmaple.com/candidate?id=xyz\",\n },\n requester: {\n userId: \"123456\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n firstName: \"John\",\n lastName: \"Doe\",\n email: \"john.doe@gmail.com\",\n role: \"Software Engineer\",\n },\n resultsUpdateUrl: \"https://exmaple.com/integrations/results/update\",\n package: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n tests: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n },\n ],\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateBackgroundCheckOrderRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.orderBackgroundCheckRequest({\n atsCreateBackgroundCheckOrderRequestDto: {\n application: {\n applicationStatus: {\n sourceValue: \"Hired\",\n value: AtsCreateBackgroundCheckOrderRequestDtoValue.Hired,\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n candidate: {\n emails: [\n {\n type: \"personal\",\n value: \"sestier.romain123@gmail.com\",\n },\n ],\n firstName: \"Romain\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n lastName: \"Sestier\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n profileUrl: \"https://exmaple.com/candidate?id=xyz\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n job: {\n hiringTeam: [\n {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n ],\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n title: \"Software Engineer\",\n },\n package: {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Test 1\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n tests: [\n {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Test 1\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n ],\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n requester: {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n resultsUpdateUrl: \"https://exmaple.com/integrations/results/update\",\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/background_checks/orders/{id}/result"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_update_background_check_result" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateBackgroundCheckResultRequestDtoValue, AttachmentValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateBackgroundCheckResult({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsUpdateBackgroundCheckResultRequestDto: {\n score: {\n label: \"Percentage\",\n value: \"80\",\n min: \"0\",\n max: \"100\",\n },\n startDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n submissionDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n summary: \"Test is passed\",\n result: {\n value: AtsUpdateBackgroundCheckResultRequestDtoValue.Passed,\n sourceValue: \"Passed\",\n },\n resultUrl: \"https://exmaple.com/result?id=xyz\",\n attachments: [\n {\n url: \"http://example.com/resume.pdf\",\n contentType: {\n value: AttachmentValue.Text,\n sourceValue: \"Text\",\n },\n },\n ],\n candidate: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n profileUrl: \"https://exmaple.com/candidate?id=xyz\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateBackgroundCheckResultRequestDtoValue, AttachmentValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateBackgroundCheckResult({\n atsUpdateBackgroundCheckResultRequestDto: {\n attachments: [\n {\n contentType: {\n sourceValue: \"Text\",\n value: AttachmentValue.Text,\n },\n url: \"http://example.com/resume.pdf\",\n },\n ],\n candidate: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n profileUrl: \"https://exmaple.com/candidate?id=xyz\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n result: {\n sourceValue: \"Passed\",\n value: AtsUpdateBackgroundCheckResultRequestDtoValue.Passed,\n },\n resultUrl: \"https://exmaple.com/result?id=xyz\",\n score: {\n label: \"Percentage\",\n max: \"100\",\n min: \"0\",\n value: \"80\",\n },\n startDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n submissionDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n summary: \"Test is passed\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/background_checks/packages"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_background_check_packages" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listBackgroundCheckPackages({\n fields: \"id,remote_id,name,description,tests,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listBackgroundCheckPackages({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,tests,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/background_checks/packages"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_create_background_check_package" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createBackgroundCheckPackage({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateBackgroundCheckPackagesRequestDto: {\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n tests: [\n {\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createBackgroundCheckPackage({\n atsCreateBackgroundCheckPackagesRequestDto: {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n name: \"Test 1\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n tests: [\n {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n name: \"Test 1\",\n },\n {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n name: \"Test 1\",\n },\n {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n name: \"Test 1\",\n },\n ],\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/background_checks/packages/{id}"]["delete"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_delete_background_check_package" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.deleteBackgroundCheckPackage({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.deleteBackgroundCheckPackage({\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/background_checks/packages/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_background_check_package" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getBackgroundCheckPackage({\n id: \"\",\n fields: \"id,remote_id,name,description,tests,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getBackgroundCheckPackage({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,tests,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/background_checks/packages/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_update_background_check_package" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateBackgroundCheckPackage({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsUpdateBackgroundCheckPackagesRequestDto: {\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n tests: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Test 1\",\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateBackgroundCheckPackage({\n atsUpdateBackgroundCheckPackagesRequestDto: {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n name: \"Test 1\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n tests: [\n {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Test 1\",\n },\n {\n description: \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Test 1\",\n },\n ],\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/candidates"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_candidates" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listCandidates({\n fields: \"id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,tags,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n include: \"custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listCandidates({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,tags,created_at,updated_at,unified_custom_fields\",\n filter: {\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n include: \"custom_fields\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/candidates"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_create_candidate" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createCandidate({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateCandidateRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n phoneNumbers: [\n {\n phone: \"+447700112233\",\n },\n ],\n name: \"Romain Sestier\",\n firstName: \"Romain\",\n lastName: \"Sestier\",\n email: \"sestier.romain123@gmail.com\",\n socialLinks: [\n {\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n },\n ],\n company: \"Company Inc.\",\n title: \"Software Engineer\",\n hiredAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n country: \"United States\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n value: \"Completed\",\n valueId: \"value_456\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n },\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createCandidate({\n atsCreateCandidateRequestDto: {\n company: \"Company Inc.\",\n country: \"United States\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n email: \"sestier.romain123@gmail.com\",\n firstName: \"Romain\",\n hiredAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n lastName: \"Sestier\",\n name: \"Romain Sestier\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n phoneNumbers: [\n {\n phone: \"+447700112233\",\n },\n {\n phone: \"+447700112233\",\n },\n ],\n socialLinks: [\n {\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n },\n {\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n },\n ],\n title: \"Software Engineer\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/candidates/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_candidate" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getCandidate({\n id: \"\",\n fields: \"id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,tags,created_at,updated_at,unified_custom_fields\",\n include: \"custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getCandidate({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,tags,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n include: \"custom_fields\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/candidates/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_update_candidate" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateCandidate({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsUpdateCandidateRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n name: \"Romain Sestier\",\n firstName: \"Romain\",\n lastName: \"Sestier\",\n email: \"sestier.romain123@gmail.com\",\n emails: [\n {\n type: \"personal\",\n value: \"sestier.romain123@gmail.com\",\n },\n ],\n socialLinks: [\n {\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n },\n ],\n phoneNumbers: [\n {\n phone: \"+447700112233\",\n },\n ],\n company: \"Company Inc.\",\n title: \"Software Engineer\",\n applicationIds: [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"523e1234-e89b-fdd2-a456-762545121101\",\n ],\n hiredAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n country: \"United States\",\n customFields: null,\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateCandidate({\n atsUpdateCandidateRequestDto: {\n applicationIds: [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"523e1234-e89b-fdd2-a456-762545121101\",\n ],\n company: \"Company Inc.\",\n country: \"United States\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n email: \"sestier.romain123@gmail.com\",\n emails: [\n {\n type: \"personal\",\n value: \"sestier.romain123@gmail.com\",\n },\n ],\n firstName: \"Romain\",\n hiredAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n lastName: \"Sestier\",\n name: \"Romain Sestier\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n phoneNumbers: [\n {\n phone: \"+447700112233\",\n },\n {\n phone: \"+447700112233\",\n },\n {\n phone: \"+447700112233\",\n },\n ],\n socialLinks: [\n {\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n },\n ],\n title: \"Software Engineer\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/candidates/{id}/notes"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_candidate_notes" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listCandidateNotes({\n id: \"\",\n fields: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listCandidateNotes({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/candidates/{id}/notes"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_create_candidate_note" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createCandidateNote({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateNotesRequestDto: {\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n authorId: \"1234567890\",\n visibility: {\n value: AtsCreateNotesRequestDtoValue.Public,\n sourceValue: \"Public\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createCandidateNote({\n atsCreateNotesRequestDto: {\n authorId: \"1234567890\",\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n visibility: {\n sourceValue: \"Public\",\n value: AtsCreateNotesRequestDtoValue.Public,\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/candidates/{id}/notes/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_candidate_note" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getCandidateNote({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getCandidateNote({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/custom_field_definitions/applications"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_application_custom_field_definitions" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationCustomFieldDefinitions({\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: null,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationCustomFieldDefinitions({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/custom_field_definitions/applications/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_application_custom_field_definition" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationCustomFieldDefinition({\n id: \"\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: null,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationCustomFieldDefinition({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/custom_field_definitions/candidates"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_candidate_custom_field_definitions" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listCandidateCustomFieldDefinitions({\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listCandidateCustomFieldDefinitions({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/custom_field_definitions/candidates/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_candidate_custom_field_definition" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getCandidateCustomFieldDefinition({\n id: \"\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getCandidateCustomFieldDefinition({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/custom_field_definitions/jobs"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_job_custom_field_definitions" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listJobCustomFieldDefinitions({\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listJobCustomFieldDefinitions({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/custom_field_definitions/jobs/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_job_custom_field_definition" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getJobCustomFieldDefinition({\n id: \"\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getJobCustomFieldDefinition({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/departments"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_departments" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listDepartments({\n fields: \"id,remote_id,name,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listDepartments({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/departments/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_department" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getDepartment({\n id: \"\",\n fields: \"id,remote_id,name,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getDepartment({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/documents/application_categories"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_application_document_categories" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationDocumentCategories({\n fields: \"id,remote_id,name,active,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listApplicationDocumentCategories({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/documents/application_categories/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_application_document_category" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationDocumentCategory({\n id: \"\",\n fields: \"id,remote_id,name,active,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getApplicationDocumentCategory({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/interviews"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_interviews" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listInterviews({\n fields: \"id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listInterviews({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields\",\n filter: {\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/interviews/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_interview" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getInterview({\n id: \"\",\n fields: \"id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getInterview({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/interviews/{id}/notes"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_create_interview_note" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createInterviewNote({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateNotesRequestDto: {\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n authorId: \"1234567890\",\n visibility: {\n value: AtsCreateNotesRequestDtoValue.Public,\n sourceValue: \"Public\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createInterviewNote({\n atsCreateNotesRequestDto: {\n authorId: \"1234567890\",\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n visibility: {\n sourceValue: \"Public\",\n value: AtsCreateNotesRequestDtoValue.Public,\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/interviews/{id}/notes/{subResourceId}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_update_interview_note" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateInterviewNote({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsUpdateNotesRequestDto: {\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n authorId: \"1234567890\",\n visibility: {\n value: AtsUpdateNotesRequestDtoValue.Public,\n sourceValue: \"Public\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateNotesRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateInterviewNote({\n atsUpdateNotesRequestDto: {\n authorId: \"1234567890\",\n content: [\n {\n body: \"This candidate seems like a good fit for the role\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n visibility: {\n sourceValue: \"Public\",\n value: AtsUpdateNotesRequestDtoValue.Public,\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/job_postings"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_job_postings" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listJobPostings({\n fields: \"id,remote_id,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,start_date,updated_at,created_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n include: \"questionnaires\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listJobPostings({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,start_date,updated_at,created_at,unified_custom_fields\",\n filter: {\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n include: \"questionnaires\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/job_postings/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_job_posting" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getJobPosting({\n id: \"\",\n fields: \"id,remote_id,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,start_date,updated_at,created_at,unified_custom_fields\",\n include: \"questionnaires\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getJobPosting({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,start_date,updated_at,created_at,unified_custom_fields\",\n id: \"\",\n include: \"questionnaires\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/jobs"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_jobs" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listJobs({\n fields: \"id,remote_id,code,title,description,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"job_postings,interview_stages\",\n include: \"custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listJobs({\n prefer: \"heartbeat\",\n expand: \"job_postings,interview_stages\",\n fields: \"id,remote_id,code,title,description,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at,unified_custom_fields\",\n filter: {\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n include: \"custom_fields\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/jobs"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_create_job" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateJobRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createJob({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateJobRequestDto: {\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n code: \"184919\",\n title: \"Software Engineer\",\n description: \"Responsible for identifying business requirements\",\n jobStatus: {\n value: AtsCreateJobRequestDtoValue.Published,\n sourceValue: \"Published\",\n },\n departmentIds: [\n \"308570\",\n \"308571\",\n \"308572\",\n ],\n locationIds: [\n \"668570\",\n \"678571\",\n \"688572\",\n ],\n hiringTeam: [\n {\n userId: \"123456\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n firstName: \"John\",\n lastName: \"Doe\",\n email: \"john.doe@gmail.com\",\n role: \"Software Engineer\",\n },\n ],\n interviewStages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n updatedAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n },\n ],\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n value: \"Completed\",\n valueId: \"value_456\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateJobRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createJob({\n atsCreateJobRequestDto: {\n code: \"184919\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n departmentIds: [\n \"308570\",\n \"308571\",\n \"308572\",\n ],\n description: \"Responsible for identifying business requirements\",\n hiringTeam: [\n {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n ],\n interviewStages: [\n {\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n updatedAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n },\n {\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n updatedAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n },\n {\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n updatedAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n },\n ],\n jobStatus: {\n sourceValue: \"Published\",\n value: AtsCreateJobRequestDtoValue.Published,\n },\n locationIds: [\n \"668570\",\n \"678571\",\n \"688572\",\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n title: \"Software Engineer\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/jobs/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_job" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getJob({\n id: \"\",\n fields: \"id,remote_id,code,title,description,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at,unified_custom_fields\",\n expand: \"job_postings,interview_stages\",\n include: \"custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getJob({\n prefer: \"heartbeat\",\n expand: \"job_postings,interview_stages\",\n fields: \"id,remote_id,code,title,description,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n include: \"custom_fields\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/jobs/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_update_job" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateJobRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateJob({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsUpdateJobRequestDto: {\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n code: \"184919\",\n title: \"Software Engineer\",\n description: \"Responsible for identifying business requirements\",\n jobStatus: {\n value: AtsUpdateJobRequestDtoValue.Published,\n sourceValue: \"Published\",\n },\n departmentIds: [\n \"308570\",\n \"308571\",\n \"308572\",\n ],\n locationIds: [\n \"668570\",\n \"678571\",\n \"688572\",\n ],\n hiringTeam: [\n {\n userId: \"123456\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n firstName: \"John\",\n lastName: \"Doe\",\n email: \"john.doe@gmail.com\",\n role: \"Software Engineer\",\n },\n ],\n interviewStages: null,\n customFields: null,\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsUpdateJobRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.updateJob({\n atsUpdateJobRequestDto: {\n code: \"184919\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n departmentIds: [\n \"308570\",\n \"308571\",\n \"308572\",\n ],\n description: \"Responsible for identifying business requirements\",\n hiringTeam: [\n {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n {\n email: \"john.doe@gmail.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n role: \"Software Engineer\",\n userId: \"123456\",\n },\n ],\n interviewStages: [\n {\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n updatedAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n },\n ],\n jobStatus: {\n sourceValue: \"Published\",\n value: AtsUpdateJobRequestDtoValue.Published,\n },\n locationIds: [\n \"668570\",\n \"678571\",\n \"688572\",\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n title: \"Software Engineer\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/jobs/{id}/application_stages"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_job_application_stages" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listJobApplicationStages({\n id: \"\",\n fields: \"id,remote_id,name,order,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listJobApplicationStages({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,order,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/jobs/{id}/application_stages/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_job_application_stage" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getJobApplicationStage({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,name,order,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getJobApplicationStage({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,order,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/lists"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_lists" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listLists({\n fields: \"id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields\",\n filter: null,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listLists({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/lists/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_list" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getList({\n id: \"\",\n fields: \"id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getList({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/locations"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_locations" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listLocations({\n fields: \"id,remote_id,name,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listLocations({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/locations/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_location" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getLocation({\n id: \"\",\n fields: \"id,remote_id,name,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getLocation({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/offers"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_offers" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listOffers({\n fields: \"id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listOffers({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/offers"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_create_offer" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateOfferRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createOffer({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n atsCreateOfferRequestDto: {\n startDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n offerStatus: {\n value: AtsCreateOfferRequestDtoValue.Pending,\n sourceValue: \"Pending\",\n },\n offerHistory: [\n {\n startDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n updatedAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { AtsCreateOfferRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.createOffer({\n atsCreateOfferRequestDto: {\n offerHistory: [\n {\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n startDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n updatedAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n },\n ],\n offerStatus: {\n sourceValue: \"Pending\",\n value: AtsCreateOfferRequestDtoValue.Pending,\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n startDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/offers/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_offer" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getOffer({\n id: \"\",\n fields: \"id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getOffer({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/rejected_reasons"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_rejected_reasons" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listRejectedReasons({\n fields: \"id,remote_id,label,type,rejected_reason_type,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listRejectedReasons({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,label,type,rejected_reason_type,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/rejected_reasons/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_rejected_reason" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getRejectedReason({\n id: \"\",\n fields: \"id,remote_id,label,type,rejected_reason_type,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getRejectedReason({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,label,type,rejected_reason_type,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ats/users"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_list_users" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listUsers({\n fields: \"id,remote_id,first_name,last_name,name,email,phone,unified_custom_fields\",\n filter: null,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.listUsers({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,first_name,last_name,name,email,phone,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ats/users/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ats_get_user" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getUser({\n id: \"\",\n fields: \"id,remote_id,first_name,last_name,name,email,phone,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ats.getUser({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,first_name,last_name,name,email,phone,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/crm/accounts"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_list_accounts" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.listAccounts({\n fields: \"id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.listAccounts({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/crm/accounts/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_get_account" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.getAccount({\n id: \"\",\n fields: \"id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.getAccount({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/crm/contacts"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_list_contacts" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.listContacts({\n fields: \"id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n include: \"custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.listContacts({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n include: \"custom_fields\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/crm/contacts"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_create_contact" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.createContact({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n crmCreateContactRequestDto: {\n firstName: \"Steve\",\n lastName: \"Wozniak\",\n companyName: \"Apple Inc.\",\n emails: [\n \"steve@apple.com\",\n ],\n phoneNumbers: [\n \"123-456-7890\",\n ],\n dealIds: [\n \"deal-001\",\n \"deal-002\",\n ],\n accountIds: [\n \"account-123\",\n \"account-456\",\n ],\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n value: \"Completed\",\n valueId: \"value_456\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.createContact({\n crmCreateContactRequestDto: {\n accountIds: [\n \"account-123\",\n \"account-456\",\n ],\n companyName: \"Apple Inc.\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n dealIds: [\n \"deal-001\",\n \"deal-002\",\n ],\n emails: [\n \"steve@apple.com\",\n ],\n firstName: \"Steve\",\n lastName: \"Wozniak\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n phoneNumbers: [\n \"123-456-7890\",\n ],\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/crm/contacts/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_get_contact" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.getContact({\n id: \"\",\n fields: \"id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at,unified_custom_fields\",\n include: \"custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.getContact({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n include: \"custom_fields\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/crm/contacts/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_update_contact" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.updateContact({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n crmCreateContactRequestDto: {\n firstName: \"Steve\",\n lastName: \"Wozniak\",\n companyName: \"Apple Inc.\",\n emails: [\n \"steve@apple.com\",\n ],\n phoneNumbers: [\n \"123-456-7890\",\n ],\n dealIds: [\n \"deal-001\",\n \"deal-002\",\n ],\n accountIds: [\n \"account-123\",\n \"account-456\",\n ],\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n value: \"Completed\",\n valueId: \"value_456\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.updateContact({\n crmCreateContactRequestDto: {\n accountIds: [\n \"account-123\",\n \"account-456\",\n ],\n companyName: \"Apple Inc.\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n dealIds: [\n \"deal-001\",\n \"deal-002\",\n ],\n emails: [\n \"steve@apple.com\",\n ],\n firstName: \"Steve\",\n lastName: \"Wozniak\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n phoneNumbers: [\n \"123-456-7890\",\n ],\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/crm/custom_field_definitions/contacts"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_list_contact_custom_field_definitions" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.listContactCustomFieldDefinitions({\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.listContactCustomFieldDefinitions({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/crm/custom_field_definitions/contacts/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_get_contact_custom_field_definition" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.getContactCustomFieldDefinition({\n id: \"\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.getContactCustomFieldDefinition({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/crm/lists"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_list_lists" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.listLists({\n fields: \"id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.listLists({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/crm/lists/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "crm_get_list" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.getList({\n id: \"\",\n fields: \"id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.crm.getList({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/documents/drives"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "documents_list_drives" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.listDrives({\n fields: \"id,remote_id,name,description,url,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.listDrives({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,url,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/documents/drives/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "documents_get_drive" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.getDrive({\n id: \"\",\n fields: \"id,remote_id,name,description,url,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.getDrive({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,url,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/documents/files"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "documents_list_files" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.listFiles({\n fields: \"id,remote_id,name,description,url,size,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n name: \"john_doe_resume.pdf\",\n content: \"FAQ of the project\",\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n driveId: \"1234567890\",\n folderId: \"1234567890\",\n },\n folderId: \"1234567890\",\n nestedItems: \"true\",\n include: \"all_parent_folder_ids\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.listFiles({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,url,size,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields\",\n filter: {\n content: \"FAQ of the project\",\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n driveId: \"1234567890\",\n folderId: \"1234567890\",\n name: \"john_doe_resume.pdf\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n folderId: \"1234567890\",\n include: \"all_parent_folder_ids\",\n nestedItems: \"true\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/documents/files/upload"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "documents_upload_file" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { UnifiedUploadRequestDtoSchemasValue, UnifiedUploadRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.uploadFile({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n unifiedUploadRequestDto: {\n name: \"weather-forecast\",\n fileFormat: {\n value: UnifiedUploadRequestDtoValue.Pdf,\n sourceValue: \"application/pdf\",\n },\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n categoryId: \"6530\",\n path: \"/path/to/file\",\n category: {\n value: \"reports, resumes\",\n sourceValue: \"550e8400-e29b-41d4-a716-446655440000, CUSTOM_CATEGORY_NAME\",\n },\n confidential: {\n value: UnifiedUploadRequestDtoSchemasValue.True,\n sourceValue: \"public\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { UnifiedUploadRequestDtoSchemasValue, UnifiedUploadRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.uploadFile({\n prefer: \"heartbeat\",\n unifiedUploadRequestDto: {\n category: {\n sourceValue: \"550e8400-e29b-41d4-a716-446655440000, CUSTOM_CATEGORY_NAME\",\n value: \"reports, resumes\",\n },\n categoryId: \"6530\",\n confidential: {\n sourceValue: \"public\",\n value: UnifiedUploadRequestDtoValue.True,\n },\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n fileFormat: {\n sourceValue: \"application/pdf\",\n value: UnifiedUploadRequestDtoSchemasValue.Pdf,\n },\n name: \"weather-forecast\",\n path: \"/path/to/file\",\n },\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/documents/files/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "documents_get_file" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.getFile({\n id: \"\",\n fields: \"id,remote_id,name,description,url,size,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields\",\n include: \"all_parent_folder_ids\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.getFile({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,url,size,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields\",\n id: \"\",\n include: \"all_parent_folder_ids\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/documents/files/{id}/download"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "documents_download_file" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.downloadFile({\n id: \"\",\n format: \"base64\",\n exportFormat: \"text/plain\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.downloadFile({\n prefer: \"heartbeat\",\n exportFormat: \"text/plain\",\n format: \"base64\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/documents/folders"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "documents_list_folders" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.listFolders({\n fields: \"id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n driveId: \"1234567890\",\n folderId: \"1234567890\",\n },\n folderId: \"1234567890\",\n nestedItems: \"true\",\n include: \"all_parent_folder_ids\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.listFolders({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields\",\n filter: {\n driveId: \"1234567890\",\n folderId: \"1234567890\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n folderId: \"1234567890\",\n include: \"all_parent_folder_ids\",\n nestedItems: \"true\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/documents/folders/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "documents_get_folder" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.getFolder({\n id: \"\",\n fields: \"id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields\",\n include: \"all_parent_folder_ids\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.documents.getFolder({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields\",\n id: \"\",\n include: \"all_parent_folder_ids\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/benefits"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_benefits" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listBenefits({\n fields: \"id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listBenefits({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/benefits/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_benefit" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getBenefit({\n id: \"\",\n fields: \"id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getBenefit({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/companies"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_companies" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listCompanies({\n fields: \"id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listCompanies({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/companies/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_company" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getCompany({\n id: \"\",\n fields: \"id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getCompany({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/custom_field_definitions/employees"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_custom_field_definitions" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeCustomFieldDefinitions({\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeCustomFieldDefinitions({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/custom_field_definitions/employees/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employee_custom_field_definition" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeCustomFieldDefinition({\n id: \"\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeCustomFieldDefinition({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,options,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/documents/employee_categories"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_categories" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeCategories({\n fields: \"id,remote_id,name,active,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeCategories({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/documents/employee_categories/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employee_document_category" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeDocumentCategory({\n id: \"\",\n fields: \"id,remote_id,name,active,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeDocumentCategory({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employees" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployees({\n fields: \"id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"company,employments,work_location,home_location,groups,skills\",\n include: \"avatar_url,avatar,custom_fields,job_description,benefits,bank_details\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployees({\n prefer: \"heartbeat\",\n expand: \"company,employments,work_location,home_location,groups,skills\",\n fields: \"id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n include: \"avatar_url,avatar,custom_fields,job_description,benefits,bank_details\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_create_employee" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n CountryCodeEnumValue,\n HrisCreateEmployeeRequestDtoSchemasHomeLocationValue,\n HrisCreateEmployeeRequestDtoSchemasValue,\n NationalIdentityNumberApiModelSchemasValue,\n NationalIdentityNumberApiModelValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployee({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisCreateEmployeeRequestDto: {\n title: \"Mr\",\n firstName: \"Isaac\",\n lastName: \"Newton\",\n name: \"Isaac Newton\",\n displayName: \"Sir Isaac Newton\",\n avatarUrl: \"https://example.com/avatar.png\",\n personalEmail: \"isaac.newton@example.com\",\n personalPhoneNumber: \"+1234567890\",\n workEmail: \"newton@example.com\",\n workPhoneNumber: \"+1234567890\",\n jobTitle: \"Physicist\",\n departmentId: \"3093\",\n teamId: \"2913\",\n department: \"Physics\",\n managerId: \"67890\",\n gender: {},\n preferredLanguage: {\n value: HrisCreateEmployeeRequestDtoSchemasValue.Eng,\n },\n ethnicity: {},\n dateOfBirth: new Date(\"1990-01-01T00:00:00.000Z\"),\n birthday: new Date(\"2021-01-01T00:00:00Z\"),\n maritalStatus: {},\n avatar: {},\n hireDate: new Date(\"2021-01-01T00:00:00.000Z\"),\n startDate: new Date(\"2021-01-01T00:00:00.000Z\"),\n employmentStatus: {},\n terminationDate: new Date(\"2021-01-01T00:00:00Z\"),\n companyId: \"1234567890\",\n citizenships: [\n {\n value: CountryCodeEnumValue.Us,\n },\n ],\n employment: null,\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n value: \"Completed\",\n valueId: \"value_456\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n },\n ],\n benefits: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Health Insurance\",\n provider: \"Aetna\",\n description: \"Health insurance for employees\",\n createdAt: new Date(\"2021-01-01T00:00:00Z\"),\n updatedAt: new Date(\"2021-01-01T00:00:00Z\"),\n },\n ],\n employeeNumber: \"125\",\n nationalIdentityNumbers: [\n {\n value: \"123456789\",\n type: {\n value: NationalIdentityNumberApiModelValue.Ssn,\n },\n country: {\n value: NationalIdentityNumberApiModelSchemasValue.Us,\n },\n },\n ],\n homeLocation: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Woolsthorpe Manor\",\n phoneNumber: \"+44 1476 860 364\",\n street1: \"Water Lane\",\n street2: \"Woolsthorpe by Colsterworth\",\n city: \"Grantham\",\n zipCode: \"NG33 5NR\",\n country: {\n value: HrisCreateEmployeeRequestDtoSchemasHomeLocationValue.Us,\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n state: {},\n },\n workLocation: null,\n costCenters: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"R&D\",\n distributionPercentage: 100,\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n CountryCodeEnumValue,\n HrisCreateEmployeeRequestDtoSchemasEmploymentPayPeriodValue,\n HrisCreateEmployeeRequestDtoSchemasEmploymentValue,\n HrisCreateEmployeeRequestDtoSchemasEmploymentWorkTimeValue,\n HrisCreateEmployeeRequestDtoSchemasHomeLocationValue,\n HrisCreateEmployeeRequestDtoSchemasPreferredLanguageValue,\n HrisCreateEmployeeRequestDtoSchemasWorkLocationValue,\n NationalIdentityNumberApiModelSchemasValue,\n NationalIdentityNumberApiModelValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployee({\n hrisCreateEmployeeRequestDto: {\n avatar: {},\n avatarUrl: \"https://example.com/avatar.png\",\n benefits: [\n {\n createdAt: new Date(\"2021-01-01T00:00:00Z\"),\n description: \"Health insurance for employees\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Health Insurance\",\n provider: \"Aetna\",\n updatedAt: new Date(\"2021-01-01T00:00:00Z\"),\n },\n {\n createdAt: new Date(\"2021-01-01T00:00:00Z\"),\n description: \"Health insurance for employees\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Health Insurance\",\n provider: \"Aetna\",\n updatedAt: new Date(\"2021-01-01T00:00:00Z\"),\n },\n ],\n birthday: new Date(\"2021-01-01T00:00:00Z\"),\n citizenships: [\n {\n value: CountryCodeEnumValue.Us,\n },\n ],\n companyId: \"1234567890\",\n costCenters: [\n {\n distributionPercentage: 100,\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"R&D\",\n },\n {\n distributionPercentage: 100,\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"R&D\",\n },\n {\n distributionPercentage: 100,\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"R&D\",\n },\n ],\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n dateOfBirth: new Date(\"1990-01-01T00:00:00.000Z\"),\n department: \"Physics\",\n departmentId: \"3093\",\n displayName: \"Sir Isaac Newton\",\n employeeNumber: \"125\",\n employment: {\n contractType: {\n contractType: {},\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Full-Time\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n endDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n grade: {\n description: \"Mid-level employee demonstrating proficiency and autonomy.\",\n id: \"1687-3\",\n name: \"1687-4\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n jobTitle: \"Software Engineer\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n payCurrency: \"USD\",\n payFrequency: {\n sourceValue: \"Hourly\",\n value: HrisCreateEmployeeRequestDtoSchemasEmploymentValue.Hourly,\n },\n payPeriod: {\n sourceValue: \"Hour\",\n value: HrisCreateEmployeeRequestDtoSchemasEmploymentPayPeriodValue.Hour,\n },\n payRate: \"40.00\",\n payrollCode: \"PC1\",\n type: null,\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n workTime: {\n duration: \"P0Y0M0DT8H0M0S\",\n period: {\n value: HrisCreateEmployeeRequestDtoSchemasEmploymentWorkTimeValue.Month,\n },\n },\n },\n employmentStatus: {},\n ethnicity: {},\n firstName: \"Isaac\",\n gender: {},\n hireDate: new Date(\"2021-01-01T00:00:00.000Z\"),\n homeLocation: {\n city: \"Grantham\",\n country: {\n value: HrisCreateEmployeeRequestDtoSchemasHomeLocationValue.Us,\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Woolsthorpe Manor\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n phoneNumber: \"+44 1476 860 364\",\n state: {},\n street1: \"Water Lane\",\n street2: \"Woolsthorpe by Colsterworth\",\n zipCode: \"NG33 5NR\",\n },\n jobTitle: \"Physicist\",\n lastName: \"Newton\",\n managerId: \"67890\",\n maritalStatus: {},\n name: \"Isaac Newton\",\n nationalIdentityNumbers: [\n {\n country: {\n value: NationalIdentityNumberApiModelValue.Us,\n },\n type: {\n value: NationalIdentityNumberApiModelSchemasValue.Ssn,\n },\n value: \"123456789\",\n },\n {\n country: {\n value: NationalIdentityNumberApiModelValue.Us,\n },\n type: {\n value: NationalIdentityNumberApiModelSchemasValue.Ssn,\n },\n value: \"123456789\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n personalEmail: \"isaac.newton@example.com\",\n personalPhoneNumber: \"+1234567890\",\n preferredLanguage: {\n value: HrisCreateEmployeeRequestDtoSchemasPreferredLanguageValue.Eng,\n },\n startDate: new Date(\"2021-01-01T00:00:00.000Z\"),\n teamId: \"2913\",\n terminationDate: new Date(\"2021-01-01T00:00:00Z\"),\n title: \"Mr\",\n workEmail: \"newton@example.com\",\n workLocation: {\n city: \"Grantham\",\n country: {\n value: HrisCreateEmployeeRequestDtoSchemasWorkLocationValue.Us,\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Woolsthorpe Manor\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n phoneNumber: \"+44 1476 860 364\",\n state: {},\n street1: \"Water Lane\",\n street2: \"Woolsthorpe by Colsterworth\",\n zipCode: \"NG33 5NR\",\n },\n workPhoneNumber: \"+1234567890\",\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employee" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployee({\n id: \"\",\n fields: \"id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields\",\n expand: \"company,employments,work_location,home_location,groups,skills\",\n include: \"avatar_url,avatar,custom_fields,job_description,benefits,bank_details\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployee({\n prefer: \"heartbeat\",\n expand: \"company,employments,work_location,home_location,groups,skills\",\n fields: \"id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields\",\n id: \"\",\n include: \"avatar_url,avatar,custom_fields,job_description,benefits,bank_details\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_update_employee" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n CountryCodeEnumValue,\n HrisUpdateEmployeeRequestDtoSchemasHomeLocationValue,\n HrisUpdateEmployeeRequestDtoSchemasValue,\n HrisUpdateEmployeeRequestDtoSchemasWorkLocationValue,\n NationalIdentityNumberApiModelSchemasValue,\n NationalIdentityNumberApiModelValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployee({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisUpdateEmployeeRequestDto: {\n title: \"Mr\",\n firstName: \"Isaac\",\n lastName: \"Newton\",\n name: \"Isaac Newton\",\n displayName: \"Sir Isaac Newton\",\n avatarUrl: \"https://example.com/avatar.png\",\n personalEmail: \"isaac.newton@example.com\",\n personalPhoneNumber: \"+1234567890\",\n workEmail: \"newton@example.com\",\n workPhoneNumber: \"+1234567890\",\n jobTitle: \"Physicist\",\n departmentId: \"3093\",\n teamId: \"2913\",\n department: \"Physics\",\n managerId: \"67890\",\n gender: {},\n preferredLanguage: {\n value: HrisUpdateEmployeeRequestDtoSchemasValue.Eng,\n },\n ethnicity: {},\n dateOfBirth: new Date(\"1990-01-01T00:00:00.000Z\"),\n birthday: new Date(\"2021-01-01T00:00:00Z\"),\n maritalStatus: {},\n avatar: {},\n hireDate: new Date(\"2021-01-01T00:00:00.000Z\"),\n startDate: new Date(\"2021-01-01T00:00:00.000Z\"),\n employmentStatus: {},\n terminationDate: new Date(\"2021-01-01T00:00:00Z\"),\n companyId: \"1234567890\",\n citizenships: [\n {\n value: CountryCodeEnumValue.Us,\n },\n ],\n employment: null,\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n value: \"Completed\",\n valueId: \"value_456\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n },\n ],\n benefits: null,\n employeeNumber: \"125\",\n nationalIdentityNumbers: [\n {\n value: \"123456789\",\n type: {\n value: NationalIdentityNumberApiModelValue.Ssn,\n },\n country: {\n value: NationalIdentityNumberApiModelSchemasValue.Us,\n },\n },\n ],\n homeLocation: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Woolsthorpe Manor\",\n phoneNumber: \"+44 1476 860 364\",\n street1: \"Water Lane\",\n street2: \"Woolsthorpe by Colsterworth\",\n city: \"Grantham\",\n zipCode: \"NG33 5NR\",\n country: {\n value: HrisUpdateEmployeeRequestDtoSchemasHomeLocationValue.Us,\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n state: {},\n },\n workLocation: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Woolsthorpe Manor\",\n phoneNumber: \"+44 1476 860 364\",\n street1: \"Water Lane\",\n street2: \"Woolsthorpe by Colsterworth\",\n city: \"Grantham\",\n zipCode: \"NG33 5NR\",\n country: {\n value: HrisUpdateEmployeeRequestDtoSchemasWorkLocationValue.Us,\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n state: {},\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n CountryCodeEnumValue,\n HrisUpdateEmployeeRequestDtoSchemasEmploymentPayPeriodValue,\n HrisUpdateEmployeeRequestDtoSchemasEmploymentValue,\n HrisUpdateEmployeeRequestDtoSchemasEmploymentWorkTimeValue,\n HrisUpdateEmployeeRequestDtoSchemasHomeLocationValue,\n HrisUpdateEmployeeRequestDtoSchemasPreferredLanguageValue,\n HrisUpdateEmployeeRequestDtoSchemasWorkLocationValue,\n NationalIdentityNumberApiModelSchemasValue,\n NationalIdentityNumberApiModelValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployee({\n hrisUpdateEmployeeRequestDto: {\n avatar: {},\n avatarUrl: \"https://example.com/avatar.png\",\n benefits: [\n {\n createdAt: new Date(\"2021-01-01T00:00:00Z\"),\n description: \"Health insurance for employees\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Health Insurance\",\n provider: \"Aetna\",\n updatedAt: new Date(\"2021-01-01T00:00:00Z\"),\n },\n {\n createdAt: new Date(\"2021-01-01T00:00:00Z\"),\n description: \"Health insurance for employees\",\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Health Insurance\",\n provider: \"Aetna\",\n updatedAt: new Date(\"2021-01-01T00:00:00Z\"),\n },\n ],\n birthday: new Date(\"2021-01-01T00:00:00Z\"),\n citizenships: [\n {\n value: CountryCodeEnumValue.Us,\n },\n ],\n companyId: \"1234567890\",\n customFields: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteValueId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n value: \"Completed\",\n valueId: \"value_456\",\n },\n ],\n dateOfBirth: new Date(\"1990-01-01T00:00:00.000Z\"),\n department: \"Physics\",\n departmentId: \"3093\",\n displayName: \"Sir Isaac Newton\",\n employeeNumber: \"125\",\n employment: {\n contractType: {\n contractType: {},\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Full-Time\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n endDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n grade: {\n description: \"Mid-level employee demonstrating proficiency and autonomy.\",\n id: \"1687-3\",\n name: \"1687-4\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n jobTitle: \"Software Engineer\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n payCurrency: \"USD\",\n payFrequency: {\n sourceValue: \"Hourly\",\n value: HrisUpdateEmployeeRequestDtoSchemasEmploymentValue.Hourly,\n },\n payPeriod: {\n sourceValue: \"Hour\",\n value: HrisUpdateEmployeeRequestDtoSchemasEmploymentPayPeriodValue.Hour,\n },\n payRate: \"40.00\",\n payrollCode: \"PC1\",\n type: null,\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n workTime: {\n duration: \"P0Y0M0DT8H0M0S\",\n period: {\n value: HrisUpdateEmployeeRequestDtoSchemasEmploymentWorkTimeValue.Month,\n },\n },\n },\n employmentStatus: {},\n ethnicity: {},\n firstName: \"Isaac\",\n gender: {},\n hireDate: new Date(\"2021-01-01T00:00:00.000Z\"),\n homeLocation: {\n city: \"Grantham\",\n country: {\n value: HrisUpdateEmployeeRequestDtoSchemasHomeLocationValue.Us,\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Woolsthorpe Manor\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n phoneNumber: \"+44 1476 860 364\",\n state: {},\n street1: \"Water Lane\",\n street2: \"Woolsthorpe by Colsterworth\",\n zipCode: \"NG33 5NR\",\n },\n jobTitle: \"Physicist\",\n lastName: \"Newton\",\n managerId: \"67890\",\n maritalStatus: {},\n name: \"Isaac Newton\",\n nationalIdentityNumbers: [\n {\n country: {\n value: NationalIdentityNumberApiModelValue.Us,\n },\n type: {\n value: NationalIdentityNumberApiModelSchemasValue.Ssn,\n },\n value: \"123456789\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n personalEmail: \"isaac.newton@example.com\",\n personalPhoneNumber: \"+1234567890\",\n preferredLanguage: {\n value: HrisUpdateEmployeeRequestDtoSchemasPreferredLanguageValue.Eng,\n },\n startDate: new Date(\"2021-01-01T00:00:00.000Z\"),\n teamId: \"2913\",\n terminationDate: new Date(\"2021-01-01T00:00:00Z\"),\n title: \"Mr\",\n workEmail: \"newton@example.com\",\n workLocation: {\n city: \"Grantham\",\n country: {\n value: HrisUpdateEmployeeRequestDtoSchemasWorkLocationValue.Us,\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Woolsthorpe Manor\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n phoneNumber: \"+44 1476 860 364\",\n state: {},\n street1: \"Water Lane\",\n street2: \"Woolsthorpe by Colsterworth\",\n zipCode: \"NG33 5NR\",\n },\n workPhoneNumber: \"+1234567890\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/documents"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_documents" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeDocuments({\n id: \"\",\n fields: \"id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeDocuments({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/documents/upload"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_upload_employee_document" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { HrisDocumentsUploadRequestDtoSchemasValue, HrisDocumentsUploadRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.uploadEmployeeDocument({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisDocumentsUploadRequestDto: {\n name: \"weather-forecast\",\n fileFormat: {\n value: HrisDocumentsUploadRequestDtoValue.Pdf,\n sourceValue: \"application/pdf\",\n },\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n categoryId: \"6530\",\n path: \"/path/to/file\",\n confidential: {\n value: HrisDocumentsUploadRequestDtoSchemasValue.True,\n sourceValue: \"public\",\n },\n category: {},\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n HrisDocumentsUploadRequestDtoSchemasFileFormatValue,\n HrisDocumentsUploadRequestDtoSchemasValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.uploadEmployeeDocument({\n hrisDocumentsUploadRequestDto: {\n category: {},\n categoryId: \"6530\",\n confidential: {\n sourceValue: \"public\",\n value: HrisDocumentsUploadRequestDtoSchemasValue.True,\n },\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n fileFormat: {\n sourceValue: \"application/pdf\",\n value: HrisDocumentsUploadRequestDtoSchemasFileFormatValue.Pdf,\n },\n name: \"weather-forecast\",\n path: \"/path/to/file\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/documents/upload/batch"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_batch_upload_employee_document" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { HrisDocumentsUploadRequestDtoSchemasValue, HrisDocumentsUploadRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.batchUploadEmployeeDocument({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisBatchDocumentUploadRequestDto: {\n items: [\n {\n name: \"weather-forecast\",\n fileFormat: {\n value: HrisDocumentsUploadRequestDtoValue.Pdf,\n sourceValue: \"application/pdf\",\n },\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n categoryId: \"6530\",\n path: \"/path/to/file\",\n confidential: {\n value: HrisDocumentsUploadRequestDtoSchemasValue.True,\n sourceValue: \"public\",\n },\n category: {},\n },\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n HrisDocumentsUploadRequestDtoSchemasFileFormatValue,\n HrisDocumentsUploadRequestDtoSchemasValue,\n HrisDocumentsUploadRequestDtoValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.batchUploadEmployeeDocument({\n hrisBatchDocumentUploadRequestDto: {\n items: [\n {\n category: {\n sourceValue: \"550e8400-e29b-41d4-a716-446655440000\",\n value: HrisDocumentsUploadRequestDtoValue.Shared,\n },\n categoryId: \"6530\",\n confidential: {\n sourceValue: \"public\",\n value: HrisDocumentsUploadRequestDtoSchemasValue.True,\n },\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n fileFormat: {\n sourceValue: \"abc\",\n value: HrisDocumentsUploadRequestDtoSchemasFileFormatValue.Pdf,\n },\n name: \"weather-forecast\",\n path: \"/path/to/file\",\n },\n {\n category: {\n sourceValue: \"550e8400-e29b-41d4-a716-446655440000\",\n value: HrisDocumentsUploadRequestDtoValue.Shared,\n },\n categoryId: \"6530\",\n confidential: {\n sourceValue: \"public\",\n value: HrisDocumentsUploadRequestDtoSchemasValue.True,\n },\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n fileFormat: {\n sourceValue: \"abc\",\n value: HrisDocumentsUploadRequestDtoSchemasFileFormatValue.Pdf,\n },\n name: \"weather-forecast\",\n path: \"/path/to/file\",\n },\n ],\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/documents/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employee_document" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeDocument({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeDocument({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/documents/{subResourceId}/download"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_download_employee_document" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.downloadEmployeeDocument({\n id: \"\",\n subResourceId: \"\",\n format: \"base64\",\n exportFormat: \"text/plain\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.downloadEmployeeDocument({\n prefer: \"heartbeat\",\n exportFormat: \"text/plain\",\n format: \"base64\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/employments"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_employments" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeEmployments({\n id: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"groups\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeEmployments({\n prefer: \"heartbeat\",\n expand: \"groups\",\n fields: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/employments"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_create_employee_employment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { HrisCreateEmploymentRequestDtoSchemasValue, HrisCreateEmploymentRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployeeEmployment({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisCreateEmploymentRequestDto: {\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n jobTitle: \"Software Engineer\",\n payRate: \"40.00\",\n payPeriod: {\n value: HrisCreateEmploymentRequestDtoValue.Hour,\n sourceValue: \"Hour\",\n },\n payFrequency: {\n value: HrisCreateEmploymentRequestDtoSchemasValue.Hourly,\n sourceValue: \"Hourly\",\n },\n payCurrency: \"USD\",\n effectiveDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n endDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n grade: {\n id: \"1687-3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"1687-4\",\n description: \"Mid-level employee demonstrating proficiency and autonomy.\",\n },\n type: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Permanent\",\n type: {},\n },\n contractType: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Full-Time\",\n contractType: {},\n },\n workTime: null,\n payrollCode: \"PC1\",\n jobId: \"5290\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n HrisCreateEmploymentRequestDtoSchemasPayFrequencyValue,\n HrisCreateEmploymentRequestDtoSchemasPayPeriodValue,\n HrisCreateEmploymentRequestDtoSchemasWorkTimeValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployeeEmployment({\n hrisCreateEmploymentRequestDto: {\n contractType: {\n contractType: {},\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Full-Time\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n effectiveDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n endDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n grade: {\n description: \"Mid-level employee demonstrating proficiency and autonomy.\",\n id: \"1687-3\",\n name: \"1687-4\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n jobId: \"5290\",\n jobTitle: \"Software Engineer\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n payCurrency: \"USD\",\n payFrequency: {\n sourceValue: \"Hourly\",\n value: HrisCreateEmploymentRequestDtoSchemasPayFrequencyValue.Hourly,\n },\n payPeriod: {\n sourceValue: \"Hour\",\n value: HrisCreateEmploymentRequestDtoSchemasPayPeriodValue.Hour,\n },\n payRate: \"40.00\",\n payrollCode: \"PC1\",\n type: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Permanent\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n type: {},\n },\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n workTime: {\n duration: \"P0Y0M0DT8H0M0S\",\n period: {\n value: HrisCreateEmploymentRequestDtoSchemasWorkTimeValue.Month,\n },\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/employments/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employee_employment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeEmployment({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields\",\n expand: \"groups\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeEmployment({\n prefer: \"heartbeat\",\n expand: \"groups\",\n fields: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/employments/{subResourceId}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_update_employee_employment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { HrisUpdateEmploymentRequestDtoSchemasValue, HrisUpdateEmploymentRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployeeEmployment({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisUpdateEmploymentRequestDto: {\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n jobTitle: \"Software Engineer\",\n payRate: \"40.00\",\n payPeriod: {\n value: HrisUpdateEmploymentRequestDtoValue.Hour,\n sourceValue: \"Hour\",\n },\n payFrequency: {\n value: HrisUpdateEmploymentRequestDtoSchemasValue.Hourly,\n sourceValue: \"Hourly\",\n },\n payCurrency: \"USD\",\n effectiveDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n endDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n grade: {\n id: \"1687-3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"1687-4\",\n description: \"Mid-level employee demonstrating proficiency and autonomy.\",\n },\n type: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Permanent\",\n type: {},\n },\n contractType: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Full-Time\",\n contractType: {},\n },\n workTime: null,\n payrollCode: \"PC1\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n HrisUpdateEmploymentRequestDtoSchemasPayFrequencyValue,\n HrisUpdateEmploymentRequestDtoSchemasPayPeriodValue,\n HrisUpdateEmploymentRequestDtoSchemasWorkTimeValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployeeEmployment({\n hrisUpdateEmploymentRequestDto: {\n contractType: {\n contractType: {},\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Full-Time\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n effectiveDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n endDate: new Date(\"2021-01-01T01:01:01.000Z\"),\n grade: {\n description: \"Mid-level employee demonstrating proficiency and autonomy.\",\n id: \"1687-3\",\n name: \"1687-4\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n jobTitle: \"Software Engineer\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n payCurrency: \"USD\",\n payFrequency: {\n sourceValue: \"Hourly\",\n value: HrisUpdateEmploymentRequestDtoSchemasPayFrequencyValue.Hourly,\n },\n payPeriod: {\n sourceValue: \"Hour\",\n value: HrisUpdateEmploymentRequestDtoSchemasPayPeriodValue.Hour,\n },\n payRate: \"40.00\",\n payrollCode: \"PC1\",\n type: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n label: \"Permanent\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n type: {},\n },\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n workTime: {\n duration: \"P0Y0M0DT8H0M0S\",\n period: {\n value: HrisUpdateEmploymentRequestDtoSchemasWorkTimeValue.Month,\n },\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/invite"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_invite_employee" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.inviteEmployee({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisInviteEmployeeRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.inviteEmployee({\n hrisInviteEmployeeRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/shifts"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_shifts" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeShifts({\n id: \"\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n startsAfter: \"2024-01-15T09:00\",\n endsBefore: \"2024-01-15T17:00\",\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeShifts({\n prefer: \"heartbeat\",\n filter: {\n endsBefore: \"2024-01-15T17:00\",\n startsAfter: \"2024-01-15T09:00\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/shifts/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employee_shift" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeShift({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeShift({\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/skills"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_skills" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeSkills({\n id: \"\",\n fields: \"id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeSkills({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/skills"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_create_employee_skill" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployeeSkill({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n entitySkillsCreateRequestDto: {\n id: \"16873-IT345\",\n name: \"Information-Technology\",\n maximumProficiency: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Expert\",\n },\n minimumProficiency: null,\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployeeSkill({\n entitySkillsCreateRequestDto: {\n id: \"16873-IT345\",\n maximumProficiency: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Expert\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n minimumProficiency: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Expert\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n name: \"Information-Technology\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/skills/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employee_skill" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeSkill({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeSkill({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/tasks"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_tasks" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeTasks({\n id: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"attachments\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeTasks({\n prefer: \"heartbeat\",\n expand: \"attachments\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields\",\n filter: {\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/tasks/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employee_task" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeTask({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields\",\n expand: \"attachments\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeTask({\n prefer: \"heartbeat\",\n expand: \"attachments\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/tasks/{subResourceId}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_update_employee_task" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { UpdateTaskRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployeeTask({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n updateTaskRequestDto: {\n comment: \"All required documents have been submitted\",\n status: {\n value: UpdateTaskRequestDtoValue.Open,\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { UpdateTaskRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployeeTask({\n prefer: \"heartbeat\",\n updateTaskRequestDto: {\n comment: \"All required documents have been submitted\",\n status: {\n value: UpdateTaskRequestDtoValue.Open,\n },\n },\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/time_off"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_time_off_requests" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeTimeOffRequests({\n id: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n startDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n endDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"policy\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeTimeOffRequests({\n prefer: \"heartbeat\",\n expand: \"policy\",\n fields: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields\",\n filter: {\n endDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n startDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/time_off"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_create_employee_time_off_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployeeTimeOffRequest({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisCreateTimeOffRequestDto: {\n approverId: \"1687-4\",\n startDate: \"2021-01-01T01:01:01.000\",\n endDate: \"2021-01-01T01:01:01.000\",\n startHalfDay: true,\n endHalfDay: true,\n timeOffPolicyId: \"cx280928933\",\n reason: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n comment: \"Taking a day off for personal reasons\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployeeTimeOffRequest({\n hrisCreateTimeOffRequestDto: {\n approverId: \"1687-4\",\n comment: \"Taking a day off for personal reasons\",\n endDate: \"2021-01-01T01:01:01.000\",\n endHalfDay: true,\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n reason: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n startDate: \"2021-01-01T01:01:01.000\",\n startHalfDay: true,\n timeOffPolicyId: \"cx280928933\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/time_off/{subResourceId}"]["delete"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_cancel_employee_time_off_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.cancelEmployeeTimeOffRequest({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.cancelEmployeeTimeOffRequest({\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/time_off/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employees_time_off_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeesTimeOffRequest({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields\",\n expand: \"policy\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeesTimeOffRequest({\n prefer: \"heartbeat\",\n expand: \"policy\",\n fields: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/time_off/{subResourceId}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_update_employee_time_off_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployeeTimeOffRequest({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisCreateTimeOffRequestDto: {\n approverId: \"1687-4\",\n startDate: \"2021-01-01T01:01:01.000\",\n endDate: \"2021-01-01T01:01:01.000\",\n startHalfDay: true,\n endHalfDay: true,\n timeOffPolicyId: \"cx280928933\",\n reason: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n comment: \"Taking a day off for personal reasons\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployeeTimeOffRequest({\n hrisCreateTimeOffRequestDto: {\n approverId: \"1687-4\",\n comment: \"Taking a day off for personal reasons\",\n endDate: \"2021-01-01T01:01:01.000\",\n endHalfDay: true,\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n reason: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n startDate: \"2021-01-01T01:01:01.000\",\n startHalfDay: true,\n timeOffPolicyId: \"cx280928933\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/time_off_balances"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_time_off_balances" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeTimeOffBalances({\n id: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"policy\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeTimeOffBalances({\n prefer: \"heartbeat\",\n expand: \"policy\",\n fields: \"id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/time_off_balances/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employee_time_off_balance" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeTimeOffBalance({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields\",\n expand: \"policy\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeeTimeOffBalance({\n prefer: \"heartbeat\",\n expand: \"policy\",\n fields: \"id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/time_off_policies"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_time_off_policies" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeTimeOffPolicies({\n id: \"\",\n fields: \"id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeTimeOffPolicies({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/work_eligibility"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employee_work_eligibility" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeWorkEligibility({\n id: \"\",\n fields: \"id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployeeWorkEligibility({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/work_eligibility"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_create_employee_work_eligibility_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { HrisCreateWorkEligibilityRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployeeWorkEligibilityRequest({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisCreateWorkEligibilityRequestDto: {\n document: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"My Document\",\n category: {},\n categoryId: \"6530\",\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n updatedAt: new Date(\"2021-01-02T01:01:01.000Z\"),\n remoteUrl: \"https://example.com/file.pdf\",\n fileFormat: null,\n },\n issuedBy: {\n value: HrisCreateWorkEligibilityRequestDtoValue.Us,\n },\n number: \"1234567890\",\n subType: \"H1B\",\n type: {},\n validFrom: new Date(\"2021-01-01T00:00:00.000Z\"),\n validTo: new Date(\"2021-01-01T00:00:00.000Z\"),\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n HrisCreateWorkEligibilityRequestDtoSchemasDocumentValue,\n HrisCreateWorkEligibilityRequestDtoValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.createEmployeeWorkEligibilityRequest({\n hrisCreateWorkEligibilityRequestDto: {\n document: {\n category: {},\n categoryId: \"6530\",\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n fileFormat: {\n sourceValue: \"application/pdf\",\n value: HrisCreateWorkEligibilityRequestDtoSchemasDocumentValue.Pdf,\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"My Document\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteUrl: \"https://example.com/file.pdf\",\n updatedAt: new Date(\"2021-01-02T01:01:01.000Z\"),\n },\n issuedBy: {\n value: HrisCreateWorkEligibilityRequestDtoValue.Us,\n },\n number: \"1234567890\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n subType: \"H1B\",\n type: {},\n validFrom: new Date(\"2021-01-01T00:00:00.000Z\"),\n validTo: new Date(\"2021-01-01T00:00:00.000Z\"),\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/work_eligibility/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employees_work_eligibility" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeesWorkEligibility({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployeesWorkEligibility({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employees/{id}/work_eligibility/{subResourceId}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_update_employee_work_eligibility_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n HrisCreateWorkEligibilityRequestDtoSchemasDocumentValue,\n HrisCreateWorkEligibilityRequestDtoValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployeeWorkEligibilityRequest({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n hrisCreateWorkEligibilityRequestDto: {\n document: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"My Document\",\n category: {},\n categoryId: \"6530\",\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n updatedAt: new Date(\"2021-01-02T01:01:01.000Z\"),\n remoteUrl: \"https://example.com/file.pdf\",\n fileFormat: {\n value: HrisCreateWorkEligibilityRequestDtoSchemasDocumentValue.Pdf,\n sourceValue: \"application/pdf\",\n },\n },\n issuedBy: {\n value: HrisCreateWorkEligibilityRequestDtoValue.Us,\n },\n number: \"1234567890\",\n subType: \"H1B\",\n type: {},\n validFrom: new Date(\"2021-01-01T00:00:00.000Z\"),\n validTo: new Date(\"2021-01-01T00:00:00.000Z\"),\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n HrisCreateWorkEligibilityRequestDtoSchemasDocumentValue,\n HrisCreateWorkEligibilityRequestDtoValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.updateEmployeeWorkEligibilityRequest({\n hrisCreateWorkEligibilityRequestDto: {\n document: {\n category: {},\n categoryId: \"6530\",\n createdAt: new Date(\"2021-01-01T01:01:01.000Z\"),\n fileFormat: {\n sourceValue: \"application/pdf\",\n value: HrisCreateWorkEligibilityRequestDtoSchemasDocumentValue.Pdf,\n },\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"My Document\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteUrl: \"https://example.com/file.pdf\",\n updatedAt: new Date(\"2021-01-02T01:01:01.000Z\"),\n },\n issuedBy: {\n value: HrisCreateWorkEligibilityRequestDtoValue.Us,\n },\n number: \"1234567890\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n subType: \"H1B\",\n type: {},\n validFrom: new Date(\"2021-01-01T00:00:00.000Z\"),\n validTo: new Date(\"2021-01-01T00:00:00.000Z\"),\n },\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/employments"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_employments" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployments({\n fields: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"groups\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listEmployments({\n prefer: \"heartbeat\",\n expand: \"groups\",\n fields: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/employments/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_employment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployment({\n id: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields\",\n expand: \"groups\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getEmployment({\n prefer: \"heartbeat\",\n expand: \"groups\",\n fields: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_groups" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listGroups({\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listGroups({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/companies"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_companies_groups" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listCompaniesGroups({\n fields: \"id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listCompaniesGroups({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/companies/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_company_group" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getCompanyGroup({\n id: \"\",\n fields: \"id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getCompanyGroup({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/cost_centers"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_cost_center_groups" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listCostCenterGroups({\n fields: \"id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listCostCenterGroups({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/cost_centers/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_cost_center_group" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getCostCenterGroup({\n id: \"\",\n fields: \"id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getCostCenterGroup({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/departments"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_department_groups" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listDepartmentGroups({\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listDepartmentGroups({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/departments/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_department_group" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getDepartmentGroup({\n id: \"\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getDepartmentGroup({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/divisions"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_division_groups" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listDivisionGroups({\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listDivisionGroups({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/divisions/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_division_group" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getDivisionGroup({\n id: \"\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getDivisionGroup({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/teams"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_team_groups" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTeamGroups({\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTeamGroups({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/teams/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_team_group" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTeamGroup({\n id: \"\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTeamGroup({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/groups/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_group" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getGroup({\n id: \"\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getGroup({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/jobs"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_jobs" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listJobs({\n fields: \"id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listJobs({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/jobs/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_job" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getJob({\n id: \"\",\n fields: \"id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getJob({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/locations"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_locations" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listLocations({\n fields: \"id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listLocations({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/locations/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_location" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getLocation({\n id: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getLocation({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/positions"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_positions" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { QueryParamStatus } from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listPositions({\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n status: QueryParamStatus.Open,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { HrisListPositionsQueryParamStatus } from \"@stackone/stackone-client-ts/sdk/models/operations\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listPositions({\n prefer: \"heartbeat\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n status: HrisListPositionsQueryParamStatus.Open,\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/positions/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_position" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getPosition({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getPosition({\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/shifts"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_shifts" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listShifts({\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n startsAfter: \"2024-01-15T09:00\",\n endsBefore: \"2024-01-15T17:00\",\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listShifts({\n prefer: \"heartbeat\",\n filter: {\n endsBefore: \"2024-01-15T17:00\",\n startsAfter: \"2024-01-15T09:00\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/shifts/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_shift" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getShift({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getShift({\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/tasks"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_tasks" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTasks({\n fields: \"id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"attachments\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTasks({\n prefer: \"heartbeat\",\n expand: \"attachments\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields\",\n filter: {\n createdAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/tasks/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_task" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTask({\n id: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields\",\n expand: \"attachments\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTask({\n prefer: \"heartbeat\",\n expand: \"attachments\",\n fields: \"id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/time_entries"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_time_entries" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTimeEntries({\n fields: \"id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n startTime: \"2020-01-01T00:00:00.000Z\",\n endTime: \"2020-01-01T00:00:00.000Z\",\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTimeEntries({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields\",\n filter: {\n endTime: \"2020-01-01T00:00:00.000Z\",\n startTime: \"2020-01-01T00:00:00.000Z\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/time_entries/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_time_entries" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTimeEntries({\n id: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTimeEntries({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/time_off"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_time_off_requests" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTimeOffRequests({\n fields: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields\",\n filter: null,\n expand: \"policy\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTimeOffRequests({\n prefer: \"heartbeat\",\n expand: \"policy\",\n fields: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields\",\n filter: {\n endDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n startDate: new Date(\"2020-01-01T00:00:00.000Z\"),\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/time_off/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_time_off_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTimeOffRequest({\n id: \"\",\n fields: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields\",\n expand: \"policy\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTimeOffRequest({\n prefer: \"heartbeat\",\n expand: \"policy\",\n fields: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/hris/time_off_policies"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_list_time_off_policies" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTimeOffPolicies({\n fields: \"id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.listTimeOffPolicies({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/hris/time_off_policies/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "hris_get_time_off_policy" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTimeOffPolicy({\n id: \"\",\n fields: \"id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.hris.getTimeOffPolicy({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/iam/groups"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_list_groups" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.listGroups({\n fields: \"id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at,unified_custom_fields\",\n filter: null,\n expand: \"roles\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.listGroups({\n prefer: \"heartbeat\",\n expand: \"roles\",\n fields: \"id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/iam/groups/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_get_group" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.getGroup({\n id: \"\",\n fields: \"id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at,unified_custom_fields\",\n expand: \"roles\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.getGroup({\n prefer: \"heartbeat\",\n expand: \"roles\",\n fields: \"id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/iam/policies"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_list_policies" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.listPolicies({\n fields: \"id,remote_id,name,permissions,description,created_at,updated_at,unified_custom_fields\",\n filter: null,\n expand: \"permissions\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.listPolicies({\n prefer: \"heartbeat\",\n expand: \"permissions\",\n fields: \"id,remote_id,name,permissions,description,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/iam/policies/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_get_policy" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.getPolicy({\n id: \"\",\n fields: \"id,remote_id,name,permissions,description,created_at,updated_at,unified_custom_fields\",\n expand: \"permissions\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.getPolicy({\n prefer: \"heartbeat\",\n expand: \"permissions\",\n fields: \"id,remote_id,name,permissions,description,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/iam/roles"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_list_roles" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.listRoles({\n fields: \"id,remote_id,name,type,policies,description,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"policies\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.listRoles({\n prefer: \"heartbeat\",\n expand: \"policies\",\n fields: \"id,remote_id,name,type,policies,description,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/iam/roles/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_get_role" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.getRole({\n id: \"\",\n fields: \"id,remote_id,name,type,policies,description,created_at,updated_at,unified_custom_fields\",\n expand: \"policies\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.getRole({\n prefer: \"heartbeat\",\n expand: \"policies\",\n fields: \"id,remote_id,name,type,policies,description,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/iam/users"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_list_users" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.listUsers({\n fields: \"id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n expand: \"roles,groups\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.listUsers({\n prefer: \"heartbeat\",\n expand: \"roles,groups\",\n fields: \"id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/iam/users/{id}"]["delete"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_delete_user" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.deleteUser({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.deleteUser({\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/iam/users/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_get_user" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.getUser({\n id: \"\",\n fields: \"id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled,unified_custom_fields\",\n expand: \"roles,groups\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.getUser({\n prefer: \"heartbeat\",\n expand: \"roles,groups\",\n fields: \"id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/iam/users/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "iam_update_user" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { IamUpdateUserRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.updateUser({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n iamUpdateUserRequestDto: {\n primaryEmailAddress: \"han@stackone.com\",\n firstName: \"Han\",\n lastName: \"Solo\",\n name: \"Han Solo\",\n username: \"hansolo1977\",\n isBotUser: true,\n status: {\n value: IamUpdateUserRequestDtoValue.Enabled,\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { IamUpdateUserRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.iam.updateUser({\n iamUpdateUserRequestDto: {\n firstName: \"Han\",\n isBotUser: true,\n lastName: \"Solo\",\n name: \"Han Solo\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n primaryEmailAddress: \"han@stackone.com\",\n status: {\n value: IamUpdateUserRequestDtoValue.Enabled,\n },\n username: \"hansolo1977\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/assignments"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_list_assignments" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listAssignments({\n fields: \"id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n userId: \"c28xyrc55866bvuv\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listAssignments({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n userId: \"c28xyrc55866bvuv\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/lms/assignments/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_get_assignment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getAssignment({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getAssignment({\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/categories"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_list_categories" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listCategories({\n fields: \"id,remote_id,name,active,hierarchy,level,language,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listCategories({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,hierarchy,level,language,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/lms/categories/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_get_category" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getCategory({\n id: \"\",\n fields: \"id,remote_id,name,active,hierarchy,level,language,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getCategory({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,hierarchy,level,language,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/completions"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_list_completions" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listCompletions({\n fields: \"id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,score,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listCompletions({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,score,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/lms/completions/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_get_completion" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getCompletion({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getCompletion({\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/content"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_list_content" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listContent({\n fields: \"id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listContent({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/lms/content"]["put"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_upsert_content" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { CreateCategoriesApiModelSchemasLanguageValue, LanguageEnumValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.upsertContent({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n lmsUpsertContentRequestDto: {\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n languages: [\n {\n value: LanguageEnumValue.EnGB,\n },\n ],\n contentUrl: \"https://www.youtube.com/watch?v=16873\",\n mobileLaunchContentUrl: \"https://www.mobile.youtube.com/watch?v=16873\",\n coverUrl: \"https://www.googledrive.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n skills: [\n {\n id: \"12345\",\n name: \"Sales Techniques\",\n },\n ],\n order: 1,\n localizations: [\n {\n title: \"Software Engineer Lv 1\",\n description: \"This course acts as learning resource for software engineers.\",\n },\n {\n title: \"Software Engineer: A comprehensive guide\",\n description: \"This course acts as learning resource for software engineers.\",\n },\n ],\n tags: [\n \"Sales Techniques\",\n \"Customer Service\",\n ],\n authors: [\n {\n id: \"123\",\n name: \"John Doe\",\n },\n ],\n updatedAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n createdAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n externalReference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n categories: [\n {\n id: \"16873-IT345\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n name: \"Information-Technology\",\n language: {\n value: CreateCategoriesApiModelSchemasLanguageValue.EnGB,\n },\n },\n ],\n additionalData: [\n {\n id: \"learning_outcomes\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n value: \"This is additional data\",\n },\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { CreateCategoriesApiModelSchemasValue, LanguageEnumValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.upsertContent({\n lmsUpsertContentRequestDto: {\n active: true,\n additionalData: [\n {\n id: \"learning_outcomes\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n value: \"This is additional data\",\n },\n {\n id: \"learning_outcomes\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n value: \"This is additional data\",\n },\n ],\n authors: [\n {\n id: \"123\",\n name: \"John Doe\",\n },\n ],\n categories: [\n {\n id: \"16873-IT345\",\n language: {\n value: CreateCategoriesApiModelSchemasValue.EnGB,\n },\n name: \"Information-Technology\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n {\n id: \"16873-IT345\",\n language: {\n value: CreateCategoriesApiModelSchemasValue.EnGB,\n },\n name: \"Information-Technology\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n ],\n contentUrl: \"https://www.youtube.com/watch?v=16873\",\n coverUrl: \"https://www.googledrive.com/?v=16873\",\n createdAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n description: \"This video acts as learning content for software engineers.\",\n duration: \"P3Y6M4DT12H30M5S\",\n externalReference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n languages: [\n {\n value: LanguageEnumValue.EnGB,\n },\n ],\n localizations: [\n {\n description: \"This course acts as learning resource for software engineers.\",\n title: \"Software Engineer Lv 1\",\n },\n {\n description: \"This course acts as learning resource for software engineers.\",\n title: \"Software Engineer: A comprehensive guide\",\n },\n ],\n mobileLaunchContentUrl: \"https://www.mobile.youtube.com/watch?v=16873\",\n order: 1,\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n skills: [\n {\n id: \"12345\",\n name: \"Sales Techniques\",\n },\n ],\n tags: [\n \"Sales Techniques\",\n \"Customer Service\",\n ],\n title: \"Software Engineer Lv 1\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n updatedAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/content/batch"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_batch_upsert_content" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { CreateCategoriesApiModelSchemasLanguageValue, LanguageEnumValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.batchUpsertContent({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n lmsBatchUpsertContentRequestDto: {\n items: [\n {\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n title: \"Software Engineer Lv 1\",\n description: \"This video acts as learning content for software engineers.\",\n languages: [\n {\n value: LanguageEnumValue.EnGB,\n },\n ],\n contentUrl: \"https://www.youtube.com/watch?v=16873\",\n mobileLaunchContentUrl: \"https://www.mobile.youtube.com/watch?v=16873\",\n coverUrl: \"https://www.googledrive.com/?v=16873\",\n active: true,\n duration: \"P3Y6M4DT12H30M5S\",\n skills: [\n {\n id: \"12345\",\n name: \"Sales Techniques\",\n },\n ],\n order: 1,\n localizations: [\n {\n title: \"Software Engineer Lv 1\",\n description: \"This course acts as learning resource for software engineers.\",\n },\n {\n title: \"Software Engineer: A comprehensive guide\",\n description: \"This course acts as learning resource for software engineers.\",\n },\n ],\n tags: [\n \"Sales Techniques\",\n \"Customer Service\",\n ],\n authors: [\n {\n id: \"123\",\n name: \"John Doe\",\n },\n ],\n updatedAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n createdAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n externalReference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n categories: [\n {\n id: \"16873-IT345\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n name: \"Information-Technology\",\n language: {\n value: CreateCategoriesApiModelSchemasLanguageValue.EnGB,\n },\n },\n ],\n additionalData: [\n {\n id: \"learning_outcomes\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n value: \"This is additional data\",\n },\n ],\n },\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n CreateCategoriesApiModelSchemasValue,\n CreateSkillsApiModelSchemasValue,\n LanguageEnumValue,\n LocalizationModelValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.batchUpsertContent({\n lmsBatchUpsertContentRequestDto: {\n items: [\n {\n active: true,\n additionalData: [\n {\n id: \"learning_outcomes\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n value: \"This is additional data\",\n },\n ],\n categories: [\n {\n id: \"16873-IT345\",\n language: {\n value: CreateCategoriesApiModelSchemasValue.EnGB,\n },\n name: \"Information-Technology\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n ],\n contentUrl: \"https://www.youtube.com/watch?v=16873\",\n coverUrl: \"https://www.googledrive.com/?v=16873\",\n createdAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n description: \"This video acts as learning content for software engineers.\",\n duration: \"P3Y6M4DT12H30M5S\",\n externalReference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n languages: [\n {\n value: LanguageEnumValue.EnGB,\n },\n {\n value: LanguageEnumValue.EnGB,\n },\n {\n value: LanguageEnumValue.EnGB,\n },\n ],\n localizations: [\n {\n description: \"This video acts as learning content for software engineers.\",\n language: {\n value: LocalizationModelValue.EnGB,\n },\n tags: [\n \"Sales Techniques\",\n \"Customer Service\",\n ],\n title: \"Software Engineer Lv 1\",\n },\n {\n description: \"This video acts as learning content for software engineers.\",\n language: {\n value: LocalizationModelValue.EnGB,\n },\n tags: [\n \"Sales Techniques\",\n \"Customer Service\",\n ],\n title: \"Software Engineer Lv 1\",\n },\n ],\n mobileLaunchContentUrl: \"https://www.mobile.youtube.com/watch?v=16873\",\n order: 1,\n skills: [\n {\n id: \"16873-IT345\",\n language: {\n value: CreateSkillsApiModelSchemasValue.EnGB,\n },\n name: \"Information-Technology\",\n },\n ],\n tags: [\n \"Sales Techniques\",\n \"Customer Service\",\n ],\n title: \"Software Engineer Lv 1\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n updatedAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n },\n {\n active: true,\n additionalData: [\n {\n id: \"learning_outcomes\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n value: \"This is additional data\",\n },\n ],\n categories: [\n {\n id: \"16873-IT345\",\n language: {\n value: CreateCategoriesApiModelSchemasValue.EnGB,\n },\n name: \"Information-Technology\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n ],\n contentUrl: \"https://www.youtube.com/watch?v=16873\",\n coverUrl: \"https://www.googledrive.com/?v=16873\",\n createdAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n description: \"This video acts as learning content for software engineers.\",\n duration: \"P3Y6M4DT12H30M5S\",\n externalReference: \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1\",\n languages: [\n {\n value: LanguageEnumValue.EnGB,\n },\n {\n value: LanguageEnumValue.EnGB,\n },\n {\n value: LanguageEnumValue.EnGB,\n },\n ],\n localizations: [\n {\n description: \"This video acts as learning content for software engineers.\",\n language: {\n value: LocalizationModelValue.EnGB,\n },\n tags: [\n \"Sales Techniques\",\n \"Customer Service\",\n ],\n title: \"Software Engineer Lv 1\",\n },\n {\n description: \"This video acts as learning content for software engineers.\",\n language: {\n value: LocalizationModelValue.EnGB,\n },\n tags: [\n \"Sales Techniques\",\n \"Customer Service\",\n ],\n title: \"Software Engineer Lv 1\",\n },\n ],\n mobileLaunchContentUrl: \"https://www.mobile.youtube.com/watch?v=16873\",\n order: 1,\n skills: [\n {\n id: \"16873-IT345\",\n language: {\n value: CreateSkillsApiModelSchemasValue.EnGB,\n },\n name: \"Information-Technology\",\n },\n ],\n tags: [\n \"Sales Techniques\",\n \"Customer Service\",\n ],\n title: \"Software Engineer Lv 1\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n updatedAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n },\n ],\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/content/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_get_content" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getContent({\n id: \"\",\n fields: \"id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getContent({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/courses"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_list_courses" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listCourses({\n fields: \"id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider,localizations,authors,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listCourses({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider,localizations,authors,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/lms/courses/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_get_course" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getCourse({\n id: \"\",\n fields: \"id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider,localizations,authors,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getCourse({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider,localizations,authors,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/skills"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_list_skills" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listSkills({\n fields: \"id,remote_id,name,active,hierarchy,language,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listSkills({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,hierarchy,language,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/lms/skills/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_get_skill" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getSkill({\n id: \"\",\n fields: \"id,remote_id,name,active,hierarchy,language,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getSkill({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,active,hierarchy,language,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/users"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_list_users" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listUsers({\n fields: \"id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name,unified_custom_fields\",\n filter: null,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listUsers({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/lms/users/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_get_user" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getUser({\n id: \"\",\n fields: \"id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getUser({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/users/{id}/assignments"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_list_user_assignments" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listUserAssignments({\n id: \"\",\n fields: \"id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n userId: \"c28xyrc55866bvuv\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listUserAssignments({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n remoteUserId: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n userId: \"c28xyrc55866bvuv\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/lms/users/{id}/assignments"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_create_user_assignment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { LmsCreateAssignmentRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.createUserAssignment({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n lmsCreateAssignmentRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n learningObjectId: \"e3gd34-23tr21-er234-345er56\",\n progress: 40,\n assignedAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n dueDate: new Date(\"2021-07-21T14:00:00.000Z\"),\n status: {\n value: LmsCreateAssignmentRequestDtoValue.InProgress,\n },\n learningObjectExternalReference: \"learning-content-123\",\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { LmsCreateAssignmentRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.createUserAssignment({\n lmsCreateAssignmentRequestDto: {\n assignedAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n dueDate: new Date(\"2021-07-21T14:00:00.000Z\"),\n learningObjectExternalReference: \"learning-content-123\",\n learningObjectId: \"e3gd34-23tr21-er234-345er56\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n progress: 40,\n status: {\n value: LmsCreateAssignmentRequestDtoValue.InProgress,\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/users/{id}/assignments/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_get_user_assignment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getUserAssignment({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getUserAssignment({\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/users/{id}/completions"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_list_user_completions" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listUserCompletions({\n id: \"\",\n fields: \"id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,score,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.listUserCompletions({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,score,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/lms/users/{id}/completions"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_create_user_completion" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.createUserCompletion({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n lmsCreateCompletionRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n completedAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n learningObjectId: \"e3gd34-23tr21-er234-345er56\",\n timeSpent: \"PT1H30M45S\",\n score: {\n percentage: 87,\n rawValue: \"87 / 100\",\n },\n learningObjectExternalReference: \"learning-content-123\",\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.createUserCompletion({\n lmsCreateCompletionRequestDto: {\n completedAt: new Date(\"2021-07-21T14:00:00.000Z\"),\n learningObjectExternalReference: \"learning-content-123\",\n learningObjectId: \"e3gd34-23tr21-er234-345er56\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n score: {\n percentage: 87,\n rawValue: \"87 / 100\",\n },\n timeSpent: \"PT1H30M45S\",\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/users/{id}/completions/{subResourceId}"]["delete"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_delete_user_completion" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.deleteUserCompletion({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.deleteUserCompletion({\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/lms/users/{id}/completions/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "lms_get_user_completion" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getUserCompletion({\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.lms.getUserCompletion({\n prefer: \"heartbeat\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/campaigns"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_list_campaigns" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listCampaigns({\n fields: \"id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listCampaigns({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/marketing/campaigns/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_get_campaign" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getCampaign({\n id: \"\",\n fields: \"id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getCampaign({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/content_blocks"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_list_content_blocks" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listContentBlocks({\n fields: \"id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listContentBlocks({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/marketing/content_blocks"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_create_content_block" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { MarketingCreateContentBlocksRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createContentBlock({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreateContentBlocksRequestDto: {\n type: {\n value: MarketingCreateContentBlocksRequestDtoValue.Html,\n sourceValue: \"text\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { MarketingCreateContentBlocksRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createContentBlock({\n marketingCreateContentBlocksRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n type: {\n sourceValue: \"text\",\n value: MarketingCreateContentBlocksRequestDtoValue.Html,\n },\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/content_blocks/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_get_content_block" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getContentBlock({\n id: \"\",\n fields: \"id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getContentBlock({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/content_blocks/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_update_content_block" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { MarketingCreateContentBlocksRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updateContentBlock({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreateContentBlocksRequestDto: {\n type: {\n value: MarketingCreateContentBlocksRequestDtoValue.Html,\n sourceValue: \"text\",\n },\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { MarketingCreateContentBlocksRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updateContentBlock({\n marketingCreateContentBlocksRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n type: {\n sourceValue: \"text\",\n value: MarketingCreateContentBlocksRequestDtoValue.Html,\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/email"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_list_email_templates" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listEmailTemplates({\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listEmailTemplates({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/email"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_create_email_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createEmailTemplate({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreateEmailTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: null,\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { EmailMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createEmailTemplate({\n marketingCreateEmailTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: EmailMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: EmailMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: EmailMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/email/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_get_email_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getEmailTemplate({\n id: \"\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getEmailTemplate({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/email/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_update_email_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { EmailMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updateEmailTemplate({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreateEmailTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n value: EmailMessagesValue.Email,\n sourceValue: \"Email\",\n },\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { EmailMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updateEmailTemplate({\n marketingCreateEmailTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: EmailMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/in_app"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_list_in_app_templates" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listInAppTemplates({\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n filter: null,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listInAppTemplates({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/in_app"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_create_in_app_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { InAppMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createInAppTemplate({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreateInAppTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n value: InAppMessagesValue.Email,\n sourceValue: \"Email\",\n },\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { InAppMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createInAppTemplate({\n marketingCreateInAppTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: InAppMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: InAppMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: InAppMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/in_app/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_get_in_app_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getInAppTemplate({\n id: \"\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getInAppTemplate({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/in_app/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_update_in_app_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { InAppMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updateInAppTemplate({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreateInAppTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n value: InAppMessagesValue.Email,\n sourceValue: \"Email\",\n },\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { InAppMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updateInAppTemplate({\n marketingCreateInAppTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: InAppMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/push"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_list_push_templates" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listPushTemplates({\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listPushTemplates({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/push"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_create_push_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { PushMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createPushTemplate({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreatePushTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n value: PushMessagesValue.Email,\n sourceValue: \"Email\",\n },\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { PushMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createPushTemplate({\n marketingCreatePushTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: PushMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: PushMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/push/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_get_push_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getPushTemplate({\n id: \"\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getPushTemplate({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/push/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_update_push_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { PushMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updatePushTemplate({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreatePushTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n value: PushMessagesValue.Email,\n sourceValue: \"Email\",\n },\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { PushMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updatePushTemplate({\n marketingCreatePushTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: PushMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: PushMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/sms"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_list_sms_templates" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listSmsTemplates({\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.listSmsTemplates({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/sms"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_create_sms_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { SmsMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createSmsTemplate({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreateSmsTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n value: SmsMessagesValue.Email,\n sourceValue: \"Email\",\n },\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { SmsMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.createSmsTemplate({\n marketingCreateSmsTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: SmsMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: SmsMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: SmsMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/sms/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_get_sms_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getSmsTemplate({\n id: \"\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.getSmsTemplate({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/marketing/templates/sms/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "marketing_update_sms_template" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { SmsMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updateSmsTemplate({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n marketingCreateSmsTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n value: SmsMessagesValue.Email,\n sourceValue: \"Email\",\n },\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { SmsMessagesValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.marketing.updateSmsTemplate({\n marketingCreateSmsTemplateRequestDto: {\n messages: [\n {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n messageType: {\n sourceValue: \"Email\",\n value: SmsMessagesValue.Email,\n },\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n },\n ],\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n },\n prefer: \"heartbeat\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/messaging/conversations"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_list_conversations" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.listConversations({\n fields: \"id,remote_id,participants,name,private,created_at,last_message_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.listConversations({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,participants,name,private,created_at,last_message_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/messaging/conversations"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_create_conversation" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.createConversation({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n messagingCreateConversationRequestDto: {\n participants: [\n \"c28xIQ1\",\n \"c28xIQ2\",\n ],\n name: \"Project Discussion\",\n private: true,\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.createConversation({\n messagingCreateConversationRequestDto: {\n name: \"Project Discussion\",\n participants: [\n \"c28xIQ1\",\n \"c28xIQ2\",\n ],\n private: true,\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/messaging/conversations/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_get_conversation" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.getConversation({\n id: \"\",\n fields: \"id,remote_id,participants,name,private,created_at,last_message_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.getConversation({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,participants,name,private,created_at,last_message_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/messaging/conversations/{id}/messages"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_list_conversation_messages" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.listConversationMessages({\n id: \"\",\n fields: \"id,remote_id,content,parent_message_id,remote_parent_message_id,attachments,author,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.listConversationMessages({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,content,parent_message_id,remote_parent_message_id,attachments,author,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/messaging/messages"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_send_message" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.sendMessage({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n messagingMessageSendRequestDto: {\n content: \"Hello, world!\",\n recipient: \"c28xyrc55866bvuv\",\n sender: \"+34820398402\",\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.sendMessage({\n messagingMessageSendRequestDto: {\n content: \"Hello, world!\",\n recipient: \"c28xyrc55866bvuv\",\n sender: \"+34820398402\",\n },\n prefer: \"heartbeat\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/messaging/messages/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_get_message" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.getMessage({\n id: \"\",\n fields: \"id,remote_id,content,parent_message_id,remote_parent_message_id,attachments,author,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.getMessage({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,content,parent_message_id,remote_parent_message_id,attachments,author,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/messaging/messages/{id}/attachments"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_list_attachments" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.listAttachments({\n id: \"\",\n fields: \"id,remote_id,file_name,file_size,file_type,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.listAttachments({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,file_name,file_size,file_type,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/messaging/messages/{id}/attachments/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_get_attachment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.getAttachment({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,file_name,file_size,file_type,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.getAttachment({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,file_name,file_size,file_type,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/messaging/messages/{id}/attachments/{subResourceId}/download"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_download_messaging_attachment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.downloadMessagingAttachment({\n id: \"\",\n subResourceId: \"\",\n format: \"base64\",\n exportFormat: \"text/plain\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.downloadMessagingAttachment({\n prefer: \"heartbeat\",\n exportFormat: \"text/plain\",\n format: \"base64\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/messaging/users"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_list_users" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.listUsers({\n fields: \"id,remote_id,email,username,name,first_name,last_name,bot,active,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.listUsers({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,email,username,name,first_name,last_name,bot,active,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/messaging/users/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "messaging_get_user" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.getUser({\n id: \"\",\n fields: \"id,remote_id,email,username,name,first_name,last_name,bot,active,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.messaging.getUser({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,email,username,name,first_name,last_name,bot,active,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/proxy"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "stackone_proxy_request" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.proxy.proxyRequest({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n proxyRequestBody: {\n url: \"https://api.sample-integration.com/v1\",\n path: \"/employees/directory\",\n headers: {\n \"Content-Type\": \"application/json\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.proxy.proxyRequest({\n prefer: \"heartbeat\",\n proxyRequestBody: {\n headers: {\n \"Content-Type\": \"application/json\",\n },\n path: \"/employees/directory\",\n url: \"https://api.sample-integration.com/v1\",\n },\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/screening/orders"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "screening_create_screening_order" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.screening.createScreeningOrder({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n screeningCreateOrderRequestDto: {\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n packageId: \"54321\",\n candidate: {\n firstName: \"John\",\n lastName: \"Doe\",\n email: \"john.doe@example.com\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.screening.createScreeningOrder({\n prefer: \"heartbeat\",\n screeningCreateOrderRequestDto: {\n candidate: {\n email: \"john.doe@example.com\",\n firstName: \"John\",\n lastName: \"Doe\",\n },\n packageId: \"54321\",\n passthrough: {\n \"other_known_names\": \"John Doe\",\n },\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/screening/packages"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "screening_list_screening_packages" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.screening.listScreeningPackages({\n fields: \"id,remote_id,name,description,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.screening.listScreeningPackages({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/screening/packages/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "screening_get_screening_package" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.screening.getScreeningPackage({\n id: \"\",\n fields: \"id,remote_id,name,description,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.screening.getScreeningPackage({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,description,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/screening/results/webhook"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "screening_webhook_screening_result" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { Event, ScreeningResultStatus } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.screening.webhookScreeningResult({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n screeningResultWebhook: {\n event: Event.ScreeningResultsCompleted,\n data: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n orderId: \"12345\",\n score: {\n label: \"Overall Risk\",\n value: \"75\",\n min: \"0\",\n max: \"100\",\n },\n startDate: new Date(\"2023-01-01T00:00:00Z\"),\n submissionDate: new Date(\"2023-01-02T00:00:00Z\"),\n summary: \"Background check completed successfully\",\n status: ScreeningResultStatus.Completed,\n resultUrl: \"https://example.com/results/12345\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { Event, ScreeningResultStatus } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.screening.webhookScreeningResult({\n prefer: \"heartbeat\",\n screeningResultWebhook: {\n data: {\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n orderId: \"12345\",\n remoteId: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n resultUrl: \"https://example.com/results/12345\",\n score: {\n label: \"Overall Risk\",\n max: \"100\",\n min: \"0\",\n value: \"75\",\n },\n startDate: new Date(\"2023-01-01T00:00:00Z\"),\n status: ScreeningResultStatus.Completed,\n submissionDate: new Date(\"2023-01-02T00:00:00Z\"),\n summary: \"Background check completed successfully\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n event: Event.ScreeningResultsCancelled,\n },\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/projects"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_list_projects" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listProjects({\n fields: \"id,remote_id,organization_id,remote_organization_id,name,description,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listProjects({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,organization_id,remote_organization_id,name,description,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/projects/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_get_project" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getProject({\n id: \"\",\n fields: \"id,remote_id,organization_id,remote_organization_id,name,description,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getProject({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,organization_id,remote_organization_id,name,description,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/projects/{id}/components"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_list_project_components" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listProjectComponents({\n id: \"\",\n fields: \"id,remote_id,organization_id,remote_organization_id,project_id,remote_project_id,name,description,created_at,updated_at,unified_custom_fields\",\n filter: null,\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listProjectComponents({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,organization_id,remote_organization_id,project_id,remote_project_id,name,description,created_at,updated_at,unified_custom_fields\",\n filter: null,\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/projects/{id}/components/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_get_project_component" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getProjectComponent({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,organization_id,remote_organization_id,project_id,remote_project_id,name,description,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getProjectComponent({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,organization_id,remote_organization_id,project_id,remote_project_id,name,description,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/projects/{id}/ticket_types"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_list_project_ticket_types" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listProjectTicketTypes({\n id: \"\",\n fields: \"id,remote_id,name,project_id,remote_project_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listProjectTicketTypes({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,project_id,remote_project_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/ticket_types"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_list_ticket_types" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listTicketTypes({\n fields: \"id,remote_id,name,project_id,remote_project_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listTicketTypes({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,project_id,remote_project_id,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/ticket_types/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_get_ticket_type" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getTicketType({\n id: \"\",\n fields: \"id,remote_id,name,project_id,remote_project_id,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getTicketType({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,name,project_id,remote_project_id,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_list_tickets" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listTickets({\n fields: \"id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listTickets({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets"]["post"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_create_ticket" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { TicketingTicketCreateRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.createTicket({\n xAccountId: \"\",\n prefer: \"heartbeat\",\n ticketingTicketCreateRequestDto: {\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n title: \"System outage in production environment\",\n creatorId: \"user-001\",\n reporters: [\n \"user-001\",\n \"user-002\",\n ],\n assignees: [\n \"user-001\",\n \"user-002\",\n ],\n content: [\n {\n plain: \"This is some content\",\n html: \"

This is some content

\",\n },\n ],\n parentId: \"ticket-002\",\n priority: {\n id: \"001\",\n value: TicketingTicketCreateRequestDtoValue.Medium,\n sourceValue: \"Normal\",\n },\n tags: [\n \"tag-001\",\n \"tag-002\",\n ],\n organizationId: \"organization-001\",\n projectId: \"project-001\",\n componentIds: \"[\\\"component-001\\\",\\\"component-002\\\"]\",\n type: \"ticket-type-001\",\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport { TicketingTicketCreateRequestDtoValue } from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.createTicket({\n prefer: \"heartbeat\",\n ticketingTicketCreateRequestDto: {\n assignees: [\n \"user-001\",\n \"user-002\",\n ],\n componentIds: \"[\\\"component-001\\\",\\\"component-002\\\"]\",\n content: [\n {\n html: \"

This is some content

\",\n plain: \"This is some content\",\n },\n {\n html: \"

This is some content

\",\n plain: \"This is some content\",\n },\n {\n html: \"

This is some content

\",\n plain: \"This is some content\",\n },\n ],\n creatorId: \"user-001\",\n organizationId: \"organization-001\",\n parentId: \"ticket-002\",\n priority: {\n id: \"001\",\n sourceValue: \"Normal\",\n value: TicketingTicketCreateRequestDtoValue.Medium,\n },\n projectId: \"project-001\",\n reporters: [\n \"user-001\",\n \"user-002\",\n ],\n tags: [\n \"tag-001\",\n \"tag-002\",\n ],\n title: \"System outage in production environment\",\n type: \"ticket-type-001\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_get_ticket" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getTicket({\n id: \"\",\n fields: \"id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getTicket({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets/{id}"]["patch"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_update_ticket" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n TicketingTicketUpdateRequestDtoSchemasValue,\n TicketingTicketUpdateRequestDtoValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.updateTicket({\n id: \"\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n ticketingTicketUpdateRequestDto: {\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n title: \"System outage in production environment\",\n reporters: [\n \"user-001\",\n \"user-002\",\n ],\n assignees: [\n \"user-001\",\n \"user-002\",\n ],\n content: [\n {\n plain: \"This is some content\",\n html: \"

This is some content

\",\n },\n ],\n parentId: \"ticket-002\",\n priority: {\n id: \"001\",\n value: TicketingTicketUpdateRequestDtoValue.Medium,\n sourceValue: \"Normal\",\n },\n tags: [\n \"tag-001\",\n \"tag-002\",\n ],\n projectId: \"project-001\",\n componentIds: \"[\\\"component-001\\\",\\\"component-002\\\"]\",\n status: {\n id: \"001\",\n type: {\n value: TicketingTicketUpdateRequestDtoSchemasValue.ToDo,\n sourceValue: \"New\",\n },\n name: \"Backlog\",\n },\n },\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\nimport {\n TicketingTicketUpdateRequestDtoSchemasValue,\n TicketingTicketUpdateRequestDtoValue,\n} from \"@stackone/stackone-client-ts/sdk/models/shared\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.updateTicket({\n prefer: \"heartbeat\",\n ticketingTicketUpdateRequestDto: {\n assignees: [\n \"user-001\",\n \"user-002\",\n ],\n componentIds: \"[\\\"component-001\\\",\\\"component-002\\\"]\",\n content: [\n {\n html: \"

This is some content

\",\n plain: \"This is some content\",\n },\n {\n html: \"

This is some content

\",\n plain: \"This is some content\",\n },\n ],\n parentId: \"ticket-002\",\n priority: {\n id: \"001\",\n sourceValue: \"Normal\",\n value: TicketingTicketUpdateRequestDtoValue.Medium,\n },\n projectId: \"project-001\",\n reporters: [\n \"user-001\",\n \"user-002\",\n ],\n status: {\n id: \"001\",\n name: \"Backlog\",\n type: {\n sourceValue: \"New\",\n value: TicketingTicketUpdateRequestDtoSchemasValue.ToDo,\n },\n },\n tags: [\n \"tag-001\",\n \"tag-002\",\n ],\n title: \"System outage in production environment\",\n unifiedCustomFields: {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\",\n },\n },\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets/{id}/attachments"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_list_attachments" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listAttachments({\n id: \"\",\n fields: \"id,remote_id,ticket_id,remote_ticket_id,user_id,remote_user_id,file_name,file_format,file_url,size,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listAttachments({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,ticket_id,remote_ticket_id,user_id,remote_user_id,file_name,file_format,file_url,size,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets/{id}/attachments/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_get_attachment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getAttachment({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,ticket_id,remote_ticket_id,user_id,remote_user_id,file_name,file_format,file_url,size,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getAttachment({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,ticket_id,remote_ticket_id,user_id,remote_user_id,file_name,file_format,file_url,size,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets/{id}/attachments/{subResourceId}/download"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_download_ticketing_attachment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.downloadTicketingAttachment({\n id: \"\",\n subResourceId: \"\",\n format: \"base64\",\n exportFormat: \"text/plain\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.downloadTicketingAttachment({\n prefer: \"heartbeat\",\n exportFormat: \"text/plain\",\n format: \"base64\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets/{id}/comments"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_list_comments" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listComments({\n id: \"\",\n fields: \"id,remote_id,ticket_id,remote_ticket_id,content,user_id,remote_user_id,internal,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listComments({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,ticket_id,remote_ticket_id,content,user_id,remote_user_id,internal,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets/{id}/comments/{subResourceId}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_get_comment" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getComment({\n id: \"\",\n subResourceId: \"\",\n fields: \"id,remote_id,ticket_id,remote_ticket_id,content,user_id,remote_user_id,internal,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getComment({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,ticket_id,remote_ticket_id,content,user_id,remote_user_id,internal,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n subResourceId: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/tickets/{id}/statuses"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_list_ticket_statuses" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listTicketStatuses({\n id: \"\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listTicketStatuses({\n prefer: \"heartbeat\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n id: \"\",\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/users"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_list_users" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listUsers({\n fields: \"id,remote_id,type,name,primary_email,primary_phone,username,active,first_name,last_name,customer_account_reference,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.listUsers({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,type,name,primary_email,primary_phone,username,active,first_name,last_name,customer_account_reference,created_at,updated_at,unified_custom_fields\",\n filter: {\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n },\n updatedAfter: new Date(\"2020-01-01T00:00:00.000Z\"),\n xAccountId: \"\",\n });\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();" - target: $["paths"]["/unified/ticketing/users/{id}"]["get"] update: "x-codeSamples": - "lang": "typescript" "label": "ticketing_get_user" - "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n username: \"\",\n password: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getUser({\n id: \"\",\n fields: \"id,remote_id,type,name,primary_email,primary_phone,username,active,first_name,last_name,customer_account_reference,created_at,updated_at,unified_custom_fields\",\n xAccountId: \"\",\n prefer: \"heartbeat\",\n });\n\n console.log(result);\n}\n\nrun();" + "source": "import { StackOne } from \"@stackone/stackone-client-ts\";\n\nconst stackOne = new StackOne({\n security: {\n password: \"\",\n username: \"\",\n },\n});\n\nasync function run() {\n const result = await stackOne.ticketing.getUser({\n prefer: \"heartbeat\",\n fields: \"id,remote_id,type,name,primary_email,primary_phone,username,active,first_name,last_name,customer_account_reference,created_at,updated_at,unified_custom_fields\",\n id: \"\",\n xAccountId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" diff --git a/docs/sdk/models/shared/linkedaccount.md b/docs/sdk/models/shared/linkedaccount.md index 556fb758..4198c642 100644 --- a/docs/sdk/models/shared/linkedaccount.md +++ b/docs/sdk/models/shared/linkedaccount.md @@ -31,6 +31,7 @@ let value: LinkedAccount = { | `provider` | *string* | :heavy_check_mark: | N/A | | | `providerName` | *string* | :heavy_minus_sign: | N/A | | | `setupInformation` | Record | :heavy_minus_sign: | N/A | | +| `shared` | *boolean* | :heavy_minus_sign: | N/A | | | `status` | [shared.LinkedAccountStatus](../../../sdk/models/shared/linkedaccountstatus.md) | :heavy_check_mark: | N/A | | | `statusReasons` | [shared.StatusReason](../../../sdk/models/shared/statusreason.md)[] | :heavy_minus_sign: | N/A | | | `type` | [shared.LinkedAccountType](../../../sdk/models/shared/linkedaccounttype.md) | :heavy_minus_sign: | The account type | [
"PRODUCTION",
"TEST"
] | diff --git a/docs/sdk/models/shared/patchaccountexternaldto.md b/docs/sdk/models/shared/patchaccountexternaldto.md index 0d4fdf86..53daa8ce 100644 --- a/docs/sdk/models/shared/patchaccountexternaldto.md +++ b/docs/sdk/models/shared/patchaccountexternaldto.md @@ -26,4 +26,5 @@ let value: PatchAccountExternalDto = { | `provider` | *string* | :heavy_minus_sign: | N/A | | | `secrets` | [shared.Secrets](../../../sdk/models/shared/secrets.md) | :heavy_minus_sign: | N/A | | | `setupInformation` | [shared.SetupInformation](../../../sdk/models/shared/setupinformation.md) | :heavy_minus_sign: | N/A | | +| `shared` | *boolean* | :heavy_minus_sign: | N/A | | | `type` | [shared.PatchAccountExternalDtoType](../../../sdk/models/shared/patchaccountexternaldtotype.md) | :heavy_minus_sign: | The account type | [
"PRODUCTION",
"TEST"
] | \ No newline at end of file diff --git a/examples/package-lock.json b/examples/package-lock.json index 7cd84bc2..8af1d5a6 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -18,7 +18,7 @@ }, "..": { "name": "@stackone/stackone-client-ts", - "version": "4.34.0", + "version": "4.34.1", "dependencies": { "zod": "^3.25.0 || ^4.0.0" }, diff --git a/gen.yaml b/gen.yaml index cd0e7b23..0e06aafc 100644 --- a/gen.yaml +++ b/gen.yaml @@ -25,7 +25,7 @@ generation: generateNewTests: false skipResponseBodyAssertions: false typescript: - version: 4.34.0 + version: 4.34.1 acceptHeaderEnum: true additionalDependencies: dependencies: {} diff --git a/jsr.json b/jsr.json index 2200332d..5cdef410 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@stackone/stackone-client-ts", - "version": "4.34.0", + "version": "4.34.1", "exports": { ".": "./src/index.ts", "./sdk/models/errors": "./src/sdk/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index ff6da2e0..81077a68 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@stackone/stackone-client-ts", - "version": "4.34.0", + "version": "4.34.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@stackone/stackone-client-ts", - "version": "4.34.0", + "version": "4.34.1", "dependencies": { "zod": "^3.25.0 || ^4.0.0" }, diff --git a/package.json b/package.json index 13f36a38..ec80113b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@stackone/stackone-client-ts", - "version": "4.34.0", + "version": "4.34.1", "author": "StackOne", "main": "./index.js", "sideEffects": false, diff --git a/src/lib/config.ts b/src/lib/config.ts index 9c39d1b6..af37571f 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -62,8 +62,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "1.0.0", - sdkVersion: "4.34.0", - genVersion: "2.812.2", + sdkVersion: "4.34.1", + genVersion: "2.824.1", userAgent: - "speakeasy-sdk/typescript 4.34.0 2.812.2 1.0.0 @stackone/stackone-client-ts", + "speakeasy-sdk/typescript 4.34.1 2.824.1 1.0.0 @stackone/stackone-client-ts", } as const; diff --git a/src/sdk/models/shared/linkedaccount.ts b/src/sdk/models/shared/linkedaccount.ts index beabca36..a1615272 100644 --- a/src/sdk/models/shared/linkedaccount.ts +++ b/src/sdk/models/shared/linkedaccount.ts @@ -47,6 +47,7 @@ export type LinkedAccount = { provider: string; providerName?: string | null | undefined; setupInformation?: { [k: string]: any } | null | undefined; + shared?: boolean | null | undefined; status: LinkedAccountStatusOpen; statusReasons?: Array | null | undefined; /** @@ -103,6 +104,7 @@ export const LinkedAccount$inboundSchema: z.ZodType< provider: z.string(), provider_name: z.nullable(z.string()).optional(), setup_information: z.nullable(z.record(z.any())).optional(), + shared: z.nullable(z.boolean()).optional(), status: LinkedAccountStatus$inboundSchema, status_reasons: z.nullable(z.array(StatusReason$inboundSchema)).optional(), type: z.nullable(LinkedAccountType$inboundSchema).optional(), diff --git a/src/sdk/models/shared/patchaccountexternaldto.ts b/src/sdk/models/shared/patchaccountexternaldto.ts index 113d71de..8d4b84f5 100644 --- a/src/sdk/models/shared/patchaccountexternaldto.ts +++ b/src/sdk/models/shared/patchaccountexternaldto.ts @@ -44,6 +44,7 @@ export type PatchAccountExternalDto = { provider?: string | null | undefined; secrets?: Secrets | null | undefined; setupInformation?: SetupInformation | null | undefined; + shared?: boolean | null | undefined; /** * The account type */ @@ -157,6 +158,7 @@ export type PatchAccountExternalDto$Outbound = { provider?: string | null | undefined; secrets?: Secrets$Outbound | null | undefined; setup_information?: SetupInformation$Outbound | null | undefined; + shared?: boolean | null | undefined; type?: string | null | undefined; }; @@ -183,6 +185,7 @@ export const PatchAccountExternalDto$outboundSchema: z.ZodType< secrets: z.nullable(z.lazy(() => Secrets$outboundSchema)).optional(), setupInformation: z.nullable(z.lazy(() => SetupInformation$outboundSchema)) .optional(), + shared: z.nullable(z.boolean()).optional(), type: z.nullable(PatchAccountExternalDtoType$outboundSchema).optional(), }).transform((v) => { return remap$(v, {