From e712fbbb78c8b528d96dc1446c563b33ebb49e47 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 8 May 2026 01:14:41 +0000 Subject: [PATCH] ## Ruby SDK Changes: * `kombo.general.create_setup_link()`: **Added** * `kombo.connect.create_connection_link()`: * `request.integration_tool` **Changed** --- .speakeasy/gen.lock | 270 +++++++++++++----- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 12 +- Gemfile.lock | 4 +- README.md | 1 + RELEASES.md | 12 +- .../operations/getatsapplicationsrequest.md | 30 +- .../operations/getatscandidatesrequest.md | 28 +- .../operations/getatsinterviewsrequest.md | 22 +- docs/models/operations/getatsjobsrequest.md | 34 +-- docs/models/operations/getatsoffersrequest.md | 20 +- docs/models/operations/getatsusersrequest.md | 22 +- .../operations/gethrisabsencesrequest.md | 28 +- .../operations/gethrisemployeesrequest.md | 34 +-- .../gethrisperformancereviewsrequest.md | 26 +- .../gethrisstaffingentitiesrequest.md | 24 +- .../gethristimeoffbalancesrequest.md | 22 +- ...tegrationsintegrationidsetuplinkrequest.md | 9 + ...egrationsintegrationidsetuplinkresponse.md | 11 + docs/models/shared/integrationtool.md | 6 + ...sintegrationidsetuplinkpositiveresponse.md | 9 + ...egrationidsetuplinkpositiveresponsedata.md | 8 + ...ationsintegrationidsetuplinkrequestbody.md | 9 + ...tegrationidsetuplinkrequestbodylanguage.md | 14 + ...tegrationidsetuplinkrequestbodylinktype.md | 11 + docs/sdks/ats/README.md | 156 +++++----- docs/sdks/general/README.md | 55 +++- docs/sdks/hris/README.md | 134 ++++----- kombo.gemspec | 2 +- lib/kombo/general.rb | 143 +++++++++- lib/kombo/models/operations.rb | 2 + .../operations/getatsapplications_request.rb | 4 +- .../operations/getatscandidates_request.rb | 4 +- .../operations/getatsinterviews_request.rb | 4 +- .../models/operations/getatsjobs_request.rb | 4 +- .../models/operations/getatsoffers_request.rb | 4 +- .../models/operations/getatsusers_request.rb | 4 +- .../operations/gethrisabsences_request.rb | 4 +- .../operations/gethrisemployees_request.rb | 4 +- .../gethrisperformancereviews_request.rb | 4 +- .../gethrisstaffingentities_request.rb | 4 +- .../gethristimeoffbalances_request.rb | 4 +- ...egrationsintegrationidsetuplink_request.rb | 36 +++ ...grationsintegrationidsetuplink_request.rbi | 15 + ...grationsintegrationidsetuplink_response.rb | 44 +++ ...rationsintegrationidsetuplink_response.rbi | 19 ++ lib/kombo/models/shared.rb | 5 + lib/kombo/models/shared/integration_tool.rb | 6 + ...sintegrationidsetuplinkpositiveresponse.rb | 39 +++ ...integrationidsetuplinkpositiveresponse.rbi | 15 + ...grationidsetuplinkpositiveresponse_data.rb | 32 +++ ...rationidsetuplinkpositiveresponse_data.rbi | 13 + ...ationsintegrationidsetuplinkrequestbody.rb | 36 +++ ...tionsintegrationidsetuplinkrequestbody.rbi | 15 + ...egrationidsetuplinkrequestbody_language.rb | 24 ++ ...grationidsetuplinkrequestbody_language.rbi | 11 + ...grationidsetuplinkrequestbody_link_type.rb | 21 ++ ...rationidsetuplinkrequestbody_link_type.rbi | 11 + lib/kombo/sdkconfiguration.rb | 4 +- 59 files changed, 1151 insertions(+), 399 deletions(-) create mode 100644 docs/models/operations/postintegrationsintegrationidsetuplinkrequest.md create mode 100644 docs/models/operations/postintegrationsintegrationidsetuplinkresponse.md create mode 100644 docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.md create mode 100644 docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponsedata.md create mode 100644 docs/models/shared/postintegrationsintegrationidsetuplinkrequestbody.md create mode 100644 docs/models/shared/postintegrationsintegrationidsetuplinkrequestbodylanguage.md create mode 100644 docs/models/shared/postintegrationsintegrationidsetuplinkrequestbodylinktype.md create mode 100644 lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rb create mode 100644 lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rbi create mode 100644 lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rb create mode 100644 lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rbi create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rb create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rbi create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rb create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rbi create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rb create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rbi create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rb create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rbi create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rb create mode 100644 lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rbi diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 4cd7c14..35fbe93 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,19 +1,19 @@ lockVersion: 2.0.0 id: a945ea15-b620-47b9-9868-c165c173bf88 management: - docChecksum: e4a73f7bc7221e532155a6ede4a1a57f + docChecksum: d43940c6f296e52bae4052ed7d382913 docVersion: 1.0.0 speakeasyVersion: 1.700.2 generationVersion: 2.801.2 - releaseVersion: 1.1.1 - configChecksum: 806f87d65890fa79a3a9081b680c8f52 + releaseVersion: 1.1.2 + configChecksum: acee7ce24346b243164c5ebc4f8610bd repoURL: https://github.com/kombohq/ruby-sdk.git installationURL: https://github.com/kombohq/ruby-sdk published: true persistentEdits: - generation_id: 17d85eb2-530e-4421-9555-a8c236d6aa17 - pristine_commit_hash: cdad13b1d6f2ada79ae9f753be0fd452bc92924b - pristine_tree_hash: 774fd12af0ddd8f5b14edd9c6c97b7885d3b4bd7 + generation_id: e44ea30d-df2e-45c2-abda-7bee3ca01266 + pristine_commit_hash: da07bf6528f5b887328f498cf636729f857ac061 + pristine_tree_hash: 858ade89697f9aaa505df80f3c41f70758a872fa features: ruby: constsAndDefaults: 0.1.1 @@ -49,8 +49,8 @@ trackedFiles: pristine_git_object: b0ea40558f3ca80dcf7d30b159d34a1e5ab33440 Gemfile.lock: id: 21fb5836b499 - last_write_checksum: sha1:ff68cf6e93932d9b29bb4e27d613568e7d77fb40 - pristine_git_object: d8efddc4f96d9467c40fdc43248fee755c585d87 + last_write_checksum: sha1:410faf9ffb4070d8290884afdcb01bc66b7c8bde + pristine_git_object: dc4187409d24d071a5464b020435c8f45b929b8e Rakefile: id: 44b7fa1ba503 last_write_checksum: sha1:bb15946e7c34d00098a6ee8fef994bbd57960092 @@ -121,8 +121,8 @@ trackedFiles: pristine_git_object: 6df2309e1c3f45320269c36446c80ac368b77285 docs/models/operations/getatsapplicationsrequest.md: id: b1609ebcb91d - last_write_checksum: sha1:0a635ea1b69ac880c9eb9fad98a79546273e53ec - pristine_git_object: bf5235432fd5f0aa0b636688982e5fd826ed39d2 + last_write_checksum: sha1:075b179f7bb73db9455b5d4a2f94ec7ebf51364e + pristine_git_object: 518974c9a14330bcfe9bb6fd95fb78cf240d9e19 docs/models/operations/getatsapplicationsresponse.md: id: 9ec04a7afe66 last_write_checksum: sha1:377e87b8b5602e6e31a2fbc211cdb57f68b9ecab @@ -145,32 +145,32 @@ trackedFiles: pristine_git_object: 2d7d0b78789db83b542c331d05746505468c4c49 docs/models/operations/getatscandidatesrequest.md: id: 2f9c30d2f917 - last_write_checksum: sha1:7d29df981acbb4651cc7862b65276e80fefca443 - pristine_git_object: 3b5620b85d566720492eee45caeff8631ca65a40 + last_write_checksum: sha1:a18e603c3cc1b40321bf06b651f53b1b1220898b + pristine_git_object: 5495db6403c3644d5004217d28ed646ee4f1d2d7 docs/models/operations/getatscandidatesresponse.md: id: b7b2aa54e364 last_write_checksum: sha1:5c2079ffa32700dfa7d3235045a5e91ccd23666d pristine_git_object: 04077c91da1eb83f5959756c2a2bf167414c4fa6 docs/models/operations/getatsinterviewsrequest.md: id: fb579bc14253 - last_write_checksum: sha1:66e5c0ecbea4cd7327a65d5199dcb5f6928347e4 - pristine_git_object: 11cc106f1b806d52e6427cde92e4307df65665ea + last_write_checksum: sha1:da6fc4e87aa33cb9307bcf98275901aff15bd30c + pristine_git_object: deb5cbe44897a17ce96c320a450e4215058beca8 docs/models/operations/getatsinterviewsresponse.md: id: 537490d27e9d last_write_checksum: sha1:aa193dacccc71a0ec5f9fbdce8f9056ac1397d41 pristine_git_object: 71296f71d06f375e0616fc10c59887ee2553fd8e docs/models/operations/getatsjobsrequest.md: id: 912e4c5aefa4 - last_write_checksum: sha1:d73752af0daaa0e1a77f65f245c62ca5fd7fd737 - pristine_git_object: 942d88e3fdb257437e99fa8703112acf597a6840 + last_write_checksum: sha1:6aee329b0c9049c7c6b889e98980216954b3b959 + pristine_git_object: d9be191a6aaeb6ddfb78d30a4ace4613fdfd09f2 docs/models/operations/getatsjobsresponse.md: id: 6f621740851c last_write_checksum: sha1:717603e3d461afc3b045a82e79d60cfe60d99198 pristine_git_object: 3bc0671bd5b344d3e6b0da70337e886200e69aeb docs/models/operations/getatsoffersrequest.md: id: 6b43bae3be30 - last_write_checksum: sha1:1a1a69c9f0402c30468b464b8e524be952376cb8 - pristine_git_object: c6b12492ba0a4b0bd4d8bb495856118ecc9b7bf0 + last_write_checksum: sha1:a57246e81d3ce7ef0e8c23946b6e844d27c57bac + pristine_git_object: 821984a202c5e0362604675210a67b277008a6b8 docs/models/operations/getatsoffersresponse.md: id: 6d1e720418d5 last_write_checksum: sha1:0358e222d981fcf90ca724e3e8c9001c27d13b9a @@ -201,8 +201,8 @@ trackedFiles: pristine_git_object: d2e9e3171b98b1afe4461ffdbe215e692e3a7bdb docs/models/operations/getatsusersrequest.md: id: ded784d73bb6 - last_write_checksum: sha1:f13ec4fb62ec63e24e2da8d2960cd44fb38c40c3 - pristine_git_object: 9027895041de2c3a005f6297fabc558ca2152c5a + last_write_checksum: sha1:145da9b330094a2ac5186fa0204e5101b2f10a36 + pristine_git_object: 42f87d417a8861b183d63010d4b4196d0ce66fbd docs/models/operations/getatsusersresponse.md: id: 18c62348bfc1 last_write_checksum: sha1:5424e8bb6e406116c9f578114c69a5e732b359d3 @@ -221,8 +221,8 @@ trackedFiles: pristine_git_object: d79900f04da96f8db66462868928f37327118c87 docs/models/operations/gethrisabsencesrequest.md: id: f08dd8d95a65 - last_write_checksum: sha1:2920c8560ee1b28c3c9d9cc534e278170c25983e - pristine_git_object: d7329c178be7ee600c3f58799a7e319bb2bfe52f + last_write_checksum: sha1:901a75f268e6730542d016b87403efb0fb153bb5 + pristine_git_object: bda5dbb6a7061c0ca69232028f24fb6237f3f41f docs/models/operations/gethrisabsencesresponse.md: id: 5bea132ace7a last_write_checksum: sha1:f8f0cfac797b812f21c118c53eb063a2f3892428 @@ -253,8 +253,8 @@ trackedFiles: pristine_git_object: 99e0f215348b27f46c93b7a185bb86a611b6627a docs/models/operations/gethrisemployeesrequest.md: id: 17c6468c9e20 - last_write_checksum: sha1:ef156d29311dbc1419f603573bd91767d32f9c92 - pristine_git_object: 0b4feb50bd7c80e4929f87f41acb5e8c294fb32c + last_write_checksum: sha1:c3a4780dbbd91dac8bf0f9d7f4e3a9485bf8080c + pristine_git_object: 0247a945d6cb1228174d97a6f4d53874f60d1d1b docs/models/operations/gethrisemployeesresponse.md: id: 6556a0997c38 last_write_checksum: sha1:438146537f6ea962c29c7ac710faf8d8e3ac6cb7 @@ -301,24 +301,24 @@ trackedFiles: pristine_git_object: 0cff2403acc6f98ecaf7fb6542512c68bb24fead docs/models/operations/gethrisperformancereviewsrequest.md: id: 0597292a68d8 - last_write_checksum: sha1:060f605f00b450bb902d0e71ec4bc6f38d880038 - pristine_git_object: bd19b24a2b3cacd34e67ad871ef0ab0d8cdf1711 + last_write_checksum: sha1:583521c498c6eef4196d3766f684d9c7fc69ef18 + pristine_git_object: b93a6bb6da69660071be94af10a7fe3c4ee44100 docs/models/operations/gethrisperformancereviewsresponse.md: id: 579cfc01abd5 last_write_checksum: sha1:31c022c9645c8a55bd9a9c95727d1c65a3f7ff8e pristine_git_object: e3cbf78b0df8f54e4c4cfe80f9a7b86fcf3ad30a docs/models/operations/gethrisstaffingentitiesrequest.md: id: b93001447b5d - last_write_checksum: sha1:8b481b0567bc19bc2386efe6b10c06448fd66023 - pristine_git_object: 8144404411940063e958ea7f66b3cd7d76c10363 + last_write_checksum: sha1:1b8ea1718b2ee5eeb8c35695256dd6224a4c4481 + pristine_git_object: 497a456ec60357571c515bd9dac91d1a54a31bed docs/models/operations/gethrisstaffingentitiesresponse.md: id: 711a576fceb3 last_write_checksum: sha1:372eabbaf8dc17630434109e711effc0a0f534ee pristine_git_object: 74f2ccee9d33b337fc00582fca8b86b287d2b4f6 docs/models/operations/gethristimeoffbalancesrequest.md: id: be7af01b4013 - last_write_checksum: sha1:392ab38a7c5b3e2147b589e00e83a2148ce13c98 - pristine_git_object: ad155c8c1333615aa6297811abd91f41bce2ba46 + last_write_checksum: sha1:655cbc0936672ea2c95bdc8e96ba35dfcd30d4eb + pristine_git_object: 759c05664286cc2c1e3559d011071e048345bedd docs/models/operations/gethristimeoffbalancesresponse.md: id: 9a5d4af658d5 last_write_checksum: sha1:6e91bf75a74e8feb9da4f7bfe9eb8c50d5973caf @@ -495,6 +495,14 @@ trackedFiles: id: 5797470445f9 last_write_checksum: sha1:77d6fb0a551439d952986a4e14df521a84055e7f pristine_git_object: 71317a4afa3589b388c9831e11a0c948d35b1c0f + docs/models/operations/postintegrationsintegrationidsetuplinkrequest.md: + id: 195bbe28a007 + last_write_checksum: sha1:0f082c5f65947e9a2cb7e436998b3a6d43da11a9 + pristine_git_object: 111f2b1ba08e5ace7c71df039ca7fdf6c14fc4c9 + docs/models/operations/postintegrationsintegrationidsetuplinkresponse.md: + id: 0e03f3bd848c + last_write_checksum: sha1:6576a2956c75af6c6eeb4c574b1492dbc5560fc9 + pristine_git_object: ac33d4402b23a399d5c8908fd64cb8c233e1aff7 docs/models/operations/postpassthroughtoolapirequest.md: id: 770c72131023 last_write_checksum: sha1:c38c906b06d62bf407b5778f99b77734d2ee674f @@ -1969,8 +1977,8 @@ trackedFiles: pristine_git_object: 1b44fd372a1b5113087190b3328e0e11317349f3 docs/models/shared/integrationtool.md: id: ccbce9847167 - last_write_checksum: sha1:8c47af660c02f267f2d2580a062bbfd0d40568f6 - pristine_git_object: f8fe6b33afc1d22414a37521d6737bccd05736cd + last_write_checksum: sha1:2662bbb3df593724dd32de3be6aaf39337f97cc7 + pristine_git_object: 33e2a15947b1623e04197e08503065f7070f604f docs/models/shared/interview.md: id: d8d282f154af last_write_checksum: sha1:8a02e7bc37075650da6db4da83362416f77a08ac @@ -3459,6 +3467,26 @@ trackedFiles: id: 20526ca9c306 last_write_checksum: sha1:be27376c5675f5ad33d7e7f9683dd45e39a7e3a2 pristine_git_object: fade32f7efbad9ba9ebf6c5f035cc5fa094ad014 + docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.md: + id: d8d4eaea2afc + last_write_checksum: sha1:f8c6ea273999a493450d1e9cf1782255c80e9ed1 + pristine_git_object: 2d8af3766a5071a1b4798738b2b1894a7904815e + docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponsedata.md: + id: 7db2932e0126 + last_write_checksum: sha1:06ab8882499fac5be14601243f9f0d17c8a794db + pristine_git_object: 0d9e3f57ef1612ee6ee407386f600a72ee20ee1c + docs/models/shared/postintegrationsintegrationidsetuplinkrequestbody.md: + id: 4917b8d64da1 + last_write_checksum: sha1:c5daab24f99b5e8c823914ae3bf3b9109d286110 + pristine_git_object: e33340cfe462a69e9b4b7e74e58d6a25b6d5ba81 + docs/models/shared/postintegrationsintegrationidsetuplinkrequestbodylanguage.md: + id: 7007c7817fb1 + last_write_checksum: sha1:8c6d7ac36d6f6a3e56662b739093ed6fe6504d2b + pristine_git_object: 5471f41187641e3170946bf097b334b3c7bfa96f + docs/models/shared/postintegrationsintegrationidsetuplinkrequestbodylinktype.md: + id: 6a32a54266e7 + last_write_checksum: sha1:77537d97b39114e98c5a1c32ecfe87653f42b6b9 + pristine_git_object: 1ea4986c76b81444b4cc3acab0847cbada064739 docs/models/shared/postpassthroughtoolapipositiveresponse.md: id: 2c2300fcc344 last_write_checksum: sha1:f98d8711d35639e54ed8784c59cab3973f651d2d @@ -4101,28 +4129,28 @@ trackedFiles: pristine_git_object: eade1e5758c19541fe811031e51a3259d2f6195f docs/sdks/ats/README.md: id: 24fafa267f6c - last_write_checksum: sha1:04de772bc40e309a9fe876be637d36c132dca286 - pristine_git_object: 24b928b6b1cd430f68002ca12425527010edbfdb + last_write_checksum: sha1:c68cb899b6e3257e99ef962390b4c0547aefdd06 + pristine_git_object: caf8b6b7d4bd6307e89b5b8ea86eb05e129ae346 docs/sdks/connect/README.md: id: 074a4658c86b last_write_checksum: sha1:063179f4d920ff19db9c7654eebbb4ea708d9fb3 pristine_git_object: fe85124ef65d5d4cc291875df2918323cc450776 docs/sdks/general/README.md: id: ce0ada6fa2e1 - last_write_checksum: sha1:7bbcb853f104aa070a75460ad607142eeac4565c - pristine_git_object: 4297fe0a0be0858db0768aa95b9fb2ab4f8b6267 + last_write_checksum: sha1:25df7f601d54808aee3f72f9c4eb610ef3c9217f + pristine_git_object: f855aca4436c5aa2a1ef74873d66db11ea298a0b docs/sdks/hris/README.md: id: 0baa868a038c - last_write_checksum: sha1:71bd5f7c0eca25a1f1d3f86f3191b9a2ab2a76c2 - pristine_git_object: 7ab696b9448a3e5299cbac7d8e758c67bb2efc71 + last_write_checksum: sha1:74c267f968293f9f79d5104bcb128c1e36e25149 + pristine_git_object: 5861dc5ce3007294077cde3ecd15b405a2d3bb30 extra.rbi: id: e2fdbbd314d3 last_write_checksum: sha1:b4d764c7b4eb0b56246a260e2a6644523dc78b04 pristine_git_object: 237a19c94ed3feee821ecd5611703991f84d91fa kombo.gemspec: id: 476dd5dc2d31 - last_write_checksum: sha1:e061e044baafb72c47ff1f9a63beca6c3c8e27bf - pristine_git_object: b8162e648609b68166654f7b0a114f2d453644bc + last_write_checksum: sha1:0d21dbeaa3eae046db9dcaf172b57551dc899d7d + pristine_git_object: 167d8651dd336fc4ac99fd4450e1a8d0f58bf07a lib/crystalline.rb: id: eca767cf937a last_write_checksum: sha1:b6ec0a2833f58ba9a6f07c9637fdca05e59006d3 @@ -4161,8 +4189,8 @@ trackedFiles: pristine_git_object: fb6c627cd04b838fc05fb26e3caacfc13e7b2806 lib/kombo/general.rb: id: b25b5d515a10 - last_write_checksum: sha1:cfdc77d31d7229338ae01db27ceb104ba333358a - pristine_git_object: e0be0cca937771eb640eb9ed0b3e5e54aae29e7a + last_write_checksum: sha1:2226f40ebcc8de454cd8f8c47dd33109bded8c41 + pristine_git_object: cd9699a60bb0e158ae2ddea53014603490671e49 lib/kombo/hris.rb: id: 13c3ecc1e9af last_write_checksum: sha1:d80d267cff27ec54e95b832c953938ff68baa5ed @@ -4213,8 +4241,8 @@ trackedFiles: pristine_git_object: abfa62ec08db3ce4ace8d32a11eca9491677814d lib/kombo/models/operations.rb: id: 0dabe81114b0 - last_write_checksum: sha1:012e9eb73096d9f47083aa45105136292b48230b - pristine_git_object: 2d0d0736771d9a22e3bed1fe90c964d6f0c5c19c + last_write_checksum: sha1:fc0640892eda8a1f5d0b11ae8961328a382ab037 + pristine_git_object: 2661afcf32f59316fd405be87cdfc496f22d6b62 lib/kombo/models/operations/deleteatscandidatescandidateidtags_request.rb: id: ae79d39fb2e8 last_write_checksum: sha1:ea4eef09846b81f0b867e27126e2a58309fdcf30 @@ -4297,8 +4325,8 @@ trackedFiles: pristine_git_object: 9fd1dafb64f49e7dc37d60677078a1ce3ce3a7a3 lib/kombo/models/operations/getatsapplications_request.rb: id: 48abe3c3cda5 - last_write_checksum: sha1:92ad9db0e9aaadc50baf37a117ab0059edaccea6 - pristine_git_object: 28d59e19957bd511f3abea97dff713125f451368 + last_write_checksum: sha1:fa003eb30002669db2491629bf125abbf543c880 + pristine_git_object: f57d1ac9f882bdbe76bc8e031ead82faaa724f91 lib/kombo/models/operations/getatsapplications_request.rbi: id: 459bae711699 last_write_checksum: sha1:23e66206464c815b1c3fb0259b3a205d9e32e1b5 @@ -4345,8 +4373,8 @@ trackedFiles: pristine_git_object: 43b0d1d96865e5071013700bd16875dd52910a90 lib/kombo/models/operations/getatscandidates_request.rb: id: 2dfe31d22e08 - last_write_checksum: sha1:3cc60f38829931a06eb71d474a73b1d7e3081f77 - pristine_git_object: 5da71917e401d5d0fa7ff8913559a8499944b9eb + last_write_checksum: sha1:a2f42f21f73359f49dee4136c1a1744429ed9eae + pristine_git_object: 11693b8aed35a366f4e53c0b35ac5df92a628efd lib/kombo/models/operations/getatscandidates_request.rbi: id: ca86fb7e3f60 last_write_checksum: sha1:983765ab056ee2579851df169e3cc18b00d2140b @@ -4377,8 +4405,8 @@ trackedFiles: pristine_git_object: 1f701480c3c793be46a9f5d6fb9f7780a3f82dd4 lib/kombo/models/operations/getatsinterviews_request.rb: id: 1f93c0a38e7e - last_write_checksum: sha1:5484f24e011bb6ee521d3024cb68d1d16d9551e2 - pristine_git_object: daf99dbc559eb21aa415967d5f4938439e42dadd + last_write_checksum: sha1:102f1674062fc95a7e7d1d6527effec925c953cf + pristine_git_object: 89cc0af2ba4bbbd7f0e41944cc1e037a0a69b7cb lib/kombo/models/operations/getatsinterviews_request.rbi: id: f1191d95b99c last_write_checksum: sha1:77eb31dc7471b629502ab9000fd59ee2155303a8 @@ -4393,8 +4421,8 @@ trackedFiles: pristine_git_object: 637996c479ebc55d60c5158edcc95c9e81d49a22 lib/kombo/models/operations/getatsjobs_request.rb: id: 4fd73303be56 - last_write_checksum: sha1:17f3b87d2e477909cc750d892648d12bda5c9588 - pristine_git_object: f1a2a069dfbbf1479f33c9f1e12056b82588fb4e + last_write_checksum: sha1:65349bddb263762bd9fdadbd52fb4c84f89ec835 + pristine_git_object: 85ea5520a71116aed2c01282a147eeba103623c5 lib/kombo/models/operations/getatsjobs_request.rbi: id: c5e2e09a484d last_write_checksum: sha1:43ddb4b0be63073308a4ebf3d36dd7b3b868e0d7 @@ -4409,8 +4437,8 @@ trackedFiles: pristine_git_object: b7cb23620dc8620c631d19c4844e6fcffc1a3cb9 lib/kombo/models/operations/getatsoffers_request.rb: id: 802568a36380 - last_write_checksum: sha1:fc63bc35a5ff9e227ab208eb69018a5419fb0695 - pristine_git_object: fc23f56d043e23210c5e313e7b51fc414c19d16b + last_write_checksum: sha1:70bb3e42d6ac0712169fce253ec831d6fc94f449 + pristine_git_object: a96f49786343d86a16d77c0b16084895fb04984f lib/kombo/models/operations/getatsoffers_request.rbi: id: 476ac4ffe27c last_write_checksum: sha1:2d1058b8c35b771548e546c5caba3a7f2a741474 @@ -4473,8 +4501,8 @@ trackedFiles: pristine_git_object: 0174c1e3fb942a510204e1c9777839abc26da97f lib/kombo/models/operations/getatsusers_request.rb: id: 91aef601db5e - last_write_checksum: sha1:a447ebc6fa75643a9ca4587aff5155621f0009f3 - pristine_git_object: e5c375eb90a53a833c7997dff8668d439465d32c + last_write_checksum: sha1:1c9c8e66e0b9d35cdd9e0ac2340d294e7ded2727 + pristine_git_object: 5ec46dc84fa5dda721e428b8d18bdebc15ac687d lib/kombo/models/operations/getatsusers_request.rbi: id: 0d9efad4e44b last_write_checksum: sha1:7db9ea3ed21d3ed6fe439a59b073b025a9037eff @@ -4513,8 +4541,8 @@ trackedFiles: pristine_git_object: e0467f6e29d158d6acf57571d4316652a86edc86 lib/kombo/models/operations/gethrisabsences_request.rb: id: 0079509b55ac - last_write_checksum: sha1:b04562bb42ea799fa7e14336473dcb42fd4a28b5 - pristine_git_object: f6677671ad7c523bb80e33ed657d593d8b49dd7f + last_write_checksum: sha1:3caa16b1c14abd4ec3878d86743f30efe6104631 + pristine_git_object: ca4fb051f489dd5c2f00017987f4484841b8e619 lib/kombo/models/operations/gethrisabsences_request.rbi: id: f375e8a9c61c last_write_checksum: sha1:c8b1d6bc1319ce96f2decc1af6b6ad0c0c75e59f @@ -4561,8 +4589,8 @@ trackedFiles: pristine_git_object: 12935057200d6f729eea84afe03071beac911d74 lib/kombo/models/operations/gethrisemployees_request.rb: id: b0a11d705233 - last_write_checksum: sha1:49ba6f53e4c13e3ef45431ee9bc9de447ac52dbe - pristine_git_object: ae3519b8dd3cbd92e80233f26ed5548675e191ea + last_write_checksum: sha1:4b24a504080acded5ebdf874802eed6cdda85481 + pristine_git_object: 253354684fb02dc33306555505718b4be1ab535b lib/kombo/models/operations/gethrisemployees_request.rbi: id: a2039820cf62 last_write_checksum: sha1:69d94fd15860caf4004c2caa5fb2c50758302da0 @@ -4673,8 +4701,8 @@ trackedFiles: pristine_git_object: fc76c78a0e97714ed9761cd9537443be73907914 lib/kombo/models/operations/gethrisperformancereviews_request.rb: id: dd64eb2c2709 - last_write_checksum: sha1:6185bef197dc1cfd1953a19464fdf57e480a7e80 - pristine_git_object: ad1fa30345b2290bd05f99b1f84e6e03d95821e9 + last_write_checksum: sha1:2840c42ffab90f7dee715a4637b2f446048a7575 + pristine_git_object: 0b4b2117f1e6aafa3e00e24f6aa1f94c248f2406 lib/kombo/models/operations/gethrisperformancereviews_request.rbi: id: ff77c547fae1 last_write_checksum: sha1:23320726a322ddd747fdaff96e8381921ee77ef0 @@ -4689,8 +4717,8 @@ trackedFiles: pristine_git_object: b565f0ceb41c33ae148e97f6abe4822874e7a359 lib/kombo/models/operations/gethrisstaffingentities_request.rb: id: 5c31c72e50be - last_write_checksum: sha1:f8099a4007d451ed5f7f56634dad7b7181a2ce42 - pristine_git_object: 1ba0a8e8077d879364b8d8b6a9f5ab3964734133 + last_write_checksum: sha1:14a16591da6b231e5ad97522c706b4c561914b9b + pristine_git_object: 8ea1175c4cf4b5ba4299f34c5737b0690ae03a88 lib/kombo/models/operations/gethrisstaffingentities_request.rbi: id: 14394461ed51 last_write_checksum: sha1:81cfaf2032bdd79d2956d9c7fc818657ec67820d @@ -4705,8 +4733,8 @@ trackedFiles: pristine_git_object: c8add8543bda4196c7f10925c1446c235998c4f6 lib/kombo/models/operations/gethristimeoffbalances_request.rb: id: 557d54e6b786 - last_write_checksum: sha1:6e05c9884c4d1ec3406ddb1aabfd48d21365f298 - pristine_git_object: 98382a5d5f29cec487526570602e24a2d0fd61e1 + last_write_checksum: sha1:1ba124ca0cabad5b1181a5f88653d2922f2b2a3f + pristine_git_object: 310e53ae847348fb5829184ec40735a98f2ce117 lib/kombo/models/operations/gethristimeoffbalances_request.rbi: id: d38b6ff47ae6 last_write_checksum: sha1:69e4d70b263d4da4ff10cad2c9cfe27263b9222d @@ -5063,6 +5091,22 @@ trackedFiles: id: 02f9cc56bb74 last_write_checksum: sha1:8542f7d910c580cfcc6ea06c19843a451cefdea8 pristine_git_object: 924e76b03b0369522c6c3de21a31ee169bdf305e + lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rb: + id: f353fa6c20bf + last_write_checksum: sha1:8a0947923c15ba61984d2dc11e76ee38a9d472b3 + pristine_git_object: 3b91c7e723a0b0829d713d13f512fbe143937705 + lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rbi: + id: 447f8bb0ca65 + last_write_checksum: sha1:aac43656179a9ff6d14830e1a9d7a9c243f568e0 + pristine_git_object: a8beed255c063ebd2ac5e6bd016abd0d49d925c6 + lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rb: + id: d540673c668a + last_write_checksum: sha1:ef6d6b95a6ba9b0c87f5acf84b48389e8292beea + pristine_git_object: 5256f3cd12dbbdfc127b46adb2140b0e949cb081 + lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rbi: + id: 62a62985757f + last_write_checksum: sha1:1388dd7ff043217ae7a7708cd8a5332cece75ca3 + pristine_git_object: 28cd1ee498f252318162ceda85d3c7e8678960dd lib/kombo/models/operations/postpassthroughtoolapi_request.rb: id: 37dc6a6397b2 last_write_checksum: sha1:1295f8e0d3e4d401cb77e14f2ec492d06e63b8ef @@ -5161,8 +5205,8 @@ trackedFiles: pristine_git_object: 5c2b698f35005fd6c12acccbf44cf5e358940129 lib/kombo/models/shared.rb: id: 243803bd4275 - last_write_checksum: sha1:36c5cee23688934f8d3cd50ea751313006bcda47 - pristine_git_object: c70b692ccb4e542bf6b0800136fbe5ad0ff1d083 + last_write_checksum: sha1:4bac7dcbb10bbd3cc66119ef1ad2591b4916bd45 + pristine_git_object: 5c68b19bca9f95a5c3c18e296c0d7162b24fad3a lib/kombo/models/shared/a3innuvanomina.rb: id: 9fd5b4269e9a last_write_checksum: sha1:07e4f292950b316a10cd82ade7c7052ab059183f @@ -7885,8 +7929,8 @@ trackedFiles: pristine_git_object: 61d9236f014e29375471436f1af74f42efce65d1 lib/kombo/models/shared/integration_tool.rb: id: ec252bdaa1fd - last_write_checksum: sha1:2d856e40dd565f9058b296dab70b44dcc08a932c - pristine_git_object: 0331d8f536020bc81739f52d19c9383a5fab8f06 + last_write_checksum: sha1:973e5b80ba63c5e42dfd15e82df7b1f8b24f46fa + pristine_git_object: 59abe44320e886f496868953cea2fbf71ce70879 lib/kombo/models/shared/integration_tool.rbi: id: fecc74b6f738 last_write_checksum: sha1:c0987391d8322f5bca901ba6cc47a8c2bac6b195 @@ -10995,6 +11039,46 @@ trackedFiles: id: 4d1f5ab420a2 last_write_checksum: sha1:73a53571c3d8202b36e026f0eeee46bbd98c9907 pristine_git_object: c87d0d3267326db46e9aee80ce549b0cd600f365 + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rb: + id: a9e92447a044 + last_write_checksum: sha1:76c95f2d88bce2900bc48552692f0183219ccc00 + pristine_git_object: 6b80e58c8744f5f96bde71edfa3e2c5cfd21aaf9 + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rbi: + id: d750df8ddd5d + last_write_checksum: sha1:394483ff9582e5c45c4a7b24d2e3e0d91eeb7e76 + pristine_git_object: eaa28fd9a64567ee97bc926639b3ee505e30190b + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rb: + id: "393318045401" + last_write_checksum: sha1:8419141d91e6730d2dc3972b332018b6f5514b2a + pristine_git_object: 7cd75baef633321860c6754955918eee66fcaf7d + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rbi: + id: 3ea5fda25a22 + last_write_checksum: sha1:c83bec449737a3ea396008eee6ffe9d621bf0032 + pristine_git_object: ac4e331fb07d45ab4dd8f7fc9e01aa9be8642ee0 + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rb: + id: 8e35ca858860 + last_write_checksum: sha1:e4ec1047bccb59756760ad841e1b9e1efe9793f5 + pristine_git_object: 448df0aad4677a6b2e863e271809202821f1aa7b + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rbi: + id: d506313c3f61 + last_write_checksum: sha1:769982de72cbc32beb6faafd838f1a7e7b9fd071 + pristine_git_object: 004960fd73611cee87438041ed8de14440493e41 + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rb: + id: 22dea9c65fe5 + last_write_checksum: sha1:140d31e2cfb6a17874fbb893413982718d5812a9 + pristine_git_object: c0aec618a09019faf39b1d01a92c32f0bf041fee + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rbi: + id: 694e20ca1af2 + last_write_checksum: sha1:b0addd1441026a9be1ace2676f2c201db274b94b + pristine_git_object: ff5bee9d31eb6d1b8ee187d6bb3895cf5d1daac4 + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rb: + id: 3a75f516118d + last_write_checksum: sha1:227e76346a9cb6f7f9781490e8fd76a39222c73d + pristine_git_object: afc5e9add12b276215227b7872a1bd3411cbe44c + lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rbi: + id: b2c1b8e466dd + last_write_checksum: sha1:17cc14a409b4be40943583eaa61b7eec28839245 + pristine_git_object: 628d84dc2999b26f91068dd0555e39b1e9223f5a lib/kombo/models/shared/postpassthroughtoolapipositiveresponse.rb: id: 4905fbf1f70e last_write_checksum: sha1:6271d6539624e50c0765867de560000e530c7bbf @@ -12277,8 +12361,8 @@ trackedFiles: pristine_git_object: cc0af5d0bc79da7ef48343408db80c1436d75ef9 lib/kombo/sdkconfiguration.rb: id: 576e58b2ad72 - last_write_checksum: sha1:5534ca7099927dbced331256123a87b30183c6f2 - pristine_git_object: b261979c564cf5694bea36aebb7964de1cd09fef + last_write_checksum: sha1:a2b7a46875f99a6620e607da88f29c7da3179673 + pristine_git_object: 74fb8287819ae6fa6d316a0d5b9219a4da2a2ee7 lib/kombo/sdkconfiguration.rbi: id: d1d4becc3542 last_write_checksum: sha1:d6a79e38280d703264428e6158d6d796ba61d63f @@ -14840,4 +14924,46 @@ 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: "## Ruby SDK Changes:\n* `kombo.general.create_setup_link()`: **Added**\n* `kombo.connect.create_connection_link()`: \n * `request.integration_tool` **Changed**\n" diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 7fe7200..b791d2e 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -31,7 +31,7 @@ generation: skipResponseBodyAssertions: false versioningStrategy: automatic ruby: - version: 1.1.1 + version: 1.1.2 additionalDependencies: development: irb: "" diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 3205511..d55cb35 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,20 +2,20 @@ speakeasyVersion: 1.700.2 sources: kombo-prepared-spec: sourceNamespace: kombo-api - sourceRevisionDigest: sha256:74a302e459881abcc6930080aab5a90b9f5213d5ffe2f4929c775094ca08d967 - sourceBlobDigest: sha256:e04250dda7ac30b9166936dc7a1492e04003ec4e7e4a1526661fb615820e4787 + sourceRevisionDigest: sha256:8d06a5107abdb581e4c1dd7752c2b8aaf07ca4fa88d1854962969b488c952d19 + sourceBlobDigest: sha256:9e84b0f5dc40f741b123cdfd0c15b346873282ccfd2a012122d4a7f5726041ac tags: - latest - - speakeasy-sdk-regen-1776301208 + - speakeasy-sdk-regen-1776387475 - 1.0.0 targets: kombo-ruby: source: kombo-prepared-spec sourceNamespace: kombo-api - sourceRevisionDigest: sha256:74a302e459881abcc6930080aab5a90b9f5213d5ffe2f4929c775094ca08d967 - sourceBlobDigest: sha256:e04250dda7ac30b9166936dc7a1492e04003ec4e7e4a1526661fb615820e4787 + sourceRevisionDigest: sha256:8d06a5107abdb581e4c1dd7752c2b8aaf07ca4fa88d1854962969b488c952d19 + sourceBlobDigest: sha256:9e84b0f5dc40f741b123cdfd0c15b346873282ccfd2a012122d4a7f5726041ac codeSamplesNamespace: kombo-api-python-ruby-code-samples - codeSamplesRevisionDigest: sha256:b0ca9118d5d50cc548c8c18c1ca90b1534cb2c36f3243f0cb4bf29d567f57649 + codeSamplesRevisionDigest: sha256:656ec4cecf867138cbd09245c92e67f77233b6fa7509163574b2f62046cb779a workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/Gemfile.lock b/Gemfile.lock index d8efddc..dc41874 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - kombo (1.1.1) + kombo (1.1.2) base64 (>= 0.2.0, < 1.0) faraday faraday-multipart (~> 1.2.0) @@ -17,7 +17,7 @@ GEM ast (2.4.2) base64 (0.3.0) benchmark (0.5.0) - bigdecimal (4.1.1) + bigdecimal (4.1.2) crack (1.0.1) bigdecimal rexml diff --git a/README.md b/README.md index 4545522..8ffc03c 100644 --- a/README.md +++ b/README.md @@ -162,6 +162,7 @@ s = ::Kombo::Kombo.new( * [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 diff --git a/RELEASES.md b/RELEASES.md index 18c088c..fea4429 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -108,4 +108,14 @@ Based on: ### Generated - [ruby v1.1.1] . ### Releases -- [Ruby Gems v1.1.1] https://rubygems.org/gems/kombo/versions/1.1.1 - . \ No newline at end of file +- [Ruby Gems v1.1.1] https://rubygems.org/gems/kombo/versions/1.1.1 - . + +## 2026-05-08 01:03:56 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.700.2 (2.801.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [ruby v1.1.2] . +### Releases +- [Ruby Gems v1.1.2] https://rubygems.org/gems/kombo/versions/1.1.2 - . \ No newline at end of file diff --git a/docs/models/operations/getatsapplicationsrequest.md b/docs/models/operations/getatsapplicationsrequest.md index bf52354..518974c 100644 --- a/docs/models/operations/getatsapplicationsrequest.md +++ b/docs/models/operations/getatsapplicationsrequest.md @@ -3,18 +3,18 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `outcomes` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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 | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `outcomes` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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/operations/getatscandidatesrequest.md b/docs/models/operations/getatscandidatesrequest.md index 3b5620b..5495db6 100644 --- a/docs/models/operations/getatscandidatesrequest.md +++ b/docs/models/operations/getatscandidatesrequest.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `email` | *T.nilable(::String)* | :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` | T::Array<*::String*> | :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` | *T.nilable(::String)* | :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` | *T.nilable(::String)* | :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 | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `email` | *T.nilable(::String)* | :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` | T::Array<*::String*> | :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` | *T.nilable(::String)* | :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` | *T.nilable(::String)* | :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/operations/getatsinterviewsrequest.md b/docs/models/operations/getatsinterviewsrequest.md index 11cc106..deb5cbe 100644 --- a/docs/models/operations/getatsinterviewsrequest.md +++ b/docs/models/operations/getatsinterviewsrequest.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `job_ids` | T::Array<*::String*> | :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 | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `job_ids` | T::Array<*::String*> | :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/operations/getatsjobsrequest.md b/docs/models/operations/getatsjobsrequest.md index 942d88e..d9be191 100644 --- a/docs/models/operations/getatsjobsrequest.md +++ b/docs/models/operations/getatsjobsrequest.md @@ -3,20 +3,20 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `job_codes` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of job codes. | | -| `post_url` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by the `post_url` field. Can be used to find a job based on its public posting URL. | | -| `statuses` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(::String)* | :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 | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `job_codes` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of job codes. | | +| `post_url` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by the `post_url` field. Can be used to find a job based on its public posting URL. | | +| `statuses` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(::String)* | :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/operations/getatsoffersrequest.md b/docs/models/operations/getatsoffersrequest.md index c6b1249..821984a 100644 --- a/docs/models/operations/getatsoffersrequest.md +++ b/docs/models/operations/getatsoffersrequest.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | \ No newline at end of file diff --git a/docs/models/operations/getatsusersrequest.md b/docs/models/operations/getatsusersrequest.md index 9027895..42f87d4 100644 --- a/docs/models/operations/getatsusersrequest.md +++ b/docs/models/operations/getatsusersrequest.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `emails` | T::Array<*::String*> | :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 | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `emails` | T::Array<*::String*> | :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/operations/gethrisabsencesrequest.md b/docs/models/operations/gethrisabsencesrequest.md index d7329c1..bda5dbb 100644 --- a/docs/models/operations/gethrisabsencesrequest.md +++ b/docs/models/operations/gethrisabsencesrequest.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `date_from` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of absence type IDs. | | -| `employee_id` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by a specific employee using their ID. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `date_from` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of absence type IDs. | | +| `employee_id` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by a specific employee using their ID. | | \ No newline at end of file diff --git a/docs/models/operations/gethrisemployeesrequest.md b/docs/models/operations/gethrisemployeesrequest.md index 0b4feb5..0247a94 100644 --- a/docs/models/operations/gethrisemployeesrequest.md +++ b/docs/models/operations/gethrisemployeesrequest.md @@ -3,20 +3,20 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `employment_statuses` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | *T.nilable(::String)* | :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 | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `employment_statuses` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | *T.nilable(::String)* | :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/operations/gethrisperformancereviewsrequest.md b/docs/models/operations/gethrisperformancereviewsrequest.md index bd19b24..b93a6bb 100644 --- a/docs/models/operations/gethrisperformancereviewsrequest.md +++ b/docs/models/operations/gethrisperformancereviewsrequest.md @@ -3,16 +3,16 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `types` | T::Array<*::String*> | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of review cycle IDs. | | -| `reviewee_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of reviewee IDs. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `types` | T::Array<*::String*> | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of review cycle IDs. | | +| `reviewee_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of reviewee IDs. | | \ No newline at end of file diff --git a/docs/models/operations/gethrisstaffingentitiesrequest.md b/docs/models/operations/gethrisstaffingentitiesrequest.md index 8144404..497a456 100644 --- a/docs/models/operations/gethrisstaffingentitiesrequest.md +++ b/docs/models/operations/gethrisstaffingentitiesrequest.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `model_types` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of `JOB`, `POSITION`, `REQUISITION`

Leave this blank to get results matching all values. | | -| `statuses` | T::Array<*::String*> | :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 | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `model_types` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of `JOB`, `POSITION`, `REQUISITION`

Leave this blank to get results matching all values. | | +| `statuses` | T::Array<*::String*> | :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/operations/gethristimeoffbalancesrequest.md b/docs/models/operations/gethristimeoffbalancesrequest.md index ad155c8..759c056 100644 --- a/docs/models/operations/gethristimeoffbalancesrequest.md +++ b/docs/models/operations/gethristimeoffbalancesrequest.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `employee_id` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by a specific employee using their ID. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `employee_id` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by a specific employee using their ID. | | \ No newline at end of file diff --git a/docs/models/operations/postintegrationsintegrationidsetuplinkrequest.md b/docs/models/operations/postintegrationsintegrationidsetuplinkrequest.md new file mode 100644 index 0000000..111f2b1 --- /dev/null +++ b/docs/models/operations/postintegrationsintegrationidsetuplinkrequest.md @@ -0,0 +1,9 @@ +# PostIntegrationsIntegrationIdSetupLinkRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *::String* | :heavy_check_mark: | POST /integrations/:integration_id/setup-link Parameter | +| `body` | [Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBody](../../models/shared/postintegrationsintegrationidsetuplinkrequestbody.md) | :heavy_check_mark: | POST /integrations/:integration_id/setup-link Request body | \ No newline at end of file diff --git a/docs/models/operations/postintegrationsintegrationidsetuplinkresponse.md b/docs/models/operations/postintegrationsintegrationidsetuplinkresponse.md new file mode 100644 index 0000000..ac33d44 --- /dev/null +++ b/docs/models/operations/postintegrationsintegrationidsetuplinkresponse.md @@ -0,0 +1,11 @@ +# PostIntegrationsIntegrationIdSetupLinkResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `post_integrations_integration_id_setup_link_positive_response` | [T.nilable(Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponse)](../../models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.md) | :heavy_minus_sign: | POST /integrations/:integration_id/setup-link Positive response | \ No newline at end of file diff --git a/docs/models/shared/integrationtool.md b/docs/models/shared/integrationtool.md index f8fe6b3..33e2a15 100644 --- a/docs/models/shared/integrationtool.md +++ b/docs/models/shared/integrationtool.md @@ -18,6 +18,7 @@ Pre-define a tool this integration link can be used for. | `RECRUITEE` | recruitee | | `RECRUITERFLOW` | recruiterflow | | `GREENHOUSE` | greenhouse | +| `GREENHOUSEV3` | greenhousev3 | | `GREENHOUSEJOBBOARD` | greenhousejobboard | | `TEAMTAILOR` | teamtailor | | `TEAMTAILORJOBBOARDS` | teamtailorjobboards | @@ -36,6 +37,7 @@ Pre-define a tool this integration link can be used for. | `REXX` | rexx | | `AFAS` | afas | | `BAMBOOHR` | bamboohr | +| `BULLHORN4SALESFORCE` | bullhorn4salesforce | | `BULLHORN` | bullhorn | | `BULLHORNLOGIN` | bullhornlogin | | `WORKABLE` | workable | @@ -75,6 +77,7 @@ Pre-define a tool this integration link can be used for. | `RECRUITCRM` | recruitcrm | | `JAZZHR` | jazzhr | | `BITE` | bite | +| `BRASSRING` | brassring | | `HOMERUN` | homerun | | `MYSOLUTION` | mysolution | | `CARERIX` | carerix | @@ -110,9 +113,12 @@ Pre-define a tool this integration link can be used for. | `SANDBOX` | sandbox | | `GUIDECOM` | guidecom | | `SPOTT` | spott | +| `LOGICMELON` | logicmelon | | `LOXO` | loxo | +| `KULA` | kula | | `WORKDAYCUSTOMREPORT` | workdaycustomreport | | `WORKDAYCUSTOMREPORTSFTP` | workdaycustomreportsftp | +| `UKGPROWFM` | ukgprowfm | | `PAYFITCUSTOMER` | payfitcustomer | | `PAYFITPARTNER` | payfitpartner | | `PAYFIT` | payfit | diff --git a/docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.md b/docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.md new file mode 100644 index 0000000..2d8af37 --- /dev/null +++ b/docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.md @@ -0,0 +1,9 @@ +# PostIntegrationsIntegrationIdSetupLinkPositiveResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `status` | *::String* | :heavy_check_mark: | N/A | +| `data` | [Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponseData](../../models/shared/postintegrationsintegrationidsetuplinkpositiveresponsedata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponsedata.md b/docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponsedata.md new file mode 100644 index 0000000..0d9e3f5 --- /dev/null +++ b/docs/models/shared/postintegrationsintegrationidsetuplinkpositiveresponsedata.md @@ -0,0 +1,8 @@ +# PostIntegrationsIntegrationIdSetupLinkPositiveResponseData + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `link` | *::String* | :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/shared/postintegrationsintegrationidsetuplinkrequestbody.md b/docs/models/shared/postintegrationsintegrationidsetuplinkrequestbody.md new file mode 100644 index 0000000..e33340c --- /dev/null +++ b/docs/models/shared/postintegrationsintegrationidsetuplinkrequestbody.md @@ -0,0 +1,9 @@ +# PostIntegrationsIntegrationIdSetupLinkRequestBody + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `language` | [T.nilable(Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage)](../../models/shared/postintegrationsintegrationidsetuplinkrequestbodylanguage.md) | :heavy_minus_sign: | Language of the setup flow UI. | +| `link_type` | [Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLinkType](../../models/shared/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/shared/postintegrationsintegrationidsetuplinkrequestbodylanguage.md b/docs/models/shared/postintegrationsintegrationidsetuplinkrequestbodylanguage.md new file mode 100644 index 0000000..5471f41 --- /dev/null +++ b/docs/models/shared/postintegrationsintegrationidsetuplinkrequestbodylanguage.md @@ -0,0 +1,14 @@ +# PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage + +Language of the setup flow UI. + + +## Values + +| Name | Value | +| ----- | ----- | +| `EN` | en | +| `DE` | de | +| `FR` | fr | +| `IT` | it | +| `ES` | es | \ No newline at end of file diff --git a/docs/models/shared/postintegrationsintegrationidsetuplinkrequestbodylinktype.md b/docs/models/shared/postintegrationsintegrationidsetuplinkrequestbodylinktype.md new file mode 100644 index 0000000..1ea4986 --- /dev/null +++ b/docs/models/shared/postintegrationsintegrationidsetuplinkrequestbodylinktype.md @@ -0,0 +1,11 @@ +# 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). + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `EMBEDDED` | EMBEDDED | +| `MAGIC_LINK` | MAGIC_LINK | \ No newline at end of file diff --git a/docs/sdks/ats/README.md b/docs/sdks/ats/README.md index 24b928b..caf8b6b 100644 --- a/docs/sdks/ats/README.md +++ b/docs/sdks/ats/README.md @@ -66,21 +66,21 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `outcomes` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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. | | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `outcomes` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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. | | ### Response @@ -527,20 +527,20 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `email` | *T.nilable(::String)* | :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` | T::Array<*::String*> | :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` | *T.nilable(::String)* | :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` | *T.nilable(::String)* | :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. | | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `email` | *T.nilable(::String)* | :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` | T::Array<*::String*> | :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` | *T.nilable(::String)* | :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` | *T.nilable(::String)* | :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. | | ### Response @@ -1226,23 +1226,23 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `job_codes` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of job codes. | | -| `post_url` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by the `post_url` field. Can be used to find a job based on its public posting URL. | | -| `statuses` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by the `name` field. Can be used to find a job by keywords present in the job name. | | +| Parameter | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `job_codes` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of job codes. | | +| `post_url` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by the `post_url` field. Can be used to find a job based on its public posting URL. | | +| `statuses` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by the `name` field. Can be used to find a job by keywords present in the job name. | | ### Response @@ -1437,17 +1437,17 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `emails` | T::Array<*::String*> | :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. | | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `emails` | T::Array<*::String*> | :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. | | ### Response @@ -1545,16 +1545,16 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | ### Response @@ -1651,17 +1651,17 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `job_ids` | T::Array<*::String*> | :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. | | +| Parameter | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `job_ids` | T::Array<*::String*> | :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. | | ### Response diff --git a/docs/sdks/general/README.md b/docs/sdks/general/README.md index 4297fe0..f855aca 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 @@ -129,6 +130,7 @@ To get started, please pick the relevant API (some tools provide multiple to due |BITE|`bite/v1`|[Bite's v1 API](https://api.b-ite.io/docs/#/). We automatically authenticate all requests and use 'https://api.b-ite.io/v1' as base URL.| |BoondManager|`boondmanager/api`|BoondManager [REST API](https://ui.boondmanager.com/administrator/developer/apisandbox). We automatically authenticate all requests and use `https://ui.boondmanager.com/api` as the base URL.| |Breezy HR|`breezyhr/v3`|[BreezyHR's v3 API](https://developer.breezy.hr/reference/overview). We automatically authenticate all requests and use "https://api.breezy.hr/v3/" as the base URL.| +|Bullhorn for Salesforce|`bullhorn4salesforce/v66`|We use `https://\{subdomain\}.my.salesforce.com/services/data/v66.0` as the base URL. Find the official docs [here](https://kb.bullhorn.com/bh4sf/Content/BH4SF/Topics/bh4sfRestAPI.htm).| |Bullhorn|`bullhorn/default`|[Bullhorn's API](https://bullhorn.github.io/rest-api-docs/index.html). We automatically use the right `https://rest.bullhornstaffing.com/rest-services/\{corpToken\}` base URL.| |CareerPlug|`careerplug/api`|We use `https://api.careerplug.com` as the base URL. Find the official docs [here](https://api.careerplug.com/docs#api).| |Carerix|`carerix/api`|Carerix [REST API](https://docs.carerix.io/rest/introduction). We automatically authenticate all requests and use `https://api.carerix.com` as the base URL. Please note that Carerix uses XML for request and response bodies.| @@ -170,12 +172,13 @@ To get started, please pick the relevant API (some tools provide multiple to due |Gem|`gem/api`|Gem's [ATS API](https://api.gem.com/ats/v0/reference) We automatically authenticate all requests.| |Google Workspace|`googleworkspace/admin`|[Googles's API](https://developers.google.com/admin-sdk/directory/reference/rest). We automatically authenticate all requests and use 'https://admin.googleapis.com' as the base URL.| |Google Workspace|`googleworkspace/people`|[Googles's API](https://developers.google.com/people/api/rest). We automatically authenticate all requests and use 'https://people.googleapis.com' as the base URL.| +|Greenhouse (V3)|`greenhousev3/harvestv3`|We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).| |Greenhouse Job Board|`greenhousejobboard/boards-api`|[Greenhouse Job Board API](https://developers.greenhouse.io/job-board). We automatically authenticate all requests and use 'https://boards-api.greenhouse.io/v1/boards/\{job_board_token\}' as the base URL. Optionally, you can provide a custom job_board_token to use a different job board.| |Greenhouse|`greenhouse/harvest-v2`|Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.| |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.| @@ -200,6 +203,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.| @@ -208,6 +212,7 @@ To get started, please pick the relevant API (some tools provide multiple to due |Leapsome|`leapsome/v1`|Leapsome [API](https://api.leapsome.com/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/v1` as the base URL.| |Lever|`lever/v1`|[Lever's v1 API](https://hire.lever.co/developer/documentation). We automatically authenticate all requests using the partner credentials which have been configured in the Lever tool settings (this uses Kombo's partner credentials by default).| |LinkedIn Learning|`linkedinlearning/v2`|LinkedIn Learning [API v2](https://learn.microsoft.com/en-us/linkedin/learning/). We automatically handle authentication and use `https://api.linkedin.com/v2` as the base URL.| +|Logic Melon|`logicmelon/json`|We use `https://api.logicmelon.co.uk` as the base URL. Find the official docs [here](https://api.logicmelon.com/JSON/Multiposter.asmx).| |Loket|`loket/api`|[Loket's REST API](https://developers.loket.nl/). We automatically authenticate all requests and use `https://\{api_domain\}` as the base URL, where `api_domain` is the API domain configured during integration setup (e.g. `api.loket.nl`).| |Loxo|`loxo/v1`|[Loxo's API](https://loxo.readme.io/reference/loxo-api). We automatically authenticate all requests and use 'https://app.loxo.co/api/\{agency_slug\}' as base URL.| |Lucca|`lucca/api`|[Luccas's API](https://developers.lucca.fr/api-reference/legacy/introduction). We automatically authenticate all requests and use 'https://\{account\}.\{ilucca|ilucca-demo\}.\{region\}/' as the base URL.| @@ -279,6 +284,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.| @@ -534,6 +540,53 @@ end | Models::Errors::KomboGeneralError | default | application/json | | Errors::APIError | 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 + + +```ruby +require 'kombo' + +Models = ::Kombo::Models +s = ::Kombo::Kombo.new( + security: Models::Shared::Security.new( + api_key: '', + ), + ) + +res = s.general.create_setup_link(integration_id: 'personio:93fCvorjZ2jas7ZekX1V1n5d', body: Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBody.new( + link_type: Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLinkType::EMBEDDED, +)) + +unless res.post_integrations_integration_id_setup_link_positive_response.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *::String* | :heavy_check_mark: | POST /integrations/:integration_id/setup-link Parameter | +| `body` | [Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBody](../../models/shared/postintegrationsintegrationidsetuplinkrequestbody.md) | :heavy_check_mark: | POST /integrations/:integration_id/setup-link Request body | + +### Response + +**[T.nilable(Models::Operations::PostIntegrationsIntegrationIdSetupLinkResponse)](../../models/operations/postintegrationsintegrationidsetuplinkresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| Models::Errors::KomboGeneralError | default | application/json | +| Errors::APIError | 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 7ab696b..5861dc5 100644 --- a/docs/sdks/hris/README.md +++ b/docs/sdks/hris/README.md @@ -55,23 +55,23 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `employment_statuses` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | *T.nilable(::String)* | :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. | | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `employment_statuses` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | T::Array<*::String*> | :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` | *T.nilable(::String)* | :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. | | ### Response @@ -646,17 +646,17 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `employee_id` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by a specific employee using their ID. | | +| Parameter | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `employee_id` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by a specific employee using their ID. | | ### Response @@ -699,20 +699,20 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `date_from` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of absence type IDs. | | -| `employee_id` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by a specific employee using their ID. | | +| Parameter | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `date_from` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of absence type IDs. | | +| `employee_id` | *T.nilable(::String)* | :heavy_minus_sign: | Filter by a specific employee using their ID. | | ### Response @@ -1058,19 +1058,19 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `types` | T::Array<*::String*> | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of review cycle IDs. | | -| `reviewee_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of reviewee IDs. | | +| Parameter | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `types` | T::Array<*::String*> | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of review cycle IDs. | | +| `reviewee_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of reviewee IDs. | | ### Response @@ -1123,18 +1123,18 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | -| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | -| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | -| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | -| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | -| `model_types` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of `JOB`, `POSITION`, `REQUISITION`

Leave this blank to get results matching all values. | | -| `statuses` | T::Array<*::String*> | :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. | | +| Parameter | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the integration you want to interact with. | workday:HWUTwvyx2wLoSUHphiWVrp28 | +| `cursor` | *T.nilable(::String)* | :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` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of results to return per page. Maximum is 250. | | +| `updated_after` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :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` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. | | +| `ignore_unsupported_filters` | *T.nilable(T::Boolean)* | :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` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. | | +| `remote_ids` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of remote IDs. | | +| `model_types` | T::Array<*::String*> | :heavy_minus_sign: | Filter by a comma-separated list of `JOB`, `POSITION`, `REQUISITION`

Leave this blank to get results matching all values. | | +| `statuses` | T::Array<*::String*> | :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. | | ### Response diff --git a/kombo.gemspec b/kombo.gemspec index b8162e6..167d865 100644 --- a/kombo.gemspec +++ b/kombo.gemspec @@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__) Gem::Specification.new do |s| s.name = 'kombo' - s.version = '1.1.1' + s.version = '1.1.2' s.platform = Gem::Platform::RUBY s.licenses = ['Apache-2.0'] s.summary = '' diff --git a/lib/kombo/general.rb b/lib/kombo/general.rb index e0be0cc..cd9699a 100644 --- a/lib/kombo/general.rb +++ b/lib/kombo/general.rb @@ -313,6 +313,7 @@ def send_passthrough_request(body:, tool:, api:, integration_id: nil, timeout_ms # |BITE|`bite/v1`|[Bite's v1 API](https://api.b-ite.io/docs/#/). We automatically authenticate all requests and use 'https://api.b-ite.io/v1' as base URL.| # |BoondManager|`boondmanager/api`|BoondManager [REST API](https://ui.boondmanager.com/administrator/developer/apisandbox). We automatically authenticate all requests and use `https://ui.boondmanager.com/api` as the base URL.| # |Breezy HR|`breezyhr/v3`|[BreezyHR's v3 API](https://developer.breezy.hr/reference/overview). We automatically authenticate all requests and use "https://api.breezy.hr/v3/" as the base URL.| + # |Bullhorn for Salesforce|`bullhorn4salesforce/v66`|We use `https://\{subdomain\}.my.salesforce.com/services/data/v66.0` as the base URL. Find the official docs [here](https://kb.bullhorn.com/bh4sf/Content/BH4SF/Topics/bh4sfRestAPI.htm).| # |Bullhorn|`bullhorn/default`|[Bullhorn's API](https://bullhorn.github.io/rest-api-docs/index.html). We automatically use the right `https://rest.bullhornstaffing.com/rest-services/\{corpToken\}` base URL.| # |CareerPlug|`careerplug/api`|We use `https://api.careerplug.com` as the base URL. Find the official docs [here](https://api.careerplug.com/docs#api).| # |Carerix|`carerix/api`|Carerix [REST API](https://docs.carerix.io/rest/introduction). We automatically authenticate all requests and use `https://api.carerix.com` as the base URL. Please note that Carerix uses XML for request and response bodies.| @@ -354,12 +355,13 @@ def send_passthrough_request(body:, tool:, api:, integration_id: nil, timeout_ms # |Gem|`gem/api`|Gem's [ATS API](https://api.gem.com/ats/v0/reference) We automatically authenticate all requests.| # |Google Workspace|`googleworkspace/admin`|[Googles's API](https://developers.google.com/admin-sdk/directory/reference/rest). We automatically authenticate all requests and use 'https://admin.googleapis.com' as the base URL.| # |Google Workspace|`googleworkspace/people`|[Googles's API](https://developers.google.com/people/api/rest). We automatically authenticate all requests and use 'https://people.googleapis.com' as the base URL.| + # |Greenhouse (V3)|`greenhousev3/harvestv3`|We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).| # |Greenhouse Job Board|`greenhousejobboard/boards-api`|[Greenhouse Job Board API](https://developers.greenhouse.io/job-board). We automatically authenticate all requests and use 'https://boards-api.greenhouse.io/v1/boards/\{job_board_token\}' as the base URL. Optionally, you can provide a custom job_board_token to use a different job board.| # |Greenhouse|`greenhouse/harvest-v2`|Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.| # |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.| @@ -384,6 +386,7 @@ def send_passthrough_request(body:, tool:, api:, integration_id: nil, timeout_ms # |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.| @@ -392,6 +395,7 @@ def send_passthrough_request(body:, tool:, api:, integration_id: nil, timeout_ms # |Leapsome|`leapsome/v1`|Leapsome [API](https://api.leapsome.com/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/v1` as the base URL.| # |Lever|`lever/v1`|[Lever's v1 API](https://hire.lever.co/developer/documentation). We automatically authenticate all requests using the partner credentials which have been configured in the Lever tool settings (this uses Kombo's partner credentials by default).| # |LinkedIn Learning|`linkedinlearning/v2`|LinkedIn Learning [API v2](https://learn.microsoft.com/en-us/linkedin/learning/). We automatically handle authentication and use `https://api.linkedin.com/v2` as the base URL.| + # |Logic Melon|`logicmelon/json`|We use `https://api.logicmelon.co.uk` as the base URL. Find the official docs [here](https://api.logicmelon.com/JSON/Multiposter.asmx).| # |Loket|`loket/api`|[Loket's REST API](https://developers.loket.nl/). We automatically authenticate all requests and use `https://\{api_domain\}` as the base URL, where `api_domain` is the API domain configured during integration setup (e.g. `api.loket.nl`).| # |Loxo|`loxo/v1`|[Loxo's API](https://loxo.readme.io/reference/loxo-api). We automatically authenticate all requests and use 'https://app.loxo.co/api/\{agency_slug\}' as base URL.| # |Lucca|`lucca/api`|[Luccas's API](https://developers.lucca.fr/api-reference/legacy/introduction). We automatically authenticate all requests and use 'https://\{account\}.\{ilucca|ilucca-demo\}.\{region\}/' as the base URL.| @@ -463,6 +467,7 @@ def send_passthrough_request(body:, tool:, api:, integration_id: nil, timeout_ms # |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.| @@ -1152,6 +1157,142 @@ def create_reconnection_link(body:, integration_id:, timeout_ms: nil) end + sig { params(body: Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBody, integration_id: ::String, timeout_ms: T.nilable(Integer)).returns(Models::Operations::PostIntegrationsIntegrationIdSetupLinkResponse) } + def create_setup_link(body:, integration_id:, timeout_ms: nil) + # create_setup_link - 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). + request = Models::Operations::PostIntegrationsIntegrationIdSetupLinkRequest.new( + integration_id: integration_id, + body: body + ) + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = Utils.generate_url( + Models::Operations::PostIntegrationsIntegrationIdSetupLinkRequest, + base_url, + '/integrations/{integration_id}/setup-link', + request, + @sdk_configuration.globals + ) + headers = {} + headers = T.cast(headers, T::Hash[String, String]) + req_content_type, data, form = Utils.serialize_request_body(request, false, false, :body, :json) + headers['content-type'] = req_content_type + raise StandardError, 'request body is required' if data.nil? && form.nil? + + if form + body = Utils.encode_form(form) + elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded') + body = URI.encode_www_form(T.cast(data, T::Hash[Symbol, Object])) + else + body = data + end + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + security = @sdk_configuration.security_source&.call + + timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil? + timeout ||= (300_000.to_f / 1000) + + + connection = @sdk_configuration.client + + hook_ctx = SDKHooks::HookContext.new( + config: @sdk_configuration, + base_url: base_url, + oauth2_scopes: nil, + operation_id: 'PostIntegrationsIntegrationIdSetupLink', + security_source: @sdk_configuration.security_source + ) + + error = T.let(nil, T.nilable(StandardError)) + http_response = T.let(nil, T.nilable(Faraday::Response)) + + + begin + http_response = T.must(connection).post(url) do |req| + req.body = body + req.headers.merge!(headers) + req.options.timeout = timeout unless timeout.nil? + Utils.configure_request_security(req, security) + + @sdk_configuration.hooks.before_request( + hook_ctx: SDKHooks::BeforeRequestHookContext.new( + hook_ctx: hook_ctx + ), + request: req + ) + end + rescue StandardError => e + error = e + ensure + if http_response.nil? || Utils.error_status?(http_response.status) + http_response = @sdk_configuration.hooks.after_error( + error: error, + hook_ctx: SDKHooks::AfterErrorHookContext.new( + hook_ctx: hook_ctx + ), + response: http_response + ) + else + http_response = @sdk_configuration.hooks.after_success( + hook_ctx: SDKHooks::AfterSuccessHookContext.new( + hook_ctx: hook_ctx + ), + response: http_response + ) + end + + if http_response.nil? + raise error if !error.nil? + raise 'no response' + end + end + + content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream') + if Utils.match_status_code(http_response.status, ['200']) + if Utils.match_content_type(content_type, 'application/json') + http_response = @sdk_configuration.hooks.after_success( + hook_ctx: SDKHooks::AfterSuccessHookContext.new( + hook_ctx: hook_ctx + ), + response: http_response + ) + response_data = http_response.env.response_body + obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponse) + response = Models::Operations::PostIntegrationsIntegrationIdSetupLinkResponse.new( + status_code: http_response.status, + content_type: content_type, + raw_response: http_response, + post_integrations_integration_id_setup_link_positive_response: T.unsafe(obj) + ) + + return response + else + raise ::Kombo::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received' + end + else + if Utils.match_content_type(content_type, 'application/json') + http_response = @sdk_configuration.hooks.after_success( + hook_ctx: SDKHooks::AfterSuccessHookContext.new( + hook_ctx: hook_ctx + ), + response: http_response + ) + response_data = http_response.env.response_body + obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::KomboGeneralError) + obj.raw_response = http_response + raise obj + else + raise ::Kombo::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received' + end + end + end + + sig { params(integration_id: ::String, cursor: T.nilable(::String), page_size: T.nilable(::Integer), timeout_ms: T.nilable(Integer)).returns(Models::Operations::GetIntegrationsIntegrationIdIntegrationFieldsResponse) } def get_integration_fields(integration_id:, cursor: nil, page_size: nil, timeout_ms: nil) # get_integration_fields - Get integration fields diff --git a/lib/kombo/models/operations.rb b/lib/kombo/models/operations.rb index 2d0d073..2661afc 100644 --- a/lib/kombo/models/operations.rb +++ b/lib/kombo/models/operations.rb @@ -112,6 +112,8 @@ module Operations autoload :PostHrisEmployeesFormResponse, 'kombo/models/operations/posthrisemployeesform_response.rb' autoload :PostIntegrationsIntegrationIdRelinkRequest, 'kombo/models/operations/postintegrationsintegrationidrelink_request.rb' autoload :PostIntegrationsIntegrationIdRelinkResponse, 'kombo/models/operations/postintegrationsintegrationidrelink_response.rb' + autoload :PostIntegrationsIntegrationIdSetupLinkRequest, 'kombo/models/operations/postintegrationsintegrationidsetuplink_request.rb' + autoload :PostIntegrationsIntegrationIdSetupLinkResponse, 'kombo/models/operations/postintegrationsintegrationidsetuplink_response.rb' autoload :PostPassthroughToolApiRequest, 'kombo/models/operations/postpassthroughtoolapi_request.rb' autoload :PostPassthroughToolApiResponse, 'kombo/models/operations/postpassthroughtoolapi_response.rb' autoload :PutAssessmentOrdersAssessmentOrderIdResultRequest, 'kombo/models/operations/putassessmentordersassessmentorderidresult_request.rb' diff --git a/lib/kombo/models/operations/getatsapplications_request.rb b/lib/kombo/models/operations/getatsapplications_request.rb index 28d59e1..f57d1ac 100644 --- a/lib/kombo/models/operations/getatsapplications_request.rb +++ b/lib/kombo/models/operations/getatsapplications_request.rb @@ -24,7 +24,7 @@ class GetAtsApplicationsRequest # # 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 | @@ -33,7 +33,7 @@ class GetAtsApplicationsRequest # | `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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/getatscandidates_request.rb b/lib/kombo/models/operations/getatscandidates_request.rb index 5da7191..11693b8 100644 --- a/lib/kombo/models/operations/getatscandidates_request.rb +++ b/lib/kombo/models/operations/getatscandidates_request.rb @@ -24,14 +24,14 @@ class GetAtsCandidatesRequest # # 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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/getatsinterviews_request.rb b/lib/kombo/models/operations/getatsinterviews_request.rb index daf99db..89cc0af 100644 --- a/lib/kombo/models/operations/getatsinterviews_request.rb +++ b/lib/kombo/models/operations/getatsinterviews_request.rb @@ -24,14 +24,14 @@ class GetAtsInterviewsRequest # # 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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/getatsjobs_request.rb b/lib/kombo/models/operations/getatsjobs_request.rb index f1a2a06..85ea552 100644 --- a/lib/kombo/models/operations/getatsjobs_request.rb +++ b/lib/kombo/models/operations/getatsjobs_request.rb @@ -24,14 +24,14 @@ class GetAtsJobsRequest # # 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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/getatsoffers_request.rb b/lib/kombo/models/operations/getatsoffers_request.rb index fc23f56..a96f497 100644 --- a/lib/kombo/models/operations/getatsoffers_request.rb +++ b/lib/kombo/models/operations/getatsoffers_request.rb @@ -24,13 +24,13 @@ class GetAtsOffersRequest # # 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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/getatsusers_request.rb b/lib/kombo/models/operations/getatsusers_request.rb index e5c375e..5ec46dc 100644 --- a/lib/kombo/models/operations/getatsusers_request.rb +++ b/lib/kombo/models/operations/getatsusers_request.rb @@ -24,11 +24,11 @@ class GetAtsUsersRequest # # 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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/gethrisabsences_request.rb b/lib/kombo/models/operations/gethrisabsences_request.rb index f667767..ca4fb05 100644 --- a/lib/kombo/models/operations/gethrisabsences_request.rb +++ b/lib/kombo/models/operations/gethrisabsences_request.rb @@ -24,11 +24,11 @@ class GetHrisAbsencesRequest # # 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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/gethrisemployees_request.rb b/lib/kombo/models/operations/gethrisemployees_request.rb index ae3519b..2533546 100644 --- a/lib/kombo/models/operations/gethrisemployees_request.rb +++ b/lib/kombo/models/operations/gethrisemployees_request.rb @@ -24,7 +24,7 @@ class GetHrisEmployeesRequest # # 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 | @@ -33,7 +33,7 @@ class GetHrisEmployeesRequest # | `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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/gethrisperformancereviews_request.rb b/lib/kombo/models/operations/gethrisperformancereviews_request.rb index ad1fa30..0b4b211 100644 --- a/lib/kombo/models/operations/gethrisperformancereviews_request.rb +++ b/lib/kombo/models/operations/gethrisperformancereviews_request.rb @@ -24,13 +24,13 @@ class GetHrisPerformanceReviewsRequest # # 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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/gethrisstaffingentities_request.rb b/lib/kombo/models/operations/gethrisstaffingentities_request.rb index 1ba0a8e..8ea1175 100644 --- a/lib/kombo/models/operations/gethrisstaffingentities_request.rb +++ b/lib/kombo/models/operations/gethrisstaffingentities_request.rb @@ -24,13 +24,13 @@ class GetHrisStaffingEntitiesRequest # # 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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/gethristimeoffbalances_request.rb b/lib/kombo/models/operations/gethristimeoffbalances_request.rb index 98382a5..310e53a 100644 --- a/lib/kombo/models/operations/gethristimeoffbalances_request.rb +++ b/lib/kombo/models/operations/gethristimeoffbalances_request.rb @@ -24,11 +24,11 @@ class GetHrisTimeOffBalancesRequest # # 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._ field :updated_after, Crystalline::Nilable.new(::DateTime), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } # Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. field :ids, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'ids', 'style': 'form', 'explode': false } } diff --git a/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rb b/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rb new file mode 100644 index 0000000..3b91c7e --- /dev/null +++ b/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rb @@ -0,0 +1,36 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module Kombo + module Models + module Operations + + class PostIntegrationsIntegrationIdSetupLinkRequest + extend T::Sig + include Crystalline::MetadataFields + + # POST /integrations/:integration_id/setup-link Parameter + field :integration_id, ::String, { 'path_param': { 'field_name': 'integration_id', 'style': 'simple', 'explode': false } } + # POST /integrations/:integration_id/setup-link Request body + field :body, Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBody, { 'request': { 'media_type': 'application/json' } } + + sig { params(integration_id: ::String, body: Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBody).void } + def initialize(integration_id:, body:) + @integration_id = integration_id + @body = body + end + + sig { params(other: T.untyped).returns(T::Boolean) } + def ==(other) + return false unless other.is_a? self.class + return false unless @integration_id == other.integration_id + return false unless @body == other.body + true + end + end + end + end +end diff --git a/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rbi b/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rbi new file mode 100644 index 0000000..a8beed2 --- /dev/null +++ b/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_request.rbi @@ -0,0 +1,15 @@ +# typed: true +# frozen_string_literal: true + + +class Kombo::Models::Operations::PostIntegrationsIntegrationIdSetupLinkRequest + extend ::Crystalline::MetadataFields::ClassMethods +end + + +class Kombo::Models::Operations::PostIntegrationsIntegrationIdSetupLinkRequest + def integration_id(); end + def integration_id=(str_); end + def body(); end + def body=(str_); end +end \ No newline at end of file diff --git a/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rb b/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rb new file mode 100644 index 0000000..5256f3c --- /dev/null +++ b/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rb @@ -0,0 +1,44 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module Kombo + module Models + module Operations + + class PostIntegrationsIntegrationIdSetupLinkResponse + extend T::Sig + include Crystalline::MetadataFields + + # HTTP response content type for this operation + field :content_type, ::String + # HTTP response status code for this operation + field :status_code, ::Integer + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # POST /integrations/:integration_id/setup-link Positive response + field :post_integrations_integration_id_setup_link_positive_response, Crystalline::Nilable.new(Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponse) + + sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, post_integrations_integration_id_setup_link_positive_response: T.nilable(Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponse)).void } + def initialize(content_type:, status_code:, raw_response:, post_integrations_integration_id_setup_link_positive_response: nil) + @content_type = content_type + @status_code = status_code + @raw_response = raw_response + @post_integrations_integration_id_setup_link_positive_response = post_integrations_integration_id_setup_link_positive_response + end + + sig { params(other: T.untyped).returns(T::Boolean) } + def ==(other) + return false unless other.is_a? self.class + return false unless @content_type == other.content_type + return false unless @status_code == other.status_code + return false unless @raw_response == other.raw_response + return false unless @post_integrations_integration_id_setup_link_positive_response == other.post_integrations_integration_id_setup_link_positive_response + true + end + end + end + end +end diff --git a/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rbi b/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rbi new file mode 100644 index 0000000..28cd1ee --- /dev/null +++ b/lib/kombo/models/operations/postintegrationsintegrationidsetuplink_response.rbi @@ -0,0 +1,19 @@ +# typed: true +# frozen_string_literal: true + + +class Kombo::Models::Operations::PostIntegrationsIntegrationIdSetupLinkResponse + extend ::Crystalline::MetadataFields::ClassMethods +end + + +class Kombo::Models::Operations::PostIntegrationsIntegrationIdSetupLinkResponse + def content_type(); end + def content_type=(str_); end + def status_code(); end + def status_code=(str_); end + def raw_response(); end + def raw_response=(str_); end + def post_integrations_integration_id_setup_link_positive_response(); end + def post_integrations_integration_id_setup_link_positive_response=(str_); end +end \ No newline at end of file diff --git a/lib/kombo/models/shared.rb b/lib/kombo/models/shared.rb index c70b692..5c68b19 100644 --- a/lib/kombo/models/shared.rb +++ b/lib/kombo/models/shared.rb @@ -680,6 +680,11 @@ module Shared autoload :PostIntegrationsIntegrationIdRelinkRequestBody, 'kombo/models/shared/postintegrationsintegrationidrelinkrequestbody.rb' autoload :PostIntegrationsIntegrationIdRelinkRequestBodyLanguage, 'kombo/models/shared/postintegrationsintegrationidrelinkrequestbody_language.rb' autoload :PostIntegrationsIntegrationIdRelinkRequestBodyLinkType, 'kombo/models/shared/postintegrationsintegrationidrelinkrequestbody_link_type.rb' + autoload :PostIntegrationsIntegrationIdSetupLinkPositiveResponse, 'kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rb' + autoload :PostIntegrationsIntegrationIdSetupLinkPositiveResponseData, 'kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rb' + autoload :PostIntegrationsIntegrationIdSetupLinkRequestBody, 'kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rb' + autoload :PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage, 'kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rb' + autoload :PostIntegrationsIntegrationIdSetupLinkRequestBodyLinkType, 'kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rb' autoload :PostPassthroughToolApiPositiveResponse, 'kombo/models/shared/postpassthroughtoolapipositiveresponse.rb' autoload :PostPassthroughToolApiPositiveResponseData, 'kombo/models/shared/postpassthroughtoolapipositiveresponse_data.rb' autoload :PostPassthroughToolApiPositiveResponseWarning, 'kombo/models/shared/postpassthroughtoolapipositiveresponse_warning.rb' diff --git a/lib/kombo/models/shared/integration_tool.rb b/lib/kombo/models/shared/integration_tool.rb index 0331d8f..59abe44 100644 --- a/lib/kombo/models/shared/integration_tool.rb +++ b/lib/kombo/models/shared/integration_tool.rb @@ -23,6 +23,7 @@ class IntegrationTool < T::Enum RECRUITEE = new('recruitee') RECRUITERFLOW = new('recruiterflow') GREENHOUSE = new('greenhouse') + GREENHOUSEV3 = new('greenhousev3') GREENHOUSEJOBBOARD = new('greenhousejobboard') TEAMTAILOR = new('teamtailor') TEAMTAILORJOBBOARDS = new('teamtailorjobboards') @@ -41,6 +42,7 @@ class IntegrationTool < T::Enum REXX = new('rexx') AFAS = new('afas') BAMBOOHR = new('bamboohr') + BULLHORN4SALESFORCE = new('bullhorn4salesforce') BULLHORN = new('bullhorn') BULLHORNLOGIN = new('bullhornlogin') WORKABLE = new('workable') @@ -80,6 +82,7 @@ class IntegrationTool < T::Enum RECRUITCRM = new('recruitcrm') JAZZHR = new('jazzhr') BITE = new('bite') + BRASSRING = new('brassring') HOMERUN = new('homerun') MYSOLUTION = new('mysolution') CARERIX = new('carerix') @@ -115,9 +118,12 @@ class IntegrationTool < T::Enum SANDBOX = new('sandbox') GUIDECOM = new('guidecom') SPOTT = new('spott') + LOGICMELON = new('logicmelon') LOXO = new('loxo') + KULA = new('kula') WORKDAYCUSTOMREPORT = new('workdaycustomreport') WORKDAYCUSTOMREPORTSFTP = new('workdaycustomreportsftp') + UKGPROWFM = new('ukgprowfm') PAYFITCUSTOMER = new('payfitcustomer') PAYFITPARTNER = new('payfitpartner') PAYFIT = new('payfit') diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rb b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rb new file mode 100644 index 0000000..6b80e58 --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rb @@ -0,0 +1,39 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module Kombo + module Models + module Shared + + class PostIntegrationsIntegrationIdSetupLinkPositiveResponse + extend T::Sig + include Crystalline::MetadataFields + + + field :status, ::String, { 'format_json': { 'letter_case': ::Kombo::Utils.field_name('status'), required: true } } + + field :data, Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponseData, { 'format_json': { 'letter_case': ::Kombo::Utils.field_name('data'), required: true } } + + sig { params(status: ::String, data: Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponseData).void } + def initialize(status:, data:) + unless status == 'success' + raise ArgumentError, 'Invalid value for status' + end + @status = 'success' + @data = data + end + + sig { params(other: T.untyped).returns(T::Boolean) } + def ==(other) + return false unless other.is_a? self.class + return false unless @status == other.status + return false unless @data == other.data + true + end + end + end + end +end diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rbi b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rbi new file mode 100644 index 0000000..eaa28fd --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse.rbi @@ -0,0 +1,15 @@ +# typed: true +# frozen_string_literal: true + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponse + extend ::Crystalline::MetadataFields::ClassMethods +end + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponse + def status(); end + def status=(str_); end + def data(); end + def data=(str_); end +end \ No newline at end of file diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rb b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rb new file mode 100644 index 0000000..7cd75ba --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rb @@ -0,0 +1,32 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module Kombo + module Models + module Shared + + class PostIntegrationsIntegrationIdSetupLinkPositiveResponseData + extend T::Sig + include Crystalline::MetadataFields + + # The setup link URL to pass to the Kombo Connect SDK. + field :link, ::String, { 'format_json': { 'letter_case': ::Kombo::Utils.field_name('link'), required: true } } + + sig { params(link: ::String).void } + def initialize(link:) + @link = link + end + + sig { params(other: T.untyped).returns(T::Boolean) } + def ==(other) + return false unless other.is_a? self.class + return false unless @link == other.link + true + end + end + end + end +end diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rbi b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rbi new file mode 100644 index 0000000..ac4e331 --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkpositiveresponse_data.rbi @@ -0,0 +1,13 @@ +# typed: true +# frozen_string_literal: true + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponseData + extend ::Crystalline::MetadataFields::ClassMethods +end + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkPositiveResponseData + def link(); end + def link=(str_); end +end \ No newline at end of file diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rb b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rb new file mode 100644 index 0000000..448df0a --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rb @@ -0,0 +1,36 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module Kombo + module Models + module Shared + + class PostIntegrationsIntegrationIdSetupLinkRequestBody + extend T::Sig + include Crystalline::MetadataFields + + # 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). + field :link_type, Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLinkType, { 'format_json': { 'letter_case': ::Kombo::Utils.field_name('link_type'), required: true, 'decoder': Utils.enum_from_string(Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLinkType, false) } } + # Language of the setup flow UI. + field :language, Crystalline::Nilable.new(Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage), { 'format_json': { 'letter_case': ::Kombo::Utils.field_name('language'), 'decoder': Utils.enum_from_string(Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage, true) } } + + sig { params(link_type: Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLinkType, language: T.nilable(Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage)).void } + def initialize(link_type:, language: Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage::EN) + @link_type = link_type + @language = language + end + + sig { params(other: T.untyped).returns(T::Boolean) } + def ==(other) + return false unless other.is_a? self.class + return false unless @link_type == other.link_type + return false unless @language == other.language + true + end + end + end + end +end diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rbi b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rbi new file mode 100644 index 0000000..004960f --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody.rbi @@ -0,0 +1,15 @@ +# typed: true +# frozen_string_literal: true + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBody + extend ::Crystalline::MetadataFields::ClassMethods +end + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBody + def link_type(); end + def link_type=(str_); end + def language(); end + def language=(str_); end +end \ No newline at end of file diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rb b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rb new file mode 100644 index 0000000..c0aec61 --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rb @@ -0,0 +1,24 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module Kombo + module Models + module Shared + # PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage - Language of the setup flow UI. + class PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage < T::Enum + + + enums do + EN = new('en') + DE = new('de') + FR = new('fr') + IT = new('it') + ES = new('es') + end + end + end + end +end diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rbi b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rbi new file mode 100644 index 0000000..ff5bee9 --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_language.rbi @@ -0,0 +1,11 @@ +# typed: true +# frozen_string_literal: true + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage + extend ::Crystalline::MetadataFields::ClassMethods +end + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLanguage +end \ No newline at end of file diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rb b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rb new file mode 100644 index 0000000..afc5e9a --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rb @@ -0,0 +1,21 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module Kombo + module Models + module Shared + # 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). + class PostIntegrationsIntegrationIdSetupLinkRequestBodyLinkType < T::Enum + + + enums do + EMBEDDED = new('EMBEDDED') + MAGIC_LINK = new('MAGIC_LINK') + end + end + end + end +end diff --git a/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rbi b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rbi new file mode 100644 index 0000000..628d84d --- /dev/null +++ b/lib/kombo/models/shared/postintegrationsintegrationidsetuplinkrequestbody_link_type.rbi @@ -0,0 +1,11 @@ +# typed: true +# frozen_string_literal: true + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLinkType + extend ::Crystalline::MetadataFields::ClassMethods +end + + +class Kombo::Models::Shared::PostIntegrationsIntegrationIdSetupLinkRequestBodyLinkType +end \ No newline at end of file diff --git a/lib/kombo/sdkconfiguration.rb b/lib/kombo/sdkconfiguration.rb index b261979..74fb828 100644 --- a/lib/kombo/sdkconfiguration.rb +++ b/lib/kombo/sdkconfiguration.rb @@ -98,9 +98,9 @@ def initialize(client, hooks, retry_config, timeout_ms, security, security_sourc @globals = globals.nil? ? {} : globals @language = 'ruby' @openapi_doc_version = '1.0.0' - @sdk_version = '1.1.1' + @sdk_version = '1.1.2' @gen_version = '2.801.2' - @user_agent = 'speakeasy-sdk/ruby 1.1.1 2.801.2 1.0.0 kombo' + @user_agent = 'speakeasy-sdk/ruby 1.1.2 2.801.2 1.0.0 kombo' end sig { returns([String, T::Hash[Symbol, String]]) }