diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 3a0e977..43f8261 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,19 +1,19 @@ lockVersion: 2.0.0 id: 0c8d1667-2710-4860-aee3-7d221dbc0a60 management: - docChecksum: e4a73f7bc7221e532155a6ede4a1a57f + docChecksum: ebbc7460c6c9b26089c81f58a5b5b3f5 docVersion: 1.0.0 - speakeasyVersion: 1.761.5 - generationVersion: 2.879.13 - releaseVersion: 1.1.1 - configChecksum: 03475110f3b12f08fec5738c9726616f + speakeasyVersion: 1.761.11 + generationVersion: 2.881.17 + releaseVersion: 1.1.2 + configChecksum: 104aca3a0881137dd95b5f03681540f1 repoURL: https://github.com/kombohq/python-sdk.git installationURL: https://github.com/kombohq/python-sdk.git published: true persistentEdits: - generation_id: 8166b1fc-975c-469d-a77c-9ac25d232d1e - pristine_commit_hash: 387e0b727f69e192d58027b8f3ed4cace49ff6a1 - pristine_tree_hash: 71f8e9f4fb94664580192106bae1a43c1f7518ae + generation_id: d330f0a6-45e3-49ba-923b-5197f5390f21 + pristine_commit_hash: c9ac2cf462475cd8286827967f4aa6957c9afa26 + pristine_tree_hash: 9407329fd32137a722b0922b4684701284e6524d features: python: additionalDependencies: 1.0.0 @@ -23,7 +23,7 @@ features: deprecations: 3.0.2 enumUnions: 0.1.1 envVarSecurityUsage: 0.3.2 - errors: 3.3.5 + errors: 3.3.6 flatRequests: 1.0.1 flattening: 3.1.1 globalSecurity: 3.0.7 @@ -39,12 +39,12 @@ features: nullables: 1.0.2 openEnums: 1.0.4 operationTimeout: 0.3.1 - pagination: 3.0.9 + pagination: 3.0.10 responseFormat: 1.1.0 - retries: 3.0.4 + retries: 3.0.5 sdkHooks: 1.2.1 serverIDs: 3.0.0 - unions: 3.1.4 + unions: 3.1.5 webhooks: 2.0.0 trackedFiles: .gitattributes: @@ -637,8 +637,8 @@ trackedFiles: pristine_git_object: 5c0c9a0b14683a0287be4701cf1a46edb5ea3f26 docs/models/getatsapplicationsrequest.md: id: 1d55698ba841 - last_write_checksum: sha1:386cad7aa0e86d5103444ade83eeee267cbc4d81 - pristine_git_object: 68c4ae98a37e8187bfb09c8debf5796bc69cc221 + last_write_checksum: sha1:08f334efe65f11e678d8cdbaeaf214af7affb1ae + pristine_git_object: 819b3d00d145e71f1c136bff8687e3b35a8dcb37 docs/models/getatsapplicationsresponse.md: id: f0c39383ff3c last_write_checksum: sha1:4372fc6d2c1424b9ab2125a4619e7b3e9bddc02f @@ -749,8 +749,8 @@ trackedFiles: pristine_git_object: 597e6595604285e2fa2e4aa1fa36c9ee07d76004 docs/models/getatscandidatesrequest.md: id: 28ff87cc1b44 - last_write_checksum: sha1:0154a24a15e3aff293971d9b9de8b7e880f7de41 - pristine_git_object: cf17eab49dbb6d8a80a272e2d5007fadc376f844 + last_write_checksum: sha1:7a34ad49feb862bc392eb5a6723142f398996c1f + pristine_git_object: 5b0f18f25f4621bf9c4c72092963cabb8f037d3d docs/models/getatscandidatesresponse.md: id: bb1650e36f72 last_write_checksum: sha1:3d80b1b7fcfa8461b9daec6cdc15376d10ba6cac @@ -797,8 +797,8 @@ trackedFiles: pristine_git_object: fd6cd14e7d4ef522d46a29c2851fe8f7404454d2 docs/models/getatsinterviewsrequest.md: id: 67fe26327e8d - last_write_checksum: sha1:bdbaace1ca036c5afc2e2846dbbf10fc688ec52b - pristine_git_object: 5ae7b0f217e4800a826aac7dca2f81dff5a1cfa8 + last_write_checksum: sha1:ee8a35a129a63cdff71c8ea4097caf11ee6bde21 + pristine_git_object: aebd92227bc3a06a8e024ec16f4317d7651577b7 docs/models/getatsinterviewsresponse.md: id: 59c69b49f81c last_write_checksum: sha1:221a6f29560a2c7b53857de1c14554b9d2aad8c6 @@ -853,8 +853,8 @@ trackedFiles: pristine_git_object: c0c0e1c48bbe7e5fe46361d8dd6daf008ebf4c45 docs/models/getatsjobsrequest.md: id: 3b9138885b9b - last_write_checksum: sha1:655596a79fecfe0524e63a796a1743417b628f7b - pristine_git_object: 8ef76da83b61c9f3e1ce67aed5307735391f1feb + last_write_checksum: sha1:9dba0c2b3c45febac40eb4531d3b32c4fb7e27a4 + pristine_git_object: 0a918a09402b89ae033bfc7fa82d984b4270fd8c docs/models/getatsjobsresponse.md: id: b012bf5224d3 last_write_checksum: sha1:633f87a2a822251dc258f7079f30f49f17552fc8 @@ -897,8 +897,8 @@ trackedFiles: pristine_git_object: e19596838531a381e2c08ef6b01d04b7420004fc docs/models/getatsoffersrequest.md: id: 603ef4fd0f3d - last_write_checksum: sha1:933c0a510ecd89c53182aed6d445142fd64882c4 - pristine_git_object: 586fcf44b9ee1ade37dffeb0737c4177499afbf2 + last_write_checksum: sha1:fd31eed3a042237f4d72de0cb5e9b56c825c788a + pristine_git_object: 3b6aa1d248e40f3ba0bfae2a6ee9415fb4a4b966 docs/models/getatsoffersresponse.md: id: 4ab504e0e14a last_write_checksum: sha1:79aaf0d29cee1ad9fd4e02013db74317d445dd06 @@ -1013,8 +1013,8 @@ trackedFiles: pristine_git_object: 0da8aeb0dd6e94ce8181753da405a64ad93c15ac docs/models/getatsusersrequest.md: id: 4e96a7cc676d - last_write_checksum: sha1:080c54613878a481cd99e221dc345bdd3251d4e0 - pristine_git_object: a85347dbd120fcc4c667afa0c4e6a9bbbcefbe03 + last_write_checksum: sha1:e5ccca2e4ce8c853ca2795cc2dde8f30ea90213f + pristine_git_object: 2eda9e660d54a8abca34580be8a9e8b8db973bec docs/models/getatsusersresponse.md: id: 6b4f57196f3b last_write_checksum: sha1:9e68cc6590f2087708b47130dbe33abfd2ade6f8 @@ -1077,8 +1077,8 @@ trackedFiles: pristine_git_object: 60e30e5d41d8ce2f5a995dab946e8a5fe531ad7f docs/models/gethrisabsencesrequest.md: id: eb3f3ab8af04 - last_write_checksum: sha1:455b42dfd6b912f58ad45328ffbcaa4adf1d5413 - pristine_git_object: 63b74b4785d5099f842b9d6af4c55931f961c070 + last_write_checksum: sha1:dede09260293c6ad1b967aeeb7f551276de6a358 + pristine_git_object: a638033dd7f303cd538e0a336e546db96ca4f23c docs/models/gethrisabsencesresponse.md: id: 7bf526c2e7d4 last_write_checksum: sha1:e711d4531d2a78878517cf1cff366de8a5ac3813 @@ -1285,8 +1285,8 @@ trackedFiles: pristine_git_object: db892dda9874dece549c35d1c8de9cf24f243801 docs/models/gethrisemployeesrequest.md: id: b0e0a0256836 - last_write_checksum: sha1:b5a4669578e73857ff9a39b4181f4d87b9001aad - pristine_git_object: 15b4c44cae54db872d32102f013c531e57241433 + last_write_checksum: sha1:0cc4b8ddeee047a656fd66299aa1c9e956026ff1 + pristine_git_object: ea7edf9615778f9628ee069176e3accb8e14688a docs/models/gethrisemployeesresponse.md: id: d4dd6f9679ba last_write_checksum: sha1:291e07dc508f5ec7ce57aa8419b48b9c8982e49f @@ -1457,8 +1457,8 @@ trackedFiles: pristine_git_object: f1ee22dd377976d12fe4eea0e2fe5381ad35e9ef docs/models/gethrisperformancereviewsrequest.md: id: 0add3452406a - last_write_checksum: sha1:58f11a8e4e79be8ff21441991f8694f573196d8c - pristine_git_object: 188792a3409028a997608ea8a295a769c6df10dc + last_write_checksum: sha1:14fdd31127259b51134df836d28acb207d05c09f + pristine_git_object: 567c3eac131a23b5fba6511d5f58d9bdb02be000 docs/models/gethrisperformancereviewsresponse.md: id: 88ec5ef57e28 last_write_checksum: sha1:f937a58791e6782c51d9d55448fead520c1d5c32 @@ -1509,8 +1509,8 @@ trackedFiles: pristine_git_object: 2d4e3b79a94aeb9c0c5f0971f1c367a8663619f8 docs/models/gethrisstaffingentitiesrequest.md: id: abb82c179c3e - last_write_checksum: sha1:fb477c868b22414b3d3cfc99073646d1a888b0df - pristine_git_object: c64b3f66a2995940bd1ecd7a70d838ca53d26606 + last_write_checksum: sha1:8a80c88bb493da500b0f8a21753156152de606d2 + pristine_git_object: cc84e997e9a4ddb38a110be46c0a9e705f867680 docs/models/gethrisstaffingentitiesresponse.md: id: a7dce7eb168b last_write_checksum: sha1:971d96d4ef3380394ce4cddc33f1af7a28a91318 @@ -1549,8 +1549,8 @@ trackedFiles: pristine_git_object: 97728de2ca37e01d7756cce3b27a181b3215b8b3 docs/models/gethristimeoffbalancesrequest.md: id: a7cb4ef4e2e9 - last_write_checksum: sha1:1bd0add1c0db0abf3d60db7bd6006bc72c24ae83 - pristine_git_object: e89063cc96764e00e90c4049de2bdb86aa344283 + last_write_checksum: sha1:d0e206d7f2c9e1600c89c5fe8db6df32c7232986 + pristine_git_object: 7e9c9802fa347765029b83de3c62a00576145865 docs/models/gethristimeoffbalancesresponse.md: id: 5b482e3d6b65 last_write_checksum: sha1:c92314bbde838d90f702a9a6d9f7fec45ce075a3 @@ -1865,8 +1865,8 @@ trackedFiles: pristine_git_object: 95d7af043b98494373f18f3ceae6a530e7e4af71 docs/models/integrationtool.md: id: 59f82e2d180c - last_write_checksum: sha1:7f5edb12b87d6307f7d9d1f1859e3685ff105ef1 - pristine_git_object: 3a218de238466c27f2252f803d0f21c64b859b79 + last_write_checksum: sha1:d0756ae4b4649f793689075d0b2755783d6071fb + pristine_git_object: c64ff0a8bd894802171e362e44d7906483b57f58 docs/models/internal/globals.md: id: 9c173b87f41f last_write_checksum: sha1:3969d44e1ad9258f466c40b241681eb82c1ac29a @@ -3459,6 +3459,30 @@ trackedFiles: id: 448cfb888ad6 last_write_checksum: sha1:9da23c17a75a5dd9b0660450e017c1a5812edf18 pristine_git_object: c226d7124c839fab2db0d9ef3d42adc99aac86e3 + docs/models/postintegrationsintegrationidsetuplinkpositiveresponse.md: + id: c30de21b213e + last_write_checksum: sha1:28c7215248c70c17e4f129018f88c5e180b77c90 + pristine_git_object: e2ff7f97f2e1a3536d44849edf14e0009ab690c2 + docs/models/postintegrationsintegrationidsetuplinkpositiveresponsedata.md: + id: 6c14e1987014 + last_write_checksum: sha1:a100e37655cf718afa3d4590fd06e969a9f85218 + pristine_git_object: e9a84ddba8a9d4b5b6a4c3aa0278a31b44c1bbc2 + docs/models/postintegrationsintegrationidsetuplinkrequest.md: + id: 067a992e6b7d + last_write_checksum: sha1:fa3f14320ba1e24145fdbcc460db8ceba8ef4114 + pristine_git_object: e015a8fab362ae592f31c0a89fb8297f70e1661b + docs/models/postintegrationsintegrationidsetuplinkrequestbody.md: + id: a4f955f1e93a + last_write_checksum: sha1:d0d2227fd149d323458d390f75cce504d2c84dee + pristine_git_object: da11382cc227bb39cdf3196dc6de541aaa319a7b + docs/models/postintegrationsintegrationidsetuplinkrequestbodylanguage.md: + id: 209674dde1d3 + last_write_checksum: sha1:be271e451854e2dca16d6a8d760e8b858c06773e + pristine_git_object: 68e77f5011545a99dab4c2e4e09889f3b25b19b4 + docs/models/postintegrationsintegrationidsetuplinkrequestbodylinktype.md: + id: 5826fa040607 + last_write_checksum: sha1:e039c6696da4a3554fe4645106327062ca3d4f6b + pristine_git_object: 547b677f27d8478cdc8609da6f6929c9e576e9b3 docs/models/postpassthroughtoolapiglobals.md: id: ff547c7c14ae last_write_checksum: sha1:77533cc0cc25f74baad571946c5f36644c756903 @@ -4113,20 +4137,20 @@ trackedFiles: pristine_git_object: 4c4d8d825ac4d8a2c1f9fa6276ed9dc4911b3517 docs/sdks/ats/README.md: id: 24fafa267f6c - last_write_checksum: sha1:74ee49ae3354620c115c22ec067274c1c789a676 - pristine_git_object: 0ed193e40c1351c3f1e37bd3863b056d9250fe48 + last_write_checksum: sha1:84472d07a44bbe6e5824db43073e9c136ee5da2f + pristine_git_object: f3c47af2d63e0e1f642f8a54468f260611fa011e docs/sdks/connect/README.md: id: 074a4658c86b last_write_checksum: sha1:bd6fbc64f979f12a97cfffa056093f5b27fada0c pristine_git_object: cb268794ca5a2389305a908323d1585a0c88d9c4 docs/sdks/general/README.md: id: ce0ada6fa2e1 - last_write_checksum: sha1:0195a6981c200644844f43687e812e85b129fee1 - pristine_git_object: 246cf5d1270f50959d044e49743feff892c13d79 + last_write_checksum: sha1:8edb309cc3931ced47bc3544ae779f3b04320f1b + pristine_git_object: 57c5bd17cae47580b408e795126e183885eaa415 docs/sdks/hris/README.md: id: 0baa868a038c - last_write_checksum: sha1:52a46f53dd9e4fb4a988c7d57374bd320ae84d36 - pristine_git_object: 00579645f87b43f045f47fa0de5499f088ef5099 + last_write_checksum: sha1:244152900db6c3aa475b41eea67649508fdff080 + pristine_git_object: 7fdbdd7a0df3a4236ff59bec259676bb8c6710b4 py.typed: id: 258c3ed47ae4 last_write_checksum: sha1:8efc425ffe830805ffcc0f3055871bdcdc542c60 @@ -4137,8 +4161,8 @@ trackedFiles: pristine_git_object: f456032107a9387ba6c98afd1c981df2f4b3d636 pyproject.toml: id: 5d07e7d72637 - last_write_checksum: sha1:a2322225212bfb6dba62511717c1ae3fdaf6f893 - pristine_git_object: 3b02b4f08d28ec3ec2db86c7ac5430cb246eb8a8 + last_write_checksum: sha1:0b785bb2f08e05acd5fa884299766d546971e5ba + pristine_git_object: a823d335599491bacc29b1dc99dafa1f1063e1ea scripts/prepare_readme.py: id: e0c5957a6035 last_write_checksum: sha1:b6ad6f0515a952d7cb052befddb6a117d4f627d8 @@ -4165,24 +4189,24 @@ trackedFiles: pristine_git_object: e589e541e5fc70d336de44780721f301d754ed72 src/kombo/_version.py: id: 45cf440ad1df - last_write_checksum: sha1:471ed6a63207d66165b12bf0691c64bd45079d82 - pristine_git_object: 10c23ff9a273f8015398aacf4f3f67ad2659c2e5 + last_write_checksum: sha1:6b8610cdadc36f303f3e84ded929f33f3f7ead8a + pristine_git_object: 2e5230d8e53e43e0f8a104cf0c3950f7d8337010 src/kombo/assessment.py: id: aec6e8a7589f - last_write_checksum: sha1:1e8221541e44ff7682dc677a49da757fab89a0a3 - pristine_git_object: 9f69447b273842e83f4fd9ede8eb90e564a1ea01 + last_write_checksum: sha1:8d496d8f3b781a727642d4b4f05b598a2eb73312 + pristine_git_object: 3ce2821942baa15829f5ffa13da682d1c1459678 src/kombo/ats.py: id: a9839762f5c3 - last_write_checksum: sha1:1281e4271281e1766cb3f46461e5088ca6bda230 - pristine_git_object: 284b4ba426acf030f25cf377cba68cb1b865271f + last_write_checksum: sha1:daa0baa8f4fafd1ffbd1bb6fd8b6c0c4267e34b4 + pristine_git_object: 524f44d0907ce1e5e0addda098f70e80e9fbb8ab src/kombo/basesdk.py: id: 8f30a0bd36ff - last_write_checksum: sha1:b898883000e9cc362628e995d289cf09cfb7a640 - pristine_git_object: a745e5c7b7140d78b0cea6edc69ac0f045dfafc4 + last_write_checksum: sha1:f7cceecb507a387fd50740b9f4cd3cfe5cb3451b + pristine_git_object: 9c2ead27b9e5aa9b765bca459a622ddc5e7510c3 src/kombo/connect.py: id: 057799091fa5 - last_write_checksum: sha1:8744b72d30c8471794579f9c778cf8fd430323de - pristine_git_object: 7985f693c9e0dc50b0e0faca3c7e848200cde35d + last_write_checksum: sha1:0ce4e74d86c4da1661801e46e07d9f690f2ef4b3 + pristine_git_object: 25bcea1808d0306086d84946249b50913015b63f src/kombo/errors/__init__.py: id: bba7abca7635 last_write_checksum: sha1:e86275cda1b1c87ef6f05fc40834739f333488a2 @@ -4217,20 +4241,20 @@ trackedFiles: pristine_git_object: 16ac2977e80b6eabe4020aa8a21dd28e83032f9a src/kombo/general.py: id: 107ecb9f3651 - last_write_checksum: sha1:daf8892177f816ce3c981b812245c009257a7596 - pristine_git_object: 49f2b798668f4265a50202f6be83d33f1ba07059 + last_write_checksum: sha1:445d08ffda9c65dd630d132d9f9c2c281bf3cbe8 + pristine_git_object: 11d12d8bccef5523249b2088b8dbb0e3924130bd src/kombo/hris.py: id: 9ba1b37ab10a - last_write_checksum: sha1:1e75b623534d17e59918e341df6af44fe1654cbe - pristine_git_object: 4c095936a7ce5c31928308e712bfd94346697c0c + last_write_checksum: sha1:7d099467a76303112c746f380bdf152c1e18ede3 + pristine_git_object: 298865d759998da0a3b958aabe7544ffc76052e2 src/kombo/httpclient.py: id: 4e74c7821304 last_write_checksum: sha1:5e55338d6ee9f01ab648cad4380201a8a3da7dd7 pristine_git_object: 89560b566073785535643e694c112bedbd3db13d src/kombo/models/__init__.py: id: 45e6e8c7f07f - last_write_checksum: sha1:2bc349424313e9ab357b199e34dbab377f3d03c4 - pristine_git_object: 8e5ecc5294008a2bf84adfa44e793dea98e18a9e + last_write_checksum: sha1:e0a2dd794b1606ceb3d17b27d3633ec68ce07932 + pristine_git_object: c6b2681a8ea8d3b661f4b036ea97174b61d01fae src/kombo/models/assessmentorderreceivedwebhookpayload.py: id: 532c2db2ee93 last_write_checksum: sha1:a89544ec063f76ec1faa875bf51141a32963ef51 @@ -4305,8 +4329,8 @@ trackedFiles: pristine_git_object: 78c6d9d0d700be464bc4ede22c504efe7972a709 src/kombo/models/getatsapplicationsop.py: id: 871cae4f97d6 - last_write_checksum: sha1:503d85481816b9f8e48ad5c6e9daf750dfdb498c - pristine_git_object: a3ee4a82a27dccd58971c819543c1adbbf7c0caa + last_write_checksum: sha1:72d9b3487ae76dd13bef5eca571eca554934b35f + pristine_git_object: df49017343e6fb8a62307511ecf10ea560a810b9 src/kombo/models/getatsapplicationspositiveresponse.py: id: a63a51b4fa00 last_write_checksum: sha1:b695cc2a6fcdcfaca5f75b45438be490bae89ce1 @@ -4329,32 +4353,32 @@ trackedFiles: pristine_git_object: 28106ce543ee396b34f79bed5592b48ad747c68c src/kombo/models/getatscandidatesop.py: id: fe3b46f57904 - last_write_checksum: sha1:299fb144ac8af809a15cab1a1db9eb8eb3940814 - pristine_git_object: ae02448ad6adaad55d38cfbfc9ac5abe66583d41 + last_write_checksum: sha1:013e833c26f2224931e206266f6b59dd24dd6874 + pristine_git_object: 61bc6ad25f5a27a7d62a96aa88290e53bf87c0d4 src/kombo/models/getatscandidatespositiveresponse.py: id: 55c347e74a19 last_write_checksum: sha1:43e85c961f0500fc7a3c8b9a796607e23d760b13 pristine_git_object: a0f51765e24bd5900c4011c3b0839b348f100b19 src/kombo/models/getatsinterviewsop.py: id: f2e589cff331 - last_write_checksum: sha1:dc00bae52292ddc36af9405494d31a6cd9d3d8dd - pristine_git_object: dfa8fcb77c6069630067e2b6ba42fa540af4f6b3 + last_write_checksum: sha1:458ef071e5f54e5fbaf01f67fa2b120bef85cbce + pristine_git_object: e802e5e1c5a1b855d4573ca0aa2c83babe482c8c src/kombo/models/getatsinterviewspositiveresponse.py: id: 05922b6fb21b last_write_checksum: sha1:93e2203ba46cdcf4d4712a403cef0a3f394c9f28 pristine_git_object: 68c9845c67db2ae7e7afa82f54b4851eedb976d4 src/kombo/models/getatsjobsop.py: id: 2c486ae8aa94 - last_write_checksum: sha1:1b90b967436e42630c57283da492bca59848a8ac - pristine_git_object: 9a8af4bfeec5139f00068882b666326c7326d4d8 + last_write_checksum: sha1:02d7e879d1d08ab6443afbae976c44f4251826ce + pristine_git_object: d601c01f7bb199ff8aa6db9fd692d0439f82f4ed src/kombo/models/getatsjobspositiveresponse.py: id: 99a8e27010c9 last_write_checksum: sha1:453026ef030ce9c138c11a41cdfee5c520f47f73 pristine_git_object: d40d6512b3a6c082de6a8fcfb2629ea91e971aba src/kombo/models/getatsoffersop.py: id: e7ea828aed53 - last_write_checksum: sha1:2aa94f60bf7e837aed419ace8fbd64084ec520fc - pristine_git_object: 72c2a0ec11a0bf614af44b496905662e3dde75ca + last_write_checksum: sha1:c73c8851a6dd5414658e0edb45dadcd9da337a8b + pristine_git_object: 2189c1931247ef90499f11be02adf750aa52323e src/kombo/models/getatsofferspositiveresponse.py: id: 1178a0958495 last_write_checksum: sha1:fd2b230e13fa9c4dd71db265ac28fc95f066012d @@ -4385,8 +4409,8 @@ trackedFiles: pristine_git_object: 9faf8279c17d34e139489f88a1e50c90ba37bba1 src/kombo/models/getatsusersop.py: id: 3dea73611e1e - last_write_checksum: sha1:d345269a5b35608ee4aa2f1c407b698da07dee29 - pristine_git_object: b59fd94c7d0b0127ae2d43e1027f530140de0f1d + last_write_checksum: sha1:ffb050e2e8878632cbfea018ccedbef88b095ae6 + pristine_git_object: 7b0819a07c3bd81c91f1850a7ea9b9c2e0903e16 src/kombo/models/getatsuserspositiveresponse.py: id: 957d5988d11c last_write_checksum: sha1:d0d9d535946c92ca55d390ae00a3823acfae78c3 @@ -4405,8 +4429,8 @@ trackedFiles: pristine_git_object: d92464f663add384a976acc8b062ac141430cef4 src/kombo/models/gethrisabsencesop.py: id: 0906c126338e - last_write_checksum: sha1:8cfdba74ea529bb004376fd318c0402c758f5d68 - pristine_git_object: 5182266fd00740199805ec2f844bc8b5c84e19c1 + last_write_checksum: sha1:105eb1d08ed526a72c6f15c9dd6491c4b3d3d8f0 + pristine_git_object: 9b894a600374a7289296f5cbf681dc16b416efb6 src/kombo/models/gethrisabsencespositiveresponse.py: id: 7976db3c6ae3 last_write_checksum: sha1:c2870a1533c69608ad7d34c80e5857df2442267f @@ -4437,8 +4461,8 @@ trackedFiles: pristine_git_object: 13d01ecb2517d8b12a742a445e5a4b154affd4e0 src/kombo/models/gethrisemployeesop.py: id: 84d84ea0468f - last_write_checksum: sha1:d4160592ff01764200930fb8a8398c22b7df5693 - pristine_git_object: 360f7741567ae8a713d238f5b7a0065f659a5610 + last_write_checksum: sha1:0ba475f478a2945d803780c4e979b66b6f6040e0 + pristine_git_object: 51ed169e95b1a8aa2015877e503862e717cf1864 src/kombo/models/gethrisemployeespositiveresponse.py: id: 346e2acc9925 last_write_checksum: sha1:0ba4ae80afa55675161a04044a326a8180a22b4f @@ -4485,24 +4509,24 @@ trackedFiles: pristine_git_object: 2674a8b2cc3abee83f61109a2d14cc582effde90 src/kombo/models/gethrisperformancereviewsop.py: id: d94f4f049afb - last_write_checksum: sha1:17ee4286d2947676e8db609524a87e04cee88a98 - pristine_git_object: 674dd88ca93dbac31455d25fa17f6c84ec2b32ea + last_write_checksum: sha1:65f48b5a7574ad90457290118ef60d26233d3187 + pristine_git_object: 7ea61446b957d7f81a202c63193a35450e5507e2 src/kombo/models/gethrisperformancereviewspositiveresponse.py: id: 44962807cdec last_write_checksum: sha1:044aa668807682798b50bde396f8b23d682ffbfb pristine_git_object: 6fec89a5c3745f5705f453a7e6a7c034959d26ee src/kombo/models/gethrisstaffingentitiesop.py: id: cb874a746b1d - last_write_checksum: sha1:25e1d55079c8a456dfb502ca021c9117f206549b - pristine_git_object: 3ca474e880088fd83588c1cfac3a3169f3d80e53 + last_write_checksum: sha1:cd16fe02a8c870d73cef275864266c96bfe6faae + pristine_git_object: b49f88cf8616cc05ebc08d99d4d8a58d0aaa3766 src/kombo/models/gethrisstaffingentitiespositiveresponse.py: id: 0a4835131da4 last_write_checksum: sha1:71d31e09bcc7555266735e83381dca5f7fe13052 pristine_git_object: 12361b2c10198a72fdd51bfc81e09195482943e0 src/kombo/models/gethristimeoffbalancesop.py: id: c5a6da4c41fd - last_write_checksum: sha1:e01912ec91d5e86c0b53bb04bdd835c03bc2749d - pristine_git_object: eba008fd97d0f445349d428f1d29420aff4c23a3 + last_write_checksum: sha1:964ef09eaab0320e321e17063f25ae5a28420211 + pristine_git_object: 859e2d064adc68eebce6a57a643ac333c01691cd src/kombo/models/gethristimeoffbalancespositiveresponse.py: id: 3d3404082bef last_write_checksum: sha1:9768783a3c63a7dcc3b373ef37196bc153e0c030 @@ -4725,8 +4749,8 @@ trackedFiles: pristine_git_object: 91e8d75513c8015aeb3f8dd2e38e2ec090b0770c src/kombo/models/postconnectcreatelinkrequestbody.py: id: 8ae6871fd392 - last_write_checksum: sha1:a7ab8fece29fc8c1fa838df46b108924751b2d86 - pristine_git_object: 8c622df5d765771d54e9f4e36d8e5d61cc605ddf + last_write_checksum: sha1:3bcb5669b8e419c27a5f39debd0c65498dffe7b4 + pristine_git_object: 2026eb89da6b53a128b7f007a8544571c849abfc src/kombo/models/postforcesyncop.py: id: 695738b0e4fb last_write_checksum: sha1:4288d66c5efda40419ee3602e124d5186662a99e @@ -4787,6 +4811,18 @@ trackedFiles: id: dfa481c1c118 last_write_checksum: sha1:4c2d070eb7de08233ff5fcaa0646e32c45e17964 pristine_git_object: 3b3fb28fdfb45683b4706c8365f92fac634cff05 + src/kombo/models/postintegrationsintegrationidsetuplinkop.py: + id: 03808fbb56b5 + last_write_checksum: sha1:73b9c0f247d60cb460c791dea09bfe24e9ac683e + pristine_git_object: ffd5462bcff80daa62bd0b3655474333ab04d787 + src/kombo/models/postintegrationsintegrationidsetuplinkpositiveresponse.py: + id: 84547d8157bd + last_write_checksum: sha1:093ee91b89b6fb6017bd0bb02289d5c2829307ec + pristine_git_object: ba51b6dc74dfdde420cb40d45579715a55d38141 + src/kombo/models/postintegrationsintegrationidsetuplinkrequestbody.py: + id: 2fc51aa8478f + last_write_checksum: sha1:9a16b9f04592549436729b79a8061abd511bdb88 + pristine_git_object: 0145bb44a6bd5a6b092e54df5a382074753f2c9d src/kombo/models/postpassthroughtoolapiop.py: id: 85a5a54ec09d last_write_checksum: sha1:88d00b720a39283d596ede0140e444a80ef07bfc @@ -4881,8 +4917,8 @@ trackedFiles: pristine_git_object: 945d8bde110ad795bc126270d735b98c65d9298d src/kombo/models/schema4.py: id: eaa7465473c1 - last_write_checksum: sha1:bede6532d50689253cc6c2e99d42bf313648f8bd - pristine_git_object: 7b5c308995eaf6388645de33e430c6717c3ef667 + last_write_checksum: sha1:feaa5dd82595414a0e0564a5762f87ddbe26cde8 + pristine_git_object: e08fe7b602156c59ac18c267548c70ed7a389322 src/kombo/models/security.py: id: fd0b836f43c5 last_write_checksum: sha1:3cd1d681cb49b2e12ad6a87ce546a02b7a2a26a2 @@ -7576,7 +7612,52 @@ examples: responses: default: application/json: {"status": "error", "error": {"code": null, "title": null, "message": "The message is always in the response.", "log_url": null}} + PostIntegrationsIntegrationIdSetupLink: + example1: + parameters: + path: + integration_id: "personio:93fCvorjZ2jas7ZekX1V1n5d" + requestBody: + application/json: {"language": "en", "link_type": "EMBEDDED"} + responses: + "200": + application/json: {"status": "success", "data": {"link": "https://hopeful-toothbrush.net"}} + default: + application/json: {"status": "error", "error": {"code": "PLATFORM.RATE_LIMIT_EXCEEDED", "title": null, "message": "", "log_url": "https://married-yin.org/"}} + Error Response: + parameters: + path: + integration_id: "" + requestBody: + application/json: {"language": "en", "link_type": "MAGIC_LINK"} + responses: + default: + application/json: {"status": "error", "error": {"code": "PLATFORM.RATE_LIMIT_EXCEEDED", "title": "This data model isn't supported for the selected integration.", "message": "The \"employees\" model is not yet available for Greenhouse. Please reach out to Kombo if you need this functionality.", "log_url": "https://app.kombo.dev/my-prod/logs?interactionId=123456"}} + Minimal Error Response: + parameters: + path: + integration_id: "" + requestBody: + application/json: {"language": "en", "link_type": "MAGIC_LINK"} + responses: + default: + application/json: {"status": "error", "error": {"code": null, "title": null, "message": "The message is always in the response.", "log_url": null}} + speakeasy-default-post-integrations-integration-id-setup-link: + parameters: + path: + integration_id: "" + requestBody: + application/json: {"language": "en", "link_type": "MAGIC_LINK"} + responses: + "200": + application/json: {"status": "success", "data": {"link": "https://hopeful-toothbrush.net"}} + default: + application/json: {"status": "error", "error": {"code": "PLATFORM.RATE_LIMIT_EXCEEDED", "title": null, "message": "", "log_url": "https://married-yin.org/"}} examplesVersion: 1.0.2 +releaseNotes: | + ## Python SDK Changes: + * `kombo.general.create_setup_link()`: **Added** + * `kombo.connect.create_connection_link()`: `request.integration_tool` **Changed** generatedFiles: - .gitattributes - .vscode/settings.json diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index f64e158..3bbdead 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -31,7 +31,7 @@ generation: generateNewTests: true skipResponseBodyAssertions: false python: - version: 1.1.1 + version: 1.1.2 additionalDependencies: dev: inline-snapshot: '>=0.13.0' diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 681b646..3f22111 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.761.5 +speakeasyVersion: 1.761.11 sources: kombo-prepared-spec: sourceNamespace: kombo-api - sourceRevisionDigest: sha256:2495709efff01d198b0b07b3e1080d88d08deff5659fc950a14f56a943c9b01e - sourceBlobDigest: sha256:d5627f0f97d17d7cf4fe2243073b7bbb59b2ee983cb7227ebda2104fd4626e34 + sourceRevisionDigest: sha256:3daa533b00c735cde59e20dc5a799136aa452a09af878140f4a24b0122dd52d9 + sourceBlobDigest: sha256:b801d6d8eab7f4ed638849e9a3b353bf4411a74162e6985ca95617746aa11d48 tags: - latest - 1.0.0 @@ -11,10 +11,10 @@ targets: kombo-python: source: kombo-prepared-spec sourceNamespace: kombo-api - sourceRevisionDigest: sha256:2495709efff01d198b0b07b3e1080d88d08deff5659fc950a14f56a943c9b01e - sourceBlobDigest: sha256:d5627f0f97d17d7cf4fe2243073b7bbb59b2ee983cb7227ebda2104fd4626e34 + sourceRevisionDigest: sha256:3daa533b00c735cde59e20dc5a799136aa452a09af878140f4a24b0122dd52d9 + sourceBlobDigest: sha256:b801d6d8eab7f4ed638849e9a3b353bf4411a74162e6985ca95617746aa11d48 codeSamplesNamespace: kombo-api-python-code-samples - codeSamplesRevisionDigest: sha256:d8fab95f3501260039e36dc3ece9cb78233349105f9282466e545ed8cae73b08 + codeSamplesRevisionDigest: sha256:d1cf0facbf04318aefedd9d76cbeae752cc98d143ae1ef1e2376ea9712e1c604 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README-PYPI.md b/README-PYPI.md index f3e9030..757782d 100644 --- a/README-PYPI.md +++ b/README-PYPI.md @@ -217,6 +217,7 @@ with SDK( * [get_integration_details](https://github.com/kombohq/python-sdk/blob/master/docs/sdks/general/README.md#get_integration_details) - Get integration details * [set_integration_enabled](https://github.com/kombohq/python-sdk/blob/master/docs/sdks/general/README.md#set_integration_enabled) - Set integration enabled * [create_reconnection_link](https://github.com/kombohq/python-sdk/blob/master/docs/sdks/general/README.md#create_reconnection_link) - Create reconnection link +* [create_setup_link](https://github.com/kombohq/python-sdk/blob/master/docs/sdks/general/README.md#create_setup_link) - Create Setup Flow link * [get_integration_fields](https://github.com/kombohq/python-sdk/blob/master/docs/sdks/general/README.md#get_integration_fields) - Get integration fields * [update_integration_field](https://github.com/kombohq/python-sdk/blob/master/docs/sdks/general/README.md#update_integration_field) - Updates an integration fields passthrough setting * [get_custom_fields](https://github.com/kombohq/python-sdk/blob/master/docs/sdks/general/README.md#get_custom_fields) - Get custom fields with current mappings @@ -333,9 +334,9 @@ with Kombo( **Inherit from [`SDKError`](https://github.com/kombohq/python-sdk/blob/master/./src/kombo/errors/sdkerror.py)**: -* [`KomboAtsError`](https://github.com/kombohq/python-sdk/blob/master/./src/kombo/errors/komboatserror.py): The standard error response with the error codes for the ATS use case. Applicable to 28 of 60 methods.* -* [`KomboHrisError`](https://github.com/kombohq/python-sdk/blob/master/./src/kombo/errors/kombohriserror.py): The standard error response with the error codes for the HRIS use case. Applicable to 18 of 60 methods.* -* [`KomboGeneralError`](https://github.com/kombohq/python-sdk/blob/master/./src/kombo/errors/kombogeneralerror.py): The standard error response with just the platform error codes. Applicable to 14 of 60 methods.* +* [`KomboAtsError`](https://github.com/kombohq/python-sdk/blob/master/./src/kombo/errors/komboatserror.py): The standard error response with the error codes for the ATS use case. Applicable to 28 of 61 methods.* +* [`KomboHrisError`](https://github.com/kombohq/python-sdk/blob/master/./src/kombo/errors/kombohriserror.py): The standard error response with the error codes for the HRIS use case. Applicable to 18 of 61 methods.* +* [`KomboGeneralError`](https://github.com/kombohq/python-sdk/blob/master/./src/kombo/errors/kombogeneralerror.py): The standard error response with just the platform error codes. Applicable to 15 of 61 methods.* * [`ResponseValidationError`](https://github.com/kombohq/python-sdk/blob/master/./src/kombo/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute. diff --git a/README.md b/README.md index 31e9d8a..679225a 100644 --- a/README.md +++ b/README.md @@ -217,6 +217,7 @@ with SDK( * [get_integration_details](docs/sdks/general/README.md#get_integration_details) - Get integration details * [set_integration_enabled](docs/sdks/general/README.md#set_integration_enabled) - Set integration enabled * [create_reconnection_link](docs/sdks/general/README.md#create_reconnection_link) - Create reconnection link +* [create_setup_link](docs/sdks/general/README.md#create_setup_link) - Create Setup Flow link * [get_integration_fields](docs/sdks/general/README.md#get_integration_fields) - Get integration fields * [update_integration_field](docs/sdks/general/README.md#update_integration_field) - Updates an integration fields passthrough setting * [get_custom_fields](docs/sdks/general/README.md#get_custom_fields) - Get custom fields with current mappings @@ -333,9 +334,9 @@ with Kombo( **Inherit from [`SDKError`](./src/kombo/errors/sdkerror.py)**: -* [`KomboAtsError`](./src/kombo/errors/komboatserror.py): The standard error response with the error codes for the ATS use case. Applicable to 28 of 60 methods.* -* [`KomboHrisError`](./src/kombo/errors/kombohriserror.py): The standard error response with the error codes for the HRIS use case. Applicable to 18 of 60 methods.* -* [`KomboGeneralError`](./src/kombo/errors/kombogeneralerror.py): The standard error response with just the platform error codes. Applicable to 14 of 60 methods.* +* [`KomboAtsError`](./src/kombo/errors/komboatserror.py): The standard error response with the error codes for the ATS use case. Applicable to 28 of 61 methods.* +* [`KomboHrisError`](./src/kombo/errors/kombohriserror.py): The standard error response with the error codes for the HRIS use case. Applicable to 18 of 61 methods.* +* [`KomboGeneralError`](./src/kombo/errors/kombogeneralerror.py): The standard error response with just the platform error codes. Applicable to 15 of 61 methods.* * [`ResponseValidationError`](./src/kombo/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute. diff --git a/RELEASES.md b/RELEASES.md index 948a9a4..0b919ef 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -188,4 +188,14 @@ Based on: ### Generated - [python v1.1.1] . ### Releases -- [PyPI v1.1.1] https://pypi.org/project/kombo/1.1.1 - . \ No newline at end of file +- [PyPI v1.1.1] https://pypi.org/project/kombo/1.1.1 - . + +## 2026-05-03 00:46:51 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.761.11 (2.881.17) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.1.2] . +### Releases +- [PyPI v1.1.2] https://pypi.org/project/kombo/1.1.2 - . \ No newline at end of file diff --git a/docs/models/getatsapplicationsrequest.md b/docs/models/getatsapplicationsrequest.md index 68c4ae9..819b3d0 100644 --- a/docs/models/getatsapplicationsrequest.md +++ b/docs/models/getatsapplicationsrequest.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `candidate` \| n/a \| ✓ Yes \|
\| `candidate` → `tags` \| ✗ No \| ✗ No \|
\| `current_stage` \| n/a \| ✓ Yes \|
\| `job` \| ✗ No \| ✗ No \|
\| `interviews` \| ✓ Yes \| ✓ Yes \|
\| `offers` \| ✓ Yes \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `outcomes` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `PENDING`, `HIRED`, `DECLINED`
* `PENDING`: The application is still being processed.
* `HIRED`: The candidate was hired.
* `DECLINED`: The candidate was declined.


Leave this blank to get results matching all values. | -| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return applications that are related to _any_ of the jobs. | -| `job_remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job remote IDs. We will only return applications that are related to _any_ of the jobs. | -| `current_stage_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of application stage IDs. We will only return applications that are currently in _any_ of the stages. | -| `remote_created_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter applications by the day they were created in the remote system. This allows you to get applications that were created on or after a certain day. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `candidate` \| n/a \| ✓ Yes \|
\| `candidate` → `tags` \| ✗ No \| ✗ No \|
\| `current_stage` \| n/a \| ✓ Yes \|
\| `job` \| ✗ No \| ✗ No \|
\| `interviews` \| ✓ Yes \| ✓ Yes \|
\| `offers` \| ✓ Yes \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `outcomes` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `PENDING`, `HIRED`, `DECLINED`
* `PENDING`: The application is still being processed.
* `HIRED`: The candidate was hired.
* `DECLINED`: The candidate was declined.


Leave this blank to get results matching all values. | +| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return applications that are related to _any_ of the jobs. | +| `job_remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job remote IDs. We will only return applications that are related to _any_ of the jobs. | +| `current_stage_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of application stage IDs. We will only return applications that are currently in _any_ of the stages. | +| `remote_created_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter applications by the day they were created in the remote system. This allows you to get applications that were created on or after a certain day. | \ No newline at end of file diff --git a/docs/models/getatscandidatesrequest.md b/docs/models/getatscandidatesrequest.md index cf17eab..5b0f18f 100644 --- a/docs/models/getatscandidatesrequest.md +++ b/docs/models/getatscandidatesrequest.md @@ -3,16 +3,16 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `applications` \| ✓ Yes \| ✓ Yes \|
\| `applications` → `current_stage` \| ✗ No \| ✗ No \|
\| `applications` → `job` \| ✗ No \| ✗ No \|
\| `tags` \| ✓ Yes \| ✗ No \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `email` | *Optional[str]* | :heavy_minus_sign: | Filter the candidates based on an email address. When set, returns only the candidates where the given `email` is in `email_addresses`. This filter is case-insensitive. | -| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return candidates that have applied to _any_ of the jobs. | -| `first_name` | *Optional[str]* | :heavy_minus_sign: | Filter candidates by first name. This filter is case-insensitive and matches the exact first name. Fuzzy matching might be enabled in the future, so consider this for your implementation. | -| `last_name` | *Optional[str]* | :heavy_minus_sign: | Filter candidates by last name. This filter is case-insensitive and matches the exact last name. Fuzzy matching might be enabled in the future, so consider this for your implementation. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `applications` \| ✓ Yes \| ✓ Yes \|
\| `applications` → `current_stage` \| ✗ No \| ✗ No \|
\| `applications` → `job` \| ✗ No \| ✗ No \|
\| `tags` \| ✓ Yes \| ✗ No \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `email` | *Optional[str]* | :heavy_minus_sign: | Filter the candidates based on an email address. When set, returns only the candidates where the given `email` is in `email_addresses`. This filter is case-insensitive. | +| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return candidates that have applied to _any_ of the jobs. | +| `first_name` | *Optional[str]* | :heavy_minus_sign: | Filter candidates by first name. This filter is case-insensitive and matches the exact first name. Fuzzy matching might be enabled in the future, so consider this for your implementation. | +| `last_name` | *Optional[str]* | :heavy_minus_sign: | Filter candidates by last name. This filter is case-insensitive and matches the exact last name. Fuzzy matching might be enabled in the future, so consider this for your implementation. | \ No newline at end of file diff --git a/docs/models/getatsinterviewsrequest.md b/docs/models/getatsinterviewsrequest.md index 5ae7b0f..aebd922 100644 --- a/docs/models/getatsinterviewsrequest.md +++ b/docs/models/getatsinterviewsrequest.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `interviewers` \| ✓ Yes \| ✗ No \|
\| `application` \| n/a \| ✓ Yes \|
\| `application` → `candidate` \| ✗ No \| ✗ No \|
\| `application` → `job` \| ✗ No \| ✗ No \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return interviews for applications associated with any of these jobs. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `interviewers` \| ✓ Yes \| ✗ No \|
\| `application` \| n/a \| ✓ Yes \|
\| `application` → `candidate` \| ✗ No \| ✗ No \|
\| `application` → `job` \| ✗ No \| ✗ No \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return interviews for applications associated with any of these jobs. | \ No newline at end of file diff --git a/docs/models/getatsjobsrequest.md b/docs/models/getatsjobsrequest.md index 8ef76da..0a918a0 100644 --- a/docs/models/getatsjobsrequest.md +++ b/docs/models/getatsjobsrequest.md @@ -3,19 +3,19 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `stages` \| ✓ Yes \| ✗ No \|
\| `screening_questions` \| ✓ Yes \| ✗ No \|
\| `job_postings` \| ✓ Yes \| ✓ Yes \|
\| `hiring_team` \| ✓ Yes \| ✗ No \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `job_codes` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job codes. | -| `post_url` | *Optional[str]* | :heavy_minus_sign: | Filter by the `post_url` field. Can be used to find a job based on its public posting URL. | -| `statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `OPEN`, `CLOSED`, `DRAFT`, `ARCHIVED`

Leave this blank to get results matching all values. | -| `employment_types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `FULL_TIME`, `PART_TIME`, `CONTRACT`, `SEASONAL`, `INTERNSHIP`

Leave this blank to get results matching all values. | -| `visibilities` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `PUBLIC`, `INTERNAL`, `UNLISTED`, `CONFIDENTIAL`

Leave this blank to get results matching all values. | -| `remote_created_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter jobs by the day they were created in the remote system. This allows you to get jobs that were created on or after a certain day. | -| `name_contains` | *Optional[str]* | :heavy_minus_sign: | Filter by the `name` field. Can be used to find a job by keywords present in the job name. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `stages` \| ✓ Yes \| ✗ No \|
\| `screening_questions` \| ✓ Yes \| ✗ No \|
\| `job_postings` \| ✓ Yes \| ✓ Yes \|
\| `hiring_team` \| ✓ Yes \| ✗ No \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `job_codes` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job codes. | +| `post_url` | *Optional[str]* | :heavy_minus_sign: | Filter by the `post_url` field. Can be used to find a job based on its public posting URL. | +| `statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `OPEN`, `CLOSED`, `DRAFT`, `ARCHIVED`

Leave this blank to get results matching all values. | +| `employment_types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `FULL_TIME`, `PART_TIME`, `CONTRACT`, `SEASONAL`, `INTERNSHIP`

Leave this blank to get results matching all values. | +| `visibilities` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `PUBLIC`, `INTERNAL`, `UNLISTED`, `CONFIDENTIAL`

Leave this blank to get results matching all values. | +| `remote_created_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter jobs by the day they were created in the remote system. This allows you to get jobs that were created on or after a certain day. | +| `name_contains` | *Optional[str]* | :heavy_minus_sign: | Filter by the `name` field. Can be used to find a job by keywords present in the job name. | \ No newline at end of file diff --git a/docs/models/getatsoffersrequest.md b/docs/models/getatsoffersrequest.md index 586fcf4..3b6aa1d 100644 --- a/docs/models/getatsoffersrequest.md +++ b/docs/models/getatsoffersrequest.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `application` \| n/a \| ✓ Yes \|
\| `application` → `candidate` \| ✗ No \| ✗ No \|
\| `application` → `job` \| ✗ No \| ✗ No \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `application` \| n/a \| ✓ Yes \|
\| `application` → `candidate` \| ✗ No \| ✗ No \|
\| `application` → `job` \| ✗ No \| ✗ No \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | \ No newline at end of file diff --git a/docs/models/getatsusersrequest.md b/docs/models/getatsusersrequest.md index a85347d..2eda9e6 100644 --- a/docs/models/getatsusersrequest.md +++ b/docs/models/getatsusersrequest.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `system_role_assignment` \| ✓ Yes \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of emails. We will only return users who have _any_ of the emails. The format of the emails is case-insensitive. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `system_role_assignment` \| ✓ Yes \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of emails. We will only return users who have _any_ of the emails. The format of the emails is case-insensitive. | \ No newline at end of file diff --git a/docs/models/gethrisabsencesrequest.md b/docs/models/gethrisabsencesrequest.md index 63b74b4..a638033 100644 --- a/docs/models/gethrisabsencesrequest.md +++ b/docs/models/gethrisabsencesrequest.md @@ -3,16 +3,16 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `type` \| n/a \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `date_from` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter for all the absences that either start _or_ haven't ended yet on/after this day. If you imagine a calendar displaying absences, this defines the left-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. | -| `date_until` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter for absences that start on or before this day (but might continue after). If you imagine a calendar displaying absences, this defines the right-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. | -| `type_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of absence type IDs. | -| `employee_id` | *Optional[str]* | :heavy_minus_sign: | Filter by a specific employee using their ID. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `type` \| n/a \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `date_from` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter for all the absences that either start _or_ haven't ended yet on/after this day. If you imagine a calendar displaying absences, this defines the left-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. | +| `date_until` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter for absences that start on or before this day (but might continue after). If you imagine a calendar displaying absences, this defines the right-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. | +| `type_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of absence type IDs. | +| `employee_id` | *Optional[str]* | :heavy_minus_sign: | Filter by a specific employee using their ID. | \ No newline at end of file diff --git a/docs/models/gethrisemployeesrequest.md b/docs/models/gethrisemployeesrequest.md index 15b4c44..ea7edf9 100644 --- a/docs/models/gethrisemployeesrequest.md +++ b/docs/models/gethrisemployeesrequest.md @@ -3,19 +3,19 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `employments` \| ✓ Yes \| ✓ Yes \|
\| `time_off_balances` \| ✓ Yes \| ✓ Yes \|
\| `manager` \| n/a \| ✓ Yes \|
\| `group_memberships` \| ✓ Yes \| ✗ No \|
\| `legal_entity` \| n/a \| ✓ Yes \|
\| `work_location` \| n/a \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `employment_statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `ACTIVE`, `PENDING`, `INACTIVE`, `LEAVE`
* `ACTIVE`: the employee is **actively employed**
* `PENDING`: the employee is **not actively employed yet** (but they signed their contract or are part of an onboarding process)
* `INACTIVE`: a full-time employee is no longer employed, or, for a contract worker when their contract runs out
* `LEAVE`: the employee is still employed but **currently on leave** (note that not all HR systems support this status — use our absences API for detailed information)


Leave this blank to get results matching all values. | -| `group_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of group IDs. We will only return employees that are members of _any_ of the groups. | -| `legal_entity_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of legal entity IDs. We will only return employees that are members of _any_ of the legal entities. | -| `work_location_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of work location IDs. We will only return employees who are at _any_ of the work locations. | -| `work_emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of work emails. We will only return employees who have _any_ of the work emails. The format of the emails is case-insensitive. | -| `personal_emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of personal emails. We will only return employees who have _any_ of the personal emails. The format of the emails is case-insensitive. | -| `custom_fields` | *Optional[str]* | :heavy_minus_sign: | A JSON string with a single key-value pair like {"fieldKey":"fieldValue"} to filter employees by a specific custom field value. Note that the value must be a string, number, boolean or null and the key must be a valid custom field key. Custom fields with a value of type array or object are not supported. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `employments` \| ✓ Yes \| ✓ Yes \|
\| `time_off_balances` \| ✓ Yes \| ✓ Yes \|
\| `manager` \| n/a \| ✓ Yes \|
\| `group_memberships` \| ✓ Yes \| ✗ No \|
\| `legal_entity` \| n/a \| ✓ Yes \|
\| `work_location` \| n/a \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `employment_statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `ACTIVE`, `PENDING`, `INACTIVE`, `LEAVE`
* `ACTIVE`: the employee is **actively employed**
* `PENDING`: the employee is **not actively employed yet** (but they signed their contract or are part of an onboarding process)
* `INACTIVE`: a full-time employee is no longer employed, or, for a contract worker when their contract runs out
* `LEAVE`: the employee is still employed but **currently on leave** (note that not all HR systems support this status — use our absences API for detailed information)


Leave this blank to get results matching all values. | +| `group_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of group IDs. We will only return employees that are members of _any_ of the groups. | +| `legal_entity_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of legal entity IDs. We will only return employees that are members of _any_ of the legal entities. | +| `work_location_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of work location IDs. We will only return employees who are at _any_ of the work locations. | +| `work_emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of work emails. We will only return employees who have _any_ of the work emails. The format of the emails is case-insensitive. | +| `personal_emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of personal emails. We will only return employees who have _any_ of the personal emails. The format of the emails is case-insensitive. | +| `custom_fields` | *Optional[str]* | :heavy_minus_sign: | A JSON string with a single key-value pair like {"fieldKey":"fieldValue"} to filter employees by a specific custom field value. Note that the value must be a string, number, boolean or null and the key must be a valid custom field key. Custom fields with a value of type array or object are not supported. | \ No newline at end of file diff --git a/docs/models/gethrisperformancereviewsrequest.md b/docs/models/gethrisperformancereviewsrequest.md index 188792a..567c3ea 100644 --- a/docs/models/gethrisperformancereviewsrequest.md +++ b/docs/models/gethrisperformancereviewsrequest.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `review_cycle` \| n/a \| ✓ Yes \|
\| `reviewee` \| n/a \| ✓ Yes \|
\| `reviewer` \| n/a \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `MANAGER`, `DIRECT_REPORT`, `PEER`, `SELF`

Leave this blank to get results matching all values. | -| `review_cycle_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of review cycle IDs. | -| `reviewee_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of reviewee IDs. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `review_cycle` \| n/a \| ✓ Yes \|
\| `reviewee` \| n/a \| ✓ Yes \|
\| `reviewer` \| n/a \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `MANAGER`, `DIRECT_REPORT`, `PEER`, `SELF`

Leave this blank to get results matching all values. | +| `review_cycle_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of review cycle IDs. | +| `reviewee_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of reviewee IDs. | \ No newline at end of file diff --git a/docs/models/gethrisstaffingentitiesrequest.md b/docs/models/gethrisstaffingentitiesrequest.md index c64b3f6..cc84e99 100644 --- a/docs/models/gethrisstaffingentitiesrequest.md +++ b/docs/models/gethrisstaffingentitiesrequest.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `locations` \| ✓ Yes \| ✓ Yes \|
\| `legal_entities` \| ✓ Yes \| ✓ Yes \|
\| `groups` \| ✓ Yes \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `model_types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `JOB`, `POSITION`, `REQUISITION`

Leave this blank to get results matching all values. | -| `statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `OPEN_LIMITED`, `OPEN_UNLIMITED`, `PENDING`, `FROZEN`, `FILLED`, `CLOSED`

Leave this blank to get results matching all values. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `locations` \| ✓ Yes \| ✓ Yes \|
\| `legal_entities` \| ✓ Yes \| ✓ Yes \|
\| `groups` \| ✓ Yes \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `model_types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `JOB`, `POSITION`, `REQUISITION`

Leave this blank to get results matching all values. | +| `statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `OPEN_LIMITED`, `OPEN_UNLIMITED`, `PENDING`, `FROZEN`, `FILLED`, `CLOSED`

Leave this blank to get results matching all values. | \ No newline at end of file diff --git a/docs/models/gethristimeoffbalancesrequest.md b/docs/models/gethristimeoffbalancesrequest.md index e89063c..7e9c980 100644 --- a/docs/models/gethristimeoffbalancesrequest.md +++ b/docs/models/gethristimeoffbalancesrequest.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `type` \| n/a \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `employee_id` | *Optional[str]* | :heavy_minus_sign: | Filter by a specific employee using their ID. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `type` \| n/a \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `employee_id` | *Optional[str]* | :heavy_minus_sign: | Filter by a specific employee using their ID. | \ No newline at end of file diff --git a/docs/models/integrationtool.md b/docs/models/integrationtool.md index 3a218de..c64ff0a 100644 --- a/docs/models/integrationtool.md +++ b/docs/models/integrationtool.md @@ -80,6 +80,7 @@ value: IntegrationTool = "workday" - `"recruitcrm"` - `"jazzhr"` - `"bite"` +- `"brassring"` - `"homerun"` - `"mysolution"` - `"carerix"` @@ -116,8 +117,10 @@ value: IntegrationTool = "workday" - `"guidecom"` - `"spott"` - `"loxo"` +- `"kula"` - `"workdaycustomreport"` - `"workdaycustomreportsftp"` +- `"ukgprowfm"` - `"payfitcustomer"` - `"payfitpartner"` - `"payfit"` diff --git a/docs/models/postintegrationsintegrationidsetuplinkpositiveresponse.md b/docs/models/postintegrationsintegrationidsetuplinkpositiveresponse.md new file mode 100644 index 0000000..e2ff7f9 --- /dev/null +++ b/docs/models/postintegrationsintegrationidsetuplinkpositiveresponse.md @@ -0,0 +1,9 @@ +# PostIntegrationsIntegrationIDSetupLinkPositiveResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `status` | *Literal["success"]* | :heavy_check_mark: | N/A | +| `data` | [models.PostIntegrationsIntegrationIDSetupLinkPositiveResponseData](../models/postintegrationsintegrationidsetuplinkpositiveresponsedata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/postintegrationsintegrationidsetuplinkpositiveresponsedata.md b/docs/models/postintegrationsintegrationidsetuplinkpositiveresponsedata.md new file mode 100644 index 0000000..e9a84dd --- /dev/null +++ b/docs/models/postintegrationsintegrationidsetuplinkpositiveresponsedata.md @@ -0,0 +1,8 @@ +# PostIntegrationsIntegrationIDSetupLinkPositiveResponseData + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `link` | *str* | :heavy_check_mark: | The setup link URL to pass to the Kombo Connect SDK. | \ No newline at end of file diff --git a/docs/models/postintegrationsintegrationidsetuplinkrequest.md b/docs/models/postintegrationsintegrationidsetuplinkrequest.md new file mode 100644 index 0000000..e015a8f --- /dev/null +++ b/docs/models/postintegrationsintegrationidsetuplinkrequest.md @@ -0,0 +1,9 @@ +# PostIntegrationsIntegrationIDSetupLinkRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *str* | :heavy_check_mark: | POST /integrations/:integration_id/setup-link Parameter | +| `body` | [models.PostIntegrationsIntegrationIDSetupLinkRequestBody](../models/postintegrationsintegrationidsetuplinkrequestbody.md) | :heavy_check_mark: | POST /integrations/:integration_id/setup-link Request body | \ No newline at end of file diff --git a/docs/models/postintegrationsintegrationidsetuplinkrequestbody.md b/docs/models/postintegrationsintegrationidsetuplinkrequestbody.md new file mode 100644 index 0000000..da11382 --- /dev/null +++ b/docs/models/postintegrationsintegrationidsetuplinkrequestbody.md @@ -0,0 +1,9 @@ +# PostIntegrationsIntegrationIDSetupLinkRequestBody + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `language` | [OptionalNullable[models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage]](../models/postintegrationsintegrationidsetuplinkrequestbodylanguage.md) | :heavy_minus_sign: | Language of the setup flow UI. | +| `link_type` | [models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType](../models/postintegrationsintegrationidsetuplinkrequestbodylinktype.md) | :heavy_check_mark: | The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (these are valid for 1 year). | \ No newline at end of file diff --git a/docs/models/postintegrationsintegrationidsetuplinkrequestbodylanguage.md b/docs/models/postintegrationsintegrationidsetuplinkrequestbodylanguage.md new file mode 100644 index 0000000..68e77f5 --- /dev/null +++ b/docs/models/postintegrationsintegrationidsetuplinkrequestbodylanguage.md @@ -0,0 +1,19 @@ +# PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage + +Language of the setup flow UI. + +## Example Usage + +```python +from kombo.models import PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage +value: PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage = "en" +``` + + +## Values + +- `"en"` +- `"de"` +- `"fr"` +- `"it"` +- `"es"` diff --git a/docs/models/postintegrationsintegrationidsetuplinkrequestbodylinktype.md b/docs/models/postintegrationsintegrationidsetuplinkrequestbodylinktype.md new file mode 100644 index 0000000..547b677 --- /dev/null +++ b/docs/models/postintegrationsintegrationidsetuplinkrequestbodylinktype.md @@ -0,0 +1,16 @@ +# PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType + +The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (these are valid for 1 year). + +## Example Usage + +```python +from kombo.models import PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType +value: PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType = "EMBEDDED" +``` + + +## Values + +- `"EMBEDDED"` +- `"MAGIC_LINK"` diff --git a/docs/sdks/ats/README.md b/docs/sdks/ats/README.md index 0ed193e..f3c47af 100644 --- a/docs/sdks/ats/README.md +++ b/docs/sdks/ats/README.md @@ -65,21 +65,21 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `candidate` \| n/a \| ✓ Yes \|
\| `candidate` → `tags` \| ✗ No \| ✗ No \|
\| `current_stage` \| n/a \| ✓ Yes \|
\| `job` \| ✗ No \| ✗ No \|
\| `interviews` \| ✓ Yes \| ✓ Yes \|
\| `offers` \| ✓ Yes \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `outcomes` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `PENDING`, `HIRED`, `DECLINED`
* `PENDING`: The application is still being processed.
* `HIRED`: The candidate was hired.
* `DECLINED`: The candidate was declined.


Leave this blank to get results matching all values. | -| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return applications that are related to _any_ of the jobs. | -| `job_remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job remote IDs. We will only return applications that are related to _any_ of the jobs. | -| `current_stage_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of application stage IDs. We will only return applications that are currently in _any_ of the stages. | -| `remote_created_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter applications by the day they were created in the remote system. This allows you to get applications that were created on or after a certain day. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `candidate` \| n/a \| ✓ Yes \|
\| `candidate` → `tags` \| ✗ No \| ✗ No \|
\| `current_stage` \| n/a \| ✓ Yes \|
\| `job` \| ✗ No \| ✗ No \|
\| `interviews` \| ✓ Yes \| ✓ Yes \|
\| `offers` \| ✓ Yes \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `outcomes` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `PENDING`, `HIRED`, `DECLINED`
* `PENDING`: The application is still being processed.
* `HIRED`: The candidate was hired.
* `DECLINED`: The candidate was declined.


Leave this blank to get results matching all values. | +| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return applications that are related to _any_ of the jobs. | +| `job_remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job remote IDs. We will only return applications that are related to _any_ of the jobs. | +| `current_stage_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of application stage IDs. We will only return applications that are currently in _any_ of the stages. | +| `remote_created_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter applications by the day they were created in the remote system. This allows you to get applications that were created on or after a certain day. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -688,20 +688,20 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `applications` \| ✓ Yes \| ✓ Yes \|
\| `applications` → `current_stage` \| ✗ No \| ✗ No \|
\| `applications` → `job` \| ✗ No \| ✗ No \|
\| `tags` \| ✓ Yes \| ✗ No \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `email` | *Optional[str]* | :heavy_minus_sign: | Filter the candidates based on an email address. When set, returns only the candidates where the given `email` is in `email_addresses`. This filter is case-insensitive. | -| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return candidates that have applied to _any_ of the jobs. | -| `first_name` | *Optional[str]* | :heavy_minus_sign: | Filter candidates by first name. This filter is case-insensitive and matches the exact first name. Fuzzy matching might be enabled in the future, so consider this for your implementation. | -| `last_name` | *Optional[str]* | :heavy_minus_sign: | Filter candidates by last name. This filter is case-insensitive and matches the exact last name. Fuzzy matching might be enabled in the future, so consider this for your implementation. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `applications` \| ✓ Yes \| ✓ Yes \|
\| `applications` → `current_stage` \| ✗ No \| ✗ No \|
\| `applications` → `job` \| ✗ No \| ✗ No \|
\| `tags` \| ✓ Yes \| ✗ No \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `email` | *Optional[str]* | :heavy_minus_sign: | Filter the candidates based on an email address. When set, returns only the candidates where the given `email` is in `email_addresses`. This filter is case-insensitive. | +| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return candidates that have applied to _any_ of the jobs. | +| `first_name` | *Optional[str]* | :heavy_minus_sign: | Filter candidates by first name. This filter is case-insensitive and matches the exact first name. Fuzzy matching might be enabled in the future, so consider this for your implementation. | +| `last_name` | *Optional[str]* | :heavy_minus_sign: | Filter candidates by last name. This filter is case-insensitive and matches the exact last name. Fuzzy matching might be enabled in the future, so consider this for your implementation. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -1581,23 +1581,23 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `stages` \| ✓ Yes \| ✗ No \|
\| `screening_questions` \| ✓ Yes \| ✗ No \|
\| `job_postings` \| ✓ Yes \| ✓ Yes \|
\| `hiring_team` \| ✓ Yes \| ✗ No \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `job_codes` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job codes. | -| `post_url` | *Optional[str]* | :heavy_minus_sign: | Filter by the `post_url` field. Can be used to find a job based on its public posting URL. | -| `statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `OPEN`, `CLOSED`, `DRAFT`, `ARCHIVED`

Leave this blank to get results matching all values. | -| `employment_types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `FULL_TIME`, `PART_TIME`, `CONTRACT`, `SEASONAL`, `INTERNSHIP`

Leave this blank to get results matching all values. | -| `visibilities` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `PUBLIC`, `INTERNAL`, `UNLISTED`, `CONFIDENTIAL`

Leave this blank to get results matching all values. | -| `remote_created_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter jobs by the day they were created in the remote system. This allows you to get jobs that were created on or after a certain day. | -| `name_contains` | *Optional[str]* | :heavy_minus_sign: | Filter by the `name` field. Can be used to find a job by keywords present in the job name. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `stages` \| ✓ Yes \| ✗ No \|
\| `screening_questions` \| ✓ Yes \| ✗ No \|
\| `job_postings` \| ✓ Yes \| ✓ Yes \|
\| `hiring_team` \| ✓ Yes \| ✗ No \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `job_codes` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job codes. | +| `post_url` | *Optional[str]* | :heavy_minus_sign: | Filter by the `post_url` field. Can be used to find a job based on its public posting URL. | +| `statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `OPEN`, `CLOSED`, `DRAFT`, `ARCHIVED`

Leave this blank to get results matching all values. | +| `employment_types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `FULL_TIME`, `PART_TIME`, `CONTRACT`, `SEASONAL`, `INTERNSHIP`

Leave this blank to get results matching all values. | +| `visibilities` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `PUBLIC`, `INTERNAL`, `UNLISTED`, `CONFIDENTIAL`

Leave this blank to get results matching all values. | +| `remote_created_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter jobs by the day they were created in the remote system. This allows you to get jobs that were created on or after a certain day. | +| `name_contains` | *Optional[str]* | :heavy_minus_sign: | Filter by the `name` field. Can be used to find a job by keywords present in the job name. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -1845,17 +1845,17 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `system_role_assignment` \| ✓ Yes \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of emails. We will only return users who have _any_ of the emails. The format of the emails is case-insensitive. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `system_role_assignment` \| ✓ Yes \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of emails. We will only return users who have _any_ of the emails. The format of the emails is case-insensitive. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -1951,16 +1951,16 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `application` \| n/a \| ✓ Yes \|
\| `application` → `candidate` \| ✗ No \| ✗ No \|
\| `application` → `job` \| ✗ No \| ✗ No \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `application` \| n/a \| ✓ Yes \|
\| `application` → `candidate` \| ✗ No \| ✗ No \|
\| `application` → `job` \| ✗ No \| ✗ No \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -2055,17 +2055,17 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `interviewers` \| ✓ Yes \| ✗ No \|
\| `application` \| n/a \| ✓ Yes \|
\| `application` → `candidate` \| ✗ No \| ✗ No \|
\| `application` → `job` \| ✗ No \| ✗ No \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return interviews for applications associated with any of these jobs. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `interviewers` \| ✓ Yes \| ✗ No \|
\| `application` \| n/a \| ✓ Yes \|
\| `application` → `candidate` \| ✗ No \| ✗ No \|
\| `application` → `job` \| ✗ No \| ✗ No \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `job_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of job IDs. We will only return interviews for applications associated with any of these jobs. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/general/README.md b/docs/sdks/general/README.md index 246cf5d..57c5bd1 100644 --- a/docs/sdks/general/README.md +++ b/docs/sdks/general/README.md @@ -11,6 +11,7 @@ * [get_integration_details](#get_integration_details) - Get integration details * [set_integration_enabled](#set_integration_enabled) - Set integration enabled * [create_reconnection_link](#create_reconnection_link) - Create reconnection link +* [create_setup_link](#create_setup_link) - Create Setup Flow link * [get_integration_fields](#get_integration_fields) - Get integration fields * [update_integration_field](#update_integration_field) - Updates an integration fields passthrough setting * [get_custom_fields](#get_custom_fields) - Get custom fields with current mappings @@ -211,7 +212,7 @@ To get started, please pick the relevant API (some tools provide multiple to due |Greenhouse|`greenhouse/harvest`|Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.| |GuideCom|`guidecom/api`|GuideCom's API. We automatically authenticate all requests and use the configured API base URL.| |Gusto|`gusto/v1`|[Gusto API](https://docs.gusto.com/app-integrations/docs/introduction). We automatically authenticate all requests with OAuth and use `\{api_base_url\}/v1` as the base URL (`https://api.gusto.com/v1` in production, `https://api.gusto-demo.com/v1` in development).| -|Hailey HR|`haileyhr/api`|Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL.| +|Hailey HR|`haileyhr/api`|Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL. Connections created against the `DEMO` remote environment are routed to `https://api.demo.haileyhr.app` instead.| |Hansalog|`hansalog/vision`|Hansalog's [Vision API](https://hansalog-vision.document360.io/docs/). We automatically authenticate all requests and use `https://\{subdomain\}.hansalog-cloud.de/vision` as the base URL.| |Haufe Umantis|`umantis/v1`|[Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.| |HeavenHR|`heavenhr/v2`|[HeavenHR API](https://api.heavenhr.com/). We automatically authenticate all requests using the provided credentials and use `https://api.heavenhr.com/api/v2` as the base URL.| @@ -236,6 +237,7 @@ To get started, please pick the relevant API (some tools provide multiple to due |Jobylon|`jobylon/push`|The [Jobylon Push API](https://developer.jobylon.com/push-api-and-webhooks/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/p1` as the base URL.| |JOIN|`join/v2`|Join's [V2 API](https://docs.join.com/reference/getting-started). We automatically authenticate all requests and use `https://api.join.com/v2` as the base URL.| |Kenjo|`kenjo/api`|Kenjo's [API](https://kenjo.readme.io/reference/generate-the-api-key). We automatically authenticate all requests using the API key and use `https://api.kenjo.io/` as the base URL.| +|Kula|`kula/v1`|Kula's [REST API](https://developers.kula.ai/docs/getting-started/overview). We automatically authenticate all requests with the provided credentials and use `https://api.kula.ai/v1` as the base URL.| |Lattice Talent|`latticetalent/talent`|Lattice's [Talent API](https://developers.lattice.com/reference/introduction). We automatically authenticate all requests using API key credentials with `https://api.latticehq.com` as the base URL.| |Lattice|`lattice/passthrough`|Lattice's [API](https://developers.lattice.com/v2/docs/base-url-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.| |Lattice|`lattice/talent`|Lattice's [Talent API](https://developers.lattice.com/docs/introduction-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.| @@ -315,6 +317,7 @@ To get started, please pick the relevant API (some tools provide multiple to due |TriNet PEO|`trinetpeo/v1`|We use `https://api.trinet.com` as the base URL. Find the official docs [here](https://developers.trinet.com).| |Ubeeo|`ubeeo/api`|Ubeeo ATS API. We automatically authenticate all requests using OAuth client credentials and use `https://api.ats-platform.com` as the base URL (sandbox: `https://api.acc.ats-platform.com`).| |Udemy Business|`udemy/learning`|Udemy Business REST API. We automatically handle authentication and use `https://\{account_name\}.udemy.com/api-2.0/organizations/\{account_id\}/` as the base URL.| +|UKG Pro WFM|`ukgprowfm/api`|UKG Pro WFM's [API](https://developer.ukg.com/wfm/reference/welcome-to-the-ukg-pro-workforce-management-api). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.| |UKG Pro|`ukgpro/default`|[UKG Pro's HRIS API](https://developer.ukg.com/hcm/reference/get_personnel-v1-person-details). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.| |UKG Pro|`ukgpro/recruting`|[UKG Pro's Recruiting API](https://developer.ukg.com/hcm/reference/retrieveapplications). We automatically authenticate all requests and use `https://\{hostname\}/talent/recruiting/v2/\{tenantalias\}/api` as the base URL.| |UKG Ready|`ukgready/api`|UKG Ready [API](https://secure.saashr.com/ta/docs/rest/public/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}` as the base URL.| @@ -665,6 +668,84 @@ with Kombo( | errors.KomboGeneralError | default | application/json | | errors.SDKDefaultError | 4XX, 5XX | \*/\* | +## create_setup_link + +Create a link that lets your customer run the [Setup Flow](/hris/features/setup-flow/introduction) for an integration. Use this to send customers back into setup steps like field mapping or employee filtering without having to go through the initial connection flow again. Pass the returned URL to `showKomboConnect` from the Kombo Connect SDK, the same way you do with a connection link. + +The integration must have at least one Setup Flow step enabled (e.g. field mapping or employee filtering); otherwise this endpoint returns a `PLATFORM.INPUT_INVALID` error. Steps can be enabled from the Integration Settings tab in the dashboard or via the [Create Connection Link endpoint](./post-connect-create-link). + +### Example Usage: Error Response + + +```python +from kombo import Kombo + + +with Kombo( + api_key="", +) as k_client: + + res = k_client.general.create_setup_link(integration_id="", link_type="MAGIC_LINK", language="en") + + # Handle response + print(res) + +``` +### Example Usage: Minimal Error Response + + +```python +from kombo import Kombo + + +with Kombo( + api_key="", +) as k_client: + + res = k_client.general.create_setup_link(integration_id="", link_type="MAGIC_LINK", language="en") + + # Handle response + print(res) + +``` +### Example Usage: example1 + + +```python +from kombo import Kombo + + +with Kombo( + api_key="", +) as k_client: + + res = k_client.general.create_setup_link(integration_id="personio:93fCvorjZ2jas7ZekX1V1n5d", link_type="EMBEDDED", language="en") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *str* | :heavy_check_mark: | POST /integrations/:integration_id/setup-link Parameter | +| `link_type` | [models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType](../../models/postintegrationsintegrationidsetuplinkrequestbodylinktype.md) | :heavy_check_mark: | The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (these are valid for 1 year). | +| `language` | [OptionalNullable[models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage]](../../models/postintegrationsintegrationidsetuplinkrequestbodylanguage.md) | :heavy_minus_sign: | Language of the setup flow UI. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | + +### Response + +**[models.PostIntegrationsIntegrationIDSetupLinkPositiveResponse](../../models/postintegrationsintegrationidsetuplinkpositiveresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------ | ------------------------ | ------------------------ | +| errors.KomboGeneralError | default | application/json | +| errors.SDKDefaultError | 4XX, 5XX | \*/\* | + ## get_integration_fields Get all fields available on the specified integration. diff --git a/docs/sdks/hris/README.md b/docs/sdks/hris/README.md index 0057964..7fdbdd7 100644 --- a/docs/sdks/hris/README.md +++ b/docs/sdks/hris/README.md @@ -54,23 +54,23 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `employments` \| ✓ Yes \| ✓ Yes \|
\| `time_off_balances` \| ✓ Yes \| ✓ Yes \|
\| `manager` \| n/a \| ✓ Yes \|
\| `group_memberships` \| ✓ Yes \| ✗ No \|
\| `legal_entity` \| n/a \| ✓ Yes \|
\| `work_location` \| n/a \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `employment_statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `ACTIVE`, `PENDING`, `INACTIVE`, `LEAVE`
* `ACTIVE`: the employee is **actively employed**
* `PENDING`: the employee is **not actively employed yet** (but they signed their contract or are part of an onboarding process)
* `INACTIVE`: a full-time employee is no longer employed, or, for a contract worker when their contract runs out
* `LEAVE`: the employee is still employed but **currently on leave** (note that not all HR systems support this status — use our absences API for detailed information)


Leave this blank to get results matching all values. | -| `group_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of group IDs. We will only return employees that are members of _any_ of the groups. | -| `legal_entity_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of legal entity IDs. We will only return employees that are members of _any_ of the legal entities. | -| `work_location_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of work location IDs. We will only return employees who are at _any_ of the work locations. | -| `work_emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of work emails. We will only return employees who have _any_ of the work emails. The format of the emails is case-insensitive. | -| `personal_emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of personal emails. We will only return employees who have _any_ of the personal emails. The format of the emails is case-insensitive. | -| `custom_fields` | *Optional[str]* | :heavy_minus_sign: | A JSON string with a single key-value pair like {"fieldKey":"fieldValue"} to filter employees by a specific custom field value. Note that the value must be a string, number, boolean or null and the key must be a valid custom field key. Custom fields with a value of type array or object are not supported. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `employments` \| ✓ Yes \| ✓ Yes \|
\| `time_off_balances` \| ✓ Yes \| ✓ Yes \|
\| `manager` \| n/a \| ✓ Yes \|
\| `group_memberships` \| ✓ Yes \| ✗ No \|
\| `legal_entity` \| n/a \| ✓ Yes \|
\| `work_location` \| n/a \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `employment_statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `ACTIVE`, `PENDING`, `INACTIVE`, `LEAVE`
* `ACTIVE`: the employee is **actively employed**
* `PENDING`: the employee is **not actively employed yet** (but they signed their contract or are part of an onboarding process)
* `INACTIVE`: a full-time employee is no longer employed, or, for a contract worker when their contract runs out
* `LEAVE`: the employee is still employed but **currently on leave** (note that not all HR systems support this status — use our absences API for detailed information)


Leave this blank to get results matching all values. | +| `group_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of group IDs. We will only return employees that are members of _any_ of the groups. | +| `legal_entity_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of legal entity IDs. We will only return employees that are members of _any_ of the legal entities. | +| `work_location_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of work location IDs. We will only return employees who are at _any_ of the work locations. | +| `work_emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of work emails. We will only return employees who have _any_ of the work emails. The format of the emails is case-insensitive. | +| `personal_emails` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of personal emails. We will only return employees who have _any_ of the personal emails. The format of the emails is case-insensitive. | +| `custom_fields` | *Optional[str]* | :heavy_minus_sign: | A JSON string with a single key-value pair like {"fieldKey":"fieldValue"} to filter employees by a specific custom field value. Note that the value must be a string, number, boolean or null and the key must be a valid custom field key. Custom fields with a value of type array or object are not supported. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -707,17 +707,17 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `type` \| n/a \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `employee_id` | *Optional[str]* | :heavy_minus_sign: | Filter by a specific employee using their ID. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `type` \| n/a \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `employee_id` | *Optional[str]* | :heavy_minus_sign: | Filter by a specific employee using their ID. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -759,20 +759,20 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `type` \| n/a \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `date_from` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter for all the absences that either start _or_ haven't ended yet on/after this day. If you imagine a calendar displaying absences, this defines the left-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. | -| `date_until` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter for absences that start on or before this day (but might continue after). If you imagine a calendar displaying absences, this defines the right-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. | -| `type_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of absence type IDs. | -| `employee_id` | *Optional[str]* | :heavy_minus_sign: | Filter by a specific employee using their ID. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `type` \| n/a \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `date_from` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter for all the absences that either start _or_ haven't ended yet on/after this day. If you imagine a calendar displaying absences, this defines the left-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. | +| `date_until` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter for absences that start on or before this day (but might continue after). If you imagine a calendar displaying absences, this defines the right-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. | +| `type_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of absence type IDs. | +| `employee_id` | *Optional[str]* | :heavy_minus_sign: | Filter by a specific employee using their ID. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -1187,19 +1187,19 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `review_cycle` \| n/a \| ✓ Yes \|
\| `reviewee` \| n/a \| ✓ Yes \|
\| `reviewer` \| n/a \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `MANAGER`, `DIRECT_REPORT`, `PEER`, `SELF`

Leave this blank to get results matching all values. | -| `review_cycle_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of review cycle IDs. | -| `reviewee_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of reviewee IDs. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `review_cycle` \| n/a \| ✓ Yes \|
\| `reviewee` \| n/a \| ✓ Yes \|
\| `reviewer` \| n/a \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `MANAGER`, `DIRECT_REPORT`, `PEER`, `SELF`

Leave this blank to get results matching all values. | +| `review_cycle_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of review cycle IDs. | +| `reviewee_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of reviewee IDs. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -1251,18 +1251,18 @@ with Kombo( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | -| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Relationship \| Target Record \|
\| --- \| --- \| --- \|
\| `locations` \| ✓ Yes \| ✓ Yes \|
\| `legal_entities` \| ✓ Yes \| ✓ Yes \|
\| `groups` \| ✓ Yes \| ✓ Yes \|

_**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | -| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | -| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | -| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | -| `model_types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `JOB`, `POSITION`, `REQUISITION`

Leave this blank to get results matching all values. | -| `statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `OPEN_LIMITED`, `OPEN_UNLIMITED`, `PENDING`, `FROZEN`, `FILLED`, `CLOSED`

Leave this blank to get results matching all values. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. | +| `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | +| `updated_after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged.

If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden.

For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior).

For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below.

\| Path \| Added/Removed \| Linked Record \|
\| --- \| --- \| --- \|
\| `locations` \| ✓ Yes \| ✓ Yes \|
\| `legal_entities` \| ✓ Yes \| ✓ Yes \|
\| `groups` \| ✓ Yes \| ✓ Yes \|

_**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ | +| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | +| `ignore_unsupported_filters` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. | +| `ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | +| `remote_ids` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | +| `model_types` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `JOB`, `POSITION`, `REQUISITION`

Leave this blank to get results matching all values. | +| `statuses` | List[*str*] | :heavy_minus_sign: | Filter by a comma-separated list of `OPEN_LIMITED`, `OPEN_UNLIMITED`, `PENDING`, `FROZEN`, `FILLED`, `CLOSED`

Leave this blank to get results matching all values. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response diff --git a/pyproject.toml b/pyproject.toml index 3b02b4f..a823d33 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "kombo" -version = "1.1.1" +version = "1.1.2" description = "The official Python SDK for the Kombo Unified API" authors = [{ name = "Kombo Technologies GmbH" },] readme = "README-PYPI.md" diff --git a/src/kombo/_version.py b/src/kombo/_version.py index 10c23ff..2e5230d 100644 --- a/src/kombo/_version.py +++ b/src/kombo/_version.py @@ -3,10 +3,10 @@ import importlib.metadata __title__: str = "kombo" -__version__: str = "1.1.1" +__version__: str = "1.1.2" __openapi_doc_version__: str = "1.0.0" -__gen_version__: str = "2.879.13" -__user_agent__: str = "speakeasy-sdk/python 1.1.1 2.879.13 1.0.0 kombo" +__gen_version__: str = "2.881.17" +__user_agent__: str = "speakeasy-sdk/python 1.1.2 2.881.17 1.0.0 kombo" try: if __package__ is not None: diff --git a/src/kombo/assessment.py b/src/kombo/assessment.py index 9f69447..3ce2821 100644 --- a/src/kombo/assessment.py +++ b/src/kombo/assessment.py @@ -86,7 +86,7 @@ def get_packages( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -176,7 +176,7 @@ async def get_packages_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -294,7 +294,7 @@ def set_packages( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -412,7 +412,7 @@ async def set_packages_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -511,7 +511,7 @@ def get_assessment_orders( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -637,7 +637,7 @@ async def get_assessment_orders_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -857,7 +857,7 @@ def update_order_result( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1048,7 +1048,7 @@ async def update_order_result_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) diff --git a/src/kombo/ats.py b/src/kombo/ats.py index 284b4ba..524f44d 100644 --- a/src/kombo/ats.py +++ b/src/kombo/ats.py @@ -54,7 +54,7 @@ def get_applications( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `candidate` | n/a | ✓ Yes | | `candidate` → `tags` | ✗ No | ✗ No | @@ -63,7 +63,7 @@ def get_applications( | `interviews` | ✓ Yes | ✓ Yes | | `offers` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -146,7 +146,7 @@ def get_applications( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -238,7 +238,7 @@ async def get_applications_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `candidate` | n/a | ✓ Yes | | `candidate` → `tags` | ✗ No | ✗ No | @@ -247,7 +247,7 @@ async def get_applications_async( | `interviews` | ✓ Yes | ✓ Yes | | `offers` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -330,7 +330,7 @@ async def get_applications_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -490,7 +490,7 @@ def move_application_to_stage( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -613,7 +613,7 @@ async def move_application_to_stage_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -774,7 +774,7 @@ def add_application_result_link( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -936,7 +936,7 @@ async def add_application_result_link_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1069,7 +1069,7 @@ def add_application_note( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1201,7 +1201,7 @@ async def add_application_note_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1292,7 +1292,7 @@ def get_application_attachments( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1384,7 +1384,7 @@ async def get_application_attachments_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1527,7 +1527,7 @@ def add_application_attachment( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1670,7 +1670,7 @@ async def add_application_attachment_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1803,7 +1803,7 @@ def reject_application( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1935,7 +1935,7 @@ async def reject_application_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1985,14 +1985,14 @@ def get_candidates( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `applications` | ✓ Yes | ✓ Yes | | `applications` → `current_stage` | ✗ No | ✗ No | | `applications` → `job` | ✗ No | ✗ No | | `tags` | ✓ Yes | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -2067,7 +2067,7 @@ def get_candidates( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2150,14 +2150,14 @@ async def get_candidates_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `applications` | ✓ Yes | ✓ Yes | | `applications` → `current_stage` | ✗ No | ✗ No | | `applications` → `job` | ✗ No | ✗ No | | `tags` | ✓ Yes | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -2232,7 +2232,7 @@ async def get_candidates_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2519,7 +2519,7 @@ def create_candidate( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2770,7 +2770,7 @@ async def create_candidate_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2859,7 +2859,7 @@ def get_candidate_attachments( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2948,7 +2948,7 @@ async def get_candidate_attachments_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3091,7 +3091,7 @@ def add_candidate_attachment( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3234,7 +3234,7 @@ async def add_candidate_attachment_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3400,7 +3400,7 @@ def add_candidate_result_link( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3566,7 +3566,7 @@ async def add_candidate_result_link_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3700,7 +3700,7 @@ def add_candidate_tag( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3834,7 +3834,7 @@ async def add_candidate_tag_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3965,7 +3965,7 @@ def remove_candidate_tag( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4096,7 +4096,7 @@ async def remove_candidate_tag_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4207,7 +4207,7 @@ def get_tags( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4347,7 +4347,7 @@ async def get_tags_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4500,7 +4500,7 @@ def get_application_stages( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4650,7 +4650,7 @@ async def get_application_stages_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4743,14 +4743,14 @@ def get_jobs( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `stages` | ✓ Yes | ✗ No | | `screening_questions` | ✓ Yes | ✗ No | | `job_postings` | ✓ Yes | ✓ Yes | | `hiring_team` | ✓ Yes | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -4837,7 +4837,7 @@ def get_jobs( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4934,14 +4934,14 @@ async def get_jobs_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `stages` | ✓ Yes | ✗ No | | `screening_questions` | ✓ Yes | ✗ No | | `job_postings` | ✓ Yes | ✓ Yes | | `hiring_team` | ✓ Yes | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -5028,7 +5028,7 @@ async def get_jobs_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -5324,7 +5324,7 @@ def create_application( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -5581,7 +5581,7 @@ async def create_application_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -5628,11 +5628,11 @@ def get_users( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `system_role_assignment` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -5701,7 +5701,7 @@ def get_users( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -5778,11 +5778,11 @@ async def get_users_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `system_role_assignment` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -5851,7 +5851,7 @@ async def get_users_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -6005,7 +6005,7 @@ def get_roles( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -6156,7 +6156,7 @@ async def get_roles_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -6235,13 +6235,13 @@ def get_offers( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `application` | n/a | ✓ Yes | | `application` → `candidate` | ✗ No | ✗ No | | `application` → `job` | ✗ No | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -6308,7 +6308,7 @@ def get_offers( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -6383,13 +6383,13 @@ async def get_offers_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `application` | n/a | ✓ Yes | | `application` → `candidate` | ✗ No | ✗ No | | `application` → `job` | ✗ No | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -6456,7 +6456,7 @@ async def get_offers_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -6601,7 +6601,7 @@ def get_rejection_reasons( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -6743,7 +6743,7 @@ async def get_rejection_reasons_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -6822,14 +6822,14 @@ def get_interviews( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `interviewers` | ✓ Yes | ✗ No | | `application` | n/a | ✓ Yes | | `application` → `candidate` | ✗ No | ✗ No | | `application` → `job` | ✗ No | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -6898,7 +6898,7 @@ def get_interviews( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -6975,14 +6975,14 @@ async def get_interviews_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `interviewers` | ✓ Yes | ✗ No | | `application` | n/a | ✓ Yes | | `application` → `candidate` | ✗ No | ✗ No | | `application` → `job` | ✗ No | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -7051,7 +7051,7 @@ async def get_interviews_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -7273,7 +7273,7 @@ def import_tracked_application( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -7462,7 +7462,7 @@ async def import_tracked_application_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) diff --git a/src/kombo/basesdk.py b/src/kombo/basesdk.py index a745e5c..9c2ead2 100644 --- a/src/kombo/basesdk.py +++ b/src/kombo/basesdk.py @@ -3,7 +3,12 @@ from .sdkconfiguration import SDKConfiguration import httpx from kombo import errors, utils -from kombo._hooks import AfterErrorContext, AfterSuccessContext, BeforeRequestContext +from kombo._hooks import ( + AfterErrorContext, + AfterSuccessContext, + BeforeRequestContext, + HookContext, +) from kombo.utils import ( RetryConfig, SerializedRequestBody, @@ -233,10 +238,10 @@ def _build_request_with_client( def do_request( self, - hook_ctx, - request, - error_status_codes, - stream=False, + hook_ctx: HookContext, + request: httpx.Request, + is_error_status_code: Callable[[int], bool], + stream: bool = False, retry_config: Optional[Tuple[RetryConfig, List[str]]] = None, ) -> httpx.Response: client = self.sdk_configuration.client @@ -280,19 +285,6 @@ def do(): "" if stream else http_res.text, ) - if utils.match_status_codes(error_status_codes, http_res.status_code): - result, err = hooks.after_error( - AfterErrorContext(hook_ctx), http_res, None - ) - if err is not None: - logger.debug("Request Exception", exc_info=True) - raise err - if result is not None: - http_res = result - else: - logger.debug("Raising unexpected SDK error") - raise errors.SDKDefaultError("Unexpected error occurred", http_res) - return http_res if retry_config is not None: @@ -300,17 +292,27 @@ def do(): else: http_res = do() - if not utils.match_status_codes(error_status_codes, http_res.status_code): + if is_error_status_code(http_res.status_code): + result, err = hooks.after_error(AfterErrorContext(hook_ctx), http_res, None) + if err is not None: + logger.debug("Request Exception", exc_info=True) + raise err + if result is not None: + http_res = result + else: + logger.debug("Raising unexpected SDK error") + raise errors.SDKDefaultError("Unexpected error occurred", http_res) + else: http_res = hooks.after_success(AfterSuccessContext(hook_ctx), http_res) return http_res async def do_request_async( self, - hook_ctx, - request, - error_status_codes, - stream=False, + hook_ctx: HookContext, + request: httpx.Request, + is_error_status_code: Callable[[int], bool], + stream: bool = False, retry_config: Optional[Tuple[RetryConfig, List[str]]] = None, ) -> httpx.Response: client = self.sdk_configuration.async_client @@ -360,20 +362,6 @@ async def do(): "" if stream else http_res.text, ) - if utils.match_status_codes(error_status_codes, http_res.status_code): - result, err = await run_sync_in_thread( - hooks.after_error, AfterErrorContext(hook_ctx), http_res, None - ) - - if err is not None: - logger.debug("Request Exception", exc_info=True) - raise err - if result is not None: - http_res = result - else: - logger.debug("Raising unexpected SDK error") - raise errors.SDKDefaultError("Unexpected error occurred", http_res) - return http_res if retry_config is not None: @@ -383,7 +371,20 @@ async def do(): else: http_res = await do() - if not utils.match_status_codes(error_status_codes, http_res.status_code): + if is_error_status_code(http_res.status_code): + result, err = await run_sync_in_thread( + hooks.after_error, AfterErrorContext(hook_ctx), http_res, None + ) + + if err is not None: + logger.debug("Request Exception", exc_info=True) + raise err + if result is not None: + http_res = result + else: + logger.debug("Raising unexpected SDK error") + raise errors.SDKDefaultError("Unexpected error occurred", http_res) + else: http_res = await run_sync_in_thread( hooks.after_success, AfterSuccessContext(hook_ctx), http_res ) diff --git a/src/kombo/connect.py b/src/kombo/connect.py index 7985f69..25bcea1 100644 --- a/src/kombo/connect.py +++ b/src/kombo/connect.py @@ -138,7 +138,7 @@ def create_connection_link( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -284,7 +284,7 @@ async def create_connection_link_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -378,7 +378,7 @@ def get_integration_by_token( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -472,7 +472,7 @@ async def get_integration_by_token_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) diff --git a/src/kombo/general.py b/src/kombo/general.py index 49f2b79..11d12d8 100644 --- a/src/kombo/general.py +++ b/src/kombo/general.py @@ -70,7 +70,7 @@ def check_api_key( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -147,7 +147,7 @@ async def check_api_key_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -242,7 +242,7 @@ def trigger_sync( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -337,7 +337,7 @@ async def trigger_sync_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -453,7 +453,7 @@ def send_passthrough_request( |Greenhouse|`greenhouse/harvest`|Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.| |GuideCom|`guidecom/api`|GuideCom's API. We automatically authenticate all requests and use the configured API base URL.| |Gusto|`gusto/v1`|[Gusto API](https://docs.gusto.com/app-integrations/docs/introduction). We automatically authenticate all requests with OAuth and use `\{api_base_url\}/v1` as the base URL (`https://api.gusto.com/v1` in production, `https://api.gusto-demo.com/v1` in development).| - |Hailey HR|`haileyhr/api`|Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL.| + |Hailey HR|`haileyhr/api`|Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL. Connections created against the `DEMO` remote environment are routed to `https://api.demo.haileyhr.app` instead.| |Hansalog|`hansalog/vision`|Hansalog's [Vision API](https://hansalog-vision.document360.io/docs/). We automatically authenticate all requests and use `https://\{subdomain\}.hansalog-cloud.de/vision` as the base URL.| |Haufe Umantis|`umantis/v1`|[Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.| |HeavenHR|`heavenhr/v2`|[HeavenHR API](https://api.heavenhr.com/). We automatically authenticate all requests using the provided credentials and use `https://api.heavenhr.com/api/v2` as the base URL.| @@ -478,6 +478,7 @@ def send_passthrough_request( |Jobylon|`jobylon/push`|The [Jobylon Push API](https://developer.jobylon.com/push-api-and-webhooks/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/p1` as the base URL.| |JOIN|`join/v2`|Join's [V2 API](https://docs.join.com/reference/getting-started). We automatically authenticate all requests and use `https://api.join.com/v2` as the base URL.| |Kenjo|`kenjo/api`|Kenjo's [API](https://kenjo.readme.io/reference/generate-the-api-key). We automatically authenticate all requests using the API key and use `https://api.kenjo.io/` as the base URL.| + |Kula|`kula/v1`|Kula's [REST API](https://developers.kula.ai/docs/getting-started/overview). We automatically authenticate all requests with the provided credentials and use `https://api.kula.ai/v1` as the base URL.| |Lattice Talent|`latticetalent/talent`|Lattice's [Talent API](https://developers.lattice.com/reference/introduction). We automatically authenticate all requests using API key credentials with `https://api.latticehq.com` as the base URL.| |Lattice|`lattice/passthrough`|Lattice's [API](https://developers.lattice.com/v2/docs/base-url-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.| |Lattice|`lattice/talent`|Lattice's [Talent API](https://developers.lattice.com/docs/introduction-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.| @@ -557,6 +558,7 @@ def send_passthrough_request( |TriNet PEO|`trinetpeo/v1`|We use `https://api.trinet.com` as the base URL. Find the official docs [here](https://developers.trinet.com).| |Ubeeo|`ubeeo/api`|Ubeeo ATS API. We automatically authenticate all requests using OAuth client credentials and use `https://api.ats-platform.com` as the base URL (sandbox: `https://api.acc.ats-platform.com`).| |Udemy Business|`udemy/learning`|Udemy Business REST API. We automatically handle authentication and use `https://\{account_name\}.udemy.com/api-2.0/organizations/\{account_id\}/` as the base URL.| + |UKG Pro WFM|`ukgprowfm/api`|UKG Pro WFM's [API](https://developer.ukg.com/wfm/reference/welcome-to-the-ukg-pro-workforce-management-api). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.| |UKG Pro|`ukgpro/default`|[UKG Pro's HRIS API](https://developer.ukg.com/hcm/reference/get_personnel-v1-person-details). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.| |UKG Pro|`ukgpro/recruting`|[UKG Pro's Recruiting API](https://developer.ukg.com/hcm/reference/retrieveapplications). We automatically authenticate all requests and use `https://\{hostname\}/talent/recruiting/v2/\{tenantalias\}/api` as the base URL.| |UKG Ready|`ukgready/api`|UKG Ready [API](https://secure.saashr.com/ta/docs/rest/public/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}` as the base URL.| @@ -664,7 +666,7 @@ def send_passthrough_request( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -780,7 +782,7 @@ async def send_passthrough_request_async( |Greenhouse|`greenhouse/harvest`|Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.| |GuideCom|`guidecom/api`|GuideCom's API. We automatically authenticate all requests and use the configured API base URL.| |Gusto|`gusto/v1`|[Gusto API](https://docs.gusto.com/app-integrations/docs/introduction). We automatically authenticate all requests with OAuth and use `\{api_base_url\}/v1` as the base URL (`https://api.gusto.com/v1` in production, `https://api.gusto-demo.com/v1` in development).| - |Hailey HR|`haileyhr/api`|Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL.| + |Hailey HR|`haileyhr/api`|Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL. Connections created against the `DEMO` remote environment are routed to `https://api.demo.haileyhr.app` instead.| |Hansalog|`hansalog/vision`|Hansalog's [Vision API](https://hansalog-vision.document360.io/docs/). We automatically authenticate all requests and use `https://\{subdomain\}.hansalog-cloud.de/vision` as the base URL.| |Haufe Umantis|`umantis/v1`|[Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.| |HeavenHR|`heavenhr/v2`|[HeavenHR API](https://api.heavenhr.com/). We automatically authenticate all requests using the provided credentials and use `https://api.heavenhr.com/api/v2` as the base URL.| @@ -805,6 +807,7 @@ async def send_passthrough_request_async( |Jobylon|`jobylon/push`|The [Jobylon Push API](https://developer.jobylon.com/push-api-and-webhooks/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/p1` as the base URL.| |JOIN|`join/v2`|Join's [V2 API](https://docs.join.com/reference/getting-started). We automatically authenticate all requests and use `https://api.join.com/v2` as the base URL.| |Kenjo|`kenjo/api`|Kenjo's [API](https://kenjo.readme.io/reference/generate-the-api-key). We automatically authenticate all requests using the API key and use `https://api.kenjo.io/` as the base URL.| + |Kula|`kula/v1`|Kula's [REST API](https://developers.kula.ai/docs/getting-started/overview). We automatically authenticate all requests with the provided credentials and use `https://api.kula.ai/v1` as the base URL.| |Lattice Talent|`latticetalent/talent`|Lattice's [Talent API](https://developers.lattice.com/reference/introduction). We automatically authenticate all requests using API key credentials with `https://api.latticehq.com` as the base URL.| |Lattice|`lattice/passthrough`|Lattice's [API](https://developers.lattice.com/v2/docs/base-url-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.| |Lattice|`lattice/talent`|Lattice's [Talent API](https://developers.lattice.com/docs/introduction-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.| @@ -884,6 +887,7 @@ async def send_passthrough_request_async( |TriNet PEO|`trinetpeo/v1`|We use `https://api.trinet.com` as the base URL. Find the official docs [here](https://developers.trinet.com).| |Ubeeo|`ubeeo/api`|Ubeeo ATS API. We automatically authenticate all requests using OAuth client credentials and use `https://api.ats-platform.com` as the base URL (sandbox: `https://api.acc.ats-platform.com`).| |Udemy Business|`udemy/learning`|Udemy Business REST API. We automatically handle authentication and use `https://\{account_name\}.udemy.com/api-2.0/organizations/\{account_id\}/` as the base URL.| + |UKG Pro WFM|`ukgprowfm/api`|UKG Pro WFM's [API](https://developer.ukg.com/wfm/reference/welcome-to-the-ukg-pro-workforce-management-api). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.| |UKG Pro|`ukgpro/default`|[UKG Pro's HRIS API](https://developer.ukg.com/hcm/reference/get_personnel-v1-person-details). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.| |UKG Pro|`ukgpro/recruting`|[UKG Pro's Recruiting API](https://developer.ukg.com/hcm/reference/retrieveapplications). We automatically authenticate all requests and use `https://\{hostname\}/talent/recruiting/v2/\{tenantalias\}/api` as the base URL.| |UKG Ready|`ukgready/api`|UKG Ready [API](https://secure.saashr.com/ta/docs/rest/public/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}` as the base URL.| @@ -991,7 +995,7 @@ async def send_passthrough_request_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1091,7 +1095,7 @@ def delete_integration( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1191,7 +1195,7 @@ async def delete_integration_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1275,7 +1279,7 @@ def get_integration_details( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1359,7 +1363,7 @@ async def get_integration_details_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1459,7 +1463,7 @@ def set_integration_enabled( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1559,7 +1563,7 @@ async def set_integration_enabled_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1684,7 +1688,7 @@ def create_reconnection_link( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1809,7 +1813,7 @@ async def create_reconnection_link_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1826,6 +1830,218 @@ async def create_reconnection_link_async( raise errors.SDKDefaultError("Unexpected response received", http_res) + def create_setup_link( + self, + *, + integration_id: str, + link_type: models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType, + language: OptionalNullable[ + models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage + ] = "en", + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.PostIntegrationsIntegrationIDSetupLinkPositiveResponse: + r"""Create Setup Flow link + + Create a link that lets your customer run the [Setup Flow](/hris/features/setup-flow/introduction) for an integration. Use this to send customers back into setup steps like field mapping or employee filtering without having to go through the initial connection flow again. Pass the returned URL to `showKomboConnect` from the Kombo Connect SDK, the same way you do with a connection link. + + The integration must have at least one Setup Flow step enabled (e.g. field mapping or employee filtering); otherwise this endpoint returns a `PLATFORM.INPUT_INVALID` error. Steps can be enabled from the Integration Settings tab in the dashboard or via the [Create Connection Link endpoint](./post-connect-create-link). + + :param integration_id: POST /integrations/:integration_id/setup-link Parameter + :param link_type: The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (these are valid for 1 year). + :param language: Language of the setup flow UI. + :param retries: Override the default retry configuration for this method + :param server_url: Override the default server URL for this method + :param timeout_ms: Override the default request timeout configuration for this method in milliseconds + :param http_headers: Additional headers to set or replace on requests. + """ + base_url = None + url_variables = None + if timeout_ms is None: + timeout_ms = self.sdk_configuration.timeout_ms + + if timeout_ms is None: + timeout_ms = 300000 + + if server_url is not None: + base_url = server_url + else: + base_url = self._get_url(base_url, url_variables) + + request = models.PostIntegrationsIntegrationIDSetupLinkRequest( + integration_id=integration_id, + body=models.PostIntegrationsIntegrationIDSetupLinkRequestBody( + language=language, + link_type=link_type, + ), + ) + + req = self._build_request( + method="POST", + path="/integrations/{integration_id}/setup-link", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=True, + request_has_path_params=True, + request_has_query_params=True, + user_agent_header="user-agent", + accept_header_value="application/json", + http_headers=http_headers, + security=self.sdk_configuration.security, + get_serialized_body=lambda: utils.serialize_request_body( + request.body, + False, + False, + "json", + models.PostIntegrationsIntegrationIDSetupLinkRequestBody, + ), + allow_empty_value=None, + timeout_ms=timeout_ms, + ) + + if retries == UNSET: + if self.sdk_configuration.retry_config is not UNSET: + retries = self.sdk_configuration.retry_config + + retry_config = None + if isinstance(retries, utils.RetryConfig): + retry_config = (retries, ["429", "500", "502", "503", "504"]) + + http_res = self.do_request( + hook_ctx=HookContext( + config=self.sdk_configuration, + base_url=base_url or "", + operation_id="PostIntegrationsIntegrationIdSetupLink", + oauth2_scopes=None, + security_source=self.sdk_configuration.security, + ), + request=req, + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return unmarshal_json_response( + models.PostIntegrationsIntegrationIDSetupLinkPositiveResponse, http_res + ) + if utils.match_response(http_res, "default", "application/json"): + response_data = unmarshal_json_response( + errors.KomboGeneralErrorData, http_res + ) + raise errors.KomboGeneralError(response_data, http_res) + + raise errors.SDKDefaultError("Unexpected response received", http_res) + + async def create_setup_link_async( + self, + *, + integration_id: str, + link_type: models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType, + language: OptionalNullable[ + models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage + ] = "en", + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.PostIntegrationsIntegrationIDSetupLinkPositiveResponse: + r"""Create Setup Flow link + + Create a link that lets your customer run the [Setup Flow](/hris/features/setup-flow/introduction) for an integration. Use this to send customers back into setup steps like field mapping or employee filtering without having to go through the initial connection flow again. Pass the returned URL to `showKomboConnect` from the Kombo Connect SDK, the same way you do with a connection link. + + The integration must have at least one Setup Flow step enabled (e.g. field mapping or employee filtering); otherwise this endpoint returns a `PLATFORM.INPUT_INVALID` error. Steps can be enabled from the Integration Settings tab in the dashboard or via the [Create Connection Link endpoint](./post-connect-create-link). + + :param integration_id: POST /integrations/:integration_id/setup-link Parameter + :param link_type: The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (these are valid for 1 year). + :param language: Language of the setup flow UI. + :param retries: Override the default retry configuration for this method + :param server_url: Override the default server URL for this method + :param timeout_ms: Override the default request timeout configuration for this method in milliseconds + :param http_headers: Additional headers to set or replace on requests. + """ + base_url = None + url_variables = None + if timeout_ms is None: + timeout_ms = self.sdk_configuration.timeout_ms + + if timeout_ms is None: + timeout_ms = 300000 + + if server_url is not None: + base_url = server_url + else: + base_url = self._get_url(base_url, url_variables) + + request = models.PostIntegrationsIntegrationIDSetupLinkRequest( + integration_id=integration_id, + body=models.PostIntegrationsIntegrationIDSetupLinkRequestBody( + language=language, + link_type=link_type, + ), + ) + + req = self._build_request_async( + method="POST", + path="/integrations/{integration_id}/setup-link", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=True, + request_has_path_params=True, + request_has_query_params=True, + user_agent_header="user-agent", + accept_header_value="application/json", + http_headers=http_headers, + security=self.sdk_configuration.security, + get_serialized_body=lambda: utils.serialize_request_body( + request.body, + False, + False, + "json", + models.PostIntegrationsIntegrationIDSetupLinkRequestBody, + ), + allow_empty_value=None, + timeout_ms=timeout_ms, + ) + + if retries == UNSET: + if self.sdk_configuration.retry_config is not UNSET: + retries = self.sdk_configuration.retry_config + + retry_config = None + if isinstance(retries, utils.RetryConfig): + retry_config = (retries, ["429", "500", "502", "503", "504"]) + + http_res = await self.do_request_async( + hook_ctx=HookContext( + config=self.sdk_configuration, + base_url=base_url or "", + operation_id="PostIntegrationsIntegrationIdSetupLink", + oauth2_scopes=None, + security_source=self.sdk_configuration.security, + ), + request=req, + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return unmarshal_json_response( + models.PostIntegrationsIntegrationIDSetupLinkPositiveResponse, http_res + ) + if utils.match_response(http_res, "default", "application/json"): + response_data = unmarshal_json_response( + errors.KomboGeneralErrorData, http_res + ) + raise errors.KomboGeneralError(response_data, http_res) + + raise errors.SDKDefaultError("Unexpected response received", http_res) + def get_integration_fields( self, *, @@ -1900,7 +2116,7 @@ def get_integration_fields( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2019,7 +2235,7 @@ async def get_integration_fields_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2151,7 +2367,7 @@ def update_integration_field( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2251,7 +2467,7 @@ async def update_integration_field_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2343,7 +2559,7 @@ def get_custom_fields( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2462,7 +2678,7 @@ async def get_custom_fields_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2592,7 +2808,7 @@ def update_custom_field_mapping( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2692,7 +2908,7 @@ async def update_custom_field_mapping_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2778,7 +2994,7 @@ def get_tools( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2863,7 +3079,7 @@ async def get_tools_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) diff --git a/src/kombo/hris.py b/src/kombo/hris.py index 4c09593..298865d 100644 --- a/src/kombo/hris.py +++ b/src/kombo/hris.py @@ -51,7 +51,7 @@ def get_employees( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `employments` | ✓ Yes | ✓ Yes | | `time_off_balances` | ✓ Yes | ✓ Yes | @@ -60,7 +60,7 @@ def get_employees( | `legal_entity` | n/a | ✓ Yes | | `work_location` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -148,7 +148,7 @@ def get_employees( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -239,7 +239,7 @@ async def get_employees_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `employments` | ✓ Yes | ✓ Yes | | `time_off_balances` | ✓ Yes | ✓ Yes | @@ -248,7 +248,7 @@ async def get_employees_async( | `legal_entity` | n/a | ✓ Yes | | `work_location` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -336,7 +336,7 @@ async def get_employees_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -540,7 +540,7 @@ def get_employee_form( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -705,7 +705,7 @@ async def get_employee_form_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -821,7 +821,7 @@ def create_employee_with_form( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -937,7 +937,7 @@ async def create_employee_with_form_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1057,7 +1057,7 @@ def add_employee_document( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1177,7 +1177,7 @@ async def add_employee_document_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1288,7 +1288,7 @@ def get_employee_document_categories( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1428,7 +1428,7 @@ async def get_employee_document_categories_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1581,7 +1581,7 @@ def get_groups( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1731,7 +1731,7 @@ async def get_groups_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -1876,7 +1876,7 @@ def get_employments( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2016,7 +2016,7 @@ async def get_employments_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2162,7 +2162,7 @@ def get_locations( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2306,7 +2306,7 @@ async def get_locations_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2450,7 +2450,7 @@ def get_absence_types( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2590,7 +2590,7 @@ async def get_absence_types_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2669,11 +2669,11 @@ def get_time_off_balances( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `type` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -2742,7 +2742,7 @@ def get_time_off_balances( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2819,11 +2819,11 @@ async def get_time_off_balances_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `type` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -2892,7 +2892,7 @@ async def get_time_off_balances_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -2975,11 +2975,11 @@ def get_absences( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `type` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -3054,7 +3054,7 @@ def get_absences( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3137,11 +3137,11 @@ async def get_absences_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `type` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -3216,7 +3216,7 @@ async def get_absences_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3408,7 +3408,7 @@ def create_absence( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3564,7 +3564,7 @@ async def create_absence_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3681,7 +3681,7 @@ def delete_absence( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3798,7 +3798,7 @@ async def delete_absence_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -3912,7 +3912,7 @@ def get_legal_entities( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4056,7 +4056,7 @@ async def get_legal_entities_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4221,7 +4221,7 @@ def get_timesheets( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4387,7 +4387,7 @@ async def get_timesheets_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4537,7 +4537,7 @@ def get_performance_review_cycles( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4679,7 +4679,7 @@ async def get_performance_review_cycles_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4764,13 +4764,13 @@ def get_performance_reviews( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `review_cycle` | n/a | ✓ Yes | | `reviewee` | n/a | ✓ Yes | | `reviewer` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -4845,7 +4845,7 @@ def get_performance_reviews( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -4928,13 +4928,13 @@ async def get_performance_reviews_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `review_cycle` | n/a | ✓ Yes | | `reviewee` | n/a | ✓ Yes | | `reviewer` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -5009,7 +5009,7 @@ async def get_performance_reviews_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -5104,13 +5104,13 @@ def get_staffing_entities( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `locations` | ✓ Yes | ✓ Yes | | `legal_entities` | ✓ Yes | ✓ Yes | | `groups` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -5185,7 +5185,7 @@ def get_staffing_entities( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) @@ -5274,13 +5274,13 @@ async def get_staffing_entities_async( For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `locations` | ✓ Yes | ✓ Yes | | `legal_entities` | ✓ Yes | ✓ Yes | | `groups` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ :param include_deleted: By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. :param ignore_unsupported_filters: When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. :param ids: Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. @@ -5355,7 +5355,7 @@ async def get_staffing_entities_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["default"], + is_error_status_code=lambda c: not utils.match_status_codes(["200"], c), retry_config=retry_config, ) diff --git a/src/kombo/models/__init__.py b/src/kombo/models/__init__.py index 8e5ecc5..c6b2681 100644 --- a/src/kombo/models/__init__.py +++ b/src/kombo/models/__init__.py @@ -1939,6 +1939,22 @@ PostIntegrationsIntegrationIDRelinkRequestBodyLinkType, PostIntegrationsIntegrationIDRelinkRequestBodyTypedDict, ) + from .postintegrationsintegrationidsetuplinkop import ( + PostIntegrationsIntegrationIDSetupLinkRequest, + PostIntegrationsIntegrationIDSetupLinkRequestTypedDict, + ) + from .postintegrationsintegrationidsetuplinkpositiveresponse import ( + PostIntegrationsIntegrationIDSetupLinkPositiveResponse, + PostIntegrationsIntegrationIDSetupLinkPositiveResponseData, + PostIntegrationsIntegrationIDSetupLinkPositiveResponseDataTypedDict, + PostIntegrationsIntegrationIDSetupLinkPositiveResponseTypedDict, + ) + from .postintegrationsintegrationidsetuplinkrequestbody import ( + PostIntegrationsIntegrationIDSetupLinkRequestBody, + PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage, + PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType, + PostIntegrationsIntegrationIDSetupLinkRequestBodyTypedDict, + ) from .postpassthroughtoolapiop import ( PostPassthroughToolAPIGlobals, PostPassthroughToolAPIGlobalsTypedDict, @@ -3738,6 +3754,16 @@ "PostIntegrationsIntegrationIDRelinkRequestBodyLinkType", "PostIntegrationsIntegrationIDRelinkRequestBodyTypedDict", "PostIntegrationsIntegrationIDRelinkRequestTypedDict", + "PostIntegrationsIntegrationIDSetupLinkPositiveResponse", + "PostIntegrationsIntegrationIDSetupLinkPositiveResponseData", + "PostIntegrationsIntegrationIDSetupLinkPositiveResponseDataTypedDict", + "PostIntegrationsIntegrationIDSetupLinkPositiveResponseTypedDict", + "PostIntegrationsIntegrationIDSetupLinkRequest", + "PostIntegrationsIntegrationIDSetupLinkRequestBody", + "PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage", + "PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType", + "PostIntegrationsIntegrationIDSetupLinkRequestBodyTypedDict", + "PostIntegrationsIntegrationIDSetupLinkRequestTypedDict", "PostPassthroughToolAPIGlobals", "PostPassthroughToolAPIGlobalsTypedDict", "PostPassthroughToolAPIPositiveResponse", @@ -5633,6 +5659,16 @@ "PostIntegrationsIntegrationIDRelinkRequestBodyLanguage": ".postintegrationsintegrationidrelinkrequestbody", "PostIntegrationsIntegrationIDRelinkRequestBodyLinkType": ".postintegrationsintegrationidrelinkrequestbody", "PostIntegrationsIntegrationIDRelinkRequestBodyTypedDict": ".postintegrationsintegrationidrelinkrequestbody", + "PostIntegrationsIntegrationIDSetupLinkRequest": ".postintegrationsintegrationidsetuplinkop", + "PostIntegrationsIntegrationIDSetupLinkRequestTypedDict": ".postintegrationsintegrationidsetuplinkop", + "PostIntegrationsIntegrationIDSetupLinkPositiveResponse": ".postintegrationsintegrationidsetuplinkpositiveresponse", + "PostIntegrationsIntegrationIDSetupLinkPositiveResponseData": ".postintegrationsintegrationidsetuplinkpositiveresponse", + "PostIntegrationsIntegrationIDSetupLinkPositiveResponseDataTypedDict": ".postintegrationsintegrationidsetuplinkpositiveresponse", + "PostIntegrationsIntegrationIDSetupLinkPositiveResponseTypedDict": ".postintegrationsintegrationidsetuplinkpositiveresponse", + "PostIntegrationsIntegrationIDSetupLinkRequestBody": ".postintegrationsintegrationidsetuplinkrequestbody", + "PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage": ".postintegrationsintegrationidsetuplinkrequestbody", + "PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType": ".postintegrationsintegrationidsetuplinkrequestbody", + "PostIntegrationsIntegrationIDSetupLinkRequestBodyTypedDict": ".postintegrationsintegrationidsetuplinkrequestbody", "PostPassthroughToolAPIGlobals": ".postpassthroughtoolapiop", "PostPassthroughToolAPIGlobalsTypedDict": ".postpassthroughtoolapiop", "PostPassthroughToolAPIRequest": ".postpassthroughtoolapiop", diff --git a/src/kombo/models/getatsapplicationsop.py b/src/kombo/models/getatsapplicationsop.py index a3ee4a8..df49017 100644 --- a/src/kombo/models/getatsapplicationsop.py +++ b/src/kombo/models/getatsapplicationsop.py @@ -58,7 +58,7 @@ class GetAtsApplicationsRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `candidate` | n/a | ✓ Yes | | `candidate` → `tags` | ✗ No | ✗ No | @@ -67,7 +67,7 @@ class GetAtsApplicationsRequestTypedDict(TypedDict): | `interviews` | ✓ Yes | ✓ Yes | | `offers` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -121,7 +121,7 @@ class GetAtsApplicationsRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `candidate` | n/a | ✓ Yes | | `candidate` → `tags` | ✗ No | ✗ No | @@ -130,7 +130,7 @@ class GetAtsApplicationsRequest(BaseModel): | `interviews` | ✓ Yes | ✓ Yes | | `offers` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/getatscandidatesop.py b/src/kombo/models/getatscandidatesop.py index ae02448..61bc6ad 100644 --- a/src/kombo/models/getatscandidatesop.py +++ b/src/kombo/models/getatscandidatesop.py @@ -58,14 +58,14 @@ class GetAtsCandidatesRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `applications` | ✓ Yes | ✓ Yes | | `applications` → `current_stage` | ✗ No | ✗ No | | `applications` → `job` | ✗ No | ✗ No | | `tags` | ✓ Yes | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -110,14 +110,14 @@ class GetAtsCandidatesRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `applications` | ✓ Yes | ✓ Yes | | `applications` → `current_stage` | ✗ No | ✗ No | | `applications` → `job` | ✗ No | ✗ No | | `tags` | ✓ Yes | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/getatsinterviewsop.py b/src/kombo/models/getatsinterviewsop.py index dfa8fcb..e802e5e 100644 --- a/src/kombo/models/getatsinterviewsop.py +++ b/src/kombo/models/getatsinterviewsop.py @@ -58,14 +58,14 @@ class GetAtsInterviewsRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `interviewers` | ✓ Yes | ✗ No | | `application` | n/a | ✓ Yes | | `application` → `candidate` | ✗ No | ✗ No | | `application` → `job` | ✗ No | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -104,14 +104,14 @@ class GetAtsInterviewsRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `interviewers` | ✓ Yes | ✗ No | | `application` | n/a | ✓ Yes | | `application` → `candidate` | ✗ No | ✗ No | | `application` → `job` | ✗ No | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/getatsjobsop.py b/src/kombo/models/getatsjobsop.py index 9a8af4b..d601c01 100644 --- a/src/kombo/models/getatsjobsop.py +++ b/src/kombo/models/getatsjobsop.py @@ -58,14 +58,14 @@ class GetAtsJobsRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `stages` | ✓ Yes | ✗ No | | `screening_questions` | ✓ Yes | ✗ No | | `job_postings` | ✓ Yes | ✓ Yes | | `hiring_team` | ✓ Yes | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -125,14 +125,14 @@ class GetAtsJobsRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `stages` | ✓ Yes | ✗ No | | `screening_questions` | ✓ Yes | ✗ No | | `job_postings` | ✓ Yes | ✓ Yes | | `hiring_team` | ✓ Yes | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/getatsoffersop.py b/src/kombo/models/getatsoffersop.py index 72c2a0e..2189c19 100644 --- a/src/kombo/models/getatsoffersop.py +++ b/src/kombo/models/getatsoffersop.py @@ -58,13 +58,13 @@ class GetAtsOffersRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `application` | n/a | ✓ Yes | | `application` → `candidate` | ✗ No | ✗ No | | `application` → `job` | ✗ No | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -101,13 +101,13 @@ class GetAtsOffersRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `application` | n/a | ✓ Yes | | `application` → `candidate` | ✗ No | ✗ No | | `application` → `job` | ✗ No | ✗ No | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/getatsusersop.py b/src/kombo/models/getatsusersop.py index b59fd94..7b0819a 100644 --- a/src/kombo/models/getatsusersop.py +++ b/src/kombo/models/getatsusersop.py @@ -58,11 +58,11 @@ class GetAtsUsersRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `system_role_assignment` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -101,11 +101,11 @@ class GetAtsUsersRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `system_role_assignment` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/gethrisabsencesop.py b/src/kombo/models/gethrisabsencesop.py index 5182266..9b894a6 100644 --- a/src/kombo/models/gethrisabsencesop.py +++ b/src/kombo/models/gethrisabsencesop.py @@ -58,11 +58,11 @@ class GetHrisAbsencesRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `type` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -107,11 +107,11 @@ class GetHrisAbsencesRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `type` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/gethrisemployeesop.py b/src/kombo/models/gethrisemployeesop.py index 360f774..51ed169 100644 --- a/src/kombo/models/gethrisemployeesop.py +++ b/src/kombo/models/gethrisemployeesop.py @@ -58,7 +58,7 @@ class GetHrisEmployeesRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `employments` | ✓ Yes | ✓ Yes | | `time_off_balances` | ✓ Yes | ✓ Yes | @@ -67,7 +67,7 @@ class GetHrisEmployeesRequestTypedDict(TypedDict): | `legal_entity` | n/a | ✓ Yes | | `work_location` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -126,7 +126,7 @@ class GetHrisEmployeesRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `employments` | ✓ Yes | ✓ Yes | | `time_off_balances` | ✓ Yes | ✓ Yes | @@ -135,7 +135,7 @@ class GetHrisEmployeesRequest(BaseModel): | `legal_entity` | n/a | ✓ Yes | | `work_location` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/gethrisperformancereviewsop.py b/src/kombo/models/gethrisperformancereviewsop.py index 674dd88..7ea6144 100644 --- a/src/kombo/models/gethrisperformancereviewsop.py +++ b/src/kombo/models/gethrisperformancereviewsop.py @@ -58,13 +58,13 @@ class GetHrisPerformanceReviewsRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `review_cycle` | n/a | ✓ Yes | | `reviewee` | n/a | ✓ Yes | | `reviewer` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -110,13 +110,13 @@ class GetHrisPerformanceReviewsRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `review_cycle` | n/a | ✓ Yes | | `reviewee` | n/a | ✓ Yes | | `reviewer` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/gethrisstaffingentitiesop.py b/src/kombo/models/gethrisstaffingentitiesop.py index 3ca474e..b49f88c 100644 --- a/src/kombo/models/gethrisstaffingentitiesop.py +++ b/src/kombo/models/gethrisstaffingentitiesop.py @@ -58,13 +58,13 @@ class GetHrisStaffingEntitiesRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `locations` | ✓ Yes | ✓ Yes | | `legal_entities` | ✓ Yes | ✓ Yes | | `groups` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -111,13 +111,13 @@ class GetHrisStaffingEntitiesRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `locations` | ✓ Yes | ✓ Yes | | `legal_entities` | ✓ Yes | ✓ Yes | | `groups` | ✓ Yes | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/gethristimeoffbalancesop.py b/src/kombo/models/gethristimeoffbalancesop.py index eba008f..859e2d0 100644 --- a/src/kombo/models/gethristimeoffbalancesop.py +++ b/src/kombo/models/gethristimeoffbalancesop.py @@ -58,11 +58,11 @@ class GetHrisTimeOffBalancesRequestTypedDict(TypedDict): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `type` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: NotRequired[bool] r"""By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.""" @@ -101,11 +101,11 @@ class GetHrisTimeOffBalancesRequest(BaseModel): For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. - | Path | Relationship | Target Record | + | Path | Added/Removed | Linked Record | | --- | --- | --- | | `type` | n/a | ✓ Yes | - _**Relationship**: Whether adding or removing entries from this list triggers an update (n/a for single references that are not lists). **Target Record**: Whether changes to the linked record itself trigger an update._ + _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ """ include_deleted: Annotated[ diff --git a/src/kombo/models/postconnectcreatelinkrequestbody.py b/src/kombo/models/postconnectcreatelinkrequestbody.py index 8c622df..2026eb8 100644 --- a/src/kombo/models/postconnectcreatelinkrequestbody.py +++ b/src/kombo/models/postconnectcreatelinkrequestbody.py @@ -85,6 +85,7 @@ "recruitcrm", "jazzhr", "bite", + "brassring", "homerun", "mysolution", "carerix", @@ -121,8 +122,10 @@ "guidecom", "spott", "loxo", + "kula", "workdaycustomreport", "workdaycustomreportsftp", + "ukgprowfm", "payfitcustomer", "payfitpartner", "payfit", diff --git a/src/kombo/models/postintegrationsintegrationidsetuplinkop.py b/src/kombo/models/postintegrationsintegrationidsetuplinkop.py new file mode 100644 index 0000000..ffd5462 --- /dev/null +++ b/src/kombo/models/postintegrationsintegrationidsetuplinkop.py @@ -0,0 +1,30 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from .postintegrationsintegrationidsetuplinkrequestbody import ( + PostIntegrationsIntegrationIDSetupLinkRequestBody, + PostIntegrationsIntegrationIDSetupLinkRequestBodyTypedDict, +) +from kombo.types import BaseModel +from kombo.utils import FieldMetadata, PathParamMetadata, RequestMetadata +from typing_extensions import Annotated, TypedDict + + +class PostIntegrationsIntegrationIDSetupLinkRequestTypedDict(TypedDict): + integration_id: str + r"""POST /integrations/:integration_id/setup-link Parameter""" + body: PostIntegrationsIntegrationIDSetupLinkRequestBodyTypedDict + r"""POST /integrations/:integration_id/setup-link Request body""" + + +class PostIntegrationsIntegrationIDSetupLinkRequest(BaseModel): + integration_id: Annotated[ + str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False)) + ] + r"""POST /integrations/:integration_id/setup-link Parameter""" + + body: Annotated[ + PostIntegrationsIntegrationIDSetupLinkRequestBody, + FieldMetadata(request=RequestMetadata(media_type="application/json")), + ] + r"""POST /integrations/:integration_id/setup-link Request body""" diff --git a/src/kombo/models/postintegrationsintegrationidsetuplinkpositiveresponse.py b/src/kombo/models/postintegrationsintegrationidsetuplinkpositiveresponse.py new file mode 100644 index 0000000..ba51b6d --- /dev/null +++ b/src/kombo/models/postintegrationsintegrationidsetuplinkpositiveresponse.py @@ -0,0 +1,39 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from kombo.types import BaseModel +from kombo.utils import validate_const +import pydantic +from pydantic.functional_validators import AfterValidator +from typing import Literal +from typing_extensions import Annotated, TypedDict + + +class PostIntegrationsIntegrationIDSetupLinkPositiveResponseDataTypedDict(TypedDict): + link: str + r"""The setup link URL to pass to the Kombo Connect SDK.""" + + +class PostIntegrationsIntegrationIDSetupLinkPositiveResponseData(BaseModel): + link: str + r"""The setup link URL to pass to the Kombo Connect SDK.""" + + +class PostIntegrationsIntegrationIDSetupLinkPositiveResponseTypedDict(TypedDict): + data: PostIntegrationsIntegrationIDSetupLinkPositiveResponseDataTypedDict + status: Literal["success"] + + +class PostIntegrationsIntegrationIDSetupLinkPositiveResponse(BaseModel): + data: PostIntegrationsIntegrationIDSetupLinkPositiveResponseData + + STATUS: Annotated[ + Annotated[Literal["success"], AfterValidator(validate_const("success"))], + pydantic.Field(alias="status"), + ] = "success" + + +try: + PostIntegrationsIntegrationIDSetupLinkPositiveResponse.model_rebuild() +except NameError: + pass diff --git a/src/kombo/models/postintegrationsintegrationidsetuplinkrequestbody.py b/src/kombo/models/postintegrationsintegrationidsetuplinkrequestbody.py new file mode 100644 index 0000000..0145bb4 --- /dev/null +++ b/src/kombo/models/postintegrationsintegrationidsetuplinkrequestbody.py @@ -0,0 +1,68 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from kombo.types import BaseModel, Nullable, OptionalNullable, UNSET_SENTINEL +from pydantic import model_serializer +from typing import Literal +from typing_extensions import NotRequired, TypedDict + + +PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage = Literal[ + "en", + "de", + "fr", + "it", + "es", +] +r"""Language of the setup flow UI.""" + + +PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType = Literal[ + "EMBEDDED", + "MAGIC_LINK", +] +r"""The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (these are valid for 1 year).""" + + +class PostIntegrationsIntegrationIDSetupLinkRequestBodyTypedDict(TypedDict): + link_type: PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType + r"""The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (these are valid for 1 year).""" + language: NotRequired[ + Nullable[PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage] + ] + r"""Language of the setup flow UI.""" + + +class PostIntegrationsIntegrationIDSetupLinkRequestBody(BaseModel): + link_type: PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType + r"""The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (these are valid for 1 year).""" + + language: OptionalNullable[ + PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage + ] = "en" + r"""Language of the setup flow UI.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = set(["language"]) + nullable_fields = set(["language"]) + serialized = handler(self) + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k, serialized.get(n)) + is_nullable_and_explicitly_set = ( + k in nullable_fields + and (self.__pydantic_fields_set__.intersection({n})) # pylint: disable=no-member + ) + + if val != UNSET_SENTINEL: + if ( + val is not None + or k not in optional_fields + or is_nullable_and_explicitly_set + ): + m[k] = val + + return m diff --git a/src/kombo/models/schema4.py b/src/kombo/models/schema4.py index 7b5c308..e08fe7b 100644 --- a/src/kombo/models/schema4.py +++ b/src/kombo/models/schema4.py @@ -7,10 +7,23 @@ Schema4TypedDict = TypeAliasType( "Schema4TypedDict", - Union[str, float, bool, Dict[str, "Schema4TypedDict"], List["Schema4TypedDict"]], + Union[ + str, + float, + bool, + Dict[str, "Schema4TypedDict"], # pyright: ignore[reportInvalidTypeForm] + List["Schema4TypedDict"], # pyright: ignore[reportInvalidTypeForm] + ], ) Schema4 = TypeAliasType( - "Schema4", Union[str, float, bool, Dict[str, "Schema4"], List["Schema4"]] + "Schema4", + Union[ + str, + float, + bool, + Dict[str, "Schema4"], # pyright: ignore[reportInvalidTypeForm] + List["Schema4"], # pyright: ignore[reportInvalidTypeForm] + ], ) diff --git a/uv.lock b/uv.lock index 0f42106..7e16d70 100644 --- a/uv.lock +++ b/uv.lock @@ -191,7 +191,7 @@ wheels = [ [[package]] name = "kombo" -version = "1.1.1" +version = "1.1.2" source = { editable = "." } dependencies = [ { name = "httpcore" },