me/kombo-ruby-sdk
1
0
Fork 0
mirror of https://github.com/acaloiaro/kombo-ruby-sdk synced 2026-07-21 10:12:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

initial commit

Browse source
This commit is contained in:
Adriano Caloiaroooo 2025-11-19 10:32:40 -08:00
parent f6a295e377
commit 000eb69c9e
No known key found for this signature in database
1960 changed files with 209443 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
.envrc Normal file
View file

@ -0,0 +1,14 @@
#!/usr/bin/env bash
if ! has nix_direnv_version || ! nix_direnv_version 3.1.0; then
source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.1.0/direnvrc" "sha256-yMJ2OVMzrFaDPn7q8nCBZFRYpL/f0RcHzhmw/i6btJM="
fi
export DEVENV_IN_DIRENV_SHELL=true
watch_file flake.nix
watch_file flake.lock
if ! use flake . --no-pure-eval; then
echo "devenv could not be built. The devenv environment was not loaded. Make the necessary changes to devenv.nix and hit enter to try again." >&2
fi

20
.gitignore vendored Normal file
View file

@ -0,0 +1,20 @@
# Ruby
*.gem
*.rbc
/.config
/coverage/
/InstalledFiles
/pkg/
/spec/reports/
/spec/examples.txt
/test/tmp/
/test/version_tmp/
/tmp/
# Generator
java_opts
ruby-client/
# Nix env
.devenv
.direnv

26
.gitlab-ci.yml Normal file
View file

@ -0,0 +1,26 @@
.ruby: &ruby
variables:
LANG: "C.UTF-8"
before_script:
- ruby -v
- bundle config set --local deployment true
- bundle install -j $(nproc)
parallel:
matrix:
- RUBY_VERSION: ['2.7', '3.0', '3.1']
image: "ruby:$RUBY_VERSION"
cache:
paths:
- vendor/ruby
key: 'ruby-$RUBY_VERSION'
gem:
extends: .ruby
script:
- bundle exec rspec
- bundle exec rake build
- bundle exec rake install
artifacts:
paths:
- pkg/*.gem

9
.openapi-generator-ignore Normal file
View file

@ -0,0 +1,9 @@
# Ignore automation files so the generator doesn't overwrite them
.github/
scripts/
README.md
.gitignore
.openapi-generator-ignore
VERSION
api_specs/
new_openapi.json

1305
.openapi-generator/FILES Normal file
View file

File diff suppressed because it is too large Load diff

1
.openapi-generator/VERSION Normal file
View file

@ -0,0 +1 @@
7.17.0

2
.rspec Normal file
View file

@ -0,0 +1,2 @@
--color
--require spec_helper

148
.rubocop.yml Normal file
View file

@ -0,0 +1,148 @@
# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
# Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
AllCops:
TargetRubyVersion: 2.4
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
# to ignore them, so only the ones explicitly set in this file are enabled.
DisabledByDefault: true
Exclude:
- '**/templates/**/*'
- '**/vendor/**/*'
- 'actionpack/lib/action_dispatch/journey/parser.rb'
# Prefer &&/|| over and/or.
Style/AndOr:
Enabled: true
# Align `when` with `case`.
Layout/CaseIndentation:
Enabled: true
# Align comments with method definitions.
Layout/CommentIndentation:
Enabled: true
Layout/ElseAlignment:
Enabled: true
Layout/EmptyLineAfterMagicComment:
Enabled: true
# In a regular class definition, no empty lines around the body.
Layout/EmptyLinesAroundClassBody:
Enabled: true
# In a regular method definition, no empty lines around the body.
Layout/EmptyLinesAroundMethodBody:
Enabled: true
# In a regular module definition, no empty lines around the body.
Layout/EmptyLinesAroundModuleBody:
Enabled: true
Layout/FirstArgumentIndentation:
Enabled: true
# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
Style/HashSyntax:
Enabled: false
# Method definitions after `private` or `protected` isolated calls need one
# extra level of indentation.
Layout/IndentationConsistency:
Enabled: true
EnforcedStyle: indented_internal_methods
# Two spaces, no tabs (for indentation).
Layout/IndentationWidth:
Enabled: true
Layout/LeadingCommentSpace:
Enabled: true
Layout/SpaceAfterColon:
Enabled: true
Layout/SpaceAfterComma:
Enabled: true
Layout/SpaceAroundEqualsInParameterDefault:
Enabled: true
Layout/SpaceAroundKeyword:
Enabled: true
Layout/SpaceAroundOperators:
Enabled: true
Layout/SpaceBeforeComma:
Enabled: true
Layout/SpaceBeforeFirstArg:
Enabled: true
Style/DefWithParentheses:
Enabled: true
# Defining a method with parameters needs parentheses.
Style/MethodDefParentheses:
Enabled: true
Style/FrozenStringLiteralComment:
Enabled: false
EnforcedStyle: always
# Use `foo {}` not `foo{}`.
Layout/SpaceBeforeBlockBraces:
Enabled: true
# Use `foo { bar }` not `foo {bar}`.
Layout/SpaceInsideBlockBraces:
Enabled: true
# Use `{ a: 1 }` not `{a:1}`.
Layout/SpaceInsideHashLiteralBraces:
Enabled: true
Layout/SpaceInsideParens:
Enabled: true
# Check quotes usage according to lint rule below.
#Style/StringLiterals:
# Enabled: true
# EnforcedStyle: single_quotes
# Detect hard tabs, no hard tabs.
Layout/IndentationStyle:
Enabled: true
# Blank lines should not have any spaces.
Layout/TrailingEmptyLines:
Enabled: true
# No trailing whitespace.
Layout/TrailingWhitespace:
Enabled: false
# Use quotes for string literals when they are enough.
Style/RedundantPercentQ:
Enabled: true
# Align `end` with the matching keyword or starting expression except for
# assignments, where it should be aligned with the LHS.
Layout/EndAlignment:
Enabled: true
EnforcedStyleAlignWith: variable
AutoCorrect: true
# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
Lint/RequireParentheses:
Enabled: true
Style/RedundantReturn:
Enabled: true
AllowMultipleReturnValues: true
Style/Semicolon:
Enabled: true
AllowAsExpressionSeparator: true

1
.ruby-version Normal file
View file

@ -0,0 +1 @@
3.4.7

9
Gemfile Normal file
View file

@ -0,0 +1,9 @@
source 'https://rubygems.org'
gemspec
group :development, :test do
gem 'rake', '~> 13.0.1'
gem 'pry-byebug'
gem 'rubocop', '~> 0.66.0'
end

94
Gemfile.lock Normal file
View file

@ -0,0 +1,94 @@
PATH
remote: .
specs:
kombo_client (0)
typhoeus (~> 1.0, >= 1.0.1)
GEM
remote: https://rubygems.org/
specs:
ast (2.4.3)
byebug (12.0.0)
coderay (1.1.3)
date (3.5.0)
diff-lcs (1.6.2)
ethon (0.15.0)
ffi (>= 1.15.0)
ffi (1.17.2)
ffi (1.17.2-aarch64-linux-gnu)
ffi (1.17.2-aarch64-linux-musl)
ffi (1.17.2-arm-linux-gnu)
ffi (1.17.2-arm-linux-musl)
ffi (1.17.2-arm64-darwin)
ffi (1.17.2-x86-linux-gnu)
ffi (1.17.2-x86-linux-musl)
ffi (1.17.2-x86_64-darwin)
ffi (1.17.2-x86_64-linux-gnu)
ffi (1.17.2-x86_64-linux-musl)
jaro_winkler (1.5.6)
method_source (1.1.0)
parallel (1.27.0)
parser (3.3.10.0)
ast (~> 2.4.1)
racc
pry (0.15.2)
coderay (~> 1.1)
method_source (~> 1.0)
pry-byebug (3.11.0)
byebug (~> 12.0)
pry (>= 0.13, < 0.16)
psych (5.2.6)
date
stringio
racc (1.8.1)
rainbow (3.1.1)
rake (13.0.6)
rspec (3.13.2)
rspec-core (~> 3.13.0)
rspec-expectations (~> 3.13.0)
rspec-mocks (~> 3.13.0)
rspec-core (3.13.6)
rspec-support (~> 3.13.0)
rspec-expectations (3.13.5)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.13.0)
rspec-mocks (3.13.7)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.13.0)
rspec-support (3.13.6)
rubocop (0.66.0)
jaro_winkler (~> 1.5.1)
parallel (~> 1.10)
parser (>= 2.5, != 2.5.1.1)
psych (>= 3.1.0)
rainbow (>= 2.2.2, < 4.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 1.4.0, < 1.6)
ruby-progressbar (1.13.0)
stringio (3.1.8)
typhoeus (1.5.0)
ethon (>= 0.9.0, < 0.16.0)
unicode-display_width (1.5.0)
PLATFORMS
aarch64-linux-gnu
aarch64-linux-musl
arm-linux-gnu
arm-linux-musl
arm64-darwin
ruby
x86-linux-gnu
x86-linux-musl
x86_64-darwin
x86_64-linux-gnu
x86_64-linux-musl
DEPENDENCIES
kombo_client!
pry-byebug
rake (~> 13.0.1)
rspec (~> 3.6, >= 3.6.0)
rubocop (~> 0.66.0)
BUNDLED WITH
2.6.3

7
README.md
View file

@ -1,2 +1,5 @@
# kombo-ruby-sdk
Experimental ruby SDK for kombo.dev
# Kombo.dev Ruby SDK Generator
This experimental repository generates a Ruby SDK from [Kombo's OpenAPI spec](https://api.kombo.dev/openapi.json).

10
Rakefile Normal file
View file

@ -0,0 +1,10 @@
require "bundler/gem_tasks"
begin
require 'rspec/core/rake_task'
RSpec::Core::RakeTask.new(:spec)
task default: :spec
rescue LoadError
# no rspec available
end

1
VERSION Normal file
View file

@ -0,0 +1 @@

1
api_specs/kombo-openapi-spec-.json Normal file
View file

File diff suppressed because one or more lines are too long

761
docs/AIApplyApi.md Normal file
View file

@ -0,0 +1,761 @@
# Kombo::AIApplyApi
All URIs are relative to *https://api.kombo.dev/v1*
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**get_ai_apply_applications**](AIApplyApi.md#get_ai_apply_applications) | **GET** /ai-apply/applications | Get applications |
| [**get_ai_apply_career_sites**](AIApplyApi.md#get_ai_apply_career_sites) | **GET** /ai-apply/career-sites | Get career sites |
| [**get_ai_apply_postings**](AIApplyApi.md#get_ai_apply_postings) | **GET** /ai-apply/postings | Get job postings |
| [**get_ai_apply_unified_api_jobs**](AIApplyApi.md#get_ai_apply_unified_api_jobs) | **GET** /ai-apply/unified-api/jobs | Get jobs |
| [**post_ai_apply_apply**](AIApplyApi.md#post_ai_apply_apply) | **POST** /ai-apply/apply | Submit job application |
| [**post_ai_apply_career_sites**](AIApplyApi.md#post_ai_apply_career_sites) | **POST** /ai-apply/career-sites | Create a career site |
| [**post_ai_apply_postings**](AIApplyApi.md#post_ai_apply_postings) | **POST** /ai-apply/postings | Parse a job posting |
| [**post_ai_apply_postings_posting_id_inquire**](AIApplyApi.md#post_ai_apply_postings_posting_id_inquire) | **POST** /ai-apply/postings/{posting_id}/inquire | Inquire about a job posting and the application f… |
| [**post_ai_apply_postings_posting_id_parse**](AIApplyApi.md#post_ai_apply_postings_posting_id_parse) | **POST** /ai-apply/postings/{posting_id}/parse | Re-parse an existing job posting |
| [**post_ai_apply_unified_api_jobs_job_id_applications**](AIApplyApi.md#post_ai_apply_unified_api_jobs_job_id_applications) | **POST** /ai-apply/unified-api/jobs/{job_id}/applications | Create application |
## get_ai_apply_applications
> <GetAiApplyApplicationsPositiveResponse> get_ai_apply_applications(opts)
Get applications
Get all applications.
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
opts = {
cursor: 'cursor_example', # String | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response.
page_size: 789, # Integer | The number of results to return per page. Maximum is 250.
ids: 'ids_example', # String | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
job_posting_ids: 'job_posting_ids_example' # String | Filter by a comma-separated list of job posting IDs such as `89V6GEKpdZwqbxQz59n1ftFb,kcGHREEXCMF26Yhpuyh1gDVE`.
}
begin
# Get applications
result = api_instance.get_ai_apply_applications(opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->get_ai_apply_applications: #{e}"
end
```
#### Using the get_ai_apply_applications_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<GetAiApplyApplicationsPositiveResponse>, Integer, Hash)> get_ai_apply_applications_with_http_info(opts)
```ruby
begin
# Get applications
data, status_code, headers = api_instance.get_ai_apply_applications_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <GetAiApplyApplicationsPositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->get_ai_apply_applications_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **cursor** | **String** | An optional cursor string used for pagination. This can be retrieved from the &#x60;next&#x60; property of the previous page response. | [optional] |
| **page_size** | **Integer** | The number of results to return per page. Maximum is 250. | [optional][default to 100] |
| **ids** | **String** | Filter by a comma-separated list of IDs such as &#x60;222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3&#x60;. | [optional] |
| **job_posting_ids** | **String** | Filter by a comma-separated list of job posting IDs such as &#x60;89V6GEKpdZwqbxQz59n1ftFb,kcGHREEXCMF26Yhpuyh1gDVE&#x60;. | [optional] |
### Return type
[**GetAiApplyApplicationsPositiveResponse**](GetAiApplyApplicationsPositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
## get_ai_apply_career_sites
> <GetAiApplyCareerSitesPositiveResponse> get_ai_apply_career_sites(opts)
Get career sites
Get all career sites.
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
opts = {
cursor: 'cursor_example', # String | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response.
page_size: 789, # Integer | The number of results to return per page. Maximum is 250.
ids: 'ids_example' # String | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
}
begin
# Get career sites
result = api_instance.get_ai_apply_career_sites(opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->get_ai_apply_career_sites: #{e}"
end
```
#### Using the get_ai_apply_career_sites_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<GetAiApplyCareerSitesPositiveResponse>, Integer, Hash)> get_ai_apply_career_sites_with_http_info(opts)
```ruby
begin
# Get career sites
data, status_code, headers = api_instance.get_ai_apply_career_sites_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <GetAiApplyCareerSitesPositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->get_ai_apply_career_sites_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **cursor** | **String** | An optional cursor string used for pagination. This can be retrieved from the &#x60;next&#x60; property of the previous page response. | [optional] |
| **page_size** | **Integer** | The number of results to return per page. Maximum is 250. | [optional][default to 100] |
| **ids** | **String** | Filter by a comma-separated list of IDs such as &#x60;222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3&#x60;. | [optional] |
### Return type
[**GetAiApplyCareerSitesPositiveResponse**](GetAiApplyCareerSitesPositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
## get_ai_apply_postings
> <GetAiApplyPostingsPositiveResponse> get_ai_apply_postings(opts)
Get job postings
Get all job postings. To get the application form and submit applications, use the POST /postings/:id/inquire endpoint.
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
opts = {
cursor: 'cursor_example', # String | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response.
page_size: 789, # Integer | The number of results to return per page. Maximum is 250.
ids: 'ids_example', # String | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
career_site_ids: 'career_site_ids_example', # String | Filter by a comma-separated list of career site IDs such as `A8m9k9RhjNokMfRTWtpQ99VtH,rCbkAA3pvcKjsFYwEeXtCQkc`.
job_codes: 'job_codes_example' # String | Filter by a comma-separated list of job codes such as `ACME_13,ACME_14`.
}
begin
# Get job postings
result = api_instance.get_ai_apply_postings(opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->get_ai_apply_postings: #{e}"
end
```
#### Using the get_ai_apply_postings_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<GetAiApplyPostingsPositiveResponse>, Integer, Hash)> get_ai_apply_postings_with_http_info(opts)
```ruby
begin
# Get job postings
data, status_code, headers = api_instance.get_ai_apply_postings_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <GetAiApplyPostingsPositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->get_ai_apply_postings_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **cursor** | **String** | An optional cursor string used for pagination. This can be retrieved from the &#x60;next&#x60; property of the previous page response. | [optional] |
| **page_size** | **Integer** | The number of results to return per page. Maximum is 250. | [optional][default to 100] |
| **ids** | **String** | Filter by a comma-separated list of IDs such as &#x60;222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3&#x60;. | [optional] |
| **career_site_ids** | **String** | Filter by a comma-separated list of career site IDs such as &#x60;A8m9k9RhjNokMfRTWtpQ99VtH,rCbkAA3pvcKjsFYwEeXtCQkc&#x60;. | [optional] |
| **job_codes** | **String** | Filter by a comma-separated list of job codes such as &#x60;ACME_13,ACME_14&#x60;. | [optional] |
### Return type
[**GetAiApplyPostingsPositiveResponse**](GetAiApplyPostingsPositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
## get_ai_apply_unified_api_jobs
> <GetAiApplyUnifiedApiJobsPositiveResponse> get_ai_apply_unified_api_jobs(opts)
Get jobs
Get jobs in a backwards compatible way as you would [via Kombo's unified API](https://docs.kombo.dev/ats/v1/get-jobs). This is not the recommended way to get jobs with AI Apply.
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
opts = {
cursor: 'cursor_example', # String | An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response.
page_size: 789, # Integer | The number of results to return per page. Maximum is 5.
ids: 'ids_example', # String | Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
remote_ids: 'remote_ids_example', # String | This parameter exists for backwards compatibility with Kombo's unified API. Supplying a comma-separated list of remote IDs such as `32,33` will return no jobs because AI Apply does not interface with a remote system that issues remote IDs.
job_codes: 'job_codes_example', # String | Filter by a comma-separated list of job codes such as `ACME_12,ACME_14`.
career_site_ids: 'career_site_ids_example' # String | Filter by a comma-separated list of career site IDs such as `A8m9k9RhjNokMfRTWtpQ99VtH,rCbkAA3pvcKjsFYwEeXtCQkc`.
}
begin
# Get jobs
result = api_instance.get_ai_apply_unified_api_jobs(opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->get_ai_apply_unified_api_jobs: #{e}"
end
```
#### Using the get_ai_apply_unified_api_jobs_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<GetAiApplyUnifiedApiJobsPositiveResponse>, Integer, Hash)> get_ai_apply_unified_api_jobs_with_http_info(opts)
```ruby
begin
# Get jobs
data, status_code, headers = api_instance.get_ai_apply_unified_api_jobs_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <GetAiApplyUnifiedApiJobsPositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->get_ai_apply_unified_api_jobs_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **cursor** | **String** | An optional cursor string used for pagination. This can be retrieved from the &#x60;next&#x60; property of the previous page response. | [optional] |
| **page_size** | **Integer** | The number of results to return per page. Maximum is 5. | [optional][default to 5] |
| **ids** | **String** | Filter by a comma-separated list of IDs such as &#x60;222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3&#x60;. | [optional] |
| **remote_ids** | **String** | This parameter exists for backwards compatibility with Kombo&#39;s unified API. Supplying a comma-separated list of remote IDs such as &#x60;32,33&#x60; will return no jobs because AI Apply does not interface with a remote system that issues remote IDs. | [optional] |
| **job_codes** | **String** | Filter by a comma-separated list of job codes such as &#x60;ACME_12,ACME_14&#x60;. | [optional] |
| **career_site_ids** | **String** | Filter by a comma-separated list of career site IDs such as &#x60;A8m9k9RhjNokMfRTWtpQ99VtH,rCbkAA3pvcKjsFYwEeXtCQkc&#x60;. | [optional] |
### Return type
[**GetAiApplyUnifiedApiJobsPositiveResponse**](GetAiApplyUnifiedApiJobsPositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
## post_ai_apply_apply
> <PostAiApplyApplyPositiveResponse> post_ai_apply_apply(opts)
Submit job application
Submit a job application using a submission token. The application will be queued and processed asynchronously. Returns ID to track progress and match with webhooks.
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
opts = {
post_ai_apply_apply_request_body: Kombo::PostAiApplyApplyRequestBody.new({submission_token: 'submission_token_example', candidate_email: 'candidate_email_example', screening_question_answers: [Kombo::PostAiApplyApplyRequestBodyScreeningQuestionAnswersInner.new({question_id: 'question_id_example', answer: nil})]}) # PostAiApplyApplyRequestBody | POST /ai-apply/apply Request body
}
begin
# Submit job application
result = api_instance.post_ai_apply_apply(opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_apply: #{e}"
end
```
#### Using the post_ai_apply_apply_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<PostAiApplyApplyPositiveResponse>, Integer, Hash)> post_ai_apply_apply_with_http_info(opts)
```ruby
begin
# Submit job application
data, status_code, headers = api_instance.post_ai_apply_apply_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <PostAiApplyApplyPositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_apply_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **post_ai_apply_apply_request_body** | [**PostAiApplyApplyRequestBody**](PostAiApplyApplyRequestBody.md) | POST /ai-apply/apply Request body | [optional] |
### Return type
[**PostAiApplyApplyPositiveResponse**](PostAiApplyApplyPositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
## post_ai_apply_career_sites
> <PostAiApplyCareerSitesPositiveResponse> post_ai_apply_career_sites(opts)
Create a career site
Create a career site entry. Career sites are required to be specified when parsing job postings, grouping them under a single entity.
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
opts = {
post_ai_apply_career_sites_request_body: Kombo::PostAiApplyCareerSitesRequestBody.new({label: 'label_example'}) # PostAiApplyCareerSitesRequestBody | POST /ai-apply/career-sites Request body
}
begin
# Create a career site
result = api_instance.post_ai_apply_career_sites(opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_career_sites: #{e}"
end
```
#### Using the post_ai_apply_career_sites_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<PostAiApplyCareerSitesPositiveResponse>, Integer, Hash)> post_ai_apply_career_sites_with_http_info(opts)
```ruby
begin
# Create a career site
data, status_code, headers = api_instance.post_ai_apply_career_sites_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <PostAiApplyCareerSitesPositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_career_sites_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **post_ai_apply_career_sites_request_body** | [**PostAiApplyCareerSitesRequestBody**](PostAiApplyCareerSitesRequestBody.md) | POST /ai-apply/career-sites Request body | [optional] |
### Return type
[**PostAiApplyCareerSitesPositiveResponse**](PostAiApplyCareerSitesPositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
## post_ai_apply_postings
> <PostAiApplyPostingsPositiveResponse> post_ai_apply_postings(opts)
Parse a job posting
Submit a job posting URL to be parsed asynchronously. Returns ID to track progress.
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
opts = {
post_ai_apply_postings_request_body: Kombo::PostAiApplyPostingsRequestBody.new({career_site_id: 'career_site_id_example', url: 'url_example'}) # PostAiApplyPostingsRequestBody | POST /ai-apply/postings Request body
}
begin
# Parse a job posting
result = api_instance.post_ai_apply_postings(opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_postings: #{e}"
end
```
#### Using the post_ai_apply_postings_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<PostAiApplyPostingsPositiveResponse>, Integer, Hash)> post_ai_apply_postings_with_http_info(opts)
```ruby
begin
# Parse a job posting
data, status_code, headers = api_instance.post_ai_apply_postings_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <PostAiApplyPostingsPositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_postings_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **post_ai_apply_postings_request_body** | [**PostAiApplyPostingsRequestBody**](PostAiApplyPostingsRequestBody.md) | POST /ai-apply/postings Request body | [optional] |
### Return type
[**PostAiApplyPostingsPositiveResponse**](PostAiApplyPostingsPositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
## post_ai_apply_postings_posting_id_inquire
> <PostAiApplyPostingsPostingIdInquirePositiveResponse> post_ai_apply_postings_posting_id_inquire(posting_id, opts)
Inquire about a job posting and the application f…
Receive the application form (screening questions) for a job posting and a submission token. This endpoint must be called before submitting an application to ensure you have the latest questions and a valid submission token. The submission token is valid for 12 hours and prevents duplicate submissions. The application form may contain conditional questions that are only shown based on answers to previous questions (check the display_when field).
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
posting_id = '9QGNv3B98kL3hyELE1qsZ86s' # String | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
opts = {
body: { ... } # Object | POST /ai-apply/postings/:posting_id/inquire Request body
}
begin
# Inquire about a job posting and the application f…
result = api_instance.post_ai_apply_postings_posting_id_inquire(posting_id, opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_postings_posting_id_inquire: #{e}"
end
```
#### Using the post_ai_apply_postings_posting_id_inquire_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<PostAiApplyPostingsPostingIdInquirePositiveResponse>, Integer, Hash)> post_ai_apply_postings_posting_id_inquire_with_http_info(posting_id, opts)
```ruby
begin
# Inquire about a job posting and the application f…
data, status_code, headers = api_instance.post_ai_apply_postings_posting_id_inquire_with_http_info(posting_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <PostAiApplyPostingsPostingIdInquirePositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_postings_posting_id_inquire_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **posting_id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **body** | **Object** | POST /ai-apply/postings/:posting_id/inquire Request body | [optional] |
### Return type
[**PostAiApplyPostingsPostingIdInquirePositiveResponse**](PostAiApplyPostingsPostingIdInquirePositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
## post_ai_apply_postings_posting_id_parse
> <PostAiApplyPostingsPostingIdParsePositiveResponse> post_ai_apply_postings_posting_id_parse(posting_id, opts)
Re-parse an existing job posting
Trigger re-parsing of an already parsed job posting.
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
posting_id = '9QGNv3B98kL3hyELE1qsZ86s' # String | The ID of the job posting to parse a new revision for
opts = {
body: { ... } # Object | POST /ai-apply/postings/:posting_id/parse Request body
}
begin
# Re-parse an existing job posting
result = api_instance.post_ai_apply_postings_posting_id_parse(posting_id, opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_postings_posting_id_parse: #{e}"
end
```
#### Using the post_ai_apply_postings_posting_id_parse_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<PostAiApplyPostingsPostingIdParsePositiveResponse>, Integer, Hash)> post_ai_apply_postings_posting_id_parse_with_http_info(posting_id, opts)
```ruby
begin
# Re-parse an existing job posting
data, status_code, headers = api_instance.post_ai_apply_postings_posting_id_parse_with_http_info(posting_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <PostAiApplyPostingsPostingIdParsePositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_postings_posting_id_parse_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **posting_id** | **String** | The ID of the job posting to parse a new revision for | |
| **body** | **Object** | POST /ai-apply/postings/:posting_id/parse Request body | [optional] |
### Return type
[**PostAiApplyPostingsPostingIdParsePositiveResponse**](PostAiApplyPostingsPostingIdParsePositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
## post_ai_apply_unified_api_jobs_job_id_applications
> <PostAiApplyUnifiedApiJobsJobIdApplicationsPositiveResponse> post_ai_apply_unified_api_jobs_job_id_applications(job_id, opts)
Create application
Create applications in a backwards compatible way as you would [via Kombo's unified API](https://docs.kombo.dev/ats/v1/post-jobs-job-id-applications). This is not the recommended way to create applications with AI Apply.
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::AIApplyApi.new
job_id = 'BDpgnpZ148nrGh4mYHNxJBgx' # String | The Kombo ID or Remote ID of the Job this candidate should apply for. If you want to use the ID of the integrated system (remote_id) you need to prefix the id with \"remote:\". You can use the remote ID if you do not want to sync jobs.
opts = {
post_ai_apply_unified_api_jobs_job_id_applications_request_body: Kombo::PostAiApplyUnifiedApiJobsJobIdApplicationsRequestBody.new({candidate: Kombo::PostAtsCandidatesRequestBodyCandidate.new({first_name: 'first_name_example', last_name: 'last_name_example', email_address: 'email_address_example'})}) # PostAiApplyUnifiedApiJobsJobIdApplicationsRequestBody | POST /ai-apply/unified-api/jobs/:job_id/applications Request body
}
begin
# Create application
result = api_instance.post_ai_apply_unified_api_jobs_job_id_applications(job_id, opts)
p result
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_unified_api_jobs_job_id_applications: #{e}"
end
```
#### Using the post_ai_apply_unified_api_jobs_job_id_applications_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<PostAiApplyUnifiedApiJobsJobIdApplicationsPositiveResponse>, Integer, Hash)> post_ai_apply_unified_api_jobs_job_id_applications_with_http_info(job_id, opts)
```ruby
begin
# Create application
data, status_code, headers = api_instance.post_ai_apply_unified_api_jobs_job_id_applications_with_http_info(job_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <PostAiApplyUnifiedApiJobsJobIdApplicationsPositiveResponse>
rescue Kombo::ApiError => e
puts "Error when calling AIApplyApi->post_ai_apply_unified_api_jobs_job_id_applications_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **job_id** | **String** | The Kombo ID or Remote ID of the Job this candidate should apply for. If you want to use the ID of the integrated system (remote_id) you need to prefix the id with \&quot;remote:\&quot;. You can use the remote ID if you do not want to sync jobs. | |
| **post_ai_apply_unified_api_jobs_job_id_applications_request_body** | [**PostAiApplyUnifiedApiJobsJobIdApplicationsRequestBody**](PostAiApplyUnifiedApiJobsJobIdApplicationsRequestBody.md) | POST /ai-apply/unified-api/jobs/:job_id/applications Request body | [optional] |
### Return type
[**PostAiApplyUnifiedApiJobsJobIdApplicationsPositiveResponse**](PostAiApplyUnifiedApiJobsJobIdApplicationsPositiveResponse.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

22
docs/AiApplyApplicationStatusUpdatedWebhookPayload.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::AiApplyApplicationStatusUpdatedWebhookPayload
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | Unique identifier for this webhook event | |
| **type** | **String** | Type of the webhook event | |
| **data** | [**AiApplyApplicationStatusUpdatedWebhookPayloadData**](AiApplyApplicationStatusUpdatedWebhookPayloadData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AiApplyApplicationStatusUpdatedWebhookPayload.new(
id: null,
type: null,
data: null
)
```

26
docs/AiApplyApplicationStatusUpdatedWebhookPayloadData.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::AiApplyApplicationStatusUpdatedWebhookPayloadData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **job_posting_id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **status** | **String** | | |
| **created_at** | **Time** | | |
| **updated_at** | **Time** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AiApplyApplicationStatusUpdatedWebhookPayloadData.new(
id: null,
job_posting_id: null,
status: null,
created_at: null,
updated_at: null
)
```

22
docs/AiApplyJobPostingStatusUpdatedWebhookPayload.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::AiApplyJobPostingStatusUpdatedWebhookPayload
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | Unique identifier for this webhook event | |
| **type** | **String** | Type of the webhook event | |
| **data** | [**AiApplyJobPostingStatusUpdatedWebhookPayloadData**](AiApplyJobPostingStatusUpdatedWebhookPayloadData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AiApplyJobPostingStatusUpdatedWebhookPayload.new(
id: null,
type: null,
data: null
)
```

34
docs/AiApplyJobPostingStatusUpdatedWebhookPayloadData.md Normal file
View file

@ -0,0 +1,34 @@
# Kombo::AiApplyJobPostingStatusUpdatedWebhookPayloadData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **career_site** | [**AiApplyJobPostingStatusUpdatedWebhookPayloadDataCareerSite**](AiApplyJobPostingStatusUpdatedWebhookPayloadDataCareerSite.md) | | |
| **url** | **String** | | |
| **job_code** | **String** | | |
| **created_at** | **Time** | | |
| **updated_at** | **Time** | | |
| **archived_at** | **Time** | The date and time the job posting was archived. You can only send applications if the job posting is not archived. | |
| **archived_reason** | **String** | | |
| **availability** | **String** | The status of the job posting. You can only send applications if the job posting is \&quot;APPLYABLE\&quot;. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AiApplyJobPostingStatusUpdatedWebhookPayloadData.new(
id: null,
career_site: null,
url: null,
job_code: null,
created_at: null,
updated_at: null,
archived_at: null,
archived_reason: null,
availability: null
)
```

20
docs/AiApplyJobPostingStatusUpdatedWebhookPayloadDataCareerSite.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::AiApplyJobPostingStatusUpdatedWebhookPayloadDataCareerSite
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **label** | **String** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AiApplyJobPostingStatusUpdatedWebhookPayloadDataCareerSite.new(
id: null,
label: null
)
```

22
docs/AssessmentOrderReceivedWebhookPayload.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::AssessmentOrderReceivedWebhookPayload
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | Unique identifier for this webhook event | |
| **type** | **String** | Type of the webhook event | |
| **data** | [**AssessmentOrderReceivedWebhookPayloadData**](AssessmentOrderReceivedWebhookPayloadData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AssessmentOrderReceivedWebhookPayload.new(
id: null,
type: null,
data: null
)
```

30
docs/AssessmentOrderReceivedWebhookPayloadData.md Normal file
View file

@ -0,0 +1,30 @@
# Kombo::AssessmentOrderReceivedWebhookPayloadData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The unique identifier of the assessment order. | |
| **package_id** | **String** | The identifier of the assessment package. | |
| **status** | **String** | The current status of the assessment order. | |
| **integration_id** | **String** | The unique identifier of the integration. | |
| **candidate** | [**AssessmentOrderReceivedWebhookPayloadDataCandidate**](AssessmentOrderReceivedWebhookPayloadDataCandidate.md) | | |
| **application** | [**AssessmentOrderReceivedWebhookPayloadDataApplication**](AssessmentOrderReceivedWebhookPayloadDataApplication.md) | | |
| **job** | [**AssessmentOrderReceivedWebhookPayloadDataJob**](AssessmentOrderReceivedWebhookPayloadDataJob.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AssessmentOrderReceivedWebhookPayloadData.new(
id: null,
package_id: null,
status: null,
integration_id: null,
candidate: null,
application: null,
job: null
)
```

18
docs/AssessmentOrderReceivedWebhookPayloadDataApplication.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::AssessmentOrderReceivedWebhookPayloadDataApplication
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **remote_id** | **String** | The application&#39;s identifier in the integrated system. | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AssessmentOrderReceivedWebhookPayloadDataApplication.new(
remote_id: null
)
```

26
docs/AssessmentOrderReceivedWebhookPayloadDataCandidate.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::AssessmentOrderReceivedWebhookPayloadDataCandidate
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **email** | **String** | The candidate&#39;s email address. | |
| **first_name** | **String** | The candidate&#39;s first name. | [optional] |
| **last_name** | **String** | The candidate&#39;s last name. | [optional] |
| **phone** | **String** | The candidate&#39;s phone number. | [optional] |
| **remote_id** | **String** | The candidate&#39;s identifier in the integrated system. | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AssessmentOrderReceivedWebhookPayloadDataCandidate.new(
email: null,
first_name: null,
last_name: null,
phone: null,
remote_id: null
)
```

24
docs/AssessmentOrderReceivedWebhookPayloadDataJob.md Normal file
View file

@ -0,0 +1,24 @@
# Kombo::AssessmentOrderReceivedWebhookPayloadDataJob
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **remote_id** | **String** | The job&#39;s identifier in the integrated system. | [optional] |
| **name** | **String** | The job title. | [optional] |
| **location** | [**AssessmentOrderReceivedWebhookPayloadDataJobLocation**](AssessmentOrderReceivedWebhookPayloadDataJobLocation.md) | | [optional] |
| **hiring_team** | [**Array&lt;AssessmentOrderReceivedWebhookPayloadDataJobHiringTeamInner&gt;**](AssessmentOrderReceivedWebhookPayloadDataJobHiringTeamInner.md) | The hiring team allows you to sync users into your system who can access the job and its applications. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AssessmentOrderReceivedWebhookPayloadDataJob.new(
remote_id: null,
name: null,
location: null,
hiring_team: null
)
```

26
docs/AssessmentOrderReceivedWebhookPayloadDataJobHiringTeamInner.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::AssessmentOrderReceivedWebhookPayloadDataJobHiringTeamInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **remote_id** | **String** | The team member&#39;s identifier in the integrated system. | |
| **email** | **String** | The team member&#39;s email address. | |
| **first_name** | **String** | The team member&#39;s first name. | |
| **last_name** | **String** | The team member&#39;s last name. | |
| **hiring_team_roles** | **Array&lt;String&gt;** | Array of the roles of the user for this specific job. Currently only &#x60;RECRUITER&#x60; and &#x60;HIRING_MANAGER&#x60; are mapped into our unified schema. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AssessmentOrderReceivedWebhookPayloadDataJobHiringTeamInner.new(
remote_id: null,
email: null,
first_name: null,
last_name: null,
hiring_team_roles: null
)
```

30
docs/AssessmentOrderReceivedWebhookPayloadDataJobLocation.md Normal file
View file

@ -0,0 +1,30 @@
# Kombo::AssessmentOrderReceivedWebhookPayloadDataJobLocation
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **city** | **String** | | [optional] |
| **country** | **String** | Contains the ISO2 country code if possible. If not, it contains the original value. | [optional] |
| **raw** | **String** | If we have address data, this is filled with the raw address string. | [optional] |
| **state** | **String** | | [optional] |
| **street_1** | **String** | If we can parse the address data, this field contains the first part of the street information. | [optional] |
| **street_2** | **String** | | [optional] |
| **zip_code** | **String** | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::AssessmentOrderReceivedWebhookPayloadDataJobLocation.new(
city: null,
country: null,
raw: null,
state: null,
street_1: null,
street_2: null,
zip_code: null
)
```

22
docs/ConnectionFlowFailedWebhookPayload.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::ConnectionFlowFailedWebhookPayload
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | Unique identifier for this webhook event | |
| **type** | **String** | Type of the webhook event | |
| **data** | [**ConnectionFlowFailedWebhookPayloadData**](ConnectionFlowFailedWebhookPayloadData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::ConnectionFlowFailedWebhookPayload.new(
id: null,
type: null,
data: null
)
```

24
docs/ConnectionFlowFailedWebhookPayloadData.md Normal file
View file

@ -0,0 +1,24 @@
# Kombo::ConnectionFlowFailedWebhookPayloadData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **integration_tool** | **String** | The name of the integrated tool (e.g., \&quot;personio\&quot;, \&quot;greenhouse\&quot;). | |
| **integration_category** | **String** | The category of the integration (HRIS, ATS, or ASSESSMENT). | |
| **end_user** | [**ConnectionFlowFailedWebhookPayloadDataEndUser**](ConnectionFlowFailedWebhookPayloadDataEndUser.md) | | |
| **log_url** | **String** | URL to view detailed logs for the operation. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::ConnectionFlowFailedWebhookPayloadData.new(
integration_tool: null,
integration_category: null,
end_user: null,
log_url: null
)
```

22
docs/ConnectionFlowFailedWebhookPayloadDataEndUser.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::ConnectionFlowFailedWebhookPayloadDataEndUser
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **organization_name** | **String** | The name of the organization that owns the integration. | |
| **creator_email** | **String** | The email address of the user who created the integration. | |
| **origin_id** | **String** | The unique identifier of the organization in the integrated system. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::ConnectionFlowFailedWebhookPayloadDataEndUser.new(
organization_name: null,
creator_email: null,
origin_id: null
)
```

1177
docs/CustomEndpointsApi.md Normal file
View file

File diff suppressed because it is too large Load diff

22
docs/DataChangedWebhookPayload.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::DataChangedWebhookPayload
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | Unique identifier for this webhook event | |
| **type** | **String** | Type of the webhook event | |
| **data** | [**DataChangedWebhookPayloadData**](DataChangedWebhookPayloadData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DataChangedWebhookPayload.new(
id: null,
type: null,
data: null
)
```

24
docs/DataChangedWebhookPayloadData.md Normal file
View file

@ -0,0 +1,24 @@
# Kombo::DataChangedWebhookPayloadData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **integration_id** | **String** | The unique identifier of the integration. | |
| **integration_tool** | **String** | The name of the integrated tool (e.g., \&quot;personio\&quot;, \&quot;greenhouse\&quot;). | |
| **integration_category** | **String** | The category of the integration (HRIS, ATS, or ASSESSMENT). | |
| **changed_models** | [**Array&lt;DataChangedWebhookPayloadDataChangedModelsInner&gt;**](DataChangedWebhookPayloadDataChangedModelsInner.md) | List of data models and connections for which one or more records were created, updated, or deleted. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DataChangedWebhookPayloadData.new(
integration_id: null,
integration_tool: null,
integration_category: null,
changed_models: null
)
```

18
docs/DataChangedWebhookPayloadDataChangedModelsInner.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::DataChangedWebhookPayloadDataChangedModelsInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **name** | **String** | The name of the Kombo model or connection that changed. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DataChangedWebhookPayloadDataChangedModelsInner.new(
name: null
)
```

766
docs/DefaultApi.md Normal file
View file

@ -0,0 +1,766 @@
# Kombo::DefaultApi
All URIs are relative to *https://api.kombo.dev/v1*
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**webhook_ai_apply_application_status_updated_webhook_payload**](DefaultApi.md#webhook_ai_apply_application_status_updated_webhook_payload) | **POST** /ai-apply-application-status-updated | AI Apply: Application status updated |
| [**webhook_ai_apply_job_posting_status_updated_webhook_payload**](DefaultApi.md#webhook_ai_apply_job_posting_status_updated_webhook_payload) | **POST** /ai-apply-job-posting-status-updated | AI Apply: Job posting status updated |
| [**webhook_assessment_order_received_webhook_payload**](DefaultApi.md#webhook_assessment_order_received_webhook_payload) | **POST** /assessment:order-received | Assessment: Order received |
| [**webhook_connection_flow_failed_webhook_payload**](DefaultApi.md#webhook_connection_flow_failed_webhook_payload) | **POST** /connection-flow-failed | Connection flow failed |
| [**webhook_data_changed_webhook_payload**](DefaultApi.md#webhook_data_changed_webhook_payload) | **POST** /data-changed | Data changed |
| [**webhook_inline_assessment_order_received_webhook_payload**](DefaultApi.md#webhook_inline_assessment_order_received_webhook_payload) | **POST** /inline-assessment:order-received | Inline assessment: Order received |
| [**webhook_integration_created_webhook_payload**](DefaultApi.md#webhook_integration_created_webhook_payload) | **POST** /integration-created | Integration created |
| [**webhook_integration_deleted_webhook_payload**](DefaultApi.md#webhook_integration_deleted_webhook_payload) | **POST** /integration-deleted | Integration deleted |
| [**webhook_integration_state_changed_webhook_payload**](DefaultApi.md#webhook_integration_state_changed_webhook_payload) | **POST** /integration-state-changed | Integration state changed |
| [**webhook_remote_event_received_webhook_payload**](DefaultApi.md#webhook_remote_event_received_webhook_payload) | **POST** /remote-event-received | Remote event received |
| [**webhook_sync_finished_webhook_payload**](DefaultApi.md#webhook_sync_finished_webhook_payload) | **POST** /sync-finished | Sync finished |
## webhook_ai_apply_application_status_updated_webhook_payload
> webhook_ai_apply_application_status_updated_webhook_payload(x_kombo_signature, ai_apply_application_status_updated_webhook_payload)
AI Apply: Application status updated
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
ai_apply_application_status_updated_webhook_payload = # AiApplyApplicationStatusUpdatedWebhookPayload |
begin
# AI Apply: Application status updated
api_instance.webhook_ai_apply_application_status_updated_webhook_payload(x_kombo_signature, ai_apply_application_status_updated_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_ai_apply_application_status_updated_webhook_payload: #{e}"
end
```
#### Using the webhook_ai_apply_application_status_updated_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_ai_apply_application_status_updated_webhook_payload_with_http_info(x_kombo_signature, ai_apply_application_status_updated_webhook_payload)
```ruby
begin
# AI Apply: Application status updated
data, status_code, headers = api_instance.webhook_ai_apply_application_status_updated_webhook_payload_with_http_info(x_kombo_signature, ai_apply_application_status_updated_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_ai_apply_application_status_updated_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **ai_apply_application_status_updated_webhook_payload** | [**AiApplyApplicationStatusUpdatedWebhookPayload**](AiApplyApplicationStatusUpdatedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_ai_apply_job_posting_status_updated_webhook_payload
> webhook_ai_apply_job_posting_status_updated_webhook_payload(x_kombo_signature, ai_apply_job_posting_status_updated_webhook_payload)
AI Apply: Job posting status updated
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
ai_apply_job_posting_status_updated_webhook_payload = # AiApplyJobPostingStatusUpdatedWebhookPayload |
begin
# AI Apply: Job posting status updated
api_instance.webhook_ai_apply_job_posting_status_updated_webhook_payload(x_kombo_signature, ai_apply_job_posting_status_updated_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_ai_apply_job_posting_status_updated_webhook_payload: #{e}"
end
```
#### Using the webhook_ai_apply_job_posting_status_updated_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_ai_apply_job_posting_status_updated_webhook_payload_with_http_info(x_kombo_signature, ai_apply_job_posting_status_updated_webhook_payload)
```ruby
begin
# AI Apply: Job posting status updated
data, status_code, headers = api_instance.webhook_ai_apply_job_posting_status_updated_webhook_payload_with_http_info(x_kombo_signature, ai_apply_job_posting_status_updated_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_ai_apply_job_posting_status_updated_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **ai_apply_job_posting_status_updated_webhook_payload** | [**AiApplyJobPostingStatusUpdatedWebhookPayload**](AiApplyJobPostingStatusUpdatedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_assessment_order_received_webhook_payload
> webhook_assessment_order_received_webhook_payload(x_kombo_signature, assessment_order_received_webhook_payload)
Assessment: Order received
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
assessment_order_received_webhook_payload = # AssessmentOrderReceivedWebhookPayload |
begin
# Assessment: Order received
api_instance.webhook_assessment_order_received_webhook_payload(x_kombo_signature, assessment_order_received_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_assessment_order_received_webhook_payload: #{e}"
end
```
#### Using the webhook_assessment_order_received_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_assessment_order_received_webhook_payload_with_http_info(x_kombo_signature, assessment_order_received_webhook_payload)
```ruby
begin
# Assessment: Order received
data, status_code, headers = api_instance.webhook_assessment_order_received_webhook_payload_with_http_info(x_kombo_signature, assessment_order_received_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_assessment_order_received_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **assessment_order_received_webhook_payload** | [**AssessmentOrderReceivedWebhookPayload**](AssessmentOrderReceivedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_connection_flow_failed_webhook_payload
> webhook_connection_flow_failed_webhook_payload(x_kombo_signature, connection_flow_failed_webhook_payload)
Connection flow failed
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
connection_flow_failed_webhook_payload = # ConnectionFlowFailedWebhookPayload |
begin
# Connection flow failed
api_instance.webhook_connection_flow_failed_webhook_payload(x_kombo_signature, connection_flow_failed_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_connection_flow_failed_webhook_payload: #{e}"
end
```
#### Using the webhook_connection_flow_failed_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_connection_flow_failed_webhook_payload_with_http_info(x_kombo_signature, connection_flow_failed_webhook_payload)
```ruby
begin
# Connection flow failed
data, status_code, headers = api_instance.webhook_connection_flow_failed_webhook_payload_with_http_info(x_kombo_signature, connection_flow_failed_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_connection_flow_failed_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **connection_flow_failed_webhook_payload** | [**ConnectionFlowFailedWebhookPayload**](ConnectionFlowFailedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_data_changed_webhook_payload
> webhook_data_changed_webhook_payload(x_kombo_signature, data_changed_webhook_payload)
Data changed
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
data_changed_webhook_payload = # DataChangedWebhookPayload |
begin
# Data changed
api_instance.webhook_data_changed_webhook_payload(x_kombo_signature, data_changed_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_data_changed_webhook_payload: #{e}"
end
```
#### Using the webhook_data_changed_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_data_changed_webhook_payload_with_http_info(x_kombo_signature, data_changed_webhook_payload)
```ruby
begin
# Data changed
data, status_code, headers = api_instance.webhook_data_changed_webhook_payload_with_http_info(x_kombo_signature, data_changed_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_data_changed_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **data_changed_webhook_payload** | [**DataChangedWebhookPayload**](DataChangedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_inline_assessment_order_received_webhook_payload
> webhook_inline_assessment_order_received_webhook_payload(x_kombo_signature, inline_assessment_order_received_webhook_payload)
Inline assessment: Order received
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
inline_assessment_order_received_webhook_payload = # InlineAssessmentOrderReceivedWebhookPayload |
begin
# Inline assessment: Order received
api_instance.webhook_inline_assessment_order_received_webhook_payload(x_kombo_signature, inline_assessment_order_received_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_inline_assessment_order_received_webhook_payload: #{e}"
end
```
#### Using the webhook_inline_assessment_order_received_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_inline_assessment_order_received_webhook_payload_with_http_info(x_kombo_signature, inline_assessment_order_received_webhook_payload)
```ruby
begin
# Inline assessment: Order received
data, status_code, headers = api_instance.webhook_inline_assessment_order_received_webhook_payload_with_http_info(x_kombo_signature, inline_assessment_order_received_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_inline_assessment_order_received_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **inline_assessment_order_received_webhook_payload** | [**InlineAssessmentOrderReceivedWebhookPayload**](InlineAssessmentOrderReceivedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_integration_created_webhook_payload
> webhook_integration_created_webhook_payload(x_kombo_signature, integration_created_webhook_payload)
Integration created
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
integration_created_webhook_payload = # IntegrationCreatedWebhookPayload |
begin
# Integration created
api_instance.webhook_integration_created_webhook_payload(x_kombo_signature, integration_created_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_integration_created_webhook_payload: #{e}"
end
```
#### Using the webhook_integration_created_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_integration_created_webhook_payload_with_http_info(x_kombo_signature, integration_created_webhook_payload)
```ruby
begin
# Integration created
data, status_code, headers = api_instance.webhook_integration_created_webhook_payload_with_http_info(x_kombo_signature, integration_created_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_integration_created_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **integration_created_webhook_payload** | [**IntegrationCreatedWebhookPayload**](IntegrationCreatedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_integration_deleted_webhook_payload
> webhook_integration_deleted_webhook_payload(x_kombo_signature, integration_deleted_webhook_payload)
Integration deleted
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
integration_deleted_webhook_payload = # IntegrationDeletedWebhookPayload |
begin
# Integration deleted
api_instance.webhook_integration_deleted_webhook_payload(x_kombo_signature, integration_deleted_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_integration_deleted_webhook_payload: #{e}"
end
```
#### Using the webhook_integration_deleted_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_integration_deleted_webhook_payload_with_http_info(x_kombo_signature, integration_deleted_webhook_payload)
```ruby
begin
# Integration deleted
data, status_code, headers = api_instance.webhook_integration_deleted_webhook_payload_with_http_info(x_kombo_signature, integration_deleted_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_integration_deleted_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **integration_deleted_webhook_payload** | [**IntegrationDeletedWebhookPayload**](IntegrationDeletedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_integration_state_changed_webhook_payload
> webhook_integration_state_changed_webhook_payload(x_kombo_signature, integration_state_changed_webhook_payload)
Integration state changed
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
integration_state_changed_webhook_payload = # IntegrationStateChangedWebhookPayload |
begin
# Integration state changed
api_instance.webhook_integration_state_changed_webhook_payload(x_kombo_signature, integration_state_changed_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_integration_state_changed_webhook_payload: #{e}"
end
```
#### Using the webhook_integration_state_changed_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_integration_state_changed_webhook_payload_with_http_info(x_kombo_signature, integration_state_changed_webhook_payload)
```ruby
begin
# Integration state changed
data, status_code, headers = api_instance.webhook_integration_state_changed_webhook_payload_with_http_info(x_kombo_signature, integration_state_changed_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_integration_state_changed_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **integration_state_changed_webhook_payload** | [**IntegrationStateChangedWebhookPayload**](IntegrationStateChangedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_remote_event_received_webhook_payload
> webhook_remote_event_received_webhook_payload(x_kombo_signature, remote_event_received_webhook_payload)
Remote event received
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
remote_event_received_webhook_payload = # RemoteEventReceivedWebhookPayload |
begin
# Remote event received
api_instance.webhook_remote_event_received_webhook_payload(x_kombo_signature, remote_event_received_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_remote_event_received_webhook_payload: #{e}"
end
```
#### Using the webhook_remote_event_received_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_remote_event_received_webhook_payload_with_http_info(x_kombo_signature, remote_event_received_webhook_payload)
```ruby
begin
# Remote event received
data, status_code, headers = api_instance.webhook_remote_event_received_webhook_payload_with_http_info(x_kombo_signature, remote_event_received_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_remote_event_received_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **remote_event_received_webhook_payload** | [**RemoteEventReceivedWebhookPayload**](RemoteEventReceivedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
## webhook_sync_finished_webhook_payload
> webhook_sync_finished_webhook_payload(x_kombo_signature, sync_finished_webhook_payload)
Sync finished
### Examples
```ruby
require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
# Configure Bearer authorization: ApiKey
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Kombo::DefaultApi.new
x_kombo_signature = # String | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature.
sync_finished_webhook_payload = # SyncFinishedWebhookPayload |
begin
# Sync finished
api_instance.webhook_sync_finished_webhook_payload(x_kombo_signature, sync_finished_webhook_payload)
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_sync_finished_webhook_payload: #{e}"
end
```
#### Using the webhook_sync_finished_webhook_payload_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> <Array(nil, Integer, Hash)> webhook_sync_finished_webhook_payload_with_http_info(x_kombo_signature, sync_finished_webhook_payload)
```ruby
begin
# Sync finished
data, status_code, headers = api_instance.webhook_sync_finished_webhook_payload_with_http_info(x_kombo_signature, sync_finished_webhook_payload)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Kombo::ApiError => e
puts "Error when calling DefaultApi->webhook_sync_finished_webhook_payload_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **x_kombo_signature** | **String** | HMAC signature for webhook verification. See the webhook documentation for details on how to verify this signature. | |
| **sync_finished_webhook_payload** | [**SyncFinishedWebhookPayload**](SyncFinishedWebhookPayload.md) | | |
### Return type
nil (empty response body)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined

22
docs/DeleteAtsCandidatesCandidateIdTagsPositiveResponse.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::DeleteAtsCandidatesCandidateIdTagsPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | **Object** | | |
| **warnings** | [**Array&lt;PostPassthroughToolApiPositiveResponseWarningsInner&gt;**](PostPassthroughToolApiPositiveResponseWarningsInner.md) | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteAtsCandidatesCandidateIdTagsPositiveResponse.new(
status: null,
data: null,
warnings: null
)
```

20
docs/DeleteAtsCandidatesCandidateIdTagsRequestBody.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::DeleteAtsCandidatesCandidateIdTagsRequestBody
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **tag** | [**DeleteAtsCandidatesCandidateIdTagsRequestBodyTag**](DeleteAtsCandidatesCandidateIdTagsRequestBodyTag.md) | | |
| **remote_fields** | [**PutAtsApplicationsApplicationIdStageRequestBodyRemoteFields**](PutAtsApplicationsApplicationIdStageRequestBodyRemoteFields.md) | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteAtsCandidatesCandidateIdTagsRequestBody.new(
tag: null,
remote_fields: null
)
```

18
docs/DeleteAtsCandidatesCandidateIdTagsRequestBodyTag.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::DeleteAtsCandidatesCandidateIdTagsRequestBodyTag
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **name** | **String** | The name of the tag you would like to remove. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteAtsCandidatesCandidateIdTagsRequestBodyTag.new(
name: null
)
```

22
docs/DeleteHrisAbsencesAbsenceIdPositiveResponse.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::DeleteHrisAbsencesAbsenceIdPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**PostHrisAbsencesPositiveResponseData**](PostHrisAbsencesPositiveResponseData.md) | | |
| **warnings** | [**Array&lt;PostPassthroughToolApiPositiveResponseWarningsInner&gt;**](PostPassthroughToolApiPositiveResponseWarningsInner.md) | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteHrisAbsencesAbsenceIdPositiveResponse.new(
status: null,
data: null,
warnings: null
)
```

18
docs/DeleteHrisAbsencesAbsenceIdRequestBody.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::DeleteHrisAbsencesAbsenceIdRequestBody
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **remote_fields** | [**DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFields**](DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFields.md) | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteHrisAbsencesAbsenceIdRequestBody.new(
remote_fields: null
)
```

18
docs/DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFields.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFields
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **adpworkforcenow** | [**DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFieldsAdpworkforcenow**](DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFieldsAdpworkforcenow.md) | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFields.new(
adpworkforcenow: null
)
```

18
docs/DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFieldsAdpworkforcenow.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFieldsAdpworkforcenow
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **employment_id** | **String** | [Required] The employment ID of the employee that the absence will be deleted from. | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteHrisAbsencesAbsenceIdRequestBodyRemoteFieldsAdpworkforcenow.new(
employment_id: null
)
```

20
docs/DeleteHrisEmployeeSkillAssignmentsEmployeeSkillAssignmentIdPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::DeleteHrisEmployeeSkillAssignmentsEmployeeSkillAssignmentIdPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetHrisEmployeeSkillAssignmentsPositiveResponseDataResultsInner**](GetHrisEmployeeSkillAssignmentsPositiveResponseDataResultsInner.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteHrisEmployeeSkillAssignmentsEmployeeSkillAssignmentIdPositiveResponse.new(
status: null,
data: null
)
```

20
docs/DeleteHrisSkillsSkillIdPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::DeleteHrisSkillsSkillIdPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetHrisSkillsPositiveResponseDataResultsInner**](GetHrisSkillsPositiveResponseDataResultsInner.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteHrisSkillsSkillIdPositiveResponse.new(
status: null,
data: null
)
```

20
docs/DeleteIntegrationsIntegrationIdPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::DeleteIntegrationsIntegrationIdPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | **Object** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::DeleteIntegrationsIntegrationIdPositiveResponse.new(
status: null,
data: null
)
```

1262
docs/GeneralApi.md Normal file
View file

File diff suppressed because one or more lines are too long

20
docs/GetAiApplyApplicationsPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAiApplyApplicationsPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAiApplyApplicationsPositiveResponseData**](GetAiApplyApplicationsPositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyApplicationsPositiveResponse.new(
status: null,
data: null
)
```

20
docs/GetAiApplyApplicationsPositiveResponseData.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAiApplyApplicationsPositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **results** | [**Array&lt;GetAiApplyApplicationsPositiveResponseDataResultsInner&gt;**](GetAiApplyApplicationsPositiveResponseDataResultsInner.md) | | |
| **_next** | **String** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyApplicationsPositiveResponseData.new(
results: null,
_next: null
)
```

26
docs/GetAiApplyApplicationsPositiveResponseDataResultsInner.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::GetAiApplyApplicationsPositiveResponseDataResultsInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **job_posting_id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **status** | **String** | | |
| **created_at** | **Time** | YYYY-MM-DDTHH:mm:ss.sssZ | |
| **updated_at** | **Time** | YYYY-MM-DDTHH:mm:ss.sssZ | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyApplicationsPositiveResponseDataResultsInner.new(
id: null,
job_posting_id: null,
status: null,
created_at: null,
updated_at: null
)
```

20
docs/GetAiApplyCareerSitesPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAiApplyCareerSitesPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAiApplyCareerSitesPositiveResponseData**](GetAiApplyCareerSitesPositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyCareerSitesPositiveResponse.new(
status: null,
data: null
)
```

20
docs/GetAiApplyCareerSitesPositiveResponseData.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAiApplyCareerSitesPositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **results** | [**Array&lt;PostAiApplyCareerSitesPositiveResponseData&gt;**](PostAiApplyCareerSitesPositiveResponseData.md) | | |
| **_next** | **String** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyCareerSitesPositiveResponseData.new(
results: null,
_next: null
)
```

20
docs/GetAiApplyPostingsPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAiApplyPostingsPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAiApplyPostingsPositiveResponseData**](GetAiApplyPostingsPositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyPostingsPositiveResponse.new(
status: null,
data: null
)
```

20
docs/GetAiApplyPostingsPositiveResponseData.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAiApplyPostingsPositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **results** | [**Array&lt;GetAiApplyPostingsPositiveResponseDataResultsInner&gt;**](GetAiApplyPostingsPositiveResponseDataResultsInner.md) | | |
| **_next** | **String** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyPostingsPositiveResponseData.new(
results: null,
_next: null
)
```

34
docs/GetAiApplyPostingsPositiveResponseDataResultsInner.md Normal file
View file

@ -0,0 +1,34 @@
# Kombo::GetAiApplyPostingsPositiveResponseDataResultsInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **career_site** | [**GetAiApplyPostingsPositiveResponseDataResultsInnerCareerSite**](GetAiApplyPostingsPositiveResponseDataResultsInnerCareerSite.md) | | |
| **url** | **String** | | |
| **job_code** | **String** | | |
| **created_at** | **Time** | YYYY-MM-DDTHH:mm:ss.sssZ | |
| **updated_at** | **Time** | YYYY-MM-DDTHH:mm:ss.sssZ | |
| **archived_at** | **Time** | The date and time the job posting was archived. You can only send applications if the job posting is not archived. | |
| **archived_reason** | **String** | | |
| **availability** | **String** | The status of the job posting. You can only send applications if the job posting is \&quot;APPLYABLE\&quot;. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyPostingsPositiveResponseDataResultsInner.new(
id: null,
career_site: null,
url: null,
job_code: null,
created_at: null,
updated_at: null,
archived_at: null,
archived_reason: null,
availability: null
)
```

20
docs/GetAiApplyPostingsPositiveResponseDataResultsInnerCareerSite.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAiApplyPostingsPositiveResponseDataResultsInnerCareerSite
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **label** | **String** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyPostingsPositiveResponseDataResultsInnerCareerSite.new(
id: null,
label: null
)
```

20
docs/GetAiApplyUnifiedApiJobsPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAiApplyUnifiedApiJobsPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAiApplyUnifiedApiJobsPositiveResponseData**](GetAiApplyUnifiedApiJobsPositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyUnifiedApiJobsPositiveResponse.new(
status: null,
data: null
)
```

20
docs/GetAiApplyUnifiedApiJobsPositiveResponseData.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAiApplyUnifiedApiJobsPositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **results** | [**Array&lt;GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInner&gt;**](GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInner.md) | | |
| **_next** | **String** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyUnifiedApiJobsPositiveResponseData.new(
results: null,
_next: null
)
```

88
docs/GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInner.md Normal file
View file

@ -0,0 +1,88 @@
# Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **remote_id** | **String** | | |
| **name** | **String** | | |
| **job_code** | **String** | | |
| **description** | **String** | | |
| **confidential** | **Boolean** | | |
| **weekly_hours** | **Float** | | |
| **category** | **String** | | |
| **department** | **String** | | |
| **post_url** | **String** | | |
| **experience_level** | **String** | | |
| **salary_amount** | **Float** | | |
| **salary_amount_from** | **Float** | | |
| **salary_amount_to** | **Float** | | |
| **salary_currency** | **String** | | |
| **custom_fields** | **Object** | | |
| **integration_fields** | **Array&lt;Object&gt;** | | |
| **opened_at** | **Time** | | |
| **closed_at** | **Time** | | |
| **remote_created_at** | **Time** | | |
| **remote_updated_at** | **Time** | | |
| **contact_id** | **String** | | |
| **remote_data** | **Object** | | |
| **changed_at** | **Time** | | |
| **remote_deleted_at** | **Time** | | |
| **remote_url** | **String** | | |
| **stages** | **Array&lt;Object&gt;** | | |
| **screening_questions** | [**Array&lt;GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInner&gt;**](GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInner.md) | | |
| **job_postings** | **Array&lt;Object&gt;** | | |
| **hiring_team** | **Array&lt;Object&gt;** | | |
| **employment_type** | [**GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerEmploymentType**](GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerEmploymentType.md) | | [optional] |
| **status** | [**GetAtsJobsPositiveResponseDataResultsInnerStatus**](GetAtsJobsPositiveResponseDataResultsInnerStatus.md) | | [optional] |
| **visibility** | **String** | | |
| **remote_work_status** | **String** | | |
| **salary_period** | **String** | | |
| **location** | [**GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerLocation**](GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerLocation.md) | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInner.new(
id: null,
remote_id: null,
name: null,
job_code: null,
description: null,
confidential: null,
weekly_hours: null,
category: null,
department: null,
post_url: null,
experience_level: null,
salary_amount: null,
salary_amount_from: null,
salary_amount_to: null,
salary_currency: null,
custom_fields: null,
integration_fields: null,
opened_at: null,
closed_at: null,
remote_created_at: null,
remote_updated_at: null,
contact_id: null,
remote_data: null,
changed_at: null,
remote_deleted_at: null,
remote_url: null,
stages: null,
screening_questions: null,
job_postings: null,
hiring_team: null,
employment_type: null,
status: null,
visibility: null,
remote_work_status: null,
salary_period: null,
location: null
)
```

15
docs/GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerEmploymentType.md Normal file
View file

@ -0,0 +1,15 @@
# Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerEmploymentType
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerEmploymentType.new()
```

30
docs/GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerLocation.md Normal file
View file

@ -0,0 +1,30 @@
# Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerLocation
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **city** | **String** | | [optional] |
| **country** | **String** | Contains the ISO2 country code if possible. If not, it contains the original value. | [optional] |
| **raw** | **String** | If we have address data, this is filled with the raw address string. | [optional] |
| **state** | **String** | | [optional] |
| **street_1** | **String** | If we can parse the address data, this field contains the first part of the street information. | [optional] |
| **street_2** | **String** | | [optional] |
| **zip_code** | **String** | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerLocation.new(
city: null,
country: null,
raw: null,
state: null,
street_1: null,
street_2: null,
zip_code: null
)
```

36
docs/GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInner.md Normal file
View file

@ -0,0 +1,36 @@
# Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | | |
| **remote_id** | **String** | | |
| **title** | **String** | | |
| **description** | **String** | | |
| **format** | [**GetAtsJobsPositiveResponseDataResultsInnerScreeningQuestionsInnerFormat**](GetAtsJobsPositiveResponseDataResultsInnerScreeningQuestionsInnerFormat.md) | | [optional] |
| **category** | **String** | | |
| **index** | **Integer** | | [optional] |
| **required** | **Boolean** | | |
| **precondition_question_id** | **String** | | [optional] |
| **precondition_options** | [**GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInnerPreconditionOptions**](GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInnerPreconditionOptions.md) | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInner.new(
id: null,
remote_id: null,
title: null,
description: null,
format: null,
category: null,
index: null,
required: null,
precondition_question_id: null,
precondition_options: null
)
```

15
docs/GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInnerPreconditionOptions.md Normal file
View file

@ -0,0 +1,15 @@
# Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInnerPreconditionOptions
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAiApplyUnifiedApiJobsPositiveResponseDataResultsInnerScreeningQuestionsInnerPreconditionOptions.new()
```

20
docs/GetAssessmentOrdersOpenPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAssessmentOrdersOpenPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAssessmentOrdersOpenPositiveResponseData**](GetAssessmentOrdersOpenPositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentOrdersOpenPositiveResponse.new(
status: null,
data: null
)
```

20
docs/GetAssessmentOrdersOpenPositiveResponseData.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAssessmentOrdersOpenPositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_next** | **String** | | |
| **results** | [**Array&lt;GetAssessmentOrdersOpenPositiveResponseDataResultsInner&gt;**](GetAssessmentOrdersOpenPositiveResponseDataResultsInner.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentOrdersOpenPositiveResponseData.new(
_next: null,
results: null
)
```

26
docs/GetAssessmentOrdersOpenPositiveResponseDataResultsInner.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The unique identifier of the assessment order. | |
| **package_id** | **String** | The identifier of the assessment package. | |
| **candidate** | [**GetAssessmentOrdersOpenPositiveResponseDataResultsInnerCandidate**](GetAssessmentOrdersOpenPositiveResponseDataResultsInnerCandidate.md) | | |
| **application** | [**GetAssessmentOrdersOpenPositiveResponseDataResultsInnerApplication**](GetAssessmentOrdersOpenPositiveResponseDataResultsInnerApplication.md) | | |
| **job** | [**GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJob**](GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJob.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInner.new(
id: null,
package_id: null,
candidate: null,
application: null,
job: null
)
```

18
docs/GetAssessmentOrdersOpenPositiveResponseDataResultsInnerApplication.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerApplication
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **remote_id** | **String** | The application&#39;s identifier in the integrated system. | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerApplication.new(
remote_id: null
)
```

26
docs/GetAssessmentOrdersOpenPositiveResponseDataResultsInnerCandidate.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerCandidate
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **email** | **String** | The candidate&#39;s email address. | |
| **first_name** | **String** | The candidate&#39;s first name. | [optional] |
| **last_name** | **String** | The candidate&#39;s last name. | [optional] |
| **phone** | **String** | The candidate&#39;s phone number. | [optional] |
| **remote_id** | **String** | The candidate&#39;s identifier in the integrated system. | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerCandidate.new(
email: null,
first_name: null,
last_name: null,
phone: null,
remote_id: null
)
```

24
docs/GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJob.md Normal file
View file

@ -0,0 +1,24 @@
# Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJob
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **remote_id** | **String** | The job&#39;s identifier in the integrated system. | [optional] |
| **name** | **String** | The job title. | [optional] |
| **location** | [**GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobLocation**](GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobLocation.md) | | [optional] |
| **hiring_team** | [**Array&lt;GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobHiringTeamInner&gt;**](GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobHiringTeamInner.md) | The hiring team allows you to sync users into your system who can access the job and its applications. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJob.new(
remote_id: null,
name: null,
location: null,
hiring_team: null
)
```

26
docs/GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobHiringTeamInner.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobHiringTeamInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **remote_id** | **String** | The team member&#39;s identifier in the integrated system. | |
| **email** | **String** | The team member&#39;s email address. | |
| **first_name** | **String** | The team member&#39;s first name. | |
| **last_name** | **String** | The team member&#39;s last name. | |
| **hiring_team_roles** | **Array&lt;String&gt;** | Array of the roles of the user for this specific job. Currently only &#x60;RECRUITER&#x60; and &#x60;HIRING_MANAGER&#x60; are mapped into our unified schema. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobHiringTeamInner.new(
remote_id: null,
email: null,
first_name: null,
last_name: null,
hiring_team_roles: null
)
```

30
docs/GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobLocation.md Normal file
View file

@ -0,0 +1,30 @@
# Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobLocation
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **city** | **String** | | [optional] |
| **country** | **String** | Contains the ISO2 country code if possible. If not, it contains the original value. | [optional] |
| **raw** | **String** | If we have address data, this is filled with the raw address string. | [optional] |
| **state** | **String** | | [optional] |
| **street_1** | **String** | If we can parse the address data, this field contains the first part of the street information. | [optional] |
| **street_2** | **String** | | [optional] |
| **zip_code** | **String** | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentOrdersOpenPositiveResponseDataResultsInnerJobLocation.new(
city: null,
country: null,
raw: null,
state: null,
street_1: null,
street_2: null,
zip_code: null
)
```

20
docs/GetAssessmentPackagesPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAssessmentPackagesPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAssessmentPackagesPositiveResponseData**](GetAssessmentPackagesPositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentPackagesPositiveResponse.new(
status: null,
data: null
)
```

18
docs/GetAssessmentPackagesPositiveResponseData.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::GetAssessmentPackagesPositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **packages** | [**Array&lt;GetAssessmentPackagesPositiveResponseDataPackagesInner&gt;**](GetAssessmentPackagesPositiveResponseDataPackagesInner.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentPackagesPositiveResponseData.new(
packages: null
)
```

26
docs/GetAssessmentPackagesPositiveResponseDataPackagesInner.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::GetAssessmentPackagesPositiveResponseDataPackagesInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | | |
| **name** | **String** | | |
| **description** | **String** | | |
| **updated_at** | **Time** | YYYY-MM-DDTHH:mm:ss.sssZ | |
| **type** | **String** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAssessmentPackagesPositiveResponseDataPackagesInner.new(
id: null,
name: null,
description: null,
updated_at: null,
type: null
)
```

20
docs/GetAtsActionsAtsAddApplicationAttachmentPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAtsActionsAtsAddApplicationAttachmentPositiveResponseData**](GetAtsActionsAtsAddApplicationAttachmentPositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponse.new(
status: null,
data: null
)
```

18
docs/GetAtsActionsAtsAddApplicationAttachmentPositiveResponseData.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **attachment_restrictions** | [**GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictions**](GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictions.md) | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseData.new(
attachment_restrictions: null
)
```

18
docs/GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictions.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictions
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **types** | [**GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypes**](GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypes.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictions.new(
types: null
)
```

22
docs/GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypes.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypes
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **cv** | [**GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCV**](GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCV.md) | | |
| **cover_letter** | [**GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER**](GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER.md) | | |
| **other** | [**GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesOTHER**](GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesOTHER.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypes.new(
cv: null,
cover_letter: null,
other: null
)
```

22
docs/GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **is_supported** | **Boolean** | | |
| **max_file_size_bytes** | **Float** | The maximum file size in bytes. If null, we don&#39;t have information about the maximum file size. | |
| **accepted_mime_types** | **Array&lt;String&gt;** | The accepted mime types. If null, we don&#39;t have information about the accepted mime types. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER.new(
is_supported: null,
max_file_size_bytes: null,
accepted_mime_types: null
)
```

22
docs/GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCV.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCV
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **is_supported** | **Boolean** | | |
| **max_file_size_bytes** | **Float** | The maximum file size in bytes. If null, we don&#39;t have information about the maximum file size. | |
| **accepted_mime_types** | **Array&lt;String&gt;** | The accepted mime types. If null, we don&#39;t have information about the accepted mime types. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCV.new(
is_supported: null,
max_file_size_bytes: null,
accepted_mime_types: null
)
```

22
docs/GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCVAnyOf.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCVAnyOf
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **is_supported** | **Boolean** | | |
| **max_file_size_bytes** | **Float** | The maximum file size in bytes. If null, we don&#39;t have information about the maximum file size. | |
| **accepted_mime_types** | **Array&lt;String&gt;** | The accepted mime types. If null, we don&#39;t have information about the accepted mime types. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesCVAnyOf.new(
is_supported: null,
max_file_size_bytes: null,
accepted_mime_types: null
)
```

22
docs/GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesOTHER.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesOTHER
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **is_supported** | **Boolean** | | |
| **max_file_size_bytes** | **Float** | The maximum file size in bytes. If null, we don&#39;t have information about the maximum file size. | |
| **accepted_mime_types** | **Array&lt;String&gt;** | The accepted mime types. If null, we don&#39;t have information about the accepted mime types. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsAddApplicationAttachmentPositiveResponseDataAttachmentRestrictionsTypesOTHER.new(
is_supported: null,
max_file_size_bytes: null,
accepted_mime_types: null
)
```

20
docs/GetAtsActionsAtsAddCandidateAttachmentPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAtsActionsAtsAddCandidateAttachmentPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAtsActionsAtsAddApplicationAttachmentPositiveResponseData**](GetAtsActionsAtsAddApplicationAttachmentPositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsAddCandidateAttachmentPositiveResponse.new(
status: null,
data: null
)
```

20
docs/GetAtsActionsAtsCreateApplicationPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAtsActionsAtsCreateApplicationPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAtsActionsAtsCreateCandidatePositiveResponseData**](GetAtsActionsAtsCreateCandidatePositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateApplicationPositiveResponse.new(
status: null,
data: null
)
```

20
docs/GetAtsActionsAtsCreateCandidatePositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAtsActionsAtsCreateCandidatePositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAtsActionsAtsCreateCandidatePositiveResponseData**](GetAtsActionsAtsCreateCandidatePositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateCandidatePositiveResponse.new(
status: null,
data: null
)
```

18
docs/GetAtsActionsAtsCreateCandidatePositiveResponseData.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **attachment_restrictions** | [**GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictions**](GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictions.md) | | [optional] |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseData.new(
attachment_restrictions: null
)
```

20
docs/GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictions.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictions
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **total_size_bytes** | **Float** | The maximum total size of all attachments. If null, we don&#39; have information about the total size of all attachments. Make sure to consider the total request size limits of Kombo. | |
| **types** | [**GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypes**](GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypes.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictions.new(
total_size_bytes: null,
types: null
)
```

22
docs/GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypes.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypes
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **cv** | [**GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCV**](GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCV.md) | | |
| **cover_letter** | [**GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER**](GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER.md) | | |
| **other** | [**GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesOTHER**](GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesOTHER.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypes.new(
cv: null,
cover_letter: null,
other: null
)
```

26
docs/GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **is_supported** | **Boolean** | | |
| **min_amount** | **Float** | The minimum amount of attachments. If null, we don&#39; have information about the minimum amount. | |
| **max_amount** | **Float** | The maximum amount of attachments. If null, we don&#39; have information about the maximum amount. | |
| **max_file_size_bytes** | **Float** | The maximum file size in bytes. If null, we don&#39;t have information about the maximum file size. | |
| **accepted_mime_types** | **Array&lt;String&gt;** | The accepted mime types. If null, we don&#39;t have information about the accepted mime types. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCOVERLETTER.new(
is_supported: null,
min_amount: null,
max_amount: null,
max_file_size_bytes: null,
accepted_mime_types: null
)
```

26
docs/GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCV.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCV
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **is_supported** | **Boolean** | | |
| **min_amount** | **Float** | The minimum amount of attachments. If null, we don&#39; have information about the minimum amount. | |
| **max_amount** | **Float** | The maximum amount of attachments. If null, we don&#39; have information about the maximum amount. | |
| **max_file_size_bytes** | **Float** | The maximum file size in bytes. If null, we don&#39;t have information about the maximum file size. | |
| **accepted_mime_types** | **Array&lt;String&gt;** | The accepted mime types. If null, we don&#39;t have information about the accepted mime types. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCV.new(
is_supported: null,
min_amount: null,
max_amount: null,
max_file_size_bytes: null,
accepted_mime_types: null
)
```

26
docs/GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCVAnyOf.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCVAnyOf
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **is_supported** | **Boolean** | | |
| **min_amount** | **Float** | The minimum amount of attachments. If null, we don&#39; have information about the minimum amount. | |
| **max_amount** | **Float** | The maximum amount of attachments. If null, we don&#39; have information about the maximum amount. | |
| **max_file_size_bytes** | **Float** | The maximum file size in bytes. If null, we don&#39;t have information about the maximum file size. | |
| **accepted_mime_types** | **Array&lt;String&gt;** | The accepted mime types. If null, we don&#39;t have information about the accepted mime types. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCVAnyOf.new(
is_supported: null,
min_amount: null,
max_amount: null,
max_file_size_bytes: null,
accepted_mime_types: null
)
```

18
docs/GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCVAnyOf1.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCVAnyOf1
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **is_supported** | **Boolean** | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesCVAnyOf1.new(
is_supported: null
)
```

26
docs/GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesOTHER.md Normal file
View file

@ -0,0 +1,26 @@
# Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesOTHER
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **is_supported** | **Boolean** | | |
| **min_amount** | **Float** | The minimum amount of attachments. If null, we don&#39; have information about the minimum amount. | |
| **max_amount** | **Float** | The maximum amount of attachments. If null, we don&#39; have information about the maximum amount. | |
| **max_file_size_bytes** | **Float** | The maximum file size in bytes. If null, we don&#39;t have information about the maximum file size. | |
| **accepted_mime_types** | **Array&lt;String&gt;** | The accepted mime types. If null, we don&#39;t have information about the accepted mime types. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsActionsAtsCreateCandidatePositiveResponseDataAttachmentRestrictionsTypesOTHER.new(
is_supported: null,
min_amount: null,
max_amount: null,
max_file_size_bytes: null,
accepted_mime_types: null
)
```

15
docs/GetAtsApplicationStagesParameterIncludeDeleted.md Normal file
View file

@ -0,0 +1,15 @@
# Kombo::GetAtsApplicationStagesParameterIncludeDeleted
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsApplicationStagesParameterIncludeDeleted.new()
```

20
docs/GetAtsApplicationStagesPositiveResponse.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAtsApplicationStagesPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAtsApplicationStagesPositiveResponseData**](GetAtsApplicationStagesPositiveResponseData.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsApplicationStagesPositiveResponse.new(
status: null,
data: null
)
```

20
docs/GetAtsApplicationStagesPositiveResponseData.md Normal file
View file

@ -0,0 +1,20 @@
# Kombo::GetAtsApplicationStagesPositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_next** | **String** | Cursor string that can be passed to the &#x60;cursor&#x60; query parameter to get the next page. If this is &#x60;null&#x60;, then there are no more pages. | |
| **results** | [**Array&lt;GetAtsApplicationStagesPositiveResponseDataResultsInner&gt;**](GetAtsApplicationStagesPositiveResponseDataResultsInner.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsApplicationStagesPositiveResponseData.new(
_next: null,
results: null
)
```

28
docs/GetAtsApplicationStagesPositiveResponseDataResultsInner.md Normal file
View file

@ -0,0 +1,28 @@
# Kombo::GetAtsApplicationStagesPositiveResponseDataResultsInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. | |
| **remote_id** | **String** | The raw ID of the object in the remote system. We don&#39;t recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn&#39;t provide a clear primary key. | |
| **name** | **String** | The application stage name. For example, \&quot;Initial Screening\&quot;. | |
| **remote_data** | **Hash&lt;String, Object&gt;** | Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: &#x60;{ \&quot;/companies\&quot;: { ... }}&#x60; This is not available on all plans. Reach out to Kombo if you need it. | |
| **changed_at** | **Time** | The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the &#x60;updated_after&#x60; parameter which will return records when either the record itself OR its related models have been updated. | |
| **remote_deleted_at** | **Time** | The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can&#39;t retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsApplicationStagesPositiveResponseDataResultsInner.new(
id: null,
remote_id: null,
name: null,
remote_data: null,
changed_at: null,
remote_deleted_at: null
)
```

22
docs/GetAtsApplicationsApplicationIdAttachmentsPositiveResponse.md Normal file
View file

@ -0,0 +1,22 @@
# Kombo::GetAtsApplicationsApplicationIdAttachmentsPositiveResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **status** | **String** | | |
| **data** | [**GetAtsApplicationsApplicationIdAttachmentsPositiveResponseData**](GetAtsApplicationsApplicationIdAttachmentsPositiveResponseData.md) | | |
| **warnings** | [**Array&lt;PostPassthroughToolApiPositiveResponseWarningsInner&gt;**](PostPassthroughToolApiPositiveResponseWarningsInner.md) | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsApplicationsApplicationIdAttachmentsPositiveResponse.new(
status: null,
data: null,
warnings: null
)
```

18
docs/GetAtsApplicationsApplicationIdAttachmentsPositiveResponseData.md Normal file
View file

@ -0,0 +1,18 @@
# Kombo::GetAtsApplicationsApplicationIdAttachmentsPositiveResponseData
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **results** | [**Array&lt;GetAtsApplicationsApplicationIdAttachmentsPositiveResponseDataResultsInner&gt;**](GetAtsApplicationsApplicationIdAttachmentsPositiveResponseDataResultsInner.md) | | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsApplicationsApplicationIdAttachmentsPositiveResponseData.new(
results: null
)
```

32
docs/GetAtsApplicationsApplicationIdAttachmentsPositiveResponseDataResultsInner.md Normal file
View file

@ -0,0 +1,32 @@
# Kombo::GetAtsApplicationsApplicationIdAttachmentsPositiveResponseDataResultsInner
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **type** | **String** | | |
| **id** | **String** | | |
| **remote_id** | **String** | | |
| **data_url** | **String** | | |
| **file_name** | **String** | | |
| **content_type** | **String** | | |
| **remote_created_at** | **Time** | The date when the attachment was created. | |
| **remote_updated_at** | **Time** | The date when the attachment was last updated. | |
## Example
```ruby
require 'kombo_client'
instance = Kombo::GetAtsApplicationsApplicationIdAttachmentsPositiveResponseDataResultsInner.new(
type: null,
id: null,
remote_id: null,
data_url: null,
file_name: null,
content_type: null,
remote_created_at: null,
remote_updated_at: null
)
```

Some files were not shown because too many files have changed in this diff Show more